eslint-config-seek 0.0.0-typescript-config-20221028024455

package/.eslintrc.js

@@ -0,0 +1,216 @@
+const path = require('path');
+const root = require('find-root')(process.cwd());
+
+const OFF = 0;
+const ERROR = 2;
+
+const baseRules = {
+  // Possible Errors
+  'no-console': ERROR,
+  'no-unexpected-multiline': ERROR,
+  'block-scoped-var': ERROR,
+  curly: [ERROR, 'all'],
+  'default-case': ERROR,
+  'dot-notation': ERROR,
+  eqeqeq: [ERROR, 'always', { null: 'ignore' }],
+  'guard-for-in': ERROR,
+  'no-alert': ERROR,
+  'no-caller': ERROR,
+  'no-div-regex': ERROR,
+  'no-else-return': ERROR,
+  'no-eval': ERROR,
+  'no-extend-native': ERROR,
+  'no-extra-bind': ERROR,
+  'no-floating-decimal': ERROR,
+  'no-implicit-coercion': ERROR,
+  'no-implied-eval': ERROR,
+  'no-iterator': ERROR,
+  'no-labels': ERROR,
+  'no-lone-blocks': ERROR,
+  'no-loop-func': ERROR,
+  'no-multi-str': ERROR,
+  'no-new-func': ERROR,
+  'no-new-wrappers': ERROR,
+  'no-new': ERROR,
+  'no-octal-escape': ERROR,
+  'no-param-reassign': ERROR,
+  'no-proto': ERROR,
+  'no-return-assign': ERROR,
+  'no-script-url': ERROR,
+  'no-self-compare': ERROR,
+  'no-sequences': ERROR,
+  'no-throw-literal': ERROR,
+  'no-useless-call': ERROR,
+  'no-void': ERROR,
+  radix: ERROR,
+  'vars-on-top': ERROR,
+  yoda: ERROR,
+  strict: [ERROR, 'never'],
+  'no-label-var': ERROR,
+  'no-shadow': ERROR,
+  'no-undef-init': ERROR,
+  'no-unused-vars': [
+    ERROR,
+    { argsIgnorePattern: '^_', ignoreRestSiblings: true },
+  ],
+  'handle-callback-err': ERROR,
+  'no-new-require': ERROR,
+  'no-path-concat': ERROR,
+  'no-process-exit': ERROR,
+  'no-restricted-modules': ERROR,
+  'no-sync': ERROR,
+  'linebreak-style': [ERROR, 'unix'],
+  'new-cap': ERROR,
+  'no-lonely-if': ERROR,
+  'no-nested-ternary': ERROR,
+  'no-unneeded-ternary': ERROR,
+  'spaced-comment': [ERROR, 'always'],
+  'no-var': ERROR,
+  'object-shorthand': ERROR,
+  'prefer-const': ERROR,
+  'prefer-spread': ERROR,
+  'prefer-template': ERROR,
+  // Allow devs to choose between performance and richer stack traces
+  // https://eslint.org/docs/rules/no-return-await#when-not-to-use-it
+  // https://github.com/goldbergyoni/nodebestpractices/blob/master@%7B2022-01-01T00:00:00Z%7D/sections/errorhandling/returningpromises.md
+  'no-return-await': OFF,
+};
+
+const reactRules = {
+  'react/prefer-es6-class': [ERROR, 'always'],
+  'react/self-closing-comp': ERROR,
+  'react/jsx-pascal-case': ERROR,
+  'react-hooks/rules-of-hooks': ERROR,
+  'react-hooks/exhaustive-deps': ERROR,
+  'react/no-children-prop': ERROR,
+  'react/display-name': OFF,
+  'react/prop-types': OFF,
+};
+
+/** @type {import('eslint').Linter.Config} */
+const baseConfig = {
+  parser: '@babel/eslint-parser',
+  parserOptions: {
+    babelOptions: {
+      presets: ['@babel/preset-react'],
+    },
+    requireConfigFile: false,
+    sourceType: 'module',
+  },
+  root: true,
+  env: {
+    browser: true,
+    node: true,
+  },
+  settings: {
+    react: {
+      version: 'detect',
+    },
+  },
+  plugins: ['react', 'react-hooks', 'import'],
+  extends: [
+    'plugin:react/recommended',
+    // this config enables eslint-plugin-import to resolve JavaScript and TypeScript files
+    // https://github.com/import-js/eslint-plugin-import/blob/v2.26.0/config/typescript.js
+    // Some rules provided by eslint-plugin-import e.g. `import/no-duplicates` don't work without it
+    'plugin:import/typescript',
+    'prettier',
+  ],
+  rules: {
+    ...baseRules,
+    ...reactRules,
+  },
+  overrides: [
+    {
+      // TypeScript config
+      files: ['**/*.ts', '**/*.tsx'],
+      parser: '@typescript-eslint/parser',
+      parserOptions: {
+        ecmaVersion: 2018,
+        sourceType: 'module',
+      },
+      extends: [
+        'plugin:@typescript-eslint/eslint-recommended',
+        'plugin:@typescript-eslint/recommended',
+        'prettier',
+      ],
+      settings: {
+        // adds comprehensive TypeScript support to eslint-plugin-import
+        // https://github.com/import-js/eslint-import-resolver-typescript
+        'import/resolver': {
+          typescript: {},
+        },
+      },
+      rules: {
+        '@typescript-eslint/no-unused-expressions': ERROR,
+        '@typescript-eslint/no-unused-vars': [
+          ERROR,
+          { argsIgnorePattern: '^_', ignoreRestSiblings: true },
+        ],
+        '@typescript-eslint/no-use-before-define': OFF,
+        '@typescript-eslint/no-non-null-assertion': OFF,
+        '@typescript-eslint/ban-ts-comment': OFF,
+        '@typescript-eslint/no-explicit-any': OFF,
+        '@typescript-eslint/explicit-function-return-type': OFF,
+        '@typescript-eslint/no-empty-function': OFF,
+        '@typescript-eslint/no-empty-interface': OFF,
+        '@typescript-eslint/no-inferrable-types': [
+          ERROR,
+          { ignoreParameters: true },
+        ],
+        // prefer TypeScript exhaustiveness checking
+        // https://www.typescriptlang.org/docs/handbook/advanced-types.html#exhaustiveness-checking
+        'default-case': OFF,
+        'arrow-body-style': [ERROR, 'as-needed'],
+        // Use `typescript-eslint`'s no-shadow to avoid false positives with enums
+        // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-shadow.md
+        'no-shadow': OFF,
+        '@typescript-eslint/no-shadow': ERROR,
+      },
+    },
+    {
+      // JavaScript config
+      files: ['**/*.js', '**/*.jsx'],
+      env: {
+        es6: true,
+      },
+      extends: ['plugin:import/errors', 'plugin:import/warnings'],
+      settings: {
+        'import/resolver': {
+          node: {
+            moduleDirectory: [root, path.join(root, 'node_modules')],
+          },
+        },
+      },
+      rules: {
+        'no-use-before-define': [ERROR, { functions: false }],
+        'no-unused-expressions': ERROR,
+        'import/no-unresolved': [
+          ERROR,
+          { commonjs: true, amd: true, ignore: ['.svg$', '^file?'] },
+        ],
+        'import/no-duplicates': ERROR,
+      },
+    },
+    {
+      // Jest config
+      files: ['**/__tests__/**/*.{js,ts,tsx}', '**/*.@(spec|test).{js,ts,tsx}'],
+      env: {
+        jest: true,
+      },
+      extends: ['plugin:jest/recommended'],
+      plugins: ['jest'],
+    },
+    {
+      // Cypress config
+      files: ['cypress/**/*.{js,ts,tsx}'],
+      env: {
+        'cypress/globals': true,
+      },
+      extends: ['plugin:cypress/recommended'],
+      plugins: ['cypress'],
+    },
+  ],
+};
+
+module.exports = baseConfig;

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 SEEK
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,32 @@
+[![Test](https://github.com/seek-oss/eslint-config-seek/actions/workflows/test.yml/badge.svg)](https://github.com/seek-oss/eslint-config-seek/actions/workflows/test.yml)
+[![Release](https://github.com/seek-oss/eslint-config-seek/actions/workflows/release.yml/badge.svg)](https://github.com/seek-oss/eslint-config-seek/actions/workflows/release.yml)
+
+# eslint-config-seek
+
+This package includes the shareable ESLint configuration used by [SEEK](https://github.com/seek-oss/).
+
+## Usage in sku Projects
+
+The easiest way to use this configuration is with [sku](https://github.com/seek-oss/sku), which includes it by default.
+
+**You don’t need to install it separately in sku projects.**
+
+## Usage Outside of sku
+
+If you want to use this ESLint configuration in a project not built with sku, you can install it with following steps.
+
+First, install this package, ESLint and the necessary plugins listed in this project's [package.json](package.json).
+
+Then create a file named `.eslintrc` with following contents in the root folder of your project:
+
+```js
+{
+  "extends": "seek"
+}
+```
+
+You can override the settings from `eslint-config-seek` by editing the `.eslintrc` file. Learn more about [configuring ESLint](http://eslint.org/docs/user-guide/configuring) on the ESLint website.
+
+## License
+
+MIT.

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "eslint-config-seek",
+  "version": "0.0.0-typescript-config-20221028024455",
+  "description": "ESLint configuration used by SEEK",
+  "main": ".eslintrc.js",
+  "files": [
+    ".eslintrc.js"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/seek-oss/eslint-config-seek.git"
+  },
+  "author": "SEEK",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/seek-oss/eslint-config-seek/issues"
+  },
+  "homepage": "https://github.com/seek-oss/eslint-config-seek#readme",
+  "dependencies": {
+    "@babel/core": "^7.19.6",
+    "@babel/eslint-parser": "^7.19.1",
+    "@babel/preset-react": "^7.18.6",
+    "@typescript-eslint/eslint-plugin": "^5.41.0",
+    "@typescript-eslint/parser": "^5.41.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-import-resolver-typescript": "3.5.2",
+    "eslint-plugin-cypress": "^2.12.1",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jest": "^27.1.3",
+    "eslint-plugin-react": "^7.31.10",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "find-root": "^1.1.0"
+  },
+  "devDependencies": {
+    "@changesets/cli": "2.25.0",
+    "@changesets/get-github-info": "0.5.1",
+    "eslint": "8.26.0",
+    "prettier": "2.7.1",
+    "typescript": "^4.8.4"
+  },
+  "peerDependencies": {
+    "eslint": ">=6",
+    "typescript": ">=3.3"
+  },
+  "packageManager": "pnpm@7.14.0",
+  "volta": {
+    "node": "16.18.0"
+  },
+  "scripts": {
+    "release": "changeset publish",
+    "test": "eslint .",
+    "changeset-version": "changeset version && prettier --write ."
+  }
+}