@fullstacksjs/eslint-config 8.1.1 → 8.4.0

package/README.md

@@ -58,6 +58,16 @@ Just extend from `@fullstacksjs`:
 
 It reads your root `package.json` dependencies and includes necessary rules.
 
+## NextJS
+
+[NextJS](https://nextjs.org/) config is subset of base config which is compatible with builtin NextJS eslint config.
+
+```json
+{
+  "extends": ["@fullstacksjs/eslint-config/nextjs"]
+}
+```
+
 ## Advanced Usage
 
 ```jsonc
@@ -70,6 +80,7 @@ It reads your root `package.json` dependencies and includes necessary rules.
     "@fullstacksjs/eslint-config/strict",
     "@fullstacksjs/eslint-config/cypress",
     "@fullstacksjs/eslint-config/storybook",
+    "@fullstacksjs/eslint-config/graphql", // Need extra config
     "@fullstacksjs/eslint-config/esm", // for native ESM modules
     "@fullstacksjs/eslint-config/typecheck" // ⚠️ Needs configurations (not included in default config)
   ]
@@ -92,6 +103,30 @@ If you need more advanced `typescript-eslint` rules, then you can extend from `"
 }
 ```
 
+## Graphql
+
+To enable graphql module you need to extends from `@fullstacksjs/eslint-config/graphql` and configure schema and operations in you eslint config or graphql config. for more information checkout [here](https://github.com/B2o5T/graphql-eslint#configuration).
+
+Here is an example:
+
+```jsonc
+// eslintrc
+
+{
+  "extends": [
+    ...
+    "@fullstacksjs/eslint-config/eslint"
+  ],
+}
+```
+
+```yaml
+# .graphqlrc.yml
+
+schema: 'path/to/schema'
+```
+
+
 ## What's included?
 
 * @typescript-eslint/eslint-plugin
@@ -108,6 +143,7 @@ If you need more advanced `typescript-eslint` rules, then you can extend from `"
 * eslint-plugin-node
 * eslint-plugin-promise
 * eslint-plugin-storybook
+* eslint-plugin-graphql
 
 That's all. Feel free to use 💛
 

package/base.js

@@ -1,3 +1,4 @@
+/** @type { import('eslint').Linter.Config } */
 module.exports = {
   plugins: ['prettier', 'import', 'simple-import-sort', 'promise', 'node', 'fp'],
   parserOptions: {

package/cypress.js

@@ -1,3 +1,4 @@
+/** @type { import('eslint').Linter.Config } */
 module.exports = {
   overrides: [
     {

package/esm.js

@@ -1,3 +1,4 @@
+/** @type { import('eslint').Linter.Config } */
 module.exports = {
   rules: {
     'import/extensions': 'off',

package/graphql.js

@@ -0,0 +1,11 @@
+/** @type { import('eslint').Linter.Config } */
+module.exports = {
+  overrides: [
+    {
+      files: ['*.graphql', '*.gql'],
+      parser: '@graphql-eslint/eslint-plugin',
+      plugins: ['@graphql-eslint'],
+      extends: './rules/graphql.js',
+    },
+  ],
+};

package/index.js

@@ -8,9 +8,11 @@ const { packageJson: pkg } = readPkgUp.sync({
 
 const packages = Packages(pkg);
 
+/** @type { import('eslint').Linter.Config } */
 module.exports = {
   extends: [
     require.resolve('./base'),
+    require.resolve('./storybook'),
     packages.ifAnyDep('jest', () => require.resolve('./jest')),
     packages.ifAnyDep('react', () => require.resolve('./react')),
     packages.ifAnyDep('typescript', () => require.resolve('./typescript')),

package/jest.js

@@ -1,6 +1,7 @@
 const exts = '(js|jsx|ts|tsx)';
 const dirs = '(test|tests|__test__|__tests__|spec|specs)';
 
+/** @type { import('eslint').Linter.Config } */
 module.exports = {
   overrides: [
     {

package/nextjs.js

@@ -0,0 +1,25 @@
+/** @type { import('eslint').Linter.Config } */
+module.exports = {
+  plugins: ['prettier', 'simple-import-sort', 'promise', 'node', 'fp'],
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
+    requireConfigFile: false,
+  },
+  env: {
+    browser: true,
+    es6: true,
+    node: true,
+  },
+  extends: [
+    './rules/base',
+    './rules/es2015',
+    './rules/forbidden',
+    './rules/style',
+    './rules/variables',
+    './rules/fp',
+    './rules/promise',
+    './rules/node',
+    'prettier',
+  ],
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fullstacksjs/eslint-config",
-  "version": "8.1.1",
+  "version": "8.4.0",
   "license": "MIT",
   "author": "fullstacks <fullstacksjs@gmail.com>",
   "description": "fullstacks eslint config",
@@ -20,8 +20,10 @@
     "base.js",
     "index.js",
     "jest.js",
+    "nextjs.js",
     "cypress.js",
     "storybook.js",
+    "graphql.js",
     "react.js",
     "typescript.js",
     "typecheck.js",
@@ -34,7 +36,10 @@
     "check-rules:react": "eslint-find-rules --no-core --unused ./tests/react.js",
     "check-rules:typescript": "eslint-find-rules --no-core --unused ./tests/typescript.js",
     "check-rules:cypress": "eslint-find-rules --no-core --unused ./tests/cypress.js",
-    "test": "npm-run-all --parallel check-rules:*",
+    "check-rules:graphql": "eslint-find-rules --no-core --unused ./tests/graphql.js",
+    "check-rules:storybook": "eslint-find-rules --no-core --unused ./tests/storybook.js",
+    "spell": "cspell ./* --no-progress",
+    "test": "npm-run-all --parallel check-rules:* && npm run spell",
     "prepublishOnly": "pinst --disable",
     "postpublish": "pinst --enable",
     "pre-commit": "npm run test && lint-staged"
@@ -42,43 +47,42 @@
   "main": "index.js",
   "dependencies": {
     "@frontendmonster/utils": "0.3.11",
-    "@typescript-eslint/eslint-plugin": "5.10.2",
-    "@typescript-eslint/parser": "5.10.2",
-    "eslint-config-prettier": "8.3.0",
-    "eslint-import-resolver-typescript": "2.5.0",
+    "@graphql-eslint/eslint-plugin": "3.10.1",
+    "@typescript-eslint/eslint-plugin": "5.17.0",
+    "@typescript-eslint/parser": "5.17.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-import-resolver-typescript": "2.7.0",
     "eslint-plugin-cypress": "2.12.1",
     "eslint-plugin-fp": "2.3.0",
     "eslint-plugin-import": "2.25.4",
-    "eslint-plugin-jest": "26.1.0",
+    "eslint-plugin-jest": "26.1.3",
     "eslint-plugin-jest-formatting": "3.1.0",
     "eslint-plugin-jsx-a11y": "6.5.1",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-prettier": "4.0.0",
     "eslint-plugin-promise": "6.0.0",
-    "eslint-plugin-react": "7.28.0",
-    "eslint-plugin-react-hooks": "4.3.0",
+    "eslint-plugin-react": "7.29.4",
+    "eslint-plugin-react-hooks": "4.4.0",
     "eslint-plugin-simple-import-sort": "7.0.0",
-    "eslint-plugin-storybook": "0.5.6",
-    "inquirer": "8.2.0",
-    "listr": "0.14.3",
-    "lodash.has": "4.5.2",
-    "read-pkg-up": "7.0.1",
-    "yargs": "17.3.1"
+    "eslint-plugin-storybook": "0.5.7",
+    "read-pkg-up": "7.0.1"
   },
   "devDependencies": {
-    "eslint": "8.8.0",
+    "cspell": "5.19.7",
+    "eslint": "8.12.0",
     "eslint-find-rules": "4.1.0",
     "husky": "7.0.4",
-    "lint-staged": "12.3.3",
-    "np": "7.6.0",
+    "lint-staged": "12.3.7",
+    "np": "7.6.1",
     "npm-run-all": "4.1.5",
-    "pinst": "2.1.6",
-    "prettier": "2.5.1",
-    "typescript": "4.5.5"
+    "pinst": "3.0.0",
+    "prettier": "2.6.1",
+    "typescript": "4.6.3"
   },
   "peerDependencies": {
     "cypress": ">=8",
     "eslint": ">=7",
+    "graphql": ">=15",
     "prettier": "2",
     "react": ">=16",
     "typescript": "4"
@@ -95,6 +99,9 @@
     },
     "jest": {
       "optional": true
+    },
+    "graphql": {
+      "optional": true
     }
   }
 }

package/react.js

@@ -1,3 +1,4 @@
+/** @type { import('eslint').Linter.Config } */
 module.exports = {
   plugins: ['react', 'react-hooks', 'jsx-a11y'],
   parserOptions: {

package/rules/graphql.js

@@ -0,0 +1,66 @@
+/** @type { import('eslint').Linter.Config } */
+module.exports = {
+  rules: {
+    '@graphql-eslint/alphabetize': ['warn', { fields: ['ObjectTypeDefinition'] }],
+    '@graphql-eslint/description-style': 'warn',
+    '@graphql-eslint/executable-definitions': 'off',
+    '@graphql-eslint/fields-on-correct-type': 'warn',
+    '@graphql-eslint/fragments-on-composite-type': 'warn',
+    '@graphql-eslint/input-name': 'warn',
+    '@graphql-eslint/known-argument-names': 'warn',
+    '@graphql-eslint/known-directives': 'warn',
+    '@graphql-eslint/known-fragment-names': 'warn',
+    '@graphql-eslint/known-type-names': 'warn',
+    '@graphql-eslint/lone-anonymous-operation': 'warn',
+    '@graphql-eslint/lone-schema-definition': 'warn',
+    '@graphql-eslint/match-document-filename': ['warn', { query: 'camelCase', mutation: 'camelCase', subscription: 'camelCase' }],
+    '@graphql-eslint/naming-convention': 'warn',
+    '@graphql-eslint/no-anonymous-operations': 'warn',
+    '@graphql-eslint/no-case-insensitive-enum-values-duplicates': 'warn',
+    '@graphql-eslint/no-deprecated': 'warn',
+    '@graphql-eslint/no-duplicate-fields': 'warn',
+    '@graphql-eslint/no-fragment-cycles': 'warn',
+    '@graphql-eslint/no-hashtag-description': 'warn',
+    '@graphql-eslint/no-root-type': 'off',
+    '@graphql-eslint/no-scalar-result-type-on-mutation': 'warn',
+    '@graphql-eslint/no-typename-prefix': 'warn',
+    '@graphql-eslint/no-undefined-variables': 'warn',
+    '@graphql-eslint/no-unreachable-types': 'warn',
+    '@graphql-eslint/no-unused-fields': 'warn',
+    '@graphql-eslint/no-unused-fragments': 'warn',
+    '@graphql-eslint/no-unused-variables': 'warn',
+    '@graphql-eslint/one-field-subscriptions': 'warn',
+    '@graphql-eslint/overlapping-fields-can-be-merged': 'warn',
+    '@graphql-eslint/possible-fragment-spread': 'warn',
+    '@graphql-eslint/possible-type-extension': 'warn',
+    '@graphql-eslint/provided-required-arguments': 'warn',
+    '@graphql-eslint/relay-arguments': 'warn',
+    '@graphql-eslint/relay-connection-types': 'warn',
+    '@graphql-eslint/relay-edge-types': 'warn',
+    '@graphql-eslint/relay-page-info': 'warn',
+    '@graphql-eslint/require-deprecation-date': 'warn',
+    '@graphql-eslint/require-deprecation-reason': 'warn',
+    '@graphql-eslint/require-description': 'off',
+    '@graphql-eslint/require-field-of-type-query-in-mutation-result': 'warn',
+    '@graphql-eslint/require-id-when-available': 'warn',
+    '@graphql-eslint/scalar-leafs': 'warn',
+    '@graphql-eslint/selection-set-depth': 'off',
+    '@graphql-eslint/strict-id-in-types': 'warn',
+    '@graphql-eslint/unique-argument-names': 'warn',
+    '@graphql-eslint/unique-directive-names': 'warn',
+    '@graphql-eslint/unique-directive-names-per-location': 'warn',
+    '@graphql-eslint/unique-enum-value-names': 'warn',
+    '@graphql-eslint/unique-field-definition-names': 'warn',
+    '@graphql-eslint/unique-fragment-name': 'warn',
+    '@graphql-eslint/unique-input-field-names': 'warn',
+    '@graphql-eslint/unique-operation-name': 'warn',
+    '@graphql-eslint/unique-operation-types': 'warn',
+    '@graphql-eslint/unique-type-names': 'warn',
+    '@graphql-eslint/unique-variable-names': 'warn',
+    '@graphql-eslint/value-literals-of-correct-type': 'warn',
+    '@graphql-eslint/variables-are-input-types': 'warn',
+    '@graphql-eslint/variables-in-allowed-position': 'warn',
+
+    'spaced-comment': 'off',
+  },
+};

package/rules/react.js

@@ -11,10 +11,12 @@ module.exports = {
     'react/forbid-foreign-prop-types': 'error',
     'react/forbid-prop-types': 'off',
     'react/function-component-definition': ['warn', { namedComponents: 'arrow-function', unnamedComponents: 'arrow-function' }],
+    'react/hook-use-state': 'warn',
+    'react/iframe-missing-sandbox': 'error',
     'react/jsx-boolean-value': 'off',
     'react/jsx-child-element-spacing': 'warn',
     'react/jsx-curly-brace-presence': ['warn', { props: 'never', children: 'ignore' }],
-    'react/jsx-filename-extension': ['error', { extensions: ['.js', '.jsx', '.ts', '.tsx'] }],
+    'react/jsx-filename-extension': ['error', { extensions: ['.jsx', '.tsx'] }],
     'react/jsx-fragments': 'off',
     'react/jsx-handler-names': 'off',
     'react/jsx-key': 'error',
@@ -42,8 +44,8 @@ module.exports = {
     'react/no-array-index-key': 'warn',
     'react/no-arrow-function-lifecycle': 'error',
     'react/no-children-prop': 'off',
-    'react/no-danger-with-children': 'error',
     'react/no-danger': 'off',
+    'react/no-danger-with-children': 'error',
     'react/no-deprecated': 'error',
     'react/no-did-mount-set-state': 'error',
     'react/no-did-update-set-state': 'error',

package/rules/storybook.js

@@ -13,5 +13,6 @@ module.exports = {
     'storybook/csf-component': 'warn',
     'storybook/no-stories-of': 'warn',
     'storybook/no-title-property-in-meta': 'warn',
+    'storybook/meta-inline-properties': 'off',
   },
 };

package/rules/typescript-requiring-type-checking.js

@@ -6,11 +6,12 @@ module.exports = {
       'warn',
       { allowPrivateClassPropertyAccess: false, allowProtectedClassPropertyAccess: false, allowIndexSignaturePropertyAccess: true },
     ],
-    '@typescript-eslint/no-meaningless-void-operator': ['warn', { checkNever: false }],
     '@typescript-eslint/no-confusing-void-expression': ['warn', { ignoreArrowShorthand: true, ignoreVoidOperator: true }],
     '@typescript-eslint/no-floating-promises': ['error', { ignoreVoid: true }],
     '@typescript-eslint/no-implied-eval': 'error',
+    '@typescript-eslint/no-meaningless-void-operator': ['warn', { checkNever: false }],
     '@typescript-eslint/no-misused-promises': 'error',
+    '@typescript-eslint/no-redundant-type-constituents': 'warn',
     '@typescript-eslint/no-throw-literal': 'error',
     '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'error',
     '@typescript-eslint/no-unnecessary-qualifier': 'error',

package/rules/typescript.js

@@ -129,6 +129,7 @@ module.exports = {
     ],
     '@typescript-eslint/no-use-before-define': ['error', { functions: false, classes: true }],
     '@typescript-eslint/no-useless-constructor': 'error',
+    '@typescript-eslint/no-useless-empty-export': 'warn',
     '@typescript-eslint/no-var-requires': 'error',
     '@typescript-eslint/object-curly-spacing': 'warn',
     '@typescript-eslint/padding-line-between-statements': ['warn', { blankLine: 'always', prev: ['return'], next: ['export'] }],
@@ -175,6 +176,7 @@ module.exports = {
       },
     ],
     '@typescript-eslint/strict-boolean-expressions': 'off', // Annoying
+    '@typescript-eslint/space-before-blocks': 'off',
 
     '@typescript-eslint/triple-slash-reference': 'error',
     '@typescript-eslint/typedef': ['error', { parameter: false, arrowParameter: false, variableDeclaration: false }],
@@ -196,6 +198,7 @@ module.exports = {
     'no-useless-constructor': 'off',
     'object-curly-spacing': 'off',
     'padding-line-between-statements': 'off',
+    'space-before-blocks': 'off',
 
     // open issues
     'react/jsx-no-useless-fragment': 'off', // Need useless-fragment for JSX return type

package/storybook.js

@@ -1,7 +1,8 @@
+/** @type { import('eslint').Linter.Config } */
 module.exports = {
   overrides: [
     {
-      plugin: ['storybook'],
+      plugins: ['storybook'],
       files: ['*.stories.@(ts|tsx|js|jsx|mjs|cjs)', '*.story.@(ts|tsx|js|jsx|mjs|cjs)'],
       extends: ['./rules/storybook.js'],
     },

package/typecheck.js

@@ -1,3 +1,4 @@
+/** @type { import('eslint').Linter.Config } */
 module.exports = {
   overrides: [
     {

package/typescript.js

@@ -1,3 +1,4 @@
+/** @type { import('eslint').Linter.Config } */
 module.exports = {
   parser: '@typescript-eslint/parser',
   plugins: ['@typescript-eslint/eslint-plugin'],