@ivanmaxlogiudice/eslint-config 0.1.10 → 1.0.0-beta.0

package/src/js.js

@@ -0,0 +1,350 @@
+import globals from 'globals'
+import jsConfig from '@eslint/js'
+import standardConfig from 'eslint-config-standard'
+import nPlugin from 'eslint-plugin-n'
+import importPlugin from 'eslint-plugin-import'
+import unusedImportsPlugin from 'eslint-plugin-unused-imports'
+import unicornPlugin from 'eslint-plugin-unicorn'
+import antfuPlugin from 'eslint-plugin-antfu'
+import noOnlyTestsPlugin from 'eslint-plugin-no-only-tests'
+import { GLOB_MARKDOWN, GLOB_SRC, GLOB_SRC_EXT } from './shared.js'
+
+export { importPlugin, unicornPlugin, antfuPlugin }
+
+/** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
+export const js = [
+    jsConfig.configs.recommended,
+    {
+        languageOptions: {
+            globals: {
+                ...globals.browser,
+                ...globals.es2021,
+                ...globals.node,
+            },
+            sourceType: 'module',
+        },
+        plugins: {
+            standard: standardConfig,
+            n: nPlugin,
+        },
+        rules: {
+            // ...standardConfig,
+            
+            'array-bracket-spacing': ['error', 'never'],
+            'array-callback-return': 'error',
+            'arrow-parens': ['error', 'as-needed', {
+                requireForBlockBody: true,
+            }],
+            'block-scoped-var': 'error',
+            'block-spacing': ['error', 'always'],
+            'brace-style': ['error', 'stroustrup', {
+                allowSingleLine: true,
+            }],
+            'consistent-return': 'error',
+            'comma-dangle': ['error', 'always-multiline'],
+            'comma-spacing': ['error', {
+                after: true,
+                before: false,
+            }],
+            'comma-style': ['error', 'last'],
+            'curly': ['error', 'multi-or-nest', 'consistent'],
+            'eqeqeq': ['error', 'smart'],
+            'func-call-spacing': ['error', 'never'],
+            'indent': ['error', 4, {
+                SwitchCase: 1,
+                outerIIFEBody: 1,
+                VariableDeclarator: 1,
+            }],
+            'key-spacing': ['error', {
+                afterColon: true,
+                beforeColon: false,
+            }],
+            'max-statements-per-line': ['error', {
+                max: 1,
+            }],
+            'object-curly-spacing': ['error', 'always'],
+            'object-shorthand': ['error', 'always', {
+                avoidQuotes: true,
+                ignoreConstructors: false,
+            }],
+            'operator-linebreak': ['error', 'before'],
+            'prefer-arrow-callback': ['error', {
+                allowNamedFunctions: false,
+                allowUnboundThis: true,
+            }],
+            'prefer-const': ['error', {
+                destructuring: 'all',
+                ignoreReadBeforeAssign: true,
+            }],
+            'prefer-exponentiation-operator': 'error',
+            'prefer-rest-params': 'error',
+            'prefer-spread': 'error',
+            'prefer-template': 'error',
+            'quote-props': ['error', 'consistent-as-needed'],
+            'quotes': ['error', 'single', {
+                avoidEscape: true,
+            }],
+            'semi': ['error', 'never'],
+            'sort-imports': ['error', {
+                allowSeparatedGroups: false,
+                ignoreCase: false,
+                ignoreDeclarationSort: true,
+                ignoreMemberSort: false,
+                memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single'],
+            }],
+            'space-before-blocks': ['error', 'always'],
+            'space-before-function-paren': ['error', {
+                anonymous: 'always',
+                asyncArrow: 'always',
+                named: 'never',
+            }],
+            'spaced-comment': ['error', 'always', {
+                block: {
+                    balanced: true,
+                    exceptions: ['*'],
+                    markers: ['!'],
+                },
+                line: {
+                    exceptions: ['/', '#'],
+                    markers: ['/'],
+                },
+            }],
+            'require-await': 'error',
+            'template-curly-spacing': 'error',
+            'vars-on-top': 'error',
+
+            // no-
+            'no-alert': 'warn',
+            'no-cond-assign': ['error', 'always'],
+            'no-console': ['error', {
+                allow: ['warn', 'error'],
+            }],
+            'no-constant-condition': 'warn',
+            'no-debugger': 'warn',
+            'no-duplicate-imports': 'error',
+            'no-empty': ['error', { 
+                allowEmptyCatch: true, 
+            }],
+            'no-invalid-this': 'error',
+            'no-lonely-if': 'error',
+            'no-multi-spaces': 'error',
+            'no-multi-str': 'error',
+            'no-return-assign': ['error', 'always'],
+            'no-return-await': 'warn',
+            'no-restricted-globals': ['error', 
+                { name: 'global', message: 'Use `globalThis` instead.' }, 
+                { name: 'self', message: 'Use `globalThis` instead.' },
+            ],
+            'no-restricted-properties': ['error',
+                { property: '__proto__', message: 'Use `Object.getPrototypeOf` or `Object.setPrototypeOf` instead.' },
+                { property: '__defineGetter__', message: 'Use `Object.defineProperty` instead.' },
+                { property: '__defineSetter__', message: 'Use `Object.defineProperty` instead.' },
+                { property: '__lookupGetter__', message: 'Use `Object.getOwnPropertyDescriptor` instead.' },
+                { property: '__lookupSetter__', message: 'Use `Object.getOwnPropertyDescriptor` instead.' },
+            ],
+            'no-restricted-syntax': ['error',
+                'DebuggerStatement',
+                'LabeledStatement',
+                'WithStatement',
+            ],
+            'no-param-reassign': 'error',
+            'no-unused-expressions': ['error', {
+                allowShortCircuit: true,
+                allowTernary: true,
+                allowTaggedTemplates: true,
+            }],
+            'no-useless-escape': 'error',
+            'no-use-before-define': ['error', {
+                classes: false,
+                functions: false,
+                variables: true,
+            }],
+            'no-var': 'error',
+            'no-void': 'error',
+
+            // node
+            'n/prefer-global/buffer': ['error', 'never'],
+            'n/no-callback-literal': 'off',
+
+            // off
+            'camelcase': 'off',
+            'complexity': 'off',
+            'generator-star-spacing': 'off',
+            'no-unused-vars': 'off', // handled by unused-imports/no-unused-vars
+        },
+    },
+    {
+        files: ['**/scripts/*', '**/cli.*'],
+        rules: {
+            'no-console': 'off',
+        },
+    },
+    {
+        plugins: {
+            noOnlyTest: noOnlyTestsPlugin,
+        },
+        files: ['**/*.{test,spec}.{js?(x),ts}'],
+        rules: {
+            'no-unused-expressions': 'off',
+            'no-only-tests/no-only-tests': 'error',
+        },
+    },
+]
+
+/** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
+export const jsx = [
+    {
+        files: ['**/*.jsx'],
+        languageOptions: {
+            parserOptions: {
+                ecmaFeatures: {
+                    jsx: true,
+                },
+            },
+        },
+    },
+]
+
+/** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
+export const imports = [
+    {
+        plugins: {
+            'import': importPlugin,
+            'unused-imports': unusedImportsPlugin,
+            'antfu': antfuPlugin,
+        },
+        settings: {
+            'import/resolver': {
+                node: { extensions: ['.js', '.mjs', '.ts', '.mts', '.d.ts'] },
+            },
+        },
+        rules: {
+            'import/first': 'error',
+            'import/newline-after-import': ['error', {
+                considerComments: true,
+                count: 1,
+            }],
+            'import/no-default-export': 'error',
+            'import/no-duplicates': 'error',
+            'import/no-mutable-exports': 'error',
+            'import/order': ['error', {
+                groups: [
+                    'builtin',
+                    'external',
+                    'internal',
+                    'parent',
+                    'sibling',
+                    'index',
+                    'object',
+                    'type',
+                ],
+                pathGroups: [{
+                    group: 'internal',
+                    pattern: '@/**',
+                }],
+                pathGroupsExcludedImportTypes: ['type'],
+            }],
+
+            // off
+            'import/namespace': 'off',
+            'import/no-absolute-path': 'off',
+            'import/no-named-as-default': 'off',
+            'import/no-named-as-default-member': 'off',
+            'import/no-unresolved': 'off',
+
+            // unused-imports
+            'unused-imports/no-unused-imports': 'error',
+            'unused-imports/no-unused-vars': ['warn', {
+                vars: 'all',
+                varsIgnorePattern: '^_',
+                args: 'after-used',
+                argsIgnorePattern: '^_',
+            }],
+
+            'antfu/if-newline': 'error',
+            'antfu/import-dedupe': 'error',
+            'antfu/prefer-inline-type-import': 'error',
+        },
+    },
+    {
+        files: [
+            `**/*config*.${GLOB_SRC_EXT}`,
+            `**/views/${GLOB_SRC}`,
+            `**/pages/${GLOB_SRC}`,
+            '**/{index,vite,esbuild,rollup,webpack,rspack}.ts',
+            '**/*.d.ts',
+            `${GLOB_MARKDOWN}/**`,
+        ],
+        plugins: {
+            import: importPlugin,
+        },
+        rules: {
+            'import/no-default-export': 'off',
+        },
+    },
+]
+
+/** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
+export const unicorn = [
+    {
+        plugins: {
+            unicorn: unicornPlugin,
+        },
+        rules: {
+            'unicorn/better-regex': 'error',
+            'unicorn/custom-error-definition': 'error',
+            'unicorn/error-message': 'error',
+            'unicorn/escape-case': 'error',
+            'unicorn/explicit-length-check': 'error',
+            'unicorn/import-index': 'error',
+            'unicorn/new-for-builtins': 'error',
+            'unicorn/no-array-callback-reference': 'error',
+            'unicorn/no-array-method-this-argument': 'error',
+            'unicorn/no-array-push-push': 'error',
+            'unicorn/no-console-spaces': 'error',
+            'unicorn/no-for-loop': 'error',
+            'unicorn/no-hex-escape': 'error',
+            'unicorn/no-instanceof-array': 'error',
+            'unicorn/no-invalid-remove-event-listener': 'error',
+            'unicorn/no-lonely-if': 'error',
+            'unicorn/no-new-array': 'error',
+            'unicorn/no-new-buffer': 'error',
+            'unicorn/no-unnecessary-await': 'error',
+            'unicorn/no-unsafe-regex': 'off',
+            'unicorn/number-literal-case': 'error',
+            'unicorn/prefer-add-event-listener': 'error',
+            'unicorn/prefer-array-find': 'error',
+            'unicorn/prefer-array-flat-map': 'error',
+            'unicorn/prefer-array-index-of': 'error',
+            'unicorn/prefer-array-some': 'error',
+            'unicorn/prefer-at': 'error',
+            'unicorn/prefer-blob-reading-methods': 'error',
+            'unicorn/prefer-date-now': 'error',
+            'unicorn/prefer-dom-node-append': 'error',
+            'unicorn/prefer-dom-node-dataset': 'error',
+            'unicorn/prefer-dom-node-remove': 'error',
+            'unicorn/prefer-dom-node-text-content': 'error',
+            'unicorn/prefer-includes': 'error',
+            'unicorn/prefer-keyboard-event-key': 'error',
+            'unicorn/prefer-logical-operator-over-ternary': 'error',
+            'unicorn/prefer-math-trunc': 'error',
+            'unicorn/prefer-modern-dom-apis': 'error',
+            'unicorn/prefer-negative-index': 'error',
+            'unicorn/prefer-node-protocol': 'error',
+            'unicorn/prefer-number-properties': 'error',
+            'unicorn/prefer-optional-catch-binding': 'error',
+            'unicorn/prefer-prototype-methods': 'error',
+            'unicorn/prefer-query-selector': 'error',
+            'unicorn/prefer-reflect-apply': 'error',
+            'unicorn/prefer-string-replace-all': 'error',
+            'unicorn/prefer-string-slice': 'error',
+            'unicorn/prefer-string-starts-ends-with': 'error',
+            'unicorn/prefer-string-trim-start-end': 'error',
+            'unicorn/prefer-text-content': 'error',
+            'unicorn/prefer-type-error': 'error',
+            'unicorn/switch-case-braces': 'error',
+            'unicorn/throw-new-error': 'error',
+        },
+    },
+]
+  

package/src/jsonc.js

@@ -0,0 +1,108 @@
+import jsoncPlugin, { configs } from 'eslint-plugin-jsonc'
+import jsoncParser from 'jsonc-eslint-parser'
+import { GLOB_JSON, GLOB_JSON5, GLOB_JSONC } from './shared.js'
+
+/** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
+export const jsonc = [
+    {
+        files: [GLOB_JSON, GLOB_JSON5, GLOB_JSONC],
+        plugins: {
+            jsonc: jsoncPlugin,
+        },
+        languageOptions: {
+            parser: jsoncParser,
+        },
+        rules: {
+            ...configs['recommended-with-jsonc'].rules,
+
+            'jsonc/array-bracket-spacing': ['error', 'never'],
+            'jsonc/comma-dangle': 'error',
+            'jsonc/comma-style': ['error', 'last'],
+            'jsonc/indent': ['error', 4],
+            'jsonc/key-spacing': ['error', { 
+                beforeColon: false, 
+                afterColon: true, 
+            }],
+            'jsonc/no-octal-escape': 'error',
+            'jsonc/object-curly-newline': ['error', { 
+                multiline: true, 
+                consistent: true, 
+            }],
+            'jsonc/object-curly-spacing': ['error', 'always'],
+            'jsonc/object-property-newline': ['error', { 
+                allowMultiplePropertiesPerLine: true, 
+            }],
+        },
+    },
+]
+  
+/** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
+export const pkgOrder = [
+    {
+        files: ['**/package.json'],
+        rules: {
+            'jsonc/sort-keys': [
+                'error',
+                {
+                    pathPattern: '^$',
+                    order: [
+                        'name',
+                        'version',
+                        'private',
+                        'packageManager',
+                        'description',
+                        'type',
+                        'keywords',
+                        'license',
+                        'homepage',
+                        'bugs',
+                        'repository',
+                        'author',
+                        'contributors',
+                        'funding',
+                        'sideEffects',
+                        'files',
+                        'main',
+                        'module',
+                        'types',
+                        'exports',
+                        'typesVersions',
+                        'unpkg',
+                        'jsdelivr',
+                        'browser',
+                        'bin',
+                        'man',
+                        'directories',
+                        'publishConfig',
+                        'scripts',
+                        'peerDependencies',
+                        'peerDependenciesMeta',
+                        'optionalDependencies',
+                        'dependencies',
+                        'devDependencies',
+                        'engines',
+                        'config',
+                        'overrides',
+                        'pnpm',
+                        'husky',
+                        'simple-git-hooks',
+                        'lint-staged',
+                        'eslintConfig',
+                    ],
+                },
+                {
+                    pathPattern: '^(?:dev|peer|optional|bundled)?[Dd]ependencies$',
+                    order: { type: 'asc' },
+                },
+                {
+                    pathPattern: '^exports.*$',
+                    order: [
+                        'types',
+                        'require',
+                        'import',
+                    ],
+                },
+            ],
+        },
+    },
+]

package/src/markdown.js

@@ -0,0 +1,43 @@
+import markdownPlugin from 'eslint-plugin-markdown'
+import tsPlugin from '@typescript-eslint/eslint-plugin'
+
+import { GLOB_MARKDOWN, GLOB_SRC, GLOB_VUE } from './shared.js'
+
+/** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
+export const markdown = [
+    {
+        files: [GLOB_MARKDOWN],
+        plugins: {
+            markdown: markdownPlugin,
+        },
+        processor: 'markdown/markdown',
+    },
+    {
+        files: [`${GLOB_MARKDOWN}/${GLOB_SRC}`, `${GLOB_MARKDOWN}/${GLOB_VUE}`],
+        languageOptions: {
+            parserOptions: {
+                ecmaFeatures: {
+                    impliedStrict: true,
+                },
+            },
+        },
+        plugins: {
+            '@typescript-eslint': tsPlugin,
+        },
+        rules: {
+            ...markdownPlugin.configs.recommended.overrides[1].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',
+            'no-undef': 'off',
+            'no-unused-expressions': 'off',
+            'no-unused-vars': 'off',
+        },
+    },
+]

package/src/presets.js

@@ -0,0 +1,63 @@
+// @ts-check
+
+import { eslintComments } from './eslint-comments.js'
+import { imports, js, jsx, unicorn } from './js.js'
+import { jsonc, pkgOrder } from './jsonc.js'
+import { typescript } from './typescript.js'
+import { markdown } from './markdown.js'
+import { yml } from './yml.js'
+import { vue } from './vue.js'
+
+import { GLOB_EXCLUDE } from './shared.js'
+
+/**
+ * @typedef { import('eslint-define-config').FlatESLintConfigItem } FlatESLintConfigItem
+ */
+
+/** @type {FlatESLintConfigItem[]} */
+export const basic = [
+    // @ts-ignore
+    { ignores: GLOB_EXCLUDE },
+
+    ...js,
+    ...jsx,
+    ...typescript,
+    ...imports,
+    ...unicorn,
+    ...jsonc,
+    ...pkgOrder,
+    ...yml,
+    ...eslintComments,
+]
+
+/** @type {FlatESLintConfigItem[]} */
+export const all = [
+    ...vue,
+    ...basic,
+]
+
+/** @type {(config?: FlatESLintConfigItem | FlatESLintConfigItem[], enables?: Partial<{
+ * vue: boolean
+ * markdown: boolean
+ * }>) => FlatESLintConfigItem[]} */
+export function config(
+    config = [],
+    {
+        vue: enableVue = true,
+        markdown: enableMarkdown = true,
+    } = {},
+) {
+    const configs = [...basic]
+    
+    if (enableVue !== false) 
+        configs.push(...vue)
+  
+    if (enableMarkdown !== false) 
+        configs.push(...markdown)
+  
+    if (Object.keys(config).length > 0) 
+        configs.push(...(Array.isArray(config) ? config : [config]))
+  
+
+    return configs
+}

package/src/shared.js

@@ -0,0 +1,67 @@
+// @ts-check
+
+export const GLOB_SRC_EXT = '?([cm])[jt]s?(x)'
+export const GLOB_SRC = '**/*.?([cm])[jt]s?(x)'
+
+export const GLOB_JS = '**/*.?([cm])js'
+export const GLOB_JSX = '**/*.?([cm])jsx'
+
+export const GLOB_TS = '**/*.?([cm])ts'
+export const GLOB_TSX = '**/*.?([cm])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_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',
+    '**/.nuxt',
+    '**/.vercel',
+    '**/.changeset',
+    '**/.idea',
+    '**/.output',
+    '**/.vite-inspect',
+
+    '**/CHANGELOG*.md',
+    '**/*.min.*',
+    '**/LICENSE*',
+    '**/__snapshots__',
+    '**/auto-import.d.ts',
+    '**/components.d.ts',
+])