@ocavue/eslint-config 0.5.0-beta.3 → 1.1.0

package/README.md

@@ -5,6 +5,7 @@ A set of ESLint shareable configs for TypeScript projects.
 - Out of the box support for TypeScript, React, and Markdown
 - Sort your imports
 - Sort your fields in `package.json`
+- Prefer top-level function declarations over function expressions
 
 ## Install
 
@@ -75,3 +76,8 @@ If you are using VS Code, you and install [ESLint extension](https://marketplace
   }
 }
 ```
+
+## Inspired by
+
+- https://github.com/antfu/eslint-config
+- https://github.com/sxzz/eslint-config

package/dist/eslint.config.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("eslint-define-config").FlatESLintConfig[];
+export default _default;
+//# sourceMappingURL=eslint.config.d.ts.map

package/dist/eslint.config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eslint.config.d.ts","sourceRoot":"","sources":["../eslint.config.js"],"names":[],"mappings":""}

package/dist/src/antfu.d.ts

@@ -0,0 +1,2 @@
+export function antfu(): import("eslint-define-config").FlatESLintConfigItem[];
+//# sourceMappingURL=antfu.d.ts.map

package/dist/src/antfu.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"antfu.d.ts","sourceRoot":"","sources":["../../src/antfu.js"],"names":[],"mappings":"AAEA,+EAcC"}

package/dist/src/basic.d.ts

@@ -1,3 +1,10 @@
+/**
+ * @typedef {Object} BasicOptions
+ * @property {import('./typescript.js').TypescriptOptions} [typescript]
+ */
+/**
+ * @param {BasicOptions} [options]
+ */
 export function basic(options?: BasicOptions | undefined): import("eslint-define-config").FlatESLintConfigItem[];
 export type BasicOptions = {
     typescript?: import("./typescript.js").TypescriptOptions | undefined;

package/dist/src/basic.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"basic.d.ts","sourceRoot":"","sources":["../../src/basic.js"],"names":[],"mappings":"AAkBO,iHAgBN"}
+{"version":3,"file":"basic.d.ts","sourceRoot":"","sources":["../../src/basic.js"],"names":[],"mappings":"AAWA;;;GAGG;AAEH;;GAEG;AACH,iHAiBC"}

package/dist/src/imports.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"imports.d.ts","sourceRoot":"","sources":["../../src/imports.js"],"names":[],"mappings":"AAKO,iFAyCN"}
+{"version":3,"file":"imports.d.ts","sourceRoot":"","sources":["../../src/imports.js"],"names":[],"mappings":"AAKA,iFA0CC"}

package/dist/src/markdown.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../src/markdown.js"],"names":[],"mappings":"AAOO,kFA0DN"}
+{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../src/markdown.js"],"names":[],"mappings":"AAOA,kFA0DC"}

package/dist/src/no-only-tests.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"no-only-tests.d.ts","sourceRoot":"","sources":["../../src/no-only-tests.js"],"names":[],"mappings":"AAKO,qFAcN"}
+{"version":3,"file":"no-only-tests.d.ts","sourceRoot":"","sources":["../../src/no-only-tests.js"],"names":[],"mappings":"AAKA,qFAcC"}

package/dist/src/package-json.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Sort package.json keys
+ */
 export function packageJson(): import("eslint-define-config").FlatESLintConfigItem[];
 //# sourceMappingURL=package-json.d.ts.map

package/dist/src/package-json.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"package-json.d.ts","sourceRoot":"","sources":["../../src/package-json.js"],"names":[],"mappings":"AAUO,qFA0EN"}
+{"version":3,"file":"package-json.d.ts","sourceRoot":"","sources":["../../src/package-json.js"],"names":[],"mappings":"AAOA;;GAEG;AACH,qFA0EC"}

package/dist/src/prettier.d.ts

@@ -1,2 +1,8 @@
+/**
+ * Turns off all rules that are unnecessary or might conflict with Prettier.
+ *
+ * Notice that this config does not run `prettier` as an ESLint rule, so you
+ * have to run `pretter` separately for formatting.
+ */
 export function prettier(): import("eslint-define-config").FlatESLintConfigItem[];
 //# sourceMappingURL=prettier.d.ts.map

package/dist/src/prettier.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"prettier.d.ts","sourceRoot":"","sources":["../../src/prettier.js"],"names":[],"mappings":"AAQO,kFAWN"}
+{"version":3,"file":"prettier.d.ts","sourceRoot":"","sources":["../../src/prettier.js"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,kFAWC"}

package/dist/src/react.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../../src/react.js"],"names":[],"mappings":"AASO,+EAwCN"}
+{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../../src/react.js"],"names":[],"mappings":"AASA,+EAwCC"}

package/dist/src/shared.d.ts

@@ -20,6 +20,6 @@ export const GLOB_ALL_SRC: readonly ["**/*.?([mt])[jt]s?(x)", "**/*.{c,le,sc}ss"
 export const GLOB_NODE_MODULES: "**/node_modules";
 export const GLOB_DIST: "**/dist";
 export const GLOB_LOCKFILE: readonly ["**/package-lock.json", "**/yarn.lock", "**/pnpm-lock.yaml"];
-export const GLOB_EXCLUDE: readonly ["**/node_modules", "**/dist", "**/package-lock.json", "**/yarn.lock", "**/pnpm-lock.yaml", "**/output", "**/coverage", "**/temp", "**/fixtures", "**/.vitepress/cache", "**/.next", "**/.nuxt", "**/.vercel", "**/.changeset", "**/.idea", "**/.output", "**/.vite-inspect", "**/dist-types", "**/CHANGELOG*.md", "**/*.min.*", "**/LICENSE*", "**/__snapshots__"];
+export const GLOB_EXCLUDE: readonly ["**/node_modules", "**/dist", "**/package-lock.json", "**/yarn.lock", "**/pnpm-lock.yaml", "**/output", "**/coverage", "**/temp", "**/fixtures", "**/.vitepress/cache", "**/.next", "**/.nuxt", "**/.vercel", "**/.changeset", "**/.idea", "**/.output", "**/.vite-inspect", "**/.yalc", "**/dist-types", "**/CHANGELOG*.md", "**/*.min.*", "**/LICENSE*", "**/__snapshots__"];
 export const EXTENSIONS: string[];
 //# sourceMappingURL=shared.d.ts.map

package/dist/src/shared.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../src/shared.js"],"names":[],"mappings":"AAEA,8CAA8C;AAC9C,+CAA+C;AAE/C,uCAAuC;AACvC,yCAAyC;AAEzC,uCAAuC;AACvC,yCAAyC;AAEzC,4CAA4C;AAC5C,kCAAkC;AAClC,oCAAoC;AACpC,oCAAoC;AAEpC,oCAAoC;AACpC,sCAAsC;AACtC,sCAAsC;AAEtC,kDAAkD;AAElD,sCAAsC;AACtC,kCAAkC;AAClC,uCAAuC;AACvC,uCAAuC;AAEvC,oKASE;AAEF,kDAAyE;AACzE,kCAAyD;AACzD,mGAIE;AACF,wYAuBE;AAEF,kCAGsC"}
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../src/shared.js"],"names":[],"mappings":"AAEA,8CAA8C;AAC9C,+CAA+C;AAE/C,uCAAuC;AACvC,yCAAyC;AAEzC,uCAAuC;AACvC,yCAAyC;AAEzC,4CAA4C;AAC5C,kCAAkC;AAClC,oCAAoC;AACpC,oCAAoC;AAEpC,oCAAoC;AACpC,sCAAsC;AACtC,sCAAsC;AAEtC,kDAAkD;AAElD,sCAAsC;AACtC,kCAAkC;AAClC,uCAAuC;AACvC,uCAAuC;AAEvC,oKASE;AAEF,kDAAyE;AACzE,kCAAyD;AACzD,mGAIE;AACF,oZAwBE;AAEF,kCAGsC"}

package/dist/src/typescript.d.ts

@@ -1,3 +1,11 @@
+/**
+ * @typedef {Object} TypescriptOptions
+ * @property {string | false} [project] - Path to tsconfig.json, defaults
+ * to './tsconfig.json'. You can pass `false` to disable the tsconfig.json check.
+ */
+/**
+ * @param {TypescriptOptions} [options]
+ */
 export function typescript(options?: TypescriptOptions | undefined): import("eslint-define-config").FlatESLintConfigItem[];
 export type TypescriptOptions = {
     /**

package/dist/src/typescript.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"typescript.d.ts","sourceRoot":"","sources":["../../src/typescript.js"],"names":[],"mappings":"AAkBO,2HAwDN;;;;;;;;qBAvEoB,2BAA2B;qBAD3B,kCAAkC"}
+{"version":3,"file":"typescript.d.ts","sourceRoot":"","sources":["../../src/typescript.js"],"names":[],"mappings":"AASA;;;;GAIG;AAEH;;GAEG;AACH,2HAsEC;;;;;;;;qBArFoB,2BAA2B;qBAD3B,kCAAkC"}

package/dist/src/unicorn.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unicorn.d.ts","sourceRoot":"","sources":["../../src/unicorn.js"],"names":[],"mappings":"AAKO,iFA+DN"}
+{"version":3,"file":"unicorn.d.ts","sourceRoot":"","sources":["../../src/unicorn.js"],"names":[],"mappings":"AAKA,iFA+DC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ocavue/eslint-config",
   "type": "module",
-  "version": "0.5.0-beta.3",
+  "version": "1.1.0",
   "packageManager": "pnpm@8.5.1",
   "description": "",
   "author": "ocavue <ocavue@gmail.com>",
@@ -23,6 +23,13 @@
     "src",
     "dist"
   ],
+  "scripts": {
+    "build": "tsc",
+    "lint": "eslint .",
+    "check": "prettier --check .",
+    "fix": "eslint --fix . && prettier --write .",
+    "prepublishOnly": "nr build"
+  },
   "dependencies": {
     "@types/eslint": "^8.40.0",
     "@typescript-eslint/eslint-plugin": "^5.59.7",
@@ -30,6 +37,7 @@
     "eslint-config-prettier": "^8.8.0",
     "eslint-define-config": "^1.20.0",
     "eslint-import-resolver-typescript": "^3.5.5",
+    "eslint-plugin-antfu": "^0.39.3",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jsonc": "^2.8.0",
     "eslint-plugin-markdown": "^3.0.0",
@@ -51,11 +59,5 @@
     "extends": [
       "github>ocavue/config-renovate"
     ]
-  },
-  "scripts": {
-    "build": "tsc",
-    "lint": "eslint .",
-    "check": "prettier --check .",
-    "fix": "eslint --fix . && prettier --write ."
   }
-}
+}

package/src/antfu.js

@@ -0,0 +1,17 @@
+import antfuPlugin from 'eslint-plugin-antfu'
+
+export function antfu() {
+  /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
+  const config = [
+    {
+      plugins: {
+        antfu: antfuPlugin,
+      },
+      rules: {
+        'antfu/top-level-function': 'error',
+      },
+    },
+  ]
+
+  return config
+}

package/src/basic.js

@@ -1,5 +1,6 @@
 // @ts-check
 
+import { antfu } from './antfu.js'
 import { imports } from './imports.js'
 import { noOnlyTests } from './no-only-tests.js'
 import { packageJson } from './package-json.js'
@@ -16,17 +17,18 @@ import { unicorn } from './unicorn.js'
 /**
  * @param {BasicOptions} [options]
  */
-export const basic = (options) => {
+export function basic(options) {
   /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
   const config = [
     {
-      // @ts-ignore
+      // @ts-expect-error: 'readonly' and cannot be assigned to the mutable type 'string[]'
       ignores: GLOB_EXCLUDE,
     },
     ...typescript(options?.typescript),
     ...imports(),
     ...packageJson(),
     ...unicorn(),
+    ...antfu(),
     ...noOnlyTests(),
     ...prettier(),
   ]

package/src/imports.js

@@ -3,7 +3,7 @@
 // @ts-expect-error no type
 import importPlugin from 'eslint-plugin-import'
 
-export const imports = () => {
+export function imports() {
   /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
   const config = [
     {
@@ -23,7 +23,8 @@ export const imports = () => {
         'import/no-extraneous-dependencies': 'warn',
         'import/first': 'warn',
         'import/no-mutable-exports': 'warn',
-        'import/no-duplicates': 'warn',
+        'import/no-useless-path-segments': 'warn',
+        'import/newline-after-import': 'warn',
         'import/order': [
           'warn',
           {
@@ -33,9 +34,9 @@ export const imports = () => {
               'builtin',
               'external',
               'internal',
-              ['parent', 'sibling'],
+              'parent',
+              'sibling',
               'index',
-              'type',
             ],
           },
         ],

package/src/markdown.js

@@ -5,7 +5,7 @@ import markdownPlugin from 'eslint-plugin-markdown'
 
 import { GLOB_MARKDOWN, GLOB_SRC, GLOB_VUE } from './shared.js'
 
-export const markdown = () => {
+export function markdown() {
   /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
   const config = [
     {

package/src/no-only-tests.js

@@ -3,7 +3,7 @@
 // @ts-expect-error: eslint-plugin-unicorn is not typed
 import plugin from 'eslint-plugin-no-only-tests'
 
-export const noOnlyTests = () => {
+export function noOnlyTests() {
   /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
   const config = [
     {

package/src/package-json.js

@@ -8,7 +8,7 @@ import { GLOB_PACKAGE_JSON } from './shared.js'
 /**
  * Sort package.json keys
  */
-export const packageJson = () => {
+export function packageJson() {
   /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
   const config = [
     {

package/src/prettier.js

@@ -6,7 +6,7 @@ import prettierConfig from 'eslint-config-prettier'
  * Notice that this config does not run `prettier` as an ESLint rule, so you
  * have to run `pretter` separately for formatting.
  */
-export const prettier = () => {
+export function prettier() {
   /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
   const config = [
     {

package/src/react.js

@@ -7,7 +7,7 @@ import reactHooksPlugin from 'eslint-plugin-react-hooks'
 
 import { GLOB_TSX } from './shared.js'
 
-export const react = () => {
+export function react() {
   /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
   const config = [
     {

package/src/shared.js

@@ -60,6 +60,7 @@ export const GLOB_EXCLUDE = /** @type {const} */ ([
   '**/.idea',
   '**/.output',
   '**/.vite-inspect',
+  '**/.yalc',
   '**/dist-types',
 
   '**/CHANGELOG*.md',

package/src/typescript.js

@@ -3,7 +3,7 @@
 import tsPlugin from '@typescript-eslint/eslint-plugin'
 import tsParser from '@typescript-eslint/parser'
 
-import { GLOB_TS, GLOB_TSX } from './shared.js'
+import { GLOB_JS, GLOB_JSX, GLOB_TS, GLOB_TSX } from './shared.js'
 
 export { tsParser, tsPlugin }
 
@@ -16,13 +16,13 @@ export { tsParser, tsPlugin }
 /**
  * @param {TypescriptOptions} [options]
  */
-export const typescript = (options) => {
+export function typescript(options) {
   const project = options?.project ?? './tsconfig.json'
 
   /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
   const config = [
     {
-      files: [GLOB_TS, GLOB_TSX],
+      files: [GLOB_TS, GLOB_TSX, GLOB_JS, GLOB_JSX],
       languageOptions: {
         // @ts-expect-error: the types for `parser` seems to be wrong
         parser: tsParser,
@@ -48,9 +48,17 @@ export const typescript = (options) => {
           ? tsPlugin.configs['recommended-requiring-type-checking'].rules
           : null),
 
+        '@typescript-eslint/no-unsafe-call': 'warn',
+        '@typescript-eslint/restrict-plus-operands': 'warn',
+        '@typescript-eslint/no-unsafe-return': 'warn',
+        '@typescript-eslint/no-unsafe-argument': 'warn',
+        '@typescript-eslint/no-unsafe-member-access': 'warn',
+        '@typescript-eslint/no-unsafe-assignment': 'warn',
+        '@typescript-eslint/no-floating-promises': 'warn',
         '@typescript-eslint/no-explicit-any': 'warn',
         '@typescript-eslint/explicit-module-boundary-types': 'off',
         '@typescript-eslint/no-non-null-assertion': 'off',
+        '@typescript-eslint/restrict-template-expressions': 'off',
         '@typescript-eslint/no-unused-vars': [
           'error',
           {
@@ -61,6 +69,12 @@ export const typescript = (options) => {
         ],
         '@typescript-eslint/no-extra-semi': 'off',
         '@typescript-eslint/prefer-function-type': 'warn',
+
+        // TODO: We should set the rules below to error in the future
+        '@typescript-eslint/no-misused-promises': 'warn',
+        '@typescript-eslint/await-thenable': 'warn',
+        '@typescript-eslint/require-await': 'warn',
+        '@typescript-eslint/unbound-method': 'warn',
       },
     },
     {

package/src/unicorn.js

@@ -3,7 +3,7 @@
 // @ts-expect-error: eslint-plugin-unicorn is not typed
 import plugin from 'eslint-plugin-unicorn'
 
-export const unicorn = () => {
+export function unicorn() {
   /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
   const config = [
     {
@@ -42,7 +42,7 @@ export const unicorn = () => {
         // Improve regexes
         'unicorn/better-regex': 'error',
         // Enforce combining multiple `Array#push()` into one call.
-        'unicorn/no-array-push-push': 'error',
+        'unicorn/no-array-push-push': 'warn',
         // Do not use a `for` loop that can be replaced with a `for-of` loop.
         'unicorn/no-for-loop': 'error',
         // Prefer `.addEventListener()` and `.removeEventListener()` over `on`-functions.
@@ -60,7 +60,7 @@ export const unicorn = () => {
         // Prefer negative index over `.length - index` when possible
         'unicorn/prefer-negative-index': 'error',
         // Prefer `Number` static properties over global ones.
-        'unicorn/prefer-number-properties': 'error',
+        'unicorn/prefer-number-properties': 'warn',
       },
     },
   ]