fix: added checks for prettier, for the eslint, stylelint and markdown lint group

prisis · prisis · commit db409b77b1db · 2023-11-02T12:44:04.000+01:00
Signed-off-by: prisis &lt;d.bannert@anolilab.de&gt;
diff --git a/.github/settings.yml b/.github/settings.yml
@@ -35,75 +35,129 @@ branches:
 # https://docs.github.com/en/rest/reference/issues#update-a-label
 
 labels:
-    - name: "Added"
-      description: "Changelog Added"
-      color: "90db3f"
+    - name: "s: needs decision"
+      description: "Needs team/maintainer decision"
+      color: "C453C3"
 
-    - name: "Changed"
-      description: "Changelog Changed"
+    - name: "s: needs proposal"
+      description: "Changelog Fixed"
       color: "fbca04"
 
-    - name: "Dependency update"
-      description: "Pull requests that update a dependency file"
-      color: "e1f788"
+    - name: "s: needs design"
+      description: "Changelog Fixed"
+      color: "fbca04"
 
-    - name: "Deprecated"
-      description: "Changelog Deprecated"
-      color: "1d76db"
+    - name: "s: accepted"
+      description: "Accepted feature / Confirmed bug"
+      color: "0E8A16"
 
-    - name: "Duplicate"
-      color: "000000"
+    - name: "s: awaiting more info"
+      description: "Additional information are requested"
+      color: "B76026"
 
-    - name: "Enhancement"
-      color: "d7e102"
+    - name: "s: invalid"
+      description: "This doesn't seem right"
+      color: "E4E669"
 
-    - name: "Stale"
-      color: "000000"
+    - name: "s: on hold"
+      description: "Blocked by something or frozen to avoid conflicts"
+      color: "A03F0B"
 
-    - name: "Fixed"
-      description: "Changelog Fixed"
-      color: "9ef42e"
+    - name: "s: pending triage"
+      description: "Pending Triage"
+      color: "dddddd"
 
-    - name: "Removed"
-      description: "Changelog Removed"
-      color: "e99695"
+    - name: "s: waiting for user interest"
+      description: "Waiting for more users interested in this feature"
+      color: "4B02CE"
 
-    - name: "Security"
-      description: "Changelog Security"
-      color: "ed3e3b"
+    - name: "wontfix"
+      description: "This will not be worked on"
+      color: "ffffff"
 
-    - name: "Status: Good first issue"
-      color: "d7e102"
+    - name: "question"
+      description: "Further information is requested"
+      color: "956692"
 
-    - name: "Status: Help wanted"
-      color: "85d84e"
+    - name: "p: 1-normal"
+      description: "Nothing urgent"
+      color: "BFDADC"
 
-    - name: "Status: Needs Work"
-      color: "fad8c7"
+    - name: "p: 2-high"
+      description: "Fix main branch"
+      color: "FF4d4d"
 
-    - name: "Status: Waiting for feedback"
-      color: "fef2c0"
+    - name: "p: 3-urgent"
+      description: "Fix and release ASAP"
+      color: "FF0000"
 
-    - name: "Type: BC Break"
-      color: "b60205"
+    - name: "needs test"
+      description: "More tests are needed"
+      color: "FAF1A2"
 
-    - name: "Type: Bug"
-      color: "b60205"
+    - name: "needs rebase"
+      description: "There is a merge conflict"
+      color: "32345B"
 
-    - name: "Type: Critical"
-      color: "ff8c00"
+    - name: "c: bug"
+      description: "Something isn't working"
+      color: "FFA500"
 
-    - name: "Type: RFC"
-      color: "fbca04"
+    - name: "c: chore"
+      description: "PR that doesn't affect the runtime behavior"
+      color: "40E0D0"
+
+    - name: "c: docs"
+      description: "Improvements or additions to documentation"
+      color: "FFFF00"
+
+    - name: "c: dependencies"
+      description: "Pull requests that adds/updates a dependency"
+      color: "AFEEEE"
+
+    - name: "c: feature"
+      description: "Request for new feature"
+      color: "2878FF"
+
+    - name: "c: infra"
+      description: "Changes to our infrastructure or project setup"
+      color: "2c3e50"
+
+    - name: "c: refactor"
+      description: "PR that affects the runtime behavior, but doesn't add new features or fixes bugs"
+      color: "40E0D0"
+
+    - name: "c: security"
+      description: "Indicates a vulnarability"
+      color: "B60205"
+
+    - name: "deprecation"
+      description: "A deprecation was made in the PR"
+      color: "C5DEF5"
+
+    - name: "do NOT merge yet"
+      description: "Do not merge this PR into the target branch yet"
+      color: "FF0205"
+
+    - name: "duplicate"
+      description: "Duplicate of another issue/PR"
+      color: "fef2c0"
+
+    - name: "good first issue"
+      description: "Good for newcomers"
+      color: "7057ff"
 
-    - name: "Type: Unconfirmed"
-      color: "444444"
+    - name: "has workaround"
+      description: "Workaround provided or linked"
+      color: "4049AD"
 
-    - name: "Type: Wontfix"
-      color: "000000"
+    - name: "help wanted"
+      description: "Extra attention is needed"
+      color: "008672"
 
-    - name: "semantic-release"
-      color: "ff0000"
+    - name: "breaking change"
+      description: "Cannot be merged when next version is not a major release"
+      color: "B05D08"
 
 # https://docs.github.com/en/rest/reference/repos#update-a-repository
 
diff --git a/packages/lint-staged-config/src/config.ts b/packages/lint-staged-config/src/config.ts
@@ -20,17 +20,17 @@ const groups: Groups = [
     {
         config: eslintConfig,
         configName: "eslint",
-        dependencies: ["prettier", "eslint"],
+        dependencies: ["eslint"],
     },
     {
         config: jsonConfig,
         configName: "json",
-        dependencies: ["prettier", "sort-package-json"],
+        dependencies: ["prettier"],
     },
     {
         config: markdownConfig,
         configName: "markdown",
-        dependencies: ["prettier", "markdownlint-cli", "markdownlint-cli2"],
+        dependencies: ["markdownlint-cli", "markdownlint-cli2"],
     },
     {
         config: secretlintConfig,
diff --git a/packages/lint-staged-config/src/global.d.ts b/packages/lint-staged-config/src/global.d.ts
@@ -12,4 +12,6 @@ declare global {
     var anolilabLintStagedPackageJsonConfig: undefined | { [key: string]: boolean | undefined };
 
     var anolilabLintStagedPackageManager: undefined | "pnpm" | "npm" | "yarn";
+
+    var hasAnolilabLintStagedPrettier: undefined | boolean;
 }
diff --git a/packages/lint-staged-config/src/groups/eslint/index.ts b/packages/lint-staged-config/src/groups/eslint/index.ts
@@ -3,6 +3,7 @@ import type { Config } from "lint-staged";
 
 import concatFiles from "../../utils/concat-files";
 import getPackageManager from "../../utils/get-package-manager";
+import consoleLog from "../../utils/logger";
 import createEslintCommands from "./create-eslint-commands";
 
 const extensions = ["cjs", "js", "mjs", "cts", "ts", "mts", "yml", "yaml", "jsx", "tsx", "mdx", "toml"];
@@ -19,10 +20,16 @@ if (!global.hasAnolilabLintStagedMarkdownCli && !global.hasAnolilabLintStagedMar
     extensions.push("md");
 }
 
+if (!global.hasAnolilabLintStagedPrettier) {
+    global.hasAnolilabLintStagedPrettier = hasDependency("prettier") || hasDevDependency("prettier");
+
+    consoleLog("Prettier was found inside your package.json. It will be used to format your files, before eslint is executed.");
+}
+
 const group: Config = {
     [`**/*.{${["json", "json5", "jsonc"].join(",")}}`]: async (filenames: string[]) => [...(await createEslintCommands(filenames))],
     [`**/*.{${[extensions].join(",")}}`]: async (filenames: string[]) => [
-        `${getPackageManager()} exec prettier --write ${concatFiles(filenames)}`,
+        ...(global.hasAnolilabLintStagedPrettier ? [`${getPackageManager()} exec prettier --write ${concatFiles(filenames)}`] : []),
         ...(await createEslintCommands(filenames)),
     ],
 };
diff --git a/packages/lint-staged-config/src/groups/markdown.ts b/packages/lint-staged-config/src/groups/markdown.ts
@@ -3,25 +3,33 @@ import type { Config } from "lint-staged";
 
 import concatFiles from "../utils/concat-files";
 import getPackageManager from "../utils/get-package-manager";
+import consoleLog from "../utils/logger";
 
 if (!global.hasAnolilabLintStagedMarkdownCli) {
     global.hasAnolilabLintStagedMarkdownCli = hasDependency("markdownlint-cli") || hasDevDependency("markdownlint-cli");
 }
+
 if (!global.hasAnolilabLintStagedMarkdownCli2) {
     global.hasAnolilabLintStagedMarkdownCli2 = hasDependency("markdownlint-cli2") || hasDevDependency("markdownlint-cli2");
 }
 
+if (!global.hasAnolilabLintStagedPrettier) {
+    global.hasAnolilabLintStagedPrettier = hasDependency("prettier") || hasDevDependency("prettier");
+
+    consoleLog("Prettier was found inside your package.json. It will be used to format your markdown files.");
+}
+
 const group: Config = {
     "**/*.md": (filenames: string[]) => [
-        `${getPackageManager()} exec prettier --write ${concatFiles(filenames)}`,
+        ...(global.hasAnolilabLintStagedPrettier ? [`${getPackageManager()} exec prettier --write ${concatFiles(filenames)}`] : []),
         ...(global.hasAnolilabLintStagedMarkdownCli
             ? [`${getPackageManager()} exec markdownlint --fix --ignore '**/node_modules/**' --ignore '**/CHANGELOG.md' ${concatFiles(filenames)}`]
             : []),
         ...(global.hasAnolilabLintStagedMarkdownCli2
             ? [`${getPackageManager()} exec markdownlint-cli2 --fix '!**/node_modules/**' '!**/CHANGELOG.md' ${concatFiles(filenames)}`]
             : []),
     ],
-    "**/*.mdx": (filenames) => [`${getPackageManager()} exec prettier --write ${concatFiles(filenames)}`],
+    "**/*.mdx": (filenames) => [...(global.hasAnolilabLintStagedPrettier ? [`${getPackageManager()} exec prettier --write ${concatFiles(filenames)}`] : [])],
 };
 
 export default group;
diff --git a/packages/lint-staged-config/src/groups/stylesheets.ts b/packages/lint-staged-config/src/groups/stylesheets.ts
@@ -1,11 +1,19 @@
+import { hasDependency, hasDevDependency } from "@anolilab/package-json-utils";
 import type { Config } from "lint-staged";
 
 import concatFiles from "../utils/concat-files";
 import getPackageManager from "../utils/get-package-manager";
+import consoleLog from "../utils/logger";
+
+if (!global.hasAnolilabLintStagedPrettier) {
+    global.hasAnolilabLintStagedPrettier = hasDependency("prettier") || hasDevDependency("prettier");
+
+    consoleLog("Prettier was found inside your package.json. It will be used to format your files, before stylelint is executed.");
+}
 
 const group: Config = {
     [`**/*.{${["css", "sass", "scss", "less"].join(",")}}`]: (filenames: string[]) => [
-        `${getPackageManager()} exec prettier --ignore-unknown --write ${concatFiles(filenames)}`,
+        ...(global.hasAnolilabLintStagedPrettier ? [`${getPackageManager()} exec prettier --ignore-unknown --write ${concatFiles(filenames)}`] : []),
         `${getPackageManager()} exec stylelint --fix`,
     ],
 };
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -20,17 +20,17 @@ const groups: Groups = [`
`20`	`20`	`{`
`21`	`21`	`config: eslintConfig,`
`22`	`22`	`configName: "eslint",`
`23`		`- dependencies: ["prettier", "eslint"],`
	`23`	`+ dependencies: ["eslint"],`
`24`	`24`	`},`
`25`	`25`	`{`
`26`	`26`	`config: jsonConfig,`
`27`	`27`	`configName: "json",`
`28`		`- dependencies: ["prettier", "sort-package-json"],`
	`28`	`+ dependencies: ["prettier"],`
`29`	`29`	`},`
`30`	`30`	`{`
`31`	`31`	`config: markdownConfig,`
`32`	`32`	`configName: "markdown",`
`33`		`- dependencies: ["prettier", "markdownlint-cli", "markdownlint-cli2"],`
	`33`	`+ dependencies: ["markdownlint-cli", "markdownlint-cli2"],`
`34`	`34`	`},`
`35`	`35`	`{`
`36`	`36`	`config: secretlintConfig,`
Original file line number	Diff line number	Diff line change
`@@ -12,4 +12,6 @@ declare global {`
`12`	`12`	`var anolilabLintStagedPackageJsonConfig: undefined \| { [key: string]: boolean \| undefined };`
`13`	`13`
`14`	`14`	`var anolilabLintStagedPackageManager: undefined \| "pnpm" \| "npm" \| "yarn";`
	`15`	`+`
	`16`	`+ var hasAnolilabLintStagedPrettier: undefined \| boolean;`
`15`	`17`	`}`