@w5s/eslint-config 1.0.0-alpha.9 → 1.0.0

package/lib/jsonc.js

@@ -0,0 +1,183 @@
+"use strict";
+// https://github.com/keithamus/sort-package-json/blob/master/defaultRules.md
+const config = {
+    extends: ['plugin:jsonc/recommended-with-jsonc', 'plugin:jsonc/prettier'],
+    overrides: [
+        {
+            files: ['tsconfig*.json'],
+            rules: {
+                'jsonc/sort-keys': [
+                    'error',
+                    {
+                        order: ['$schema', 'display', 'extends', 'compilerOptions', 'include', 'exclude', 'files', 'references'],
+                        pathPattern: '^$',
+                    },
+                    {
+                        order: { type: 'asc' },
+                        pathPattern: '.*',
+                    },
+                ],
+            },
+        },
+        {
+            files: ['package.json'],
+            rules: {
+                'jsonc/sort-keys': [
+                    'error',
+                    {
+                        order: [
+                            '$schema',
+                            'name',
+                            'displayName',
+                            'version',
+                            'private',
+                            'description',
+                            'categories',
+                            'keywords',
+                            'homepage',
+                            'bugs',
+                            'repository',
+                            'funding',
+                            'license',
+                            'qna',
+                            'author',
+                            'maintainers',
+                            'contributors',
+                            'publisher',
+                            'sideEffects',
+                            'type',
+                            'imports',
+                            'exports',
+                            'main',
+                            'svelte',
+                            'umd:main',
+                            'jsdelivr',
+                            'unpkg',
+                            'module',
+                            'source',
+                            'jsnext:main',
+                            'browser',
+                            'react-native',
+                            'types',
+                            'typesVersions',
+                            'typings',
+                            'style',
+                            'example',
+                            'examplestyle',
+                            'assets',
+                            'bin',
+                            'man',
+                            'directories',
+                            'files',
+                            'workspaces',
+                            'binary',
+                            'scripts',
+                            'betterScripts',
+                            'contributes',
+                            'activationEvents',
+                            'husky',
+                            'simple-git-hooks',
+                            'pre-commit',
+                            'commitlint',
+                            'lint-staged',
+                            'config',
+                            'nodemonConfig',
+                            'browserify',
+                            'babel',
+                            'browserslist',
+                            'xo',
+                            'prettier',
+                            'eslintConfig',
+                            'eslintIgnore',
+                            'npmpackagejsonlint',
+                            'release',
+                            'remarkConfig',
+                            'stylelint',
+                            'ava',
+                            'jest',
+                            'mocha',
+                            'nyc',
+                            'tap',
+                            'resolutions',
+                            'dependencies',
+                            'devDependencies',
+                            'dependenciesMeta',
+                            'peerDependencies',
+                            'peerDependenciesMeta',
+                            'optionalDependencies',
+                            'bundledDependencies',
+                            'bundleDependencies',
+                            'extensionPack',
+                            'extensionDependencies',
+                            'flat',
+                            'packageManager',
+                            'engines',
+                            'engineStrict',
+                            'volta',
+                            'languageName',
+                            'os',
+                            'cpu',
+                            'preferGlobal',
+                            'publishConfig',
+                            'icon',
+                            'badges',
+                            'galleryBanner',
+                            'preview',
+                            'markdown',
+                        ],
+                        pathPattern: '^$',
+                    },
+                    {
+                        order: ['url', 'email'],
+                        pathPattern: `^bugs$`,
+                    },
+                    ...['repository', 'funding', 'license', 'author'].map((key) => ({
+                        order: ['type', 'name', 'email', 'url'],
+                        pathPattern: `^${key}$`,
+                    })),
+                    ...['scripts', 'betterScripts'].map((key) => ({
+                        order: { type: 'asc' },
+                        pathPattern: `^${key}$`,
+                    })),
+                    ...[
+                        'bin',
+                        'contributes',
+                        'commitlint',
+                        'config',
+                        'nodemonConfig',
+                        'browserify',
+                        'babel',
+                        'xo',
+                        'release',
+                        'remarkConfig',
+                        'ava',
+                        'jest',
+                        'mocha',
+                        'nyc',
+                        'tap',
+                        'resolutions',
+                        'engines',
+                        'engineStrict',
+                        'preferGlobal',
+                        'publishConfig',
+                        'galleryBanner',
+                    ].map((key) => ({
+                        order: { type: 'asc' },
+                        pathPattern: `^${key}$`,
+                    })),
+                    {
+                        order: { type: 'asc' },
+                        pathPattern: '^(?:dev|peer|optional|bundled|extension)?[Dd]ependencies$',
+                    },
+                    {
+                        order: ['types', 'require', 'import'],
+                        pathPattern: '^exports.*$',
+                    },
+                ],
+            },
+        },
+    ],
+    parser: 'jsonc-eslint-parser',
+    plugins: ['jsonc'],
+};
+module.exports = config;

package/lib/prettier.d.ts

@@ -0,0 +1,3 @@
+import type eslint from 'eslint';
+declare const config: eslint.Linter.Config;
+export = config;

package/lib/prettier.js

@@ -0,0 +1,43 @@
+"use strict";
+/* eslint-disable global-require */
+/* eslint-disable import/no-dynamic-require */
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable @typescript-eslint/no-require-imports */
+const getPackageScope = () => {
+    try {
+        const { name } = require('../package.json');
+        const prefixMatch = (name ?? '').match(/(@\w+)\//);
+        const packageScope = prefixMatch == null ? undefined : prefixMatch[1];
+        return packageScope;
+    }
+    catch (error_) {
+        // eslint-disable-next-line no-console
+        console.warn(error_);
+        return undefined;
+    }
+};
+const getPrettierConfig = (moduleName) => {
+    try {
+        const moduleConfig = require(moduleName);
+        return moduleConfig;
+    }
+    catch {
+        return undefined;
+    }
+};
+// Try require '@my-organization/prettier-config'
+const getPrettierConfigDefault = () => {
+    const defaultConfig = {
+        trailingComma: 'es5',
+    };
+    const packageScope = getPackageScope();
+    return (packageScope == null ? undefined : getPrettierConfig(`${packageScope}/prettier-config`)) ?? defaultConfig;
+};
+const config = {
+    extends: ['prettier'],
+    plugins: ['prettier'],
+    rules: {
+        'prettier/prettier': ['error', getPrettierConfigDefault()],
+    },
+};
+module.exports = config;

package/lib/typescript.d.ts

@@ -0,0 +1,3 @@
+import type eslint from 'eslint';
+declare const config: eslint.Linter.Config;
+export = config;

package/lib/typescript.js

@@ -0,0 +1,248 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const dev_1 = require("@w5s/dev");
+const _rule_js_1 = require("./_rule.js");
+const base_js_1 = __importDefault(require("./es/base.js"));
+const import_js_1 = __importDefault(require("./es/import.js"));
+// Inspired by https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+// Fix Hack : TS plugin seems to modify the rules
+const deepClone = (anyValue) => JSON.parse(JSON.stringify(anyValue));
+const baseRules = deepClone(base_js_1.default.rules);
+const baseImportRules = deepClone(import_js_1.default.rules);
+const duplicateTSC = 'off'; // = "off because tsc already checks that"
+const config = dev_1.ESLintConfig.concat(
+/**
+ * Plugin rules
+ */
+{
+    extends: ['plugin:@typescript-eslint/recommended-requiring-type-checking'],
+    parser: '@typescript-eslint/parser',
+    parserOptions: {
+        sourceType: 'module',
+    },
+    plugins: ['@typescript-eslint', 'import'],
+    rules: {
+        '@typescript-eslint/adjacent-overload-signatures': 'error',
+        '@typescript-eslint/ban-ts-comment': [
+            'warn',
+            {
+                minimumDescriptionLength: 3,
+                'ts-check': false,
+                'ts-expect-error': 'allow-with-description',
+                'ts-ignore': 'allow-with-description',
+                'ts-nocheck': true,
+            },
+        ],
+        '@typescript-eslint/ban-types': 'error',
+        '@typescript-eslint/brace-style': baseRules['brace-style'],
+        '@typescript-eslint/comma-dangle': [
+            baseRules['comma-dangle'][0],
+            {
+                ...baseRules['comma-dangle'][1],
+                enums: baseRules['comma-dangle'][1].arrays,
+                generics: baseRules['comma-dangle'][1].arrays,
+                tuples: baseRules['comma-dangle'][1].arrays,
+            },
+        ],
+        '@typescript-eslint/comma-spacing': baseRules['comma-spacing'],
+        '@typescript-eslint/consistent-type-assertions': [
+            'error',
+            { assertionStyle: 'as', objectLiteralTypeAssertions: 'never' },
+        ],
+        '@typescript-eslint/default-param-last': baseRules['default-param-last'],
+        '@typescript-eslint/dot-notation': baseRules['dot-notation'],
+        '@typescript-eslint/explicit-function-return-type': 'off',
+        '@typescript-eslint/explicit-module-boundary-types': 'off',
+        '@typescript-eslint/func-call-spacing': baseRules['func-call-spacing'],
+        '@typescript-eslint/indent': baseRules.indent,
+        '@typescript-eslint/keyword-spacing': baseRules['keyword-spacing'],
+        '@typescript-eslint/lines-between-class-members': baseRules['lines-between-class-members'],
+        '@typescript-eslint/member-delimiter-style': 'error',
+        '@typescript-eslint/naming-convention': [
+            'error',
+            {
+                format: ['PascalCase', 'camelCase'],
+                leadingUnderscore: 'allow',
+                selector: 'default',
+                trailingUnderscore: 'allow',
+            },
+            {
+                format: ['PascalCase', 'camelCase', 'UPPER_CASE'],
+                leadingUnderscore: 'allow',
+                selector: 'variable',
+                trailingUnderscore: 'allow',
+            },
+            {
+                format: ['PascalCase', 'camelCase', 'UPPER_CASE'],
+                leadingUnderscore: 'allowSingleOrDouble',
+                selector: 'memberLike',
+                trailingUnderscore: 'allowDouble',
+            },
+            {
+                format: ['PascalCase'],
+                selector: 'typeLike',
+            },
+        ],
+        '@typescript-eslint/no-array-constructor': baseRules['no-array-constructor'],
+        '@typescript-eslint/no-base-to-string': 'error',
+        '@typescript-eslint/no-dupe-class-members': baseRules['no-dupe-class-members'],
+        '@typescript-eslint/no-empty-function': baseRules['no-empty-function'],
+        '@typescript-eslint/no-empty-interface': ['error', { allowSingleExtends: true }],
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/no-extra-parens': baseRules['no-extra-parens'],
+        '@typescript-eslint/no-extra-semi': baseRules['no-extra-semi'],
+        '@typescript-eslint/no-implicit-any-catch': 'error',
+        '@typescript-eslint/no-inferrable-types': 'error',
+        '@typescript-eslint/no-loop-func': baseRules['no-loop-func'],
+        '@typescript-eslint/no-loss-of-precision': baseRules['no-loss-of-precision'],
+        '@typescript-eslint/no-magic-numbers': baseRules['no-magic-numbers'],
+        '@typescript-eslint/no-misused-new': 'error',
+        '@typescript-eslint/no-namespace': 'off',
+        '@typescript-eslint/no-non-null-assertion': 'error',
+        '@typescript-eslint/no-redeclare': (0, _rule_js_1.fixme)(baseRules['no-redeclare']),
+        '@typescript-eslint/no-require-imports': 'error',
+        '@typescript-eslint/no-shadow': baseRules['no-shadow'],
+        '@typescript-eslint/no-this-alias': 'error',
+        '@typescript-eslint/no-throw-literal': baseRules['no-throw-literal'],
+        '@typescript-eslint/no-unnecessary-condition': 'error',
+        '@typescript-eslint/no-unsafe-argument': 'error',
+        '@typescript-eslint/no-unused-expressions': baseRules['no-unused-expressions'],
+        '@typescript-eslint/no-unused-vars': baseRules['no-unused-vars'],
+        '@typescript-eslint/no-use-before-define': baseRules['no-use-before-define'],
+        '@typescript-eslint/no-useless-constructor': baseRules['no-useless-constructor'],
+        '@typescript-eslint/no-var-requires': 'error',
+        '@typescript-eslint/object-curly-spacing': baseRules['object-curly-spacing'],
+        '@typescript-eslint/prefer-namespace-keyword': 'error',
+        '@typescript-eslint/prefer-reduce-type-parameter': 'error',
+        '@typescript-eslint/quotes': baseRules.quotes,
+        '@typescript-eslint/require-await': baseRules['require-await'],
+        '@typescript-eslint/return-await': baseRules['no-return-await'],
+        '@typescript-eslint/semi': baseRules.semi,
+        '@typescript-eslint/space-before-function-paren': baseRules['space-before-function-paren'],
+        '@typescript-eslint/space-infix-ops': baseRules['space-infix-ops'],
+        '@typescript-eslint/strict-boolean-expressions': [
+            'error',
+            {
+                allowNullableObject: false,
+                allowNumber: false,
+                allowString: false,
+            },
+        ],
+        '@typescript-eslint/switch-exhaustiveness-check': 'error',
+        '@typescript-eslint/triple-slash-reference': 'error',
+        '@typescript-eslint/type-annotation-spacing': 'error',
+    },
+}, 
+/**
+ * JSDoc overrides
+ */
+{
+    rules: {
+        'jsdoc/no-types': 'error',
+        'jsdoc/require-param': 'off',
+        'jsdoc/require-param-type': 'off',
+        'jsdoc/require-returns': 'off',
+        'jsdoc/require-returns-type': 'off',
+    },
+}, 
+/**
+ * Import overrides
+ */
+{
+    rules: {
+        'import/extensions': [
+            baseImportRules['import/extensions'][0],
+            baseImportRules['import/extensions'][1],
+            {
+                ...baseImportRules['import/extensions'][2],
+                ts: 'never',
+                tsx: 'never',
+            },
+        ],
+        'import/no-extraneous-dependencies': [
+            baseImportRules['import/no-extraneous-dependencies'][0],
+            {
+                ...baseImportRules['import/no-extraneous-dependencies'][1],
+                devDependencies: baseImportRules['import/no-extraneous-dependencies'][1].devDependencies.reduce((result, devDep) => {
+                    const toAppend = [devDep];
+                    const devDepWithTs = devDep.replace(/\bjs(x?)\b/g, 'ts$1');
+                    if (devDepWithTs !== devDep) {
+                        toAppend.push(devDepWithTs);
+                    }
+                    return [...result, ...toAppend];
+                }, []),
+            },
+        ],
+    },
+}, 
+/**
+ * Disabled rules
+ */
+{
+    // https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md#eslint-plugin-import
+    rules: {
+        'brace-style': 'off',
+        camelcase: 'off',
+        'comma-dangle': 'off',
+        'comma-spacing': 'off',
+        'constructor-super': 'off',
+        'default-param-last': 'off',
+        'dot-notation': 'off',
+        'func-call-spacing': 'off',
+        'getter-return': 'off',
+        'import/default': duplicateTSC,
+        'import/export': (0, _rule_js_1.fixme)('error'),
+        'import/named': duplicateTSC,
+        'import/namespace': duplicateTSC,
+        'import/no-named-as-default-member': duplicateTSC,
+        'import/no-unresolved': duplicateTSC,
+        indent: 'off',
+        'keyword-spacing': 'off',
+        'lines-between-class-members': 'off',
+        'no-array-constructor': 'off',
+        'no-const-assign': 'off',
+        'no-dupe-args': 'off',
+        'no-dupe-class-members': 'off',
+        'no-dupe-keys': 'off',
+        'no-empty-function': 'off',
+        'no-extra-parens': 'off',
+        'no-extra-semi': 'off',
+        'no-func-assign': 'off',
+        'no-implied-eval': 'off',
+        'no-import-assign': 'off',
+        'no-inner-declarations': (0, _rule_js_1.fixme)('error'),
+        'no-loop-func': 'off',
+        'no-loss-of-precision': 'off',
+        'no-magic-numbers': 'off',
+        'no-new-func': 'off',
+        'no-new-symbol': 'off',
+        'no-obj-calls': 'off',
+        'no-redeclare': 'off',
+        'no-return-await': 'off',
+        'no-setter-return': 'off',
+        'no-shadow': 'off',
+        'no-this-before-super': 'off',
+        'no-throw-literal': 'off',
+        'no-undef': 'off',
+        'no-unreachable': 'off',
+        'no-unsafe-negation': 'off',
+        'no-unused-expressions': 'off',
+        'no-unused-vars': 'off',
+        'no-use-before-define': 'off',
+        'no-useless-constructor': 'off',
+        'no-var': 'error',
+        'object-curly-spacing': 'off',
+        'prefer-const': 'error',
+        'prefer-rest-params': 'error',
+        'prefer-spread': 'error',
+        quotes: 'off',
+        'require-await': 'off',
+        semi: 'off',
+        'space-before-function-paren': 'off',
+        'space-infix-ops': 'off',
+        'valid-typeof': 'off',
+    },
+});
+module.exports = config;

package/lib/yml.d.ts

@@ -0,0 +1,3 @@
+import type eslint from 'eslint';
+declare const config: eslint.Linter.Config;
+export = config;

package/lib/yml.js

@@ -0,0 +1,7 @@
+"use strict";
+const config = {
+    extends: ['plugin:yml/standard', 'plugin:yml/prettier'],
+    parser: 'yaml-eslint-parser',
+    plugins: ['yml'],
+};
+module.exports = config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@w5s/eslint-config",
-  "version": "1.0.0-alpha.9",
+  "version": "1.0.0",
   "description": "ESLint configuration presets",
   "keywords": [
     "eslint",
@@ -13,75 +13,94 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/w5s/project-config.git",
+    "url": "git@github.com:w5s/project-config.git",
     "directory": "packages/eslint-config"
   },
   "license": "MIT",
   "author": "Julien Polo <julien.polo@gmail.com>",
+  "type": "commonjs",
   "main": "index.js",
   "files": [
+    "lib/**/!(*.spec).d.ts",
+    "lib/**/!(*.spec).js.map",
+    "lib/**/!(*.spec).js",
+    "src/**/!(*.spec).ts",
+    "!example/**/*",
+    "!*.cjs",
+    "index.js",
+    "index.d.ts",
     "*.js",
     "rules/*.js"
   ],
   "scripts": {
-    "build": "npm-run-all -p 'build:*'",
-    "build:empty": ":",
-    "docs": "md-magic --path '**/*.md' --ignore='node_modules'",
-    "format": "eslint . --fix",
-    "lint": "eslint .",
-    "test": "scripts/test"
+    "build": "concurrently \"npm:build:*\" \":\"",
+    "build:tsc": "tsc -b tsconfig.build.json",
+    "clean": "concurrently \"npm:clean:*\" \":\"",
+    "clean:tsc": "rm -rf lib",
+    "docs": "node ../../markdown.mjs",
+    "format": "concurrently \"npm:format:*\" \":\"",
+    "format:src": "eslint . --fix --ext=mjs,cjs,js,jsx,ts,tsx,json,jsonc,json5,yml,yaml",
+    "lint": "concurrently \"npm:lint:*\" \":\"",
+    "lint:src": "eslint . --ext=mjs,cjs,js,jsx,ts,tsx,json,jsonc,json5,yml,yaml",
+    "prepare": "concurrently \"npm:prepare:*\" \":\"",
+    "prepublishOnly": "npm run clean;npm run build",
+    "spellcheck": "cspell --no-progress '**'",
+    "test": "concurrently \"npm:test:*\" \":\"",
+    "test:script": "scripts/test",
+    "test_:rule-coverage": "eslint-find-rules --unused"
   },
-  "eslintConfig": {
-    "rules": {
-      "sort-keys-fix/sort-keys-fix": "error"
-    }
-  },
-  "eslintIgnore": [
-    "__tests__"
-  ],
   "dependencies": {
-    "@babel/eslint-parser": "^7.0.0",
-    "@babel/plugin-syntax-class-properties": "^7.0.0",
-    "@babel/plugin-syntax-jsx": "^7.0.0",
+    "@rushstack/eslint-patch": "^1.1.0",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
+    "@w5s/dev": "^1.0.0",
+    "@w5s/prettier-config": "^1.0.14",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "^8.0.0",
-    "eslint-plugin-functional": "^4.2.0",
     "eslint-plugin-import": "^2.25.0",
-    "eslint-plugin-jest": "^26.0.0",
-    "eslint-plugin-jsdoc": "^37.0.0",
-    "eslint-plugin-json-format": "^2.0.1",
+    "eslint-plugin-jest": "^27.0.0",
+    "eslint-plugin-jsdoc": "^40.0.0",
+    "eslint-plugin-jsonc": "^2.4.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-react": "^7.28.0",
-    "eslint-plugin-total-functions": "^5.0.0",
-    "eslint-plugin-unicorn": "^41.0.0"
+    "eslint-plugin-promise": "^6.0.0",
+    "eslint-plugin-unicorn": "^45.0.0",
+    "eslint-plugin-yml": "^1.1.0",
+    "find-up": "^5.0.0",
+    "parse-gitignore": "^2.0.0"
   },
   "devDependencies": {
-    "@babel/eslint-parser": "7.17.0",
-    "@types/eslint": "8.4.1",
-    "@types/eslint-plugin-prettier": "^3.1.0",
-    "@types/prettier": "2.4.4",
-    "@types/react": "17.0.2",
-    "@typescript-eslint/parser": "5.11.0",
-    "eslint": "8.9.0",
-    "eslint-config-prettier": "8.3.0",
-    "eslint-index": "1.5.0",
-    "prettier": "2.5.1",
-    "react": "17.0.2"
+    "@types/eslint": "8.21.1",
+    "@types/eslint-plugin-prettier": "3.1.0",
+    "@types/parse-gitignore": "1.0.0",
+    "@types/prettier": "2.7.2",
+    "@types/react": "18.0.28",
+    "@typescript-eslint/parser": "5.54.0",
+    "eslint": "8.35.0",
+    "eslint-config-prettier": "8.6.0",
+    "eslint-find-rules": "4.1.0",
+    "prettier": "2.8.4",
+    "react": "18.2.0",
+    "vite": "4.1.4",
+    "vitest": "0.29.2"
   },
   "peerDependencies": {
-    "eslint": "5.x || 6.x || 7.x || 8.x",
+    "eslint": "8.x",
     "prettier": "2.x",
     "typescript": "4.x"
   },
   "peerDependenciesMeta": {
+    "eslint": {
+      "optional": true
+    },
     "typescript": {
       "optional": true
     }
   },
+  "engines": {
+    "node": ">=16.0.0"
+  },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "0bf05f35388f1ddb53438a017186cf64d2ce99f2"
+  "gitHead": "20f944de90b5a5c30d6446ced65271ea3fd31c99"
 }

package/src/_rule.ts

@@ -0,0 +1,5 @@
+import type { Linter } from 'eslint';
+
+export function fixme(_status: Linter.RuleLevel | [Linter.RuleLevel, ...any[]] | undefined) {
+  return 'off' as const;
+}