chore: release v0.38.0

Co-authored-by: 赵龙生 <zhaolongsheng@tenwit.com>

README.md

@@ -3,7 +3,7 @@
 [![npm](https://img.shields.io/npm/v/@antfu/eslint-config?color=a1b858&label=)](https://npmjs.com/package/@antfu/eslint-config)
 
 - Single quotes, no semi
-- Auto fix for formatting (aimed to be used standalone without Prettier)
+- Auto fix for formatting (aimed to be used standalone **without** Prettier)
 - Designed to work with TypeScript, Vue out-of-box
 - Lint also for json, yaml, markdown
 - Sorted imports, dangling commas
@@ -68,9 +68,53 @@ module.exports = {
 }
 ```
 
-## Extended Reading
+### Lint Staged
 
-Learn more about the context - [Why I don't use Prettier](https://antfu.me/posts/why-not-prettier).
+If you want to apply lint and auto-fix before every commit, you can add the following to your `package.json`:
+
+```json
+{
+  "simple-git-hooks": {
+    "pre-commit": "pnpm lint-staged"
+  },
+  "lint-staged": {
+    "*": "eslint --fix"
+  }
+}
+```
+
+and then
+
+```bash
+npm i -D lint-staged simple-git-hooks
+```
+
+## FAQ
+
+### Prettier?
+
+[Why I don't use Prettier](https://antfu.me/posts/why-not-prettier)
+
+### How to lint CSS?
+
+This config does NOT lint CSS. I personally use [UnoCSS](https://github.com/unocss/unocss) so I don't write CSS. If you still prefer CSS, you can use [stylelint](https://stylelint.io/) for CSS linting.
+
+### I prefer XXX...
+
+Sure, you can override the rules in your `.eslintrc` file.
+
+<!-- eslint-skip -->
+
+```jsonc
+{
+  "extends": "@antfu",
+  "rules": {
+    // your rules...
+  }
+}
+```
+
+Or you can always fork this repo and make your own.
 
 ## Check Also
 

fixtures/vitesse/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "private": true,
-  "packageManager": "pnpm@7.8.0",
+  "packageManager": "pnpm@8.0.0",
   "scripts": {
     "build": "vite-ssg build",
     "dev": "vite --port 3333 --open",
@@ -15,48 +15,48 @@
     "up": "taze major -I"
   },
   "dependencies": {
-    "@unocss/reset": "^0.49.1",
-    "@vueuse/core": "^9.11.1",
-    "@vueuse/head": "^1.0.23",
+    "@unocss/reset": "^0.50.6",
+    "@vueuse/core": "^9.13.0",
+    "@vueuse/head": "^1.1.23",
     "nprogress": "^0.2.0",
-    "pinia": "^2.0.29",
-    "vue": "^3.2.45",
+    "pinia": "^2.0.33",
+    "vue": "^3.2.47",
     "vue-demi": "^0.13.11",
     "vue-i18n": "^9.2.2",
     "vue-router": "^4.1.6"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^0.34.1",
-    "@iconify-json/carbon": "^1.1.14",
+    "@antfu/eslint-config": "^0.37.0",
+    "@iconify-json/carbon": "^1.1.16",
     "@intlify/vite-plugin-vue-i18n": "^7.0.0",
     "@types/markdown-it-link-attributes": "^3.0.1",
     "@types/nprogress": "^0.2.0",
-    "@vitejs/plugin-vue": "^4.0.0",
-    "@vue/test-utils": "^2.2.8",
+    "@vitejs/plugin-vue": "^4.1.0",
+    "@vue/test-utils": "^2.3.2",
     "critters": "^0.0.16",
     "cross-env": "^7.0.3",
-    "cypress": "^12.4.1",
-    "eslint": "^8.33.0",
-    "eslint-plugin-cypress": "^2.12.1",
+    "cypress": "^12.9.0",
+    "eslint": "^8.37.0",
+    "eslint-plugin-cypress": "^2.13.2",
     "https-localhost": "^4.7.1",
     "markdown-it-link-attributes": "^4.0.1",
-    "markdown-it-shiki": "^0.7.2",
-    "pnpm": "^7.26.1",
-    "shiki": "^0.13.0",
-    "taze": "^0.8.5",
-    "typescript": "^4.9.4",
-    "unocss": "^0.49.1",
-    "unplugin-auto-import": "^0.12.2",
-    "unplugin-vue-components": "^0.23.0",
-    "vite": "^4.0.4",
-    "vite-plugin-inspect": "^0.7.15",
-    "vite-plugin-pages": "^0.28.0",
-    "vite-plugin-pwa": "^0.14.1",
-    "vite-plugin-vue-layouts": "^0.7.0",
-    "vite-plugin-vue-markdown": "^0.22.2",
+    "markdown-it-shiki": "^0.8.0",
+    "pnpm": "^8.0.0",
+    "shiki": "^0.14.1",
+    "taze": "^0.9.1",
+    "typescript": "^5.0.2",
+    "unocss": "^0.50.6",
+    "unplugin-auto-import": "^0.15.2",
+    "unplugin-vue-components": "^0.24.1",
+    "vite": "^4.2.1",
+    "vite-plugin-inspect": "^0.7.18",
+    "vite-plugin-pages": "^0.29.0",
+    "vite-plugin-pwa": "^0.14.7",
+    "vite-plugin-vue-layouts": "^0.8.0",
+    "vite-plugin-vue-markdown": "^0.22.4",
     "vite-ssg": "^0.22.1",
     "vite-ssg-sitemap": "^0.4.3",
-    "vitest": "^0.28.3",
-    "vue-tsc": "^1.0.24"
+    "vitest": "^0.29.8",
+    "vue-tsc": "^1.2.0"
   }
 }

fixtures/vitesse/src/components/Footer.vue

@@ -1,7 +1,7 @@
 <script setup lang="ts">
 const { t, availableLocales, locale } = useI18n()
 
-const toggleLocales = () => {
+function toggleLocales() {
   // change to some real logic
   const locales = availableLocales
   locale.value = locales[(locales.indexOf(locale.value) + 1) % locales.length]

fixtures/vitesse/src/pages/index.vue

@@ -3,7 +3,7 @@ const user = useUserStore()
 const name = $ref(user.savedName)
 
 const router = useRouter()
-const go = () => {
+function go() {
   if (name)
     router.push(`/hi/${encodeURIComponent(name)}`)
 }

fixtures/vitesse/vite.config.ts

@@ -1,4 +1,4 @@
-import path from 'path'
+import path from 'node:path'
 import { defineConfig } from 'vite'
 import Vue from '@vitejs/plugin-vue'
 import Pages from 'vite-plugin-pages'

package.json

@@ -1,22 +1,22 @@
 {
   "name": "@antfu/eslint-config-monorepo",
-  "version": "0.35.0",
+  "version": "0.38.0",
   "private": true,
-  "packageManager": "pnpm@7.1.0",
+  "packageManager": "pnpm@8.0.0",
   "author": "Anthony Fu <anthonyfu117@hotmail.com> (https://github.com/antfu/)",
   "license": "MIT",
   "scripts": {
     "lint": "eslint .",
     "test": "pnpm -r run test",
     "prepare": "pnpm -r run stub",
-    "release": "bumpp package.json packages/*/package.json --commit --push --tag && pnpm -r publish --access public"
+    "release": "bumpp -r && pnpm -r publish"
   },
   "devDependencies": {
     "@antfu/eslint-config": "*",
-    "bumpp": "^8.2.1",
-    "eslint": "^8.33.0",
+    "bumpp": "^9.0.0",
+    "eslint": "^8.37.0",
     "eslint-plugin-antfu": "workspace:*",
-    "rimraf": "^4.1.2",
-    "typescript": "^4.9.4"
+    "rimraf": "^4.4.1",
+    "typescript": "^5.0.2"
   }
 }

packages/eslint-config-basic/index.js

@@ -28,6 +28,17 @@ module.exports = {
     'pnpm-lock.yaml',
     'yarn.lock',
     '__snapshots__',
+    // ignore for in lint-staged
+    '*.css',
+    '*.png',
+    '*.ico',
+    '*.toml',
+    '*.patch',
+    '*.txt',
+    '*.crt',
+    '*.key',
+    'Dockerfile',
+    // force include
     '!.github',
     '!.vitepress',
     '!.vscode',
@@ -326,6 +337,8 @@ module.exports = {
     'unicorn/prefer-type-error': 'error',
     // Use new when throwing error
     'unicorn/throw-new-error': 'error',
+    // Prefer using the node: protocol
+    'unicorn/prefer-node-protocol': 'error',
 
     'no-use-before-define': ['error', { functions: false, classes: false, variables: true }],
     'eslint-comments/disable-enable-pair': 'off',
@@ -352,6 +365,7 @@ module.exports = {
     // antfu
     'antfu/if-newline': 'error',
     'antfu/import-dedupe': 'error',
+    'antfu/top-level-function': 'error',
     // 'antfu/prefer-inline-type-import': 'error',
   },
 }

packages/eslint-config-basic/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antfu/eslint-config-basic",
-  "version": "0.35.0",
+  "version": "0.38.0",
   "description": "",
   "author": "Anthony Fu <anthonyfu117@hotmail.com> (https://github.com/antfu/)",
   "license": "MIT",
@@ -23,18 +23,18 @@
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-html": "^7.1.0",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jsonc": "^2.6.0",
+    "eslint-plugin-jsonc": "^2.7.0",
     "eslint-plugin-markdown": "^3.0.0",
-    "eslint-plugin-n": "^15.6.1",
+    "eslint-plugin-n": "^15.7.0",
     "eslint-plugin-no-only-tests": "^3.1.0",
     "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-unicorn": "^45.0.2",
+    "eslint-plugin-unicorn": "^46.0.0",
     "eslint-plugin-unused-imports": "^2.0.0",
-    "eslint-plugin-yml": "^1.4.0",
-    "jsonc-eslint-parser": "^2.1.0",
-    "yaml-eslint-parser": "^1.1.0"
+    "eslint-plugin-yml": "^1.5.0",
+    "jsonc-eslint-parser": "^2.2.0",
+    "yaml-eslint-parser": "^1.2.0"
   },
   "devDependencies": {
-    "eslint": "^8.33.0"
+    "eslint": "^8.37.0"
   }
 }

packages/eslint-config-react/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antfu/eslint-config-react",
-  "version": "0.35.0",
+  "version": "0.38.0",
   "description": "",
   "author": "Anthony Fu <anthonyfu117@hotmail.com> (https://github.com/antfu/)",
   "license": "MIT",
@@ -20,12 +20,12 @@
   },
   "dependencies": {
     "@antfu/eslint-config-ts": "workspace:*",
-    "eslint-plugin-react": "^7.32.1",
+    "eslint-plugin-react": "^7.32.2",
     "eslint-plugin-react-hooks": "^4.6.0"
   },
   "devDependencies": {
-    "eslint": "^8.33.0",
+    "eslint": "^8.37.0",
     "react": "^18.2.0",
-    "typescript": "^4.9.4"
+    "typescript": "^5.0.2"
   }
 }

packages/eslint-config-ts/index.js

@@ -1,5 +1,5 @@
-const fs = require('fs')
-const { join } = require('path')
+const fs = require('node:fs')
+const { join } = require('node:path')
 const basic = require('@antfu/eslint-config-basic')
 
 const tsconfig = process.env.ESLINT_TSCONFIG || 'tsconfig.eslint.json'
@@ -171,5 +171,7 @@ module.exports = {
     '@typescript-eslint/ban-types': 'off',
     '@typescript-eslint/no-namespace': 'off',
     '@typescript-eslint/triple-slash-reference': 'off',
+    // handled by unused-imports/no-unused-imports
+    '@typescript-eslint/no-unused-vars': 'off',
   },
 }

packages/eslint-config-ts/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antfu/eslint-config-ts",
-  "version": "0.35.0",
+  "version": "0.38.0",
   "description": "",
   "author": "Anthony Fu <anthonyfu117@hotmail.com> (https://github.com/antfu/)",
   "license": "MIT",
@@ -18,11 +18,11 @@
   },
   "dependencies": {
     "@antfu/eslint-config-basic": "workspace:*",
-    "@typescript-eslint/eslint-plugin": "^5.49.0",
-    "@typescript-eslint/parser": "^5.49.0",
+    "@typescript-eslint/eslint-plugin": "^5.57.0",
+    "@typescript-eslint/parser": "^5.57.0",
     "eslint-plugin-jest": "^27.2.1"
   },
   "devDependencies": {
-    "eslint": "^8.33.0"
+    "eslint": "^8.37.0"
   }
 }

packages/eslint-config-vue/index.js

@@ -35,6 +35,7 @@ module.exports = {
     'vue/require-default-prop': 'off',
     'vue/multi-word-component-names': 'off',
     'vue/prefer-import-from-vue': 'off',
+    'vue/no-v-text-v-html-on-component': 'off',
 
     // reactivity transform
     'vue/no-setup-props-destructure': 'off',
@@ -57,7 +58,7 @@ module.exports = {
     }],
     'vue/no-restricted-v-bind': ['error', '/^v-/'],
     'vue/no-useless-v-bind': 'error',
-    'vue/no-v-text-v-html-on-component': 'error',
+    'vue/no-unused-refs': 'error',
     'vue/padding-line-between-blocks': ['error', 'always'],
     'vue/prefer-separate-static-class': 'error',
 

packages/eslint-config-vue/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antfu/eslint-config-vue",
-  "version": "0.35.0",
+  "version": "0.38.0",
   "description": "",
   "author": "Anthony Fu <anthonyfu117@hotmail.com> (https://github.com/antfu/)",
   "license": "MIT",
@@ -17,10 +17,10 @@
   "dependencies": {
     "@antfu/eslint-config-basic": "workspace:*",
     "@antfu/eslint-config-ts": "workspace:*",
-    "eslint-plugin-vue": "^9.9.0",
+    "eslint-plugin-vue": "^9.10.0",
     "local-pkg": "^0.4.3"
   },
   "devDependencies": {
-    "eslint": "^8.33.0"
+    "eslint": "^8.37.0"
   }
 }

packages/eslint-config/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antfu/eslint-config",
-  "version": "0.35.0",
+  "version": "0.38.0",
   "description": "Anthony's ESLint config",
   "author": "Anthony Fu <anthonyfu117@hotmail.com> (https://github.com/antfu/)",
   "license": "MIT",
@@ -17,21 +17,21 @@
   },
   "dependencies": {
     "@antfu/eslint-config-vue": "workspace:*",
-    "@typescript-eslint/eslint-plugin": "^5.49.0",
-    "@typescript-eslint/parser": "^5.49.0",
+    "@typescript-eslint/eslint-plugin": "^5.57.0",
+    "@typescript-eslint/parser": "^5.57.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-html": "^7.1.0",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jsonc": "^2.6.0",
-    "eslint-plugin-n": "^15.6.1",
+    "eslint-plugin-jsonc": "^2.7.0",
+    "eslint-plugin-n": "^15.7.0",
     "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-unicorn": "^45.0.2",
-    "eslint-plugin-vue": "^9.9.0",
-    "eslint-plugin-yml": "^1.4.0",
-    "jsonc-eslint-parser": "^2.1.0",
-    "yaml-eslint-parser": "^1.1.0"
+    "eslint-plugin-unicorn": "^46.0.0",
+    "eslint-plugin-vue": "^9.10.0",
+    "eslint-plugin-yml": "^1.5.0",
+    "jsonc-eslint-parser": "^2.2.0",
+    "yaml-eslint-parser": "^1.2.0"
   },
   "devDependencies": {
-    "eslint": "^8.33.0"
+    "eslint": "^8.37.0"
   }
 }

packages/eslint-plugin-antfu/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-antfu",
-  "version": "0.35.0",
+  "version": "0.38.0",
   "license": "MIT",
   "homepage": "https://github.com/antfu/eslint-config",
   "main": "./dist/index.cjs",
@@ -16,11 +16,11 @@
     "prepublishOnly": "nr build"
   },
   "dependencies": {
-    "@typescript-eslint/utils": "^5.49.0"
+    "@typescript-eslint/utils": "^5.57.0"
   },
   "devDependencies": {
-    "@types/node": "^18.11.18",
-    "unbuild": "^1.1.1",
-    "vitest": "^0.28.3"
+    "@types/node": "^18.15.11",
+    "unbuild": "^1.1.2",
+    "vitest": "^0.29.8"
   }
 }

packages/eslint-plugin-antfu/src/index.ts

@@ -2,6 +2,7 @@ import genericSpacing from './rules/generic-spacing'
 import ifNewline from './rules/if-newline'
 import importDedupe from './rules/import-dedupe'
 import preferInlineTypeImport from './rules/prefer-inline-type-import'
+import topLevelFunction from './rules/top-level-function'
 
 export default {
   rules: {
@@ -9,5 +10,6 @@ export default {
     'import-dedupe': importDedupe,
     'prefer-inline-type-import': preferInlineTypeImport,
     'generic-spacing': genericSpacing,
+    'top-level-function': topLevelFunction,
   },
 }

packages/eslint-plugin-antfu/src/rules/prefer-inline-type-import.ts

@@ -13,7 +13,7 @@ export default createEslintRule<Options, MessageIds>({
   meta: {
     type: 'suggestion',
     docs: {
-      description: 'Newline after if',
+      description: 'Inline type import',
       recommended: 'error',
     },
     fixable: 'code',

packages/eslint-plugin-antfu/src/rules/top-level-function.test.ts

@@ -0,0 +1,51 @@
+import { RuleTester } from '@typescript-eslint/utils/dist/ts-eslint'
+import { it } from 'vitest'
+import rule, { RULE_NAME } from './top-level-function'
+
+const valids = [
+  'function foo() {}',
+  // allow arrow function inside function
+  'function foo() { const bar = () => {} }',
+  // allow arrow function when type is specified
+  'const Foo: Bar = () => {}',
+  // allow let/var
+  'let foo = () => {}',
+  // allow arrow function in as
+  'const foo = (() => {}) as any',
+  // allow iife
+  ';(() => {})()',
+]
+
+const invalids = [
+  [
+    'const foo = (as: string, bar: number) => { return as + bar }',
+    'function foo (as: string, bar: number) { return as + bar }',
+  ],
+  [
+    'const foo = <K, T extends Boolean>(as: string, bar: number): Omit<T, K> => as + bar',
+    'function foo <K, T extends Boolean>(as: string, bar: number): Omit<T, K> { return as + bar }',
+  ],
+  [
+    'export const foo = () => {}',
+    'export function foo () {}',
+  ],
+  [
+    'export const foo = () => ({})',
+    'export function foo () { return {} }',
+  ],
+]
+
+it('runs', () => {
+  const ruleTester: RuleTester = new RuleTester({
+    parser: require.resolve('@typescript-eslint/parser'),
+  })
+
+  ruleTester.run(RULE_NAME, rule, {
+    valid: valids,
+    invalid: invalids.map(i => ({
+      code: i[0],
+      output: i[1],
+      errors: [{ messageId: 'topLevelFunctionDeclaration' }],
+    })),
+  })
+})

packages/eslint-plugin-antfu/src/rules/top-level-function.ts

@@ -0,0 +1,81 @@
+import { createEslintRule } from '../utils'
+
+export const RULE_NAME = 'top-level-function'
+export type MessageIds = 'topLevelFunctionDeclaration'
+export type Options = []
+
+export default createEslintRule<Options, MessageIds>({
+  name: RULE_NAME,
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'Enforce top-level functions to be declared with function keyword',
+      recommended: 'error',
+    },
+    fixable: 'code',
+    schema: [],
+    messages: {
+      topLevelFunctionDeclaration: 'Top-level functions should be declared with function keyword',
+    },
+  },
+  defaultOptions: [],
+  create: (context) => {
+    return {
+      VariableDeclaration(node) {
+        if (node.parent.type !== 'Program' && node.parent.type !== 'ExportNamedDeclaration')
+          return
+
+        if (node.declarations.length !== 1)
+          return
+        if (node.kind !== 'const')
+          return
+        if (node.declare)
+          return
+
+        const declaration = node.declarations[0]
+
+        if (declaration.init?.type !== 'ArrowFunctionExpression')
+          return
+        if (declaration.id?.type !== 'Identifier')
+          return
+        if (declaration.id.typeAnnotation)
+          return
+
+        const arrowFn = declaration.init
+        const body = declaration.init.body
+        const id = declaration.id
+
+        context.report({
+          node,
+          loc: {
+            start: node.loc.start,
+            end: node.loc.end,
+          },
+          messageId: 'topLevelFunctionDeclaration',
+          fix(fixer) {
+            const code = context.getSourceCode().text
+            const textName = code.slice(id.range[0], id.range[1])
+            const textArgs = arrowFn.params.length
+              ? code.slice(arrowFn.params[0].range[0], arrowFn.params[arrowFn.params.length - 1].range[1])
+              : ''
+            const textBody = body.type === 'BlockStatement'
+              ? code.slice(body.range[0], body.range[1])
+              : `{ return ${code.slice(body.range[0], body.range[1])} }`
+            const textGeneric = arrowFn.typeParameters
+              ? code.slice(arrowFn.typeParameters.range[0], arrowFn.typeParameters.range[1])
+              : ''
+            const textTypeReturn = arrowFn.returnType
+              ? code.slice(arrowFn.returnType.range[0], arrowFn.returnType.range[1])
+              : ''
+            const text = `function ${textName} ${textGeneric}(${textArgs})${textTypeReturn} ${textBody}`
+            // console.log({
+            //   input: code.slice(node.range[0], node.range[1]),
+            //   output: text,
+            // })
+            return fixer.replaceTextRange([node.range[0], node.range[1]], text)
+          },
+        })
+      },
+    }
+  },
+})