@fullstacksjs/eslint-config 7.2.0 → 8.1.1

package/README.md

@@ -58,16 +58,6 @@ 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
@@ -79,6 +69,7 @@ It reads your root `package.json` dependencies and includes necessary rules.
     "@fullstacksjs/eslint-config/typescript",
     "@fullstacksjs/eslint-config/strict",
     "@fullstacksjs/eslint-config/cypress",
+    "@fullstacksjs/eslint-config/storybook",
     "@fullstacksjs/eslint-config/esm", // for native ESM modules
     "@fullstacksjs/eslint-config/typecheck" // ⚠️ Needs configurations (not included in default config)
   ]
@@ -116,6 +107,7 @@ If you need more advanced `typescript-eslint` rules, then you can extend from `"
 * eslint-plugin-fp
 * eslint-plugin-node
 * eslint-plugin-promise
+* eslint-plugin-storybook
 
 That's all. Feel free to use 💛
 

package/bin/lib/askWhenConfigExists.js

@@ -0,0 +1,51 @@
+const { readFile } = require('fs/promises');
+const inquirer = require('inquirer');
+
+const isObject = x => typeof x === 'object' && !Array.isArray(x) && x !== null;
+
+// TODO: add this function to the toolbox
+const merge = (obj, obj2) =>
+  Object.entries(obj)
+    .concat(Object.entries(obj2))
+    .reduce((acc, [key, value]) => {
+      const accValue = acc[key];
+      return Array.isArray(accValue) && Array.isArray(value)
+        ? { ...acc, [key]: accValue.concat(value) }
+        : isObject(accValue) && isObject(value)
+        ? { ...acc, [key]: merge(accValue, value) }
+        : { ...acc, [key]: value };
+    }, {});
+
+const Choice = {
+  noConfig: 'noConfig',
+  overwrite: 'overwrite',
+  extend: 'extend',
+};
+
+const askWhenConfigExists = async eslintrc => {
+  const file = await readFile('.eslintrc.json').catch(() => null);
+  if (file === null) return eslintrc;
+
+  const currentConfig = JSON.parse(file);
+  const isConfiguredBefore = eslintrc?.extends.every(c => currentConfig?.extends?.includes(c));
+  if (isConfiguredBefore) return currentConfig;
+
+  const { choice } = await inquirer.prompt({
+    type: 'list',
+    name: 'choice',
+    message: 'config found',
+    choices: [
+      {
+        value: 'overwrite',
+        name: 'overwrite the current config completely',
+      },
+      {
+        value: 'extend',
+        name: 'extend the fullstacks config alongside current config',
+      },
+    ],
+  });
+  return choice === Choice.extend ? merge(currentConfig, eslintrc) : eslintrc;
+};
+
+module.exports = askWhenConfigExists;

package/bin/lib/createOptions.js

@@ -12,7 +12,7 @@ async function createOptions() {
   const optionsFromArgs = { technology: args.t };
   const userInput = isTechnologyInArgv ? optionsFromArgs : await getUserInput();
 
-  if (userInput.language === 'ts') {
+  if (userInput.technology === 'ts') {
     requiredPackages.push('typescript');
   }
 

package/bin/lib/generateFile.js

@@ -1,7 +1,7 @@
 const { writeFile } = require('fs/promises');
 
 function createFileTask(eslintrc, ctx, task) {
-  return writeFile('.eslintrc', JSON.stringify(eslintrc, null, 2))
+  return writeFile('.eslintrc.json', JSON.stringify(eslintrc, null, 2))
     .then(() => {
       task.title = `.eslintrc - Successfully Generated.`;
     })

package/bin/lib/getUserInput.js

@@ -4,7 +4,7 @@ function getUserInput() {
   return inquirer.prompt([
     {
       type: 'list',
-      name: 'language',
+      name: 'technology',
       message: 'which technology are you using?',
       choices: [
         {

package/bin/lib/tasks.js

@@ -1,14 +1,17 @@
 const Listr = require('listr');
 const util = require('util');
+const askWhenConfigExists = require('./askWhenConfigExists');
 const exec = util.promisify(require('child_process').exec);
 const createFileTask = require('./generateFile');
 
-function createTasks({ packages, eslintrc }) {
+async function createTasks({ packages, eslintrc }) {
   const installTasks = packages.map(pkg => ({
     title: `Installing ${pkg}`,
     task: (ctx, task) => exec(`npm i -D ${pkg}`).then(() => (task.title = `${pkg} Installed`)),
   }));
 
+  const config = await askWhenConfigExists(eslintrc);
+
   return new Listr(
     [
       {
@@ -16,8 +19,8 @@ function createTasks({ packages, eslintrc }) {
         task: () => new Listr(installTasks, { exitOnError: true }),
       },
       {
-        title: 'Generating .eslintrc file',
-        task: (ctx, task) => createFileTask(eslintrc, ctx, task),
+        title: 'Generating .eslintrc.json file',
+        task: (ctx, task) => createFileTask(config, ctx, task),
       },
     ],
     { exitOnError: false },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fullstacksjs/eslint-config",
-  "version": "7.2.0",
+  "version": "8.1.1",
   "license": "MIT",
   "author": "fullstacks <fullstacksjs@gmail.com>",
   "description": "fullstacks eslint config",
@@ -21,7 +21,7 @@
     "index.js",
     "jest.js",
     "cypress.js",
-    "nextjs.js",
+    "storybook.js",
     "react.js",
     "typescript.js",
     "typecheck.js",
@@ -42,38 +42,39 @@
   "main": "index.js",
   "dependencies": {
     "@frontendmonster/utils": "0.3.11",
-    "@typescript-eslint/eslint-plugin": "5.6.0",
-    "@typescript-eslint/parser": "5.6.0",
+    "@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",
     "eslint-plugin-cypress": "2.12.1",
     "eslint-plugin-fp": "2.3.0",
-    "eslint-plugin-import": "2.25.3",
-    "eslint-plugin-jest": "25.3.0",
+    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-jest": "26.1.0",
     "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.27.1",
+    "eslint-plugin-react": "7.28.0",
     "eslint-plugin-react-hooks": "4.3.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"
+    "read-pkg-up": "7.0.1",
+    "yargs": "17.3.1"
   },
   "devDependencies": {
-    "eslint": "8.5.0",
-    "eslint-find-rules": "4.0.0",
+    "eslint": "8.8.0",
+    "eslint-find-rules": "4.1.0",
     "husky": "7.0.4",
-    "inquirer": "8.2.0",
-    "lint-staged": "12.1.2",
-    "listr": "0.14.3",
+    "lint-staged": "12.3.3",
     "np": "7.6.0",
     "npm-run-all": "4.1.5",
     "pinst": "2.1.6",
     "prettier": "2.5.1",
-    "typescript": "4.5.4",
-    "yargs": "17.3.1"
+    "typescript": "4.5.5"
   },
   "peerDependencies": {
     "cypress": ">=8",

package/rules/jest.js

@@ -7,6 +7,7 @@ module.exports = {
     'jest/no-alias-methods': 'off',
     'jest/no-commented-out-tests': 'warn',
     'jest/no-conditional-expect': 'error',
+    'jest/no-conditional-in-test': 'error',
     'jest/no-deprecated-functions': 'error',
     'jest/no-disabled-tests': 'warn',
     'jest/no-done-callback': 'warn',
@@ -16,7 +17,6 @@ module.exports = {
     'jest/no-focused-tests': 'error',
     'jest/no-hooks': 'off',
     'jest/no-identical-title': 'error',
-    'jest/no-if': 'error',
     'jest/no-interpolation-in-snapshots': 'error',
     'jest/no-jasmine-globals': 'off',
     'jest/no-jest-import': 'error',
@@ -34,6 +34,7 @@ module.exports = {
     'jest/prefer-hooks-on-top': 'error',
     'jest/prefer-inline-snapshots': 'off',
     'jest/prefer-lowercase-title': 'off',
+    'jest/prefer-snapshot-hint': 'warn',
     'jest/prefer-spy-on': 'off',
     'jest/prefer-strict-equal': 'off',
     'jest/prefer-to-be-null': 'off',

package/rules/react.js

@@ -10,7 +10,7 @@ module.exports = {
     'react/forbid-elements': 'off',
     'react/forbid-foreign-prop-types': 'error',
     'react/forbid-prop-types': 'off',
-    'react/function-component-definition': 'off',
+    'react/function-component-definition': ['warn', { namedComponents: 'arrow-function', unnamedComponents: 'arrow-function' }],
     'react/jsx-boolean-value': 'off',
     'react/jsx-child-element-spacing': 'warn',
     'react/jsx-curly-brace-presence': ['warn', { props: 'never', children: 'ignore' }],
@@ -68,10 +68,10 @@ module.exports = {
     'react/no-unused-state': 'error',
     'react/no-will-update-set-state': 'error',
     'react/prefer-es6-class': 'off',
+    'react/prefer-exact-props': 'off',
     'react/prefer-read-only-props': 'off',
     'react/prefer-stateless-function': 'off',
     'react/prop-types': 'off',
-    'react/prefer-exact-props': 'off',
     'react/react-in-jsx-scope': 'off', // jsx automatic runtime
     'react/require-default-props': 'off',
     'react/require-optimization': 'off',

package/rules/storybook.js

@@ -0,0 +1,17 @@
+module.exports = {
+  rules: {
+    'storybook/await-interactions': 'error',
+    'storybook/context-in-play-function': 'error',
+    'storybook/default-exports': 'error',
+    'storybook/hierarchy-separator': 'warn',
+    'storybook/no-redundant-story-name': 'warn',
+    'storybook/prefer-pascal-case': 'warn',
+    'storybook/story-exports': 'error',
+    'storybook/use-storybook-expect': 'error',
+    'storybook/use-storybook-testing-library': 'error',
+
+    'storybook/csf-component': 'warn',
+    'storybook/no-stories-of': 'warn',
+    'storybook/no-title-property-in-meta': 'warn',
+  },
+};

package/rules/strict.js

@@ -28,7 +28,7 @@ module.exports = {
       {
         selector: 'parameter',
         format: ['camelCase', 'PascalCase'],
-        leadingUnderscore: 'allow',
+        leadingUnderscore: 'allowSingleOrDouble',
       },
       {
         selector: 'memberLike',

package/rules/typescript.js

@@ -47,7 +47,7 @@ module.exports = {
       {
         selector: 'parameter',
         format: ['camelCase', 'PascalCase'],
-        leadingUnderscore: 'allow',
+        leadingUnderscore: 'allowSingleOrDouble',
       },
       {
         selector: 'memberLike',

package/storybook.js

@@ -0,0 +1,9 @@
+module.exports = {
+  overrides: [
+    {
+      plugin: ['storybook'],
+      files: ['*.stories.@(ts|tsx|js|jsx|mjs|cjs)', '*.story.@(ts|tsx|js|jsx|mjs|cjs)'],
+      extends: ['./rules/storybook.js'],
+    },
+  ],
+};

package/nextjs.js

@@ -1,24 +0,0 @@
-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',
-  ],
-};