feat: Add shared ESLint config, rename tanstackBuildConfig (#103)

* chore: Add custom eslint flat config

* Newline

* Update maps

* Add eslint export

* Rename to tanstackVitePlugin

* Try downgrading prettier

* Remove tanstack/temp

Author: lachlancollins

.prettierignore

@@ -0,0 +1,8 @@
+**/.next
+**/.nx/cache
+**/.svelte-kit
+**/coverage
+**/dist
+**/docs
+**/snap
+pnpm-lock.yaml

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "all"
+}

.vscode/settings.json

@@ -55,7 +55,7 @@ function checkForConfigFile(configPath) {
   console.error(
     [
       'No tanstack.config.js file found!',
-      'This may be because you\'re not passing the --config or --cwd flags.',
+      "This may be because you're not passing the --config or --cwd flags.",
       'If you are passing these flags, check that the path is correct.',
       'Otherwise, you can create a `tanstack.config.js` file in your project root.',
     ].join('\n'),

bin/config.js

@@ -14,12 +14,16 @@
           "to": "overview"
         },
         {
-          "label": "Build",
-          "to": "build"
+          "label": "ESLint",
+          "to": "eslint"
         },
         {
           "label": "Publish",
           "to": "publish"
+        },
+        {
+          "label": "Vite",
+          "to": "vite"
         }
       ]
     }

docs/config.json

@@ -0,0 +1,6 @@
+---
+id: eslint
+title: ESLint
+---
+
+To-do!

docs/eslint.md

@@ -7,8 +7,9 @@ TanStack Config allows you to publish, update, and maintain your packages withou
 
 ## Utilities
 
-- [Build](../build)
+- [ESLint](../eslint)
 - [Publish](../publish)
+- [Vite](../vite)
 
 ## Required Pre-Requisites
 

docs/overview.md

@@ -1,6 +1,6 @@
 ---
-id: build
-title: Build
+id: vite
+title: Vite
 ---
 
 The Vite build setup is the culmination of several attempts to dual publish ESM and CJS for TanStack projects, while preserving compatibility with all Typescript module resolution options.
@@ -45,22 +45,22 @@ The build config is quite opinionated, as it is designed to work with our intern
 
 ### vite.config.ts
 
-- Import `mergeConfig` and `tanstackBuildConfig`.
-- Merge your custom config first, followed by `tanstackBuildConfig`.
+- Import `mergeConfig` and `tanstackViteConfig`.
+- Merge your custom config first, followed by `tanstackViteConfig`.
 - Please avoid modifying `build` in your custom config.
 - See an example below:
 
 ```ts
 import { defineConfig, mergeConfig } from 'vite'
-import { tanstackBuildConfig } from '@tanstack/config/build'
+import { tanstackViteConfig } from '@tanstack/config/vite'
 
 const config = defineConfig({
   // Framework plugins, vitest config, etc.
 })
 
 export default mergeConfig(
   config,
-  tanstackBuildConfig({
+  tanstackViteConfig({
     entry: './src/index.ts',
     srcDir: './src',
   }),

docs/build.md renamed to docs/vite.md

@@ -1,28 +1,5 @@
-import antfu from '@antfu/eslint-config'
+// @ts-check
 
-export default antfu(
-  {
-    formatters: true,
-    ignores: [
-      '**/snap',
-      '**/vite.config.js.timestamp-*',
-      '**/vite.config.ts.timestamp-*',
-    ],
-  },
-  {
-    rules: {
-      'antfu/if-newline': 'off',
-      'antfu/top-level-function': 'off',
-      'jsdoc/require-returns-description': 'off',
-      'style/arrow-parens': ['error', 'always'],
-      'style/brace-style': ['error', '1tbs'],
-      'node/prefer-global/process': 'off',
-      'ts/array-type': ['error', { default: 'generic', readonly: 'generic' }],
-      'ts/ban-ts-comment': 'off',
-      'ts/consistent-type-definitions': 'off',
-      'ts/no-inferrable-types': ['error', { ignoreParameters: true }],
-      'curly': 'off',
-      'no-console': 'off',
-    },
-  },
-)
+import { rootConfig } from './src/eslint/index.js'
+
+export default [...rootConfig]

eslint.config.js

@@ -1,6 +1,6 @@
 import { defineConfig, mergeConfig } from 'vitest/config'
 import react from '@vitejs/plugin-react'
-import { tanstackBuildConfig } from '@tanstack/config/build'
+import { tanstackViteConfig } from '@tanstack/config/vite'
 
 const config = defineConfig({
   plugins: [react()],
@@ -12,7 +12,7 @@ const config = defineConfig({
 
 export default mergeConfig(
   config,
-  tanstackBuildConfig({
+  tanstackViteConfig({
     entry: './src/index.ts',
     srcDir: './src',
   }),