-
Notifications
You must be signed in to change notification settings - Fork 19
chore(monorepo): π€ make linting, formatting centralized #955
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
punkbit
wants to merge
21
commits into
chore/design-tokens-package
Choose a base branch
from
chore/monorepo-make-linting-formatting-centralized
base: chore/design-tokens-package
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
3ade323
refactor: π‘ make eslint config root-level
punkbit 8511f1e
refactor: π‘ make tsconfig base
punkbit a788d8e
refactor: π‘ root-level tsconfig for eslint
punkbit b922b20
fix: π Removed the non-functional references array
punkbit 74d62f2
fix: π remove duplicate prettier version
punkbit 31f9637
chore: π€ exclude non eslint packages
punkbit 76d3e40
refactor: π‘ shared eslint config
punkbit faa3f91
fix: π missing type def
punkbit ce767c5
refactor: π‘ convert the eslint root-level config a typescript file
punkbit 3fc9993
refactor: π‘ move click-ui specific eslint rules
punkbit 3b007a8
fix: π type errors, e.g. Using Record<string, unknown> as the type anβ¦
punkbit 1270a82
fix: π Using Linter.RulesRecord from eslint provides the correct typeβ¦
punkbit 8443376
refactor: π‘ React/Storybook plugins should be added at
punkbit e8ab91b
chore: π€ add comment
punkbit 8f24d86
chore: π€ remove comment
punkbit fb80f48
refactor: π‘ root-level tsconfig.eslint doesnt need a includes
punkbit b43d4e5
refactor: π‘ move click ui specific eslint packages
punkbit 548f696
chore: π€ tsconfig.eslint default include set to eslint.config.ts
punkbit af27131
refactor: π‘ add local configs and extend to follow convention
punkbit 6b7a58d
chore: π€ update lockfile
punkbit f6c22c1
fix: π remove redundant @typescript-eslint/eslint-plugin (bundled in β¦
punkbit File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| /** | ||
| * Shared ESLint configuration for TypeScript packages. | ||
| * | ||
| * Important: | ||
| * - Packages should create their own eslint.config.ts that imports and extends this. | ||
| * - React/Storybook-specific plugins and rules should be added at the package level. | ||
| * | ||
| * Excluded packages (using alternative linters): | ||
| * - design-tokens: uses Terrazzo's linter (tz lint) | ||
| */ | ||
| import js from '@eslint/js'; | ||
| import tseslint from 'typescript-eslint'; | ||
| import preferArrowFunctions from 'eslint-plugin-prefer-arrow-functions'; | ||
| import importPlugin from 'eslint-plugin-import'; | ||
| import globals from 'globals'; | ||
| import type { Linter } from 'eslint'; | ||
|
|
||
| export const ignores = { | ||
| ignores: [ | ||
| '**/dist/**', | ||
| '**/node_modules/**', | ||
| '**/build/**', | ||
| '**/coverage/**', | ||
| '**/*.d.ts', | ||
| ], | ||
| }; | ||
|
|
||
| export const baseConfigs = [js.configs.recommended, ...tseslint.configs.recommended]; | ||
|
|
||
| export const plugins = { | ||
| 'prefer-arrow-functions': preferArrowFunctions, | ||
| import: importPlugin, | ||
| }; | ||
|
|
||
| export const sharedLanguageOptions = { | ||
| ecmaVersion: 'latest' as const, | ||
| sourceType: 'module' as const, | ||
| parser: tseslint.parser, | ||
| parserOptions: { | ||
| ecmaFeatures: { | ||
| jsx: true, | ||
| }, | ||
| }, | ||
| globals: { | ||
| ...globals.browser, | ||
| ...globals.es2020, | ||
| }, | ||
| }; | ||
|
|
||
| export const sharedRules: Linter.RulesRecord = { | ||
| curly: ['error', 'all'], | ||
| 'no-multiple-empty-lines': 'error', | ||
| quotes: ['error', 'single', { avoidEscape: true }], | ||
| 'arrow-parens': ['error', 'as-needed'], | ||
| 'prefer-arrow-functions/prefer-arrow-functions': [ | ||
| 'warn', | ||
| { | ||
| classPropertiesAllowed: false, | ||
| disallowPrototype: false, | ||
| returnStyle: 'unchanged', | ||
| singleReturnOnly: false, | ||
| }, | ||
| ], | ||
| '@typescript-eslint/no-empty-object-type': 'off', | ||
| 'import/extensions': [ | ||
| 'error', | ||
| 'ignorePackages', | ||
| { | ||
| js: 'never', | ||
| jsx: 'never', | ||
| ts: 'never', | ||
| tsx: 'never', | ||
| }, | ||
| ], | ||
| 'import/no-cycle': [ | ||
| 'error', | ||
| { | ||
| maxDepth: 10, | ||
| ignoreExternal: true, | ||
| allowUnsafeDynamicCyclicDependency: false, | ||
| }, | ||
| ], | ||
| 'import/no-self-import': 'error', | ||
| '@typescript-eslint/no-deprecated': 'warn', | ||
| }; | ||
|
|
||
| export const testFileRules: Linter.RulesRecord = { | ||
| '@typescript-eslint/no-unused-expressions': 'off', | ||
| }; | ||
|
|
||
| export { tseslint }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,10 @@ | ||||||||
| { | ||||||||
| "extends": "../../tsconfig.eslint.json", | ||||||||
| "compilerOptions": { | ||||||||
| "baseUrl": ".", | ||||||||
| "paths": { | ||||||||
| "@/*": ["src/*"] | ||||||||
| } | ||||||||
|
||||||||
| } | |
| }, | |
| "types": ["vitest/globals", "@testing-library/jest-dom"] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,14 @@ | ||
| { | ||
| "extends": "../../tsconfig.base.json", | ||
| "compilerOptions": { | ||
| "target": "ESNext", | ||
| "esModuleInterop": true, | ||
| "lib": ["DOM", "DOM.Iterable", "ESNext"], | ||
| "module": "ESNext", | ||
| "skipLibCheck": true, | ||
|
|
||
| /* Bundler mode */ | ||
| "moduleResolution": "bundler", | ||
| "allowImportingTsExtensions": true, | ||
| "resolveJsonModule": true, | ||
| "isolatedModules": true, | ||
| "noEmit": true, | ||
| "jsx": "react-jsx", | ||
|
|
||
| /* Linting */ | ||
| "strict": true, | ||
| "noUnusedLocals": true, | ||
| "noUnusedParameters": true, | ||
| "noFallthroughCasesInSwitch": true, | ||
| "paths": { | ||
| "@/*": ["./src/*"], | ||
| "@/*": ["./src/*"] | ||
| }, | ||
| "types": ["@testing-library/jest-dom", "vitest/globals"] | ||
| }, | ||
| "include": ["src"], | ||
| "exclude": [ | ||
| "node_modules", | ||
| "dist", | ||
| ], | ||
| "references": [{ "path": "./tsconfig.node.json" }] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,4 @@ | ||
| { | ||
| "compilerOptions": { | ||
| "target": "ESNext", | ||
| "module": "ESNext", | ||
| "moduleResolution": "bundler", | ||
| "esModuleInterop": true, | ||
| "skipLibCheck": true, | ||
| "strict": true, | ||
| "noUnusedLocals": true, | ||
| "noUnusedParameters": true, | ||
| "noFallthroughCasesInSwitch": true, | ||
| "resolveJsonModule": true, | ||
| "isolatedModules": true, | ||
| "noEmit": true | ||
| }, | ||
| "include": ["*.ts"], | ||
| "exclude": ["node_modules", "dist"] | ||
| "extends": "../../tsconfig.base.json", | ||
| "include": ["*.ts"] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| { | ||
| "compilerOptions": { | ||
| "target": "ESNext", | ||
| "module": "ESNext", | ||
| "moduleResolution": "bundler", | ||
| "esModuleInterop": true, | ||
| "skipLibCheck": true, | ||
| "resolveJsonModule": true, | ||
| "isolatedModules": true, | ||
| "noEmit": true, | ||
| "strict": true, | ||
| "noUnusedLocals": true, | ||
| "noUnusedParameters": true, | ||
| "noFallthroughCasesInSwitch": true | ||
| }, | ||
| "exclude": ["node_modules", "dist"] | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Root
prettierwas changed to a caret range (^3.7.4), which is already resolving to3.8.1inyarn.lock. Since formatting consistency is the goal of this PR (and@clickhouse/click-uipreviously pinned Prettier), consider pinning Prettier to an exact version (or adding a Yarn resolution) to avoid formatting diffs when new minor versions are released.