fix: lint-staged config (#55)

* fix: lint-staged config * fix: lint-staged config * fix: lint-staged config * fix: lint-staged config * fix: lint-staged config * chore: changeset * chore: update lockfile
wayofdev · Feb 23, 2023 · 72695a5 · 72695a5
1 parent ffda9fc
commit 72695a5
Show file tree

Hide file tree

Showing 32 changed files with 245 additions and 226 deletions.
diff --git a/.changeset/twenty-bags-dress.md b/.changeset/twenty-bags-dress.md
@@ -0,0 +1,14 @@
+---
+'@wayofdev/browserslist-config': patch
+'@wayofdev/eslint-config-bases': patch
+'@wayofdev/markdownlint-config': patch
+'@wayofdev/lint-staged-config': patch
+'@wayofdev/commitlint-config': patch
+'@wayofdev/secretlint-config': patch
+'@wayofdev/stylelint-config': patch
+'@wayofdev/htmlhint-config': patch
+'@wayofdev/tsconfig-config': patch
+'@wayofdev/postcss-config': patch
+---
+
+fix: lint-staged config changes
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,15 @@
+const { getDefaultIgnorePatterns } = require('@wayofdev/eslint-config-bases/helpers')
+
+module.exports = {
+  root: true,
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: 'tsconfig.base.json',
+  },
+  ignorePatterns: [...getDefaultIgnorePatterns()],
+  extends: [
+    '@wayofdev/eslint-config-bases/typescript',
+    '@wayofdev/eslint-config-bases/mdx',
+    '@wayofdev/eslint-config-bases/prettier-plugin',
+  ],
+}
diff --git a/lint-staged.config.js b/lint-staged.config.js
@@ -1,18 +1,17 @@
 // @ts-check
 
-const {
-  concatFilesForPrettier,
-  jsonRules,
-  secretsRules,
-  mdRules,
-  yamlRules,
-} = require('@wayofdev/lint-staged-config')
+const { concatFilesForPrettier } = require('@wayofdev/lint-staged-config')
+
+const json = require('@wayofdev/lint-staged-config/json')
+const yaml = require('@wayofdev/lint-staged-config/yaml')
+const secrets = require('@wayofdev/lint-staged-config/secrets')
+const md = require('@wayofdev/lint-staged-config/md')
 
 const rules = {
-  ...jsonRules,
-  ...yamlRules,
-  ...secretsRules,
-  ...mdRules,
+  ...json,
+  ...yaml,
+  ...secrets,
+  ...md,
   '**/*.{js,jsx,cjs,mjs,ts,tsx,mts,cts}': filenames => {
     return [`prettier --write ${concatFilesForPrettier(filenames)}`]
   },

diff --git a/packages/browserslist-config/lint-staged.config.js b/packages/browserslist-config/lint-staged.config.js
@@ -7,20 +7,24 @@
  * {@link https://github.com/belgattitude/nextjs-monorepo-example/blob/main/docs/about-lint-staged.md}
  */
 
-const {
-  getEslintFixCmd,
-  jsonRules,
-  secretsRules,
-  mdRules,
-  yamlRules,
-  htmlRules,
-} = require('@wayofdev/lint-staged-config')
+const { getEslintFixCmd } = require('@wayofdev/lint-staged-config')
+
+const json = require('@wayofdev/lint-staged-config/json')
+const yaml = require('@wayofdev/lint-staged-config/yaml')
+const secrets = require('@wayofdev/lint-staged-config/secrets')
+const md = require('@wayofdev/lint-staged-config/md')
+const html = require('@wayofdev/lint-staged-config/html')
 
 /**
  * @typedef {Record<string, (filenames: string[]) => string | string[] | Promise<string | string[]>>} LintRule
  */
 const rules = {
-  '**/*.{js,jsx,ts,tsx}': (/** @type {any} */ filenames) => {
+  ...json,
+  ...secrets,
+  ...md,
+  ...yaml,
+  ...html,
+  '**/*.{js,jsx,ts,tsx}': filenames => {
     return getEslintFixCmd({
       cwd: __dirname,
       fix: true,
@@ -32,11 +36,6 @@ const rules = {
       files: filenames,
     })
   },
-  ...jsonRules,
-  ...secretsRules,
-  ...mdRules,
-  ...yamlRules,
-  ...htmlRules,
 }
 
 module.exports = rules
diff --git a/packages/browserslist-config/package.json b/packages/browserslist-config/package.json
@@ -41,7 +41,8 @@
     "browserslist": "^4.21.5"
   },
   "devDependencies": {
-    "rimraf": "^4.1.2"
+    "rimraf": "^4.1.2",
+    "@wayofdev/lint-staged-config": "workspace:*"
   },
   "publishConfig": {
     "access": "public"

diff --git a/packages/commitlint-config/lint-staged.config.js b/packages/commitlint-config/lint-staged.config.js
@@ -7,14 +7,13 @@
  * {@link https://github.com/belgattitude/nextjs-monorepo-example/blob/main/docs/about-lint-staged.md}
  */
 
-const {
-  getEslintFixCmd,
-  jsonRules,
-  secretsRules,
-  mdRules,
-  yamlRules,
-  htmlRules,
-} = require('@wayofdev/lint-staged-config')
+const { getEslintFixCmd } = require('@wayofdev/lint-staged-config')
+
+const json = require('@wayofdev/lint-staged-config/json')
+const yaml = require('@wayofdev/lint-staged-config/yaml')
+const secrets = require('@wayofdev/lint-staged-config/secrets')
+const md = require('@wayofdev/lint-staged-config/md')
+const html = require('@wayofdev/lint-staged-config/html')
 
 /**
  * @typedef {Record<string, (filenames: string[]) => string | string[] | Promise<string | string[]>>} LintRule
@@ -32,11 +31,11 @@ const rules = {
       files: filenames,
     })
   },
-  ...jsonRules,
-  ...secretsRules,
-  ...mdRules,
-  ...yamlRules,
-  ...htmlRules,
+  ...json,
+  ...secrets,
+  ...md,
+  ...yaml,
+  ...html,
 }
 
 module.exports = rules
diff --git a/packages/commitlint-config/package.json b/packages/commitlint-config/package.json
@@ -44,7 +44,8 @@
   },
   "devDependencies": {
     "es-check": "^7.1.0",
-    "rimraf": "^4.1.2"
+    "rimraf": "^4.1.2",
+    "@wayofdev/lint-staged-config": "workspace:*"
   },
   "peerDependencies": {
     "@commitlint/cli": ">= 17"

diff --git a/packages/eslint-config-bases/lint-staged.config.js b/packages/eslint-config-bases/lint-staged.config.js
@@ -7,14 +7,13 @@
  * {@link https://github.com/belgattitude/nextjs-monorepo-example/blob/main/docs/about-lint-staged.md}
  */
 
-const {
-  getEslintFixCmd,
-  jsonRules,
-  secretsRules,
-  mdRules,
-  yamlRules,
-  htmlRules,
-} = require('@wayofdev/lint-staged-config')
+const { getEslintFixCmd } = require('@wayofdev/lint-staged-config')
+
+const json = require('@wayofdev/lint-staged-config/json')
+const yaml = require('@wayofdev/lint-staged-config/yaml')
+const secrets = require('@wayofdev/lint-staged-config/secrets')
+const md = require('@wayofdev/lint-staged-config/md')
+const html = require('@wayofdev/lint-staged-config/html')
 
 /**
  * @typedef {Record<string, (filenames: string[]) => string | string[] | Promise<string | string[]>>} LintRule
@@ -32,11 +31,11 @@ const rules = {
       files: filenames,
     })
   },
-  ...jsonRules,
-  ...secretsRules,
-  ...mdRules,
-  ...yamlRules,
-  ...htmlRules,
+  ...json,
+  ...secrets,
+  ...md,
+  ...yaml,
+  ...html,
 }
 
 module.exports = rules
diff --git a/packages/htmlhint-config/lint-staged.config.js b/packages/htmlhint-config/lint-staged.config.js
@@ -7,14 +7,13 @@
  * {@link https://github.com/belgattitude/nextjs-monorepo-example/blob/main/docs/about-lint-staged.md}
  */
 
-const {
-  getEslintFixCmd,
-  jsonRules,
-  secretsRules,
-  mdRules,
-  yamlRules,
-  htmlRules,
-} = require('@wayofdev/lint-staged-config')
+const { getEslintFixCmd } = require('@wayofdev/lint-staged-config')
+
+const json = require('@wayofdev/lint-staged-config/json')
+const yaml = require('@wayofdev/lint-staged-config/yaml')
+const secrets = require('@wayofdev/lint-staged-config/secrets')
+const md = require('@wayofdev/lint-staged-config/md')
+const html = require('@wayofdev/lint-staged-config/html')
 
 /**
  * @typedef {Record<string, (filenames: string[]) => string | string[] | Promise<string | string[]>>} LintRule
@@ -32,11 +31,11 @@ const rules = {
       files: filenames,
     })
   },
-  ...jsonRules,
-  ...secretsRules,
-  ...mdRules,
-  ...yamlRules,
-  ...htmlRules,
+  ...json,
+  ...secrets,
+  ...md,
+  ...yaml,
+  ...html,
 }
 
 module.exports = rules
diff --git a/packages/htmlhint-config/package.json b/packages/htmlhint-config/package.json
@@ -33,7 +33,8 @@
     "lint:types": "tsc --project tsconfig.json --noEmit"
   },
   "devDependencies": {
-    "rimraf": "^4.1.2"
+    "rimraf": "^4.1.2",
+    "@wayofdev/lint-staged-config": "workspace:*"
   },
   "peerDependencies": {
     "htmlhint": ">= 1"

diff --git a/packages/lint-staged-config/README.md b/packages/lint-staged-config/README.md
@@ -69,68 +69,62 @@ This package should be installed in the root of your mono-repository, where you
 1. Create `lint-staged.config.js` file in root of mono-repository and add lines:
 
    ```javascript
-   // @ts-check
-
-   const {
-     concatFilesForPrettier,
-     jsonRules,
-     secretsRules,
-     mdRules,
-     yamlRules,
-   } = require('@wayofdev/lint-staged-config')
-
+   const { concatFilesForPrettier } = require("@wayofdev/lint-staged-config")
+
+   const json = require("@wayofdev/lint-staged-config/json")
+   const yaml = require("@wayofdev/lint-staged-config/yaml")
+   const secrets = require("@wayofdev/lint-staged-config/secrets")
+   const md = require("@wayofdev/lint-staged-config/md")
+
    const rules = {
-     ...jsonRules,
-     ...yamlRules,
-     ...secretsRules,
-     ...mdRules,
-     '**/*.{js,jsx,cjs,mjs,ts,tsx,mts,cts}': filenames => {
+     ...json,
+     ...yaml,
+     ...secrets,
+     ...md,
+     "**/*.{js,jsx,cjs,mjs,ts,tsx,mts,cts}": filenames => {
        return [`prettier --write ${concatFilesForPrettier(filenames)}`]
      },
    }
-   
+
    module.exports = rules
    ```
-   
+
 2. If needed, override the base `lint-staged.config.js` in each package or application.
 
    Example `lint-staged.config.js` in folder `./packages/eslint-config-bases/`
 
    ```typescript
-   // @ts-check
-
-   const {
-     getEslintFixCmd,
-     jsonRules,
-     secretsRules,
-     mdRules,
-     yamlRules,
-     htmlRules,
-   } = require('@wayofdev/lint-staged-config')
-
+   const { getEslintFixCmd } = require("@wayofdev/lint-staged-config")
+
+   const json = require("@wayofdev/lint-staged-config/json")
+   const yaml = require("@wayofdev/lint-staged-config/yaml")
+   const secrets = require("@wayofdev/lint-staged-config/secrets")
+   const md = require("@wayofdev/lint-staged-config/md")
+   const html = require("@wayofdev/lint-staged-config/html")
+
    /**
     * @typedef {Record<string, (filenames: string[]) => string | string[] | Promise<string | string[]>>} LintRule
     */
    const rules = {
-     '**/*.{js,jsx,ts,tsx}': (/** @type {any} */ filenames) => {
+     "**/*.{js,jsx,ts,tsx}": (/** @type {any} */ filenames) => {
        return getEslintFixCmd({
          cwd: __dirname,
          fix: true,
          cache: true,
          // when autofixing staged-files a good tip is to disable react-hooks/exhaustive-deps, cause
          // a change here can potentially break things without proper visibility.
-         rules: ['react-hooks/exhaustive-deps: off'],
+         rules: ["react-hooks/exhaustive-deps: off"],
          maxWarnings: 25,
          files: filenames,
        })
      },
-     ...jsonRules,
-     ...secretsRules,
-     ...mdRules,
-     ...yamlRules,
-     ...htmlRules,
+     ...json,
+     ...secrets,
+     ...md,
+     ...yaml,
+     ...html,
    }
-   
+
    module.exports = rules
    ```
 

diff --git a/packages/lint-staged-config/package.json b/packages/lint-staged-config/package.json
@@ -26,6 +26,12 @@
     ".": {
       "require": "./src/common.js"
     },
+    "./helpers": {
+      "require": "./src/common.js"
+    },
+    "./bases": {
+      "require": "./src/bases/index.js"
+    },
     "./css": {
       "require": "./src/bases/css.js"
     },

diff --git a/packages/lint-staged-config/src/bases/css.js b/packages/lint-staged-config/src/bases/css.js
@@ -3,10 +3,8 @@ const { concatFilesForPrettier } = require('../common')
 /**
  * @type {Record<string, (filenames: string[]) => string | string[] | Promise<string | string[]>>}
  */
-const rules = {
+module.exports = {
   '**/*.{css}': filenames => {
     return [`prettier --write ${concatFilesForPrettier(filenames)}`, `stylelint --fix`]
   },
 }
-
-module.exports = rules
diff --git a/packages/lint-staged-config/src/bases/graphql.js b/packages/lint-staged-config/src/bases/graphql.js
@@ -3,10 +3,8 @@ const { concatFilesForPrettier } = require('../common')
 /**
  * @type {Record<string, (filenames: string[]) => string | string[] | Promise<string | string[]>>}
  */
-const rules = {
+module.exports = {
   '**/*.{gql,graphql}': filenames => {
     return [`prettier --write ${concatFilesForPrettier(filenames)}`]
   },
 }
-
-module.exports = rules