feat: add eslintignore to eslint

Author: allohamora

.eslintignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+bin

__tests__/categories/js/eslint/eslint-test.utils.ts

@@ -3,8 +3,9 @@ import { Config } from 'src/categories/js/eslint/config/config.interface';
 export const createConfig = ({
   dependencies = [],
   eslintConfig = {},
+  ignore = [],
   scripts = [],
   mutations = [],
 }: Partial<Config> = {}) => {
-  return { dependencies, eslintConfig, scripts, mutations };
+  return { dependencies, eslintConfig, ignore, scripts, mutations };
 };

__tests__/categories/js/eslint/eslint.entrypoint.test.ts

@@ -61,6 +61,15 @@ describe('eslint', () => {
     expect(fsMocked.addJsonFileToRoot).toBeCalledWith('.eslintrc.json', config.eslintConfig);
   });
 
+  test('should add .eslintignore to root', async () => {
+    const config = createConfig({ ignore: ['node_modules', 'dist'] });
+    configMocked.getConfig.mockReturnValueOnce(config);
+
+    await eslint();
+
+    expect(fsMocked.addFileToRoot).toBeCalledWith('.eslintignore', 'node_modules\ndist');
+  });
+
   test('should add npm script to package.json', async () => {
     const config = createConfig({ scripts: [{ name: 'test', script: '__test__' }] });
     configMocked.getConfig.mockReturnValueOnce(config);

package.json

@@ -18,8 +18,8 @@
     "release:minor": "standard-version --release-as minor --tag-prefix=",
     "release:patch": "standard-version --release-as patch --tag-prefix=",
     "release:major": "standard-version --release-as major --tag-prefix=",
-    "lint": "eslint \"src/**/*.ts\"",
-    "lint:fix": "eslint \"src/**/*.ts\" --fix",
+    "lint": "eslint \"**/*.ts\"",
+    "lint:fix": "eslint \"**/*.ts\" --fix",
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage"

src/categories/js/eslint/config/config.interface.ts

@@ -23,6 +23,7 @@ export interface EslintConfig {
 export interface Config {
   dependencies: string[];
   eslintConfig: EslintConfig;
+  ignore: string[];
   scripts: { name: string; script: string }[];
   mutations: Mutation<Config>[];
 }

src/categories/js/eslint/config/default.config.ts

@@ -16,9 +16,10 @@ export const defaultConfig: Config = {
     root: true,
     extends: ['eslint:recommended'],
   },
+  ignore: ['node_modules', 'dist'],
   scripts: [
-    { name: 'lint', script: 'eslint "src/**/*.js"' },
-    { name: 'lint:fix', script: 'eslint "src/**/*.js" --fix' },
+    { name: 'lint', script: 'eslint "**/*.js"' },
+    { name: 'lint:fix', script: 'eslint "**/*.js" --fix' },
   ],
   mutations: [prettierMutation, jestMutation],
 };

src/categories/js/eslint/config/node:ts.config.ts

@@ -32,9 +32,10 @@ export const nodeTsConfig: Config = {
       ],
     },
   },
+  ignore: ['node_modules', 'dist'],
   scripts: [
-    { name: 'lint', script: 'eslint "src/**/*.ts"' },
-    { name: 'lint:fix', script: 'eslint "src/**/*.ts" --fix' },
+    { name: 'lint', script: 'eslint "**/*.ts"' },
+    { name: 'lint:fix', script: 'eslint "**/*.ts" --fix' },
   ],
   mutations: [prettierMutation, jestMutation],
 };

src/categories/js/eslint/config/react:ts.config.ts

@@ -52,9 +52,10 @@ export const reactTsConfig: Config = {
       ],
     },
   },
+  ignore: ['node_modules', 'dist'],
   scripts: [
-    { name: 'lint', script: 'eslint "src/**/*.{ts,tsx}"' },
-    { name: 'lint:fix', script: 'eslint "src/**/*.{ts,tsx}" --fix' },
+    { name: 'lint', script: 'eslint "**/*.{ts,tsx}"' },
+    { name: 'lint:fix', script: 'eslint "**/*.{ts,tsx}" --fix' },
   ],
   mutations: [prettierMutation, jestMutation],
 };

src/categories/js/eslint/eslint.const.ts

@@ -2,3 +2,4 @@ export const SCRIPT_NAME = 'eslint';
 export const PACKAGE_NAME = SCRIPT_NAME;
 export const CLI_NAME = PACKAGE_NAME;
 export const CONFIG_FILE_NAME = '.eslintrc.json';
+export const CONFIG_IGNORE_FILE_NAME = '.eslintignore';

src/categories/js/eslint/eslint.entrypoint.ts

@@ -1,16 +1,17 @@
 import { getConfig } from './eslint.config';
-import { addJsonFileToRoot } from 'src/utils/fs';
+import { addFileToRoot, addJsonFileToRoot } from 'src/utils/fs';
 import { addScripts, installDevelopmentDependencies } from 'src/utils/npm';
-import { CONFIG_FILE_NAME, PACKAGE_NAME } from './eslint.const';
+import { CONFIG_FILE_NAME, CONFIG_IGNORE_FILE_NAME, PACKAGE_NAME } from './eslint.const';
 import { applyMutations } from 'src/utils/mutation';
 
 export const eslint = async () => {
   const config = getConfig();
   await applyMutations(config, config.mutations);
 
-  const { dependencies, eslintConfig, scripts } = config;
+  const { dependencies, eslintConfig, scripts, ignore } = config;
 
   await installDevelopmentDependencies(PACKAGE_NAME, ...dependencies);
   await addJsonFileToRoot(CONFIG_FILE_NAME, eslintConfig);
+  await addFileToRoot(CONFIG_IGNORE_FILE_NAME, ignore.join('\n'));
   await addScripts(...scripts);
 };