Enhance linting (#2312)

Adopt enhancements from
vivid-planet/comet-starter#95 for core.

.github/workflows/lint.yml

@@ -67,7 +67,6 @@ jobs:
 
             - name: Lint
               run: |
-                  pnpm exec prettier --check "./*.{js,json,md,yml}"
                   pnpm run lint
                   # check for duplicate ids of formatted messages
                   pnpm run intl:extract

demo/admin/.prettierignore

@@ -1,8 +1,5 @@
-package-lock.json
-.gitignore
-*.lock
-*.gql
-*.dist
-fragmentTypes.json
-graphql.generated.ts
-blocks-admin-lang/
+block-meta.json
+lang-compiled/
+lang/
+schema.json
+src/fragmentTypes.json

demo/admin/lint-staged.config.js

@@ -1,4 +1,5 @@
 module.exports = {
-    "*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
-    "*.{ts,tsx}": () => "pnpm lint:tsc",
+    "src/**/*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
+    "src/**/*.{ts,tsx}": () => "pnpm lint:tsc",
+    "*.{js,json,md,yml,yaml}": () => "pnpm lint:prettier",
 };

demo/admin/package.json

@@ -14,8 +14,9 @@
         "intl:compile:comet": "formatjs compile-folder --format simple --ast lang/comet-lang lang-compiled/comet-lang",
         "intl:compile:comet-demo": "formatjs compile-folder --format simple --ast lang/comet-demo-lang/admin lang-compiled/comet-demo-lang-admin",
         "intl:extract": "formatjs extract \"src/**/*.ts*\" --ignore ./**.d.ts --out-file lang-extracted/en.json --format simple",
-        "lint": "run-s intl:compile && run-p gql:types generate-block-types && run-p lint:eslint lint:tsc && $npm_execpath lint:generated-files-not-modified",
+        "lint": "run-s intl:compile && run-p gql:types generate-block-types && run-p lint:prettier lint:eslint lint:tsc && $npm_execpath lint:generated-files-not-modified",
         "lint:eslint": "eslint --max-warnings 0  --config ./.eslintrc.cli.js --ext .ts,.tsx,.js,.jsx,.json,.md src/ package.json",
+        "lint:prettier": "npx prettier --check './**/*.{js,json,md,yml,yaml}'",
         "lint:tsc": "tsc --project .",
         "lint:generated-files-not-modified": "$npm_execpath admin-generator && git diff --exit-code HEAD --",
         "start": "run-s intl:compile && run-p gql:types generate-block-types && dotenv -- chokidar --initial -s \"../../packages/admin/*/src/**\" -c \"kill-port $ADMIN_PORT && vite --force\""

demo/api/.prettierignore

@@ -1,6 +1,2 @@
-package-lock.json
-.gitignore
-*.lock
-*.gql
-*.dist
+dist/
 block-meta.json

demo/api/lint-staged.config.js

@@ -1,4 +1,5 @@
 module.exports = {
-    "*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
-    "*.{ts,tsx}": () => "pnpm lint:tsc",
+    "src/**/*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
+    "src/**/*.{ts,tsx}": () => "pnpm lint:tsc",
+    "*.{js,json,md,yml,yaml}": () => "pnpm lint:prettier",
 };

demo/api/package.json

@@ -11,8 +11,9 @@
         "db:migrate:prod": "$npm_execpath console:prod migrate --",
         "fixtures": "$npm_execpath console fixtures --",
         "fixtures:prod": "$npm_execpath console:prod fixtures --",
-        "lint": "run-p lint:eslint lint:tsc && $npm_execpath lint:generated-files-not-modified",
+        "lint": "run-p lint:prettier lint:eslint lint:tsc && $npm_execpath lint:generated-files-not-modified",
         "lint:eslint": "eslint --max-warnings 0  --ext .ts,.tsx,.js,.jsx,.json,.md src/ package.json",
+        "lint:prettier": "npx prettier --check './**/*.{js,json,md,yml,yaml}'",
         "lint:tsc": "tsc --project ./tsconfig.lint.json",
         "lint:generated-files-not-modified": "$npm_execpath api-generator && git diff --exit-code HEAD --",
         "mikro-orm": "mikro-orm",

demo/site/.prettierignore

@@ -0,0 +1,5 @@
+.next/
+block-meta.json
+lang-compiled/
+lang/
+preBuild/

demo/site/lint-staged.config.js

@@ -1,4 +1,5 @@
 module.exports = {
-    "*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
-    "*.{ts,tsx}": () => "pnpm lint:tsc",
+    "src/**/*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
+    "src/**/*.{ts,tsx}": () => "pnpm lint:tsc",
+    "*.{js,json,md,yml,yaml}": () => "pnpm lint:prettier",
 };

demo/site/package.json

@@ -17,8 +17,9 @@
         "gql:watch": "graphql-codegen --watch",
         "intl:extract": "formatjs extract \"src/**/*.ts*\" --ignore **/*.d.ts --out-file lang-extracted/en.json --format simple",
         "intl:compile": "formatjs compile-folder --format simple --ast lang/comet-demo-lang/site lang-compiled/",
-        "lint": "run-s intl:compile && run-p gql:types generate-block-types && run-p lint:eslint lint:tsc",
+        "lint": "run-s intl:compile && run-p gql:types generate-block-types && run-p lint:prettier lint:eslint lint:tsc",
         "lint:eslint": "eslint --max-warnings 0 --config ./.eslintrc.cli.js --ext .ts,.tsx,.js,.jsx,.json,.md src/ package.json",
+        "lint:prettier": "npx prettier --check './**/*.{js,json,md,yml,yaml}'",
         "lint:tsc": "tsc --project .",
         "lint:tscPreBuild": "tsc --project tsconfig.preBuild.json",
         "next-build": "$npm_execpath build:publicGenerated && next build",

docs/.prettierignore

@@ -0,0 +1,8 @@
+# Copy of .gitignore, remove once Prettier v3 is in use
+
+# Production
+build
+
+# Generated files
+.docusaurus
+.cache-loader

docs/docs/content-scope/index.md

@@ -4,4 +4,3 @@ sidebar_position: 6
 ---
 
 COMET DXP can be used to create both, content websites and data-driven applications. The usage of the content scope differs considerably between these two use cases.
-

docs/lint-staged.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+    "*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
+    "*.{ts,tsx}": () => "pnpm lint:tsc",
+    "*.{js,json,md,yml,yaml}": () => "pnpm lint:prettier",
+};

docs/package.json

@@ -7,8 +7,9 @@
         "clear": "docusaurus clear",
         "deploy": "docusaurus deploy",
         "docusaurus": "docusaurus",
-        "lint": "pnpm run lint:eslint",
+        "lint": "run-p lint:prettier lint:eslint",
         "lint:eslint": "eslint --max-warnings 0 src/ package.json",
+        "lint:prettier": "npx prettier --check './**/*.{js,json,md,yml,yaml}'",
         "serve": "docusaurus serve",
         "start": "docusaurus start --port 3300",
         "swizzle": "docusaurus swizzle",
@@ -76,6 +77,7 @@
         "@tsconfig/docusaurus": "^1.0.5",
         "@types/react": "^17.0.48",
         "@types/react-dom": "^17.0.17",
+        "npm-run-all": "^4.1.5",
         "prettier": "^2.6.2",
         "sucrase": "^3.32.0",
         "typescript": "^4.7.4",

lint-staged.config.js

@@ -1,3 +1,3 @@
 module.exports = {
-    "./*{js,json,md,yml}": "pnpm exec prettier --check",
+    "./!(demo|docs|packages|storybook)/**/*.{js,json,md,yml,yaml}": () => "pnpm lint:root",
 };

package.json

@@ -23,7 +23,8 @@
         "dev:demo:site": "dev-pm start @demo-site",
         "postinstall": "husky install",
         "intl:extract": "formatjs extract './packages/admin/**/*.ts*' --out-file 'lang/en.json' --ignore './**.d.ts' --ignore './**.d.ts.map' --format simple --throws",
-        "lint": "pnpm recursive run lint",
+        "lint": "pnpm lint:root && pnpm recursive run lint",
+        "lint:root": "$npm_execpath prettier --check './!(demo|docs|packages|storybook)/**/*.{js,json,md,yml,yaml}'",
         "lint:eslint": "pnpm recursive run lint:eslint",
         "lint:tsc": "pnpm recursive run lint:tsc",
         "storybook": "pnpm --filter comet-storybook run storybook",

packages/admin/admin-color-picker/.prettierignore

@@ -0,0 +1 @@
+lib/

packages/admin/admin-color-picker/lint-staged.config.js

@@ -1,4 +1,5 @@
 module.exports = {
-    "*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
-    "*.{ts,tsx}": () => "pnpm lint:tsc",
+    "src/**/*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
+    "src/**/*.{ts,tsx}": () => "pnpm lint:tsc",
+    "*.{js,json,md,yml,yaml}": () => "pnpm lint:prettier",
 };

packages/admin/admin-color-picker/package.json

@@ -17,8 +17,9 @@
         "build:babel": "npx babel ./src -x \".ts,.tsx\" -d lib",
         "build:types": "tsc --project ./tsconfig.json --emitDeclarationOnly",
         "clean": "rimraf lib",
-        "lint": "run-p lint:eslint lint:tsc",
+        "lint": "run-p lint:prettier lint:eslint lint:tsc",
         "lint:eslint": "eslint --max-warnings 0 src/ package.json",
+        "lint:prettier": "npx prettier --check './**/*.{js,json,md,yml,yaml}'",
         "lint:tsc": "tsc --noEmit",
         "start": "run-p start:babel start:types",
         "start:babel": "npx babel ./src -x \".ts,.tsx\" -d lib -w",

packages/admin/admin-date-time/.prettierignore

@@ -0,0 +1 @@
+lib/

packages/admin/admin-date-time/lint-staged.config.js

@@ -1,4 +1,5 @@
 module.exports = {
-    "*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
-    "*.{ts,tsx}": () => "pnpm lint:tsc",
+    "src/**/*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
+    "src/**/*.{ts,tsx}": () => "pnpm lint:tsc",
+    "*.{js,json,md,yml,yaml}": () => "pnpm lint:prettier",
 };

packages/admin/admin-date-time/package.json

@@ -17,8 +17,9 @@
         "build:babel": "npx babel ./src -x \".ts,.tsx\" -d lib",
         "build:types": "tsc --project ./tsconfig.json --emitDeclarationOnly",
         "clean": "rimraf lib",
-        "lint": "run-p lint:eslint lint:tsc",
+        "lint": "run-p lint:prettier lint:eslint lint:tsc",
         "lint:eslint": "eslint --max-warnings 0 src/ package.json",
+        "lint:prettier": "npx prettier --check './**/*.{js,json,md,yml,yaml}'",
         "lint:tsc": "tsc --noEmit",
         "start": "run-p start:babel start:types",
         "start:babel": "npx babel ./src -x \".ts,.tsx\" -d lib -w",

packages/admin/admin-icons/.prettierignore

@@ -0,0 +1 @@
+lib/

packages/admin/admin-icons/lint-staged.config.js

@@ -1,4 +1,5 @@
 module.exports = {
-    "*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
-    "*.{ts,tsx}": () => "pnpm lint:tsc",
+    "src/**/*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
+    "src/**/*.{ts,tsx}": () => "pnpm lint:tsc",
+    "*.{js,json,md,yml,yaml}": () => "pnpm lint:prettier",
 };

packages/admin/admin-icons/package.json

@@ -14,8 +14,9 @@
         "build:types": "tsc --project ./tsconfig.json --emitDeclarationOnly",
         "clean": "rimraf lib",
         "generate-icons": "ts-node generate-icons.ts",
-        "lint": "run-p lint:eslint lint:tsc",
+        "lint": "run-p lint:prettier lint:eslint lint:tsc",
         "lint:eslint": "eslint --max-warnings 0 src/ package.json",
+        "lint:prettier": "npx prettier --check './**/*.{js,json,md,yml,yaml}'",
         "lint:tsc": "tsc --noEmit",
         "start": "$npm_execpath run generate-icons && run-p start:babel start:types",
         "start:babel": "npx babel ./src -x \".ts,.tsx\" -d lib -w",

packages/admin/admin-react-select/.prettierignore

@@ -0,0 +1 @@
+lib/

packages/admin/admin-react-select/lint-staged.config.js

@@ -1,4 +1,5 @@
 module.exports = {
-    "*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
-    "*.{ts,tsx}": () => "pnpm lint:tsc",
+    "src/**/*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
+    "src/**/*.{ts,tsx}": () => "pnpm lint:tsc",
+    "*.{js,json,md,yml,yaml}": () => "pnpm lint:prettier",
 };

packages/admin/admin-react-select/package.json

@@ -17,8 +17,9 @@
         "build:babel": "npx babel ./src -x \".ts,.tsx\" -d lib",
         "build:types": "tsc --project ./tsconfig.json --emitDeclarationOnly",
         "clean": "rimraf lib",
-        "lint": "run-p lint:eslint lint:tsc",
+        "lint": "run-p lint:prettier lint:eslint lint:tsc",
         "lint:eslint": "eslint --max-warnings 0 src/ package.json",
+        "lint:prettier": "npx prettier --check './**/*.{js,json,md,yml,yaml}'",
         "lint:tsc": "tsc --noEmit",
         "start": "run-p start:babel start:types",
         "start:babel": "npx babel ./src -x \".ts,.tsx\" -d lib -w",

packages/admin/admin-rte/.prettierignore

@@ -0,0 +1 @@
+lib/

packages/admin/admin-rte/lint-staged.config.js

@@ -1,4 +1,5 @@
 module.exports = {
-    "*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
-    "*.{ts,tsx}": () => "pnpm lint:tsc",
+    "src/**/*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
+    "src/**/*.{ts,tsx}": () => "pnpm lint:tsc",
+    "*.{js,json,md,yml,yaml}": () => "pnpm lint:prettier",
 };

packages/admin/admin-rte/package.json

@@ -17,8 +17,9 @@
         "build:babel": "npx babel ./src -x \".ts,.tsx\" -d lib",
         "build:types": "tsc --project ./tsconfig.json --emitDeclarationOnly",
         "clean": "rimraf lib",
-        "lint": "run-p lint:eslint lint:tsc",
+        "lint": "run-p lint:prettier lint:eslint lint:tsc",
         "lint:eslint": "eslint --max-warnings 0 src/ package.json",
+        "lint:prettier": "npx prettier --check './**/*.{js,json,md,yml,yaml}'",
         "lint:tsc": "tsc --noEmit",
         "start": "run-p start:babel start:types",
         "start:babel": "npx babel ./src -x \".ts,.tsx\" -d lib -w",

packages/admin/admin-theme/.prettierignore

@@ -0,0 +1 @@
+lib/

packages/admin/admin-theme/lint-staged.config.js

@@ -1,4 +1,5 @@
 module.exports = {
-    "*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
-    "*.{ts,tsx}": () => "pnpm lint:tsc",
+    "src/**/*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
+    "src/**/*.{ts,tsx}": () => "pnpm lint:tsc",
+    "*.{js,json,md,yml,yaml}": () => "pnpm lint:prettier",
 };

packages/admin/admin-theme/package.json

@@ -17,8 +17,9 @@
         "build:babel": "npx babel ./src -x \".ts,.tsx\" -d lib",
         "build:types": "tsc --project ./tsconfig.json --emitDeclarationOnly",
         "clean": "rimraf lib",
-        "lint": "run-p lint:eslint lint:tsc",
+        "lint": "run-p lint:prettier lint:eslint lint:tsc",
         "lint:eslint": "eslint --max-warnings 0 src/ package.json",
+        "lint:prettier": "npx prettier --check './**/*.{js,json,md,yml,yaml}'",
         "lint:tsc": "tsc --noEmit",
         "start": "run-p start:babel start:types",
         "start:babel": "npx babel ./src -x \".ts,.tsx\" -d lib -w",

packages/admin/admin/.babelrc.json

@@ -1,6 +1,4 @@
 {
     "presets": ["@comet/admin-babel-preset"],
-    "ignore": [
-        "**/*.test.ts", "**/*.test.tsx", "**/*.spec.ts", "**/*.spec.tsx", "**/__tests__/**"
-    ]
+    "ignore": ["**/*.test.ts", "**/*.test.tsx", "**/*.spec.ts", "**/*.spec.tsx", "**/__tests__/**"]
 }

packages/admin/admin/.prettierignore

@@ -0,0 +1 @@
+lib/

packages/admin/admin/lint-staged.config.js

@@ -1,4 +1,5 @@
 module.exports = {
-    "*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
-    "*.{ts,tsx}": () => "pnpm lint:tsc",
+    "src/**/*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
+    "src/**/*.{ts,tsx}": () => "pnpm lint:tsc",
+    "*.{js,json,md,yml,yaml}": () => "pnpm lint:prettier",
 };

packages/admin/admin/package.json

@@ -17,8 +17,9 @@
         "build:babel": "npx babel ./src -x \".ts,.tsx\" -d lib",
         "build:types": "tsc --project ./tsconfig.build.json --emitDeclarationOnly",
         "clean": "rimraf lib",
-        "lint": "run-p lint:eslint lint:tsc",
+        "lint": "run-p lint:prettier lint:eslint lint:tsc",
         "lint:eslint": "eslint --max-warnings 0 src/ package.json",
+        "lint:prettier": "npx prettier --check './**/*.{js,json,md,yml,yaml}'",
         "lint:tsc": "tsc --noEmit",
         "start": "run-p start:babel start:types",
         "start:babel": "npx babel ./src -x \".ts,.tsx\" -d lib -w",

packages/admin/blocks-admin/.babelrc.json

@@ -1,6 +1,4 @@
 {
     "presets": ["@comet/admin-babel-preset"],
-    "ignore": [
-        "**/*.test.ts", "**/*.test.tsx", "**/*.spec.ts", "**/*.spec.tsx", "**/__tests__/**"
-    ]
+    "ignore": ["**/*.test.ts", "**/*.test.tsx", "**/*.spec.ts", "**/*.spec.tsx", "**/__tests__/**"]
 }

packages/admin/blocks-admin/.prettierignore

@@ -0,0 +1,2 @@
+lib/
+block-meta.json

packages/admin/blocks-admin/lint-staged.config.js

@@ -1,4 +1,5 @@
 module.exports = {
-    "*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
-    "*.{ts,tsx}": () => "pnpm lint:tsc",
+    "src/**/*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
+    "src/**/*.{ts,tsx}": () => "pnpm lint:tsc",
+    "*.{js,json,md,yml,yaml}": () => "pnpm lint:prettier",
 };

packages/admin/blocks-admin/package.json

@@ -19,8 +19,9 @@
         "clean": "rimraf lib",
         "generate-block-types": "comet generate-block-types --inputs",
         "generate-block-types:watch": "chokidar -s \"**/block-meta.json\" -c \"$npm_execpath generate-block-types\"",
-        "lint": "$npm_execpath generate-block-types && run-p lint:eslint lint:tsc",
+        "lint": "$npm_execpath generate-block-types && run-p lint:prettier lint:eslint lint:tsc",
         "lint:eslint": "eslint --max-warnings 0 src/ package.json",
+        "lint:prettier": "npx prettier --check './**/*.{js,json,md,yml,yaml}'",
         "lint:tsc": "tsc --noEmit",
         "start": "$npm_execpath generate-block-types && run-p start:babel start:types",
         "start:babel": "npx babel ./src -x \".ts,.tsx\" -d lib -w",

packages/admin/cms-admin/.babelrc.json

@@ -1,6 +1,4 @@
 {
     "presets": ["@comet/admin-babel-preset"],
-    "ignore": [
-        "**/*.test.ts", "**/*.test.tsx", "**/*.spec.ts", "**/*.spec.tsx", "**/__tests__/**"
-    ]
+    "ignore": ["**/*.test.ts", "**/*.test.tsx", "**/*.spec.ts", "**/*.spec.tsx", "**/__tests__/**"]
 }

packages/admin/cms-admin/.prettierignore

@@ -0,0 +1,2 @@
+lib/
+block-meta.json

packages/admin/cms-admin/lint-staged.config.js

@@ -1,4 +1,5 @@
 module.exports = {
-    "*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
-    "*.{ts,tsx}": () => "pnpm lint:tsc",
+    "src/**/*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
+    "src/**/*.{ts,tsx}": () => "pnpm lint:tsc",
+    "*.{js,json,md,yml,yaml}": () => "pnpm lint:prettier",
 };

packages/admin/cms-admin/package.json

@@ -24,8 +24,9 @@
         "generate-block-types:watch": "chokidar -s \"**/block-meta.json\" -c \"$npm_execpath generate-block-types\"",
         "generate-graphql-types": "graphql-codegen",
         "generate-graphql-types:watch": "$npm_execpath generate-graphql-types --watch",
-        "lint": "run-p generate-graphql-types generate-block-types && run-p lint:eslint lint:tsc",
+        "lint": "run-p generate-graphql-types generate-block-types && run-p lint:prettier lint:eslint lint:tsc",
         "lint:eslint": "eslint --max-warnings 0 src/ package.json",
+        "lint:prettier": "npx prettier --check './**/*.{js,json,md,yml,yaml}'",
         "lint:tsc": "tsc --noEmit",
         "start": "run-p generate-graphql-types generate-block-types && run-p start:babel start:types",
         "start:babel": "npx babel ./src -x \".ts,.tsx\" -d lib -w",

packages/api/blocks-api/.prettierignore

@@ -0,0 +1,2 @@
+lib/
+block-meta.json