@w5s/eslint-config 1.0.0-alpha.1

package/README.md

@@ -0,0 +1,85 @@
+<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=# W5s ESLint configuration _(${name})_) -->
+# W5s ESLint configuration _(@w5s/eslint-config)_
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+[![NPM Version][package-version-svg]][package-url]
+[![License][license-image]][license-url]
+
+<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=> ${description}&unknownTxt= ) -->
+> ESLint configuration presets
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+## Installation
+
+<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=```console\nnpm install --save-dev ${name}\n```) -->
+```console
+npm install --save-dev @w5s/eslint-config
+```
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+## Usage
+
+### Default JS/TS project
+
+For most kind of project, just edit `eslintrc.json` and add default configuration
+
+```js
+{
+  "extends": [
+    "@w5s/eslint-config"
+  ]
+}
+```
+
+**Features :**
+
+- `ES` and `TS` validation
+- `Prettier` formatting
+- `JSX` and `React` syntax validation
+- `Jest` tests
+
+### Custom project
+
+For most kind of project, just edit `eslintrc.json` and cherry pick only configurations
+
+```js
+{
+  "root": true,
+  "extends": [
+    "@w5s/eslint-config/es",
+    "@w5s/eslint-config/functional",
+    "@w5s/eslint-config/jest",
+    "@w5s/eslint-config/json",
+    "@w5s/eslint-config/react",
+    "@w5s/eslint-config/ts",
+    // include more configurations here
+  ]
+  //...
+}
+```
+
+**Available configurations :**
+
+- `@w5s/eslint-config/es`: for ECMA Script (ES) files
+- `@w5s/eslint-config/jest`: for jest environment tests
+- `@w5s/eslint-config/functional`: for pure functional programming
+- `@w5s/eslint-config/react`: for react capability
+- `@w5s/eslint-config/ts`: for typescript files
+
+## License
+<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=[${license}][license-url] © ${author}) -->
+[MIT][license-url] © Julien Polo <julien.polo@gmail.com>
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+<!-- VARIABLES -->
+
+<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=[package-version-svg]: https://img.shields.io/npm/v/${name}.svg?style=flat-square) -->
+[package-version-svg]: https://img.shields.io/npm/v/@w5s/eslint-config.svg?style=flat-square
+<!-- AUTO-GENERATED-CONTENT:END -->
+<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=[package-url]: https://www.npmjs.com/package/${name}) -->
+[package-url]: https://www.npmjs.com/package/@w5s/eslint-config
+<!-- AUTO-GENERATED-CONTENT:END -->
+<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=[license-image]: https://img.shields.io/badge/license-${license}-green.svg?style=flat-square) -->
+[license-image]: https://img.shields.io/badge/license-MIT-green.svg?style=flat-square
+<!-- AUTO-GENERATED-CONTENT:END -->
+[license-url]: ../../LICENSE

package/es.js

@@ -0,0 +1,23 @@
+// http://eslint.org/docs/user-guide/configuring
+module.exports = {
+  extends: [
+    require.resolve('./rules/base'),
+    require.resolve('./rules/jsdoc'),
+    require.resolve('./rules/import'),
+    require.resolve('./rules/unicorn'),
+    'prettier',
+    require.resolve('./rules/prettier'),
+  ],
+  parser: '@babel/eslint-parser',
+  parserOptions: {
+    babelOptions: {
+      plugins: ['@babel/plugin-syntax-class-properties', '@babel/plugin-syntax-jsx'],
+    },
+    ecmaFeatures: {
+      jsx: true,
+    },
+    ecmaVersion: 2020,
+    requireConfigFile: false,
+    sourceType: 'module',
+  },
+};

package/functional.js

@@ -0,0 +1,51 @@
+// @see https://github.com/danielnixon/eslint-config-typed-fp/blob/master/src/index.ts
+
+const { off, error } = require('./rules/_rule');
+
+module.exports = {
+  overrides: [
+    {
+      extends: ['plugin:functional/recommended', 'plugin:total-functions/recommended'],
+      files: [
+        'src/**/!(*.spec|*.ispec).ts',
+        // 'src/**/!(*.spec).js'
+      ],
+      rules: {
+        'functional/functional-parameters': [
+          error,
+          {
+            allowArgumentsKeyword: false,
+            allowRestParameter: false,
+            enforceParameterCount: false,
+          },
+        ],
+
+        'functional/no-conditional-statement': off,
+        'functional/no-method-signature': off,
+        'functional/prefer-readonly-type': [
+          // @see https://github.com/jonaskello/eslint-plugin-functional/issues/51
+          off, // error
+          {
+            // When you call methods like `filter` and `concat` on an array (_even a readonly_ array) you always get back a mutable array.
+            // By default prefer-readonly-type won't catch these cases, but with the checkImplicit option on it will.
+            // See https://github.com/jonaskello/eslint-plugin-functional/blob/master/docs/rules/prefer-readonly-type.md#checkimplicit
+            // @see also https://github.com/danielnixon/readonly-types/issues/7
+            // @see https://github.com/jonaskello/eslint-plugin-functional/issues/153
+            checkImplicit: true,
+          },
+        ],
+        'functional/prefer-type-literal': off,
+        'total-functions/no-unsafe-readonly-mutable-assignment': [
+          // @see https://github.com/danielnixon/eslint-plugin-total-functions/issues?q=is%3Aissue+is%3Aopen+no-unsafe-readonly-mutable-assignment
+          off,
+        ],
+
+        'total-functions/no-unsafe-type-assertion': [
+          // Don't need this given consistent-type-assertions bans type assertions entirely.,
+          off,
+        ],
+      },
+    },
+  ],
+  plugins: ['functional', 'total-functions'],
+};

package/index.js

@@ -0,0 +1,19 @@
+// http://eslint.org/docs/user-guide/configuring
+module.exports = {
+  extends: [require.resolve('./es'), require.resolve('./react'), require.resolve('./json')],
+  overrides: [
+    {
+      extends: [require.resolve('./ts')],
+      files: ['*.+(ts|tsx)'],
+    },
+    {
+      extends: [require.resolve('./jest')],
+      files: [
+        '**/__mocks__/**/*.+(ts|tsx|js|jsx)',
+        '**/__tests__/**/*.+(ts|tsx|js|jsx)',
+        '**/?(*.)+(spec|test).+(ts|tsx|js|jsx)',
+      ],
+    },
+  ],
+  root: true,
+};

package/jest.js

@@ -0,0 +1,4 @@
+// http://eslint.org/docs/user-guide/configuring
+module.exports = {
+  extends: [require.resolve('./rules/jest')],
+};

package/json.js

@@ -0,0 +1,8 @@
+module.exports = {
+  plugins: ['json-format'],
+  settings: {
+    'json/ignore-files': ['**/package-lock.json'],
+    'json/json-with-comments-files': ['**/tsconfig.json', '.vscode/**'],
+    'json/sort-package-json': 'standard',
+  },
+};

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@w5s/eslint-config",
+  "version": "1.0.0-alpha.1",
+  "description": "ESLint configuration presets",
+  "keywords": [
+    "eslint",
+    "config",
+    "lint"
+  ],
+  "homepage": "https://github.com/w5s/project-config/blob/master/packages/eslint-config#readme",
+  "bugs": {
+    "url": "https://github.com/w5s/project-config.git/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/w5s/project-config.git",
+    "directory": "packages/eslint-config"
+  },
+  "license": "MIT",
+  "author": "Julien Polo <julien.polo@gmail.com>",
+  "main": "index.js",
+  "files": [
+    "*.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"
+  },
+  "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",
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/parser": "^5.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-prettier": "^4.0.0",
+    "eslint-plugin-react": "^7.28.0",
+    "eslint-plugin-total-functions": "^5.0.0",
+    "eslint-plugin-unicorn": "^40.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.10.2",
+    "eslint": "8.8.0",
+    "eslint-config-prettier": "8.3.0",
+    "eslint-index": "1.5.0",
+    "prettier": "2.5.1",
+    "react": "17.0.2"
+  },
+  "peerDependencies": {
+    "eslint": "5.x || 6.x || 7.x || 8.x",
+    "prettier": "2.x"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/react.js

@@ -0,0 +1,10 @@
+// http://eslint.org/docs/user-guide/configuring
+module.exports = {
+  extends: [require.resolve('./rules/react'), 'prettier'],
+  settings: {
+    react: {
+      flowVersion: '0.100',
+      version: 'detect',
+    },
+  },
+};

package/rules/_rule.js

@@ -0,0 +1,15 @@
+/** @type {'error'} */
+const error = 'error';
+
+/** @type {'warn'} */
+const warn = 'warn';
+
+/** @type {'off'} */
+const off = 'off';
+
+module.exports = {
+  error,
+  fixme: (/** @type {'off'|'warn'|'error'} */ _status) => off,
+  off,
+  warn,
+};