@ocavue/eslint-config 0.4.7 → 1.0.0

package/README.md

@@ -1,6 +1,10 @@
 # @ocavue/eslint-config
 
-A set of ESLint rules for TypeScript projects.
+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`
 
 ## Install
 
@@ -10,11 +14,64 @@ $ npm install -D eslint prettier @ocavue/eslint-config
 
 ## Usage
 
-In your ESLint configuration file
+### Config ESLint
+
+You will need to use the new ["flat" ESLint configuration](https://eslint.org/docs/latest/use/configure/configuration-files-new) (i.e. `eslint.config.js`).
+
+In your `eslint.config.js` file, add the following to extend the basic config:
+
+```JS
+// eslint.config.js
+import { basic } from '@ocavue/eslint-config'
+
+export default [...basic()]
+```
+
+If you want to use the React config, you can do the following:
+
+```JS
+// eslint.config.js
+import { basic, react } from '@ocavue/eslint-config'
+
+export default [...basic(), ...react()]
+```
+
+If you want to use the check the code blocks in markdown files, you can do the following:
 
 ```JS
-// .eslintrc.cjs
-module.exports = {
-  extends: ['@ocavue/eslint-config'],
+// eslint.config.js
+import { basic, markdown } from '@ocavue/eslint-config'
+
+export default [...basic(), ...markdown()]
+```
+
+### Add script for package.json
+
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "check": "prettier --check .",
+    "fix": "eslint --fix . && prettier --write ."
+  }
+}
+```
+
+### Add `.prettierignore`
+
+Add a [`.prettierignore`](https://prettier.io/docs/en/ignore.html#ignoring-files-prettierignore) file in the root of your project. You can copy the `.prettierignore` file from this project.
+
+### VS Code integration
+
+If you are using VS Code, you and install [ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and [Prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode), then add the following to your VS Code settings:
+
+```json
+// .vscode/settings.json
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  }
 }
 ```

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/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./src/typescript.js";
+export * from "./src/prettier.js";
+export * from "./src/basic.js";
+export * from "./src/markdown.js";
+export * from "./src/react.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

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

package/dist/src/basic.d.ts

@@ -0,0 +1,5 @@
+export function basic(options?: BasicOptions | undefined): import("eslint-define-config").FlatESLintConfigItem[];
+export type BasicOptions = {
+    typescript?: import("./typescript.js").TypescriptOptions | undefined;
+};
+//# sourceMappingURL=basic.d.ts.map

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

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

package/dist/src/imports.d.ts

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

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

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

package/dist/src/markdown.d.ts

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

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

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

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

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

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

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

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

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

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

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

package/dist/src/prettier.d.ts

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

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

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

package/dist/src/react.d.ts

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

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

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

package/dist/src/shared.d.ts

@@ -0,0 +1,25 @@
+export const GLOB_SRC_EXT: "?([mt])[jt]s?(x)";
+export const GLOB_SRC: "**/*.?([mt])[jt]s?(x)";
+export const GLOB_JS: "**/*.?([mt])js";
+export const GLOB_JSX: "**/*.?([mt])jsx";
+export const GLOB_TS: "**/*.?([mt])ts";
+export const GLOB_TSX: "**/*.?([mt])tsx";
+export const GLOB_STYLE: "**/*.{c,le,sc}ss";
+export const GLOB_CSS: "**/*.css";
+export const GLOB_LESS: "**/*.less";
+export const GLOB_SCSS: "**/*.scss";
+export const GLOB_JSON: "**/*.json";
+export const GLOB_JSON5: "**/*.json5";
+export const GLOB_JSONC: "**/*.jsonc";
+export const GLOB_PACKAGE_JSON: "**/package.json";
+export const GLOB_MARKDOWN: "**/*.md";
+export const GLOB_VUE: "**/*.vue";
+export const GLOB_YAML: "**/*.y?(a)ml";
+export const GLOB_HTML: "**/*.htm?(l)";
+export const GLOB_ALL_SRC: readonly ["**/*.?([mt])[jt]s?(x)", "**/*.{c,le,sc}ss", "**/*.json", "**/*.json5", "**/*.md", "**/*.vue", "**/*.y?(a)ml", "**/*.htm?(l)"];
+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", "**/.yalc", "**/dist-types", "**/CHANGELOG*.md", "**/*.min.*", "**/LICENSE*", "**/__snapshots__"];
+export const EXTENSIONS: string[];
+//# sourceMappingURL=shared.d.ts.map

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

@@ -0,0 +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,oZAwBE;AAEF,kCAGsC"}

package/dist/src/typescript.d.ts

@@ -0,0 +1,12 @@
+export function typescript(options?: TypescriptOptions | undefined): import("eslint-define-config").FlatESLintConfigItem[];
+export type TypescriptOptions = {
+    /**
+     * - Path to tsconfig.json, defaults
+     * to './tsconfig.json'. You can pass `false` to disable the tsconfig.json check.
+     */
+    project?: string | false | undefined;
+};
+import tsParser from '@typescript-eslint/parser';
+import tsPlugin from '@typescript-eslint/eslint-plugin';
+export { tsParser, tsPlugin };
+//# sourceMappingURL=typescript.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"typescript.d.ts","sourceRoot":"","sources":["../../src/typescript.js"],"names":[],"mappings":"AAkBO,2HAsEN;;;;;;;;qBArFoB,2BAA2B;qBAD3B,kCAAkC"}

package/dist/src/unicorn.d.ts

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

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

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

package/index.js

@@ -1,10 +1,5 @@
-// @ts-check
-
-const { defineConfig } = require('eslint-define-config')
-const basic = require('@ocavue/eslint-config-basic')
-
-module.exports = defineConfig({
-  extends: ['@ocavue/eslint-config-basic', '@ocavue/eslint-config-prettier'],
-
-  overrides: basic.overrides,
-})
+export * from './src/typescript.js'
+export * from './src/prettier.js'
+export * from './src/basic.js'
+export * from './src/markdown.js'
+export * from './src/react.js'

package/package.json

@@ -1,29 +1,62 @@
 {
   "name": "@ocavue/eslint-config",
-  "version": "0.4.7",
+  "type": "module",
+  "version": "1.0.0",
+  "packageManager": "pnpm@8.5.1",
+  "description": "",
+  "author": "ocavue <ocavue@gmail.com>",
+  "license": "MIT",
   "funding": "https://github.com/sponsors/ocavue",
   "homepage": "https://github.com/ocavue/eslint-config#readme",
   "repository": {
     "type": "git",
-    "url": "https://github.com/ocavue/eslint-config.git",
-    "directory": "packages/eslint-config"
+    "url": "https://github.com/ocavue/eslint-config.git"
   },
   "bugs": "https://github.com/ocavue/eslint-config/issues",
-  "main": "index.js",
-  "dependencies": {
-    "@ocavue/eslint-config-basic": "^0.6.5",
-    "@ocavue/eslint-config-prettier": "^0.4.3",
-    "eslint-define-config": "^1.13.0"
+  "keywords": [],
+  "sideEffects": false,
+  "main": "./index.js",
+  "module": "./index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "index.js",
+    "src",
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "lint": "eslint .",
+    "check": "prettier --check .",
+    "fix": "eslint --fix . && prettier --write .",
+    "prepublishOnly": "nr build"
   },
-  "peerDependencies": {
-    "eslint": ">=8.0.0"
+  "dependencies": {
+    "@types/eslint": "^8.40.0",
+    "@typescript-eslint/eslint-plugin": "^5.59.7",
+    "@typescript-eslint/parser": "^5.59.7",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-define-config": "^1.20.0",
+    "eslint-import-resolver-typescript": "^3.5.5",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jsonc": "^2.8.0",
+    "eslint-plugin-markdown": "^3.0.0",
+    "eslint-plugin-no-only-tests": "^3.1.0",
+    "eslint-plugin-react": "^7.32.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-unicorn": "^47.0.0",
+    "jsonc-eslint-parser": "^2.3.0"
   },
   "devDependencies": {
-    "eslint": "^8.31.0",
-    "prettier": "^2.8.2",
-    "typescript": "~4.9.4"
+    "@antfu/ni": "^0.21.3",
+    "@types/eslint-plugin-markdown": "^2.0.0",
+    "@types/node": "^18.16.15",
+    "eslint": "^8.41.0",
+    "prettier": "^2.8.8",
+    "typescript": "^5.0.4"
   },
-  "publishConfig": {
-    "access": "public"
+  "renovate": {
+    "extends": [
+      "github>ocavue/config-renovate"
+    ]
   }
-}
+}

package/src/basic.js

@@ -0,0 +1,35 @@
+// @ts-check
+
+import { imports } from './imports.js'
+import { noOnlyTests } from './no-only-tests.js'
+import { packageJson } from './package-json.js'
+import { prettier } from './prettier.js'
+import { GLOB_EXCLUDE } from './shared.js'
+import { typescript } from './typescript.js'
+import { unicorn } from './unicorn.js'
+
+/**
+ * @typedef {Object} BasicOptions
+ * @property {import('./typescript.js').TypescriptOptions} [typescript]
+ */
+
+/**
+ * @param {BasicOptions} [options]
+ */
+export const basic = (options) => {
+  /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
+  const config = [
+    {
+      // @ts-expect-error: 'readonly' and cannot be assigned to the mutable type 'string[]'
+      ignores: GLOB_EXCLUDE,
+    },
+    ...typescript(options?.typescript),
+    ...imports(),
+    ...packageJson(),
+    ...unicorn(),
+    ...noOnlyTests(),
+    ...prettier(),
+  ]
+
+  return config
+}

package/src/imports.js

@@ -0,0 +1,48 @@
+// @ts-check
+
+// @ts-expect-error no type
+import importPlugin from 'eslint-plugin-import'
+
+export const imports = () => {
+  /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
+  const config = [
+    {
+      plugins: {
+        import: importPlugin,
+      },
+      settings: {
+        'import/resolver': {
+          // You will also need to install and configure the TypeScript resolver
+          // See also https://github.com/import-js/eslint-import-resolver-typescript#configuration
+          typescript: true,
+          node: true,
+        },
+      },
+      rules: {
+        // External modules must be declared in the package.json
+        'import/no-extraneous-dependencies': 'warn',
+        'import/first': 'warn',
+        'import/no-mutable-exports': 'warn',
+        'import/no-useless-path-segments': 'warn',
+        'import/newline-after-import': 'warn',
+        'import/order': [
+          'warn',
+          {
+            'newlines-between': 'always',
+            alphabetize: { order: 'asc' },
+            groups: [
+              'builtin',
+              'external',
+              'internal',
+              'parent',
+              'sibling',
+              'index',
+            ],
+          },
+        ],
+      },
+    },
+  ]
+
+  return config
+}

package/src/markdown.js

@@ -0,0 +1,66 @@
+// @ts-check
+
+import tsPlugin from '@typescript-eslint/eslint-plugin'
+import markdownPlugin from 'eslint-plugin-markdown'
+
+import { GLOB_MARKDOWN, GLOB_SRC, GLOB_VUE } from './shared.js'
+
+export const markdown = () => {
+  /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
+  const config = [
+    {
+      files: [GLOB_MARKDOWN],
+      plugins: {
+        markdown: markdownPlugin,
+      },
+      processor: 'markdown/markdown',
+    },
+    {
+      files: [`${GLOB_MARKDOWN}/${GLOB_SRC}`, `${GLOB_MARKDOWN}/${GLOB_VUE}`],
+      languageOptions: {
+        parserOptions: {
+          ecmaFeatures: {
+            impliedStrict: true,
+          },
+        },
+      },
+      plugins: {
+        // @ts-expect-error: wrong typing
+        '@typescript-eslint': tsPlugin,
+      },
+      rules: {
+        '@typescript-eslint/no-redeclare': 'off',
+        '@typescript-eslint/no-unused-vars': 'off',
+        '@typescript-eslint/no-use-before-define': 'off',
+        '@typescript-eslint/no-var-requires': 'off',
+        'no-alert': 'off',
+        'no-console': 'off',
+        'no-restricted-imports': 'off',
+
+        // Below are taken from https://github.com/eslint/eslint-plugin-markdown/blob/v3.0.0/lib/index.js#L31-L52
+
+        // The Markdown parser automatically trims trailing
+        // newlines from code blocks.
+        'eol-last': 'off',
+
+        // In code snippets and examples, these rules are often
+        // counterproductive to clarity and brevity.
+        'no-undef': 'off',
+        'no-unused-expressions': 'off',
+        'no-unused-vars': 'off',
+        'padded-blocks': 'off',
+
+        // Adding a "use strict" directive at the top of every
+        // code block is tedious and distracting. The config
+        // opts into strict mode parsing without the directive.
+        strict: 'off',
+
+        // The processor will not receive a Unicode Byte Order
+        // Mark from the Markdown parser.
+        'unicode-bom': 'off',
+      },
+    },
+  ]
+
+  return config
+}

package/src/no-only-tests.js

@@ -0,0 +1,20 @@
+// @ts-check
+
+// @ts-expect-error: eslint-plugin-unicorn is not typed
+import plugin from 'eslint-plugin-no-only-tests'
+
+export const noOnlyTests = () => {
+  /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
+  const config = [
+    {
+      plugins: {
+        'no-only-tests': plugin,
+      },
+      rules: {
+        'no-only-tests/no-only-tests': 'error',
+      },
+    },
+  ]
+
+  return config
+}

package/src/package-json.js

@@ -0,0 +1,85 @@
+// @ts-check
+
+import plugin from 'eslint-plugin-jsonc'
+import parser from 'jsonc-eslint-parser'
+
+import { GLOB_PACKAGE_JSON } from './shared.js'
+
+/**
+ * Sort package.json keys
+ */
+export const packageJson = () => {
+  /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
+  const config = [
+    {
+      files: [GLOB_PACKAGE_JSON],
+      languageOptions: {
+        // @ts-expect-error: the types for `parser` seems to be wrong
+        parser,
+        parserOptions: {
+          jsonSyntax: 'JSON5',
+        },
+      },
+      plugins: {
+        // @ts-expect-error: incorrect types
+        jsonc: plugin,
+      },
+      rules: {
+        'jsonc/sort-keys': [
+          'warn',
+          {
+            pathPattern: '^$',
+            order: [
+              'name',
+              'displayName',
+              'publisher',
+              'type',
+              'version',
+              'private',
+              'packageManager',
+              'description',
+              'author',
+              'license',
+              'funding',
+              'homepage',
+              'repository',
+              'bugs',
+              'contributes',
+              'keywords',
+              'categories',
+              'sideEffects',
+              'main',
+              'module',
+              'types',
+              'exports',
+              'typesVersions',
+              'bin',
+              'icon',
+              'files',
+              'engines',
+              'scripts',
+              'dependencies',
+              'peerDependencies',
+              'peerDependenciesMeta',
+              'optionalDependencies',
+              'devDependencies',
+              'publishConfig',
+              'overrides',
+              'resolutions',
+            ],
+          },
+          {
+            pathPattern: '^(?:dev|peer|optional|bundled)?[Dd]ependencies$',
+            order: { type: 'asc' },
+          },
+          {
+            pathPattern: '^exports.*$',
+            order: ['types', 'require', 'import', 'default'],
+          },
+        ],
+      },
+    },
+  ]
+
+  return config
+}

package/src/prettier.js

@@ -0,0 +1,20 @@
+import prettierConfig from 'eslint-config-prettier'
+
+/**
+ * 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 const prettier = () => {
+  /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
+  const config = [
+    {
+      rules: {
+        ...prettierConfig.rules,
+      },
+    },
+  ]
+
+  return config
+}

package/src/react.js

@@ -0,0 +1,50 @@
+// @ts-check
+
+// @ts-expect-error no types
+import reactPlugin from 'eslint-plugin-react'
+// @ts-expect-error no types
+import reactHooksPlugin from 'eslint-plugin-react-hooks'
+
+import { GLOB_TSX } from './shared.js'
+
+export const react = () => {
+  /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
+  const config = [
+    {
+      files: [GLOB_TSX],
+      plugins: {
+        react: reactPlugin,
+      },
+      languageOptions: {
+        parserOptions: {
+          ecmaFeatures: {
+            jsx: true,
+          },
+        },
+      },
+      settings: {
+        react: {
+          version: 'detect',
+        },
+      },
+      rules: {
+        ...reactPlugin.configs.recommended.rules,
+        'react/prop-types': 'off',
+        'react/react-in-jsx-scope': 'off',
+      },
+    },
+
+    {
+      files: [GLOB_TSX],
+      plugins: {
+        'react-hooks': reactHooksPlugin,
+      },
+      rules: {
+        'react-hooks/rules-of-hooks': 'error',
+        'react-hooks/exhaustive-deps': 'warn',
+      },
+    },
+  ]
+
+  return config
+}

package/src/shared.js

@@ -0,0 +1,75 @@
+// @ts-check
+
+export const GLOB_SRC_EXT = '?([mt])[jt]s?(x)'
+export const GLOB_SRC = '**/*.?([mt])[jt]s?(x)'
+
+export const GLOB_JS = '**/*.?([mt])js'
+export const GLOB_JSX = '**/*.?([mt])jsx'
+
+export const GLOB_TS = '**/*.?([mt])ts'
+export const GLOB_TSX = '**/*.?([mt])tsx'
+
+export const GLOB_STYLE = '**/*.{c,le,sc}ss'
+export const GLOB_CSS = '**/*.css'
+export const GLOB_LESS = '**/*.less'
+export const GLOB_SCSS = '**/*.scss'
+
+export const GLOB_JSON = '**/*.json'
+export const GLOB_JSON5 = '**/*.json5'
+export const GLOB_JSONC = '**/*.jsonc'
+
+export const GLOB_PACKAGE_JSON = '**/package.json'
+
+export const GLOB_MARKDOWN = '**/*.md'
+export const GLOB_VUE = '**/*.vue'
+export const GLOB_YAML = '**/*.y?(a)ml'
+export const GLOB_HTML = '**/*.htm?(l)'
+
+export const GLOB_ALL_SRC = /** @type {const} */ ([
+  GLOB_SRC,
+  GLOB_STYLE,
+  GLOB_JSON,
+  GLOB_JSON5,
+  GLOB_MARKDOWN,
+  GLOB_VUE,
+  GLOB_YAML,
+  GLOB_HTML,
+])
+
+export const GLOB_NODE_MODULES = /** @type {const} */ ('**/node_modules')
+export const GLOB_DIST = /** @type {const} */ ('**/dist')
+export const GLOB_LOCKFILE = /** @type {const} */ ([
+  '**/package-lock.json',
+  '**/yarn.lock',
+  '**/pnpm-lock.yaml',
+])
+export const GLOB_EXCLUDE = /** @type {const} */ ([
+  GLOB_NODE_MODULES,
+  GLOB_DIST,
+  ...GLOB_LOCKFILE,
+
+  '**/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 = /** @type {const} */ ['ts', 'js']
+  .flatMap((ext) => [ext, ext + 'x'])
+  .flatMap((ext) => [ext, 'm' + ext, 'c' + ext])
+  .flatMap((ext) => [ext, 'd.' + ext])

package/src/typescript.js

@@ -0,0 +1,89 @@
+// @ts-check
+
+import tsPlugin from '@typescript-eslint/eslint-plugin'
+import tsParser from '@typescript-eslint/parser'
+
+import { GLOB_JS, GLOB_JSX, GLOB_TS, GLOB_TSX } from './shared.js'
+
+export { tsParser, tsPlugin }
+
+/**
+ * @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 const typescript = (options) => {
+  const project = options?.project ?? './tsconfig.json'
+
+  /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
+  const config = [
+    {
+      files: [GLOB_TS, GLOB_TSX, GLOB_JS, GLOB_JSX],
+      languageOptions: {
+        // @ts-expect-error: the types for `parser` seems to be wrong
+        parser: tsParser,
+        parserOptions: project
+          ? {
+              project,
+              sourceType: 'module',
+              ecmaVersion: 'latest',
+            }
+          : {
+              sourceType: 'module',
+              ecmaVersion: 'latest',
+            },
+      },
+      plugins: {
+        // @ts-expect-error: they just don't play very well
+        '@typescript-eslint': tsPlugin,
+      },
+      rules: {
+        ...tsPlugin.configs['eslint-recommended'].overrides?.[0].rules,
+        ...tsPlugin.configs['recommended'].rules,
+        ...(project
+          ? 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',
+          {
+            argsIgnorePattern: '^_',
+            varsIgnorePattern: '^_',
+            caughtErrorsIgnorePattern: '^_',
+          },
+        ],
+        '@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',
+      },
+    },
+    {
+      files: ['**/*.js', '**/*.cjs'],
+      rules: {
+        '@typescript-eslint/no-var-requires': 'off',
+      },
+    },
+  ]
+
+  return config
+}

package/src/unicorn.js

@@ -0,0 +1,69 @@
+// @ts-check
+
+// @ts-expect-error: eslint-plugin-unicorn is not typed
+import plugin from 'eslint-plugin-unicorn'
+
+export const unicorn = () => {
+  /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
+  const config = [
+    {
+      plugins: {
+        unicorn: plugin,
+      },
+      rules: {
+        // Pass error message when throwing errors
+        'unicorn/error-message': 'error',
+        // Uppercase regex escapes
+        'unicorn/escape-case': 'error',
+        // Array.isArray instead of instanceof
+        'unicorn/no-instanceof-array': 'error',
+        // Prevent deprecated `new Buffer()`
+        'unicorn/no-new-buffer': 'error',
+        // Keep regex literals safe!
+        'unicorn/no-unsafe-regex': 'off',
+        // Lowercase number formatting for octal, hex, binary (0x1'error' instead of 0X1'error')
+        'unicorn/number-literal-case': 'error',
+        // includes over indexOf when checking for existence
+        'unicorn/prefer-includes': 'error',
+        // String methods startsWith/endsWith instead of more complicated stuff
+        'unicorn/prefer-string-starts-ends-with': 'error',
+        // textContent instead of innerText
+        'unicorn/prefer-text-content': 'error',
+        // Enforce throwing type error when throwing error while checking typeof
+        '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',
+        // Enforce explicitly comparing the length or size property of a value
+        'unicorn/explicit-length-check': 'error',
+        // Prefer `.flatMap(…)` over `.map(…).flat()`
+        'unicorn/prefer-array-index-of': 'error',
+        // Improve regexes
+        'unicorn/better-regex': 'error',
+        // Enforce combining multiple `Array#push()` into one call.
+        '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.
+        'unicorn/prefer-add-event-listener': 'error',
+        // Prefer `.find(…)` and `.findLast(…)` over the first or last element from
+        'unicorn/prefer-array-find': 'error',
+        // Prefer `.flatMap(…)` over `.map(…).flat()`.
+        'unicorn/prefer-array-flat-map': 'error',
+        // Prefer `.some(…)` over `.filter(…).length` check
+        'unicorn/prefer-array-some': 'error',
+        // Prefer `KeyboardEvent#key` over `KeyboardEvent#keyCode`
+        'unicorn/prefer-keyboard-event-key': 'error',
+        // Enforce the use of `Math.trunc` instead of bitwise operators.
+        'unicorn/prefer-math-trunc': 'error',
+        // Prefer negative index over `.length - index` when possible
+        'unicorn/prefer-negative-index': 'error',
+        // Prefer `Number` static properties over global ones.
+        'unicorn/prefer-number-properties': 'warn',
+      },
+    },
+  ]
+
+  return config
+}

package/CHANGELOG.md

@@ -1,85 +0,0 @@
-# Changelog
-
-### Dependencies
-
-* The following workspace dependencies were updated
-  * dependencies
-    * @ocavue/eslint-config-basic bumped from ^0.4.0 to ^0.5.0
-    * @ocavue/eslint-config-prettier bumped from ^0.4.0 to ^0.4.1
-
-### Dependencies
-
-* The following workspace dependencies were updated
-  * dependencies
-    * @ocavue/eslint-config-basic bumped from ^0.5.0 to ^0.6.0
-
-### Dependencies
-
-* The following workspace dependencies were updated
-  * dependencies
-    * @ocavue/eslint-config-basic bumped from ^0.6.0 to ^0.6.1
-
-### Dependencies
-
-* The following workspace dependencies were updated
-  * dependencies
-    * @ocavue/eslint-config-basic bumped from ^0.6.2 to ^0.6.3
-
-## [0.4.7](https://github.com/ocavue/eslint-config/compare/eslint-config-v0.4.6...eslint-config-v0.4.7) (2023-01-15)
-
-
-### Bug Fixes
-
-* correct the repository link in package.json ([#10](https://github.com/ocavue/eslint-config/issues/10)) ([4b5ad5e](https://github.com/ocavue/eslint-config/commit/4b5ad5e40459c470abb8fda326b76730f270d4a1))
-
-
-### Dependencies
-
-* The following workspace dependencies were updated
-  * dependencies
-    * @ocavue/eslint-config-basic bumped from ^0.6.4 to ^0.6.5
-    * @ocavue/eslint-config-prettier bumped from ^0.4.2 to ^0.4.3
-
-## [0.4.6](https://github.com/ocavue/eslint-config/compare/eslint-config-v0.4.5...eslint-config-v0.4.6) (2023-01-09)
-
-
-### Bug Fixes
-
-* update dependencies ([b1c1738](https://github.com/ocavue/eslint-config/commit/b1c17382b337a31564b627776a44b6048efcfd6f))
-
-
-### Dependencies
-
-* The following workspace dependencies were updated
-  * dependencies
-    * @ocavue/eslint-config-basic bumped from ^0.6.3 to ^0.6.4
-    * @ocavue/eslint-config-prettier bumped from ^0.4.1 to ^0.4.2
-
-## [0.4.4](https://github.com/ocavue/eslint-config/compare/eslint-config-v0.4.3...eslint-config-v0.4.4) (2022-11-23)
-
-
-### Bug Fixes
-
-* add missing dependencies ([70eaaa5](https://github.com/ocavue/eslint-config/commit/70eaaa50bb482ce3bd3575deb5e7b0011b417c7b))
-
-
-### Dependencies
-
-* The following workspace dependencies were updated
-  * dependencies
-    * @ocavue/eslint-config-basic bumped from ^0.6.1 to ^0.6.2
-
-## [0.4.0](https://github.com/ocavue/eslint-config/compare/eslint-config-v0.3.0...eslint-config-v0.4.0) (2022-11-23)
-
-
-### Features
-
-* release packages ([247817b](https://github.com/ocavue/eslint-config/commit/247817b1397b6291b5c800435a23748075d535f7))
-
-
-### Dependencies
-
-* The following workspace dependencies were updated
-  * dependencies
-    * @ocavue/eslint-config-basic bumped from ^0.2.1 to ^0.4.0
-    * @ocavue/eslint-config-prettier bumped from ^0.2.1 to ^0.4.0