9ef070d33a
## Description This PR: - moves the icon-related ESLint rules from to `eslintrc.base.json` – to make them apply to all packages - fixes direct `remixicon` imports surfaced by the change #### Type of change - Bug fix (non-breaking change which fixes an issue) ## Testing #### How Has This Been Tested? - [ ] Manual – smoke-tested that the dashboard and the editor open correctly - [ ] Jest - [ ] Cypress #### Test Plan > Add Testsmith test cases links that relate to this PR > > #### Issues raised during DP testing > Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR) > > > ## Checklist: #### Dev activity - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag #### QA activity: - [ ] [Speedbreak features](https://github.com/appsmithorg/TestSmith/wiki/Test-plan-implementation#speedbreaker-features-to-consider-for-every-change) have been covered - [ ] Test plan covers all impacted features and [areas of interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans/_edit#areas-of-interest) - [ ] Test plan has been peer reviewed by project stakeholders and other QA members - [ ] Manually tested functionality on DP - [ ] We had an implementation alignment call with stakeholders post QA Round 2 - [ ] Cypress test cases have been added and approved by SDET/manual QA - [ ] Added `Test Plan Approved` label after Cypress tests were reviewed - [ ] Added `Test Plan Approved` label after JUnit tests were reviewed
96 lines
3.8 KiB
JSON
96 lines
3.8 KiB
JSON
// This file is a base for all package-specific ESLint configurations
|
||
{
|
||
"$schema": "http://json.schemastore.org/eslintrc",
|
||
"root": true,
|
||
"parser": "@typescript-eslint/parser",
|
||
"plugins": [
|
||
"react",
|
||
"@typescript-eslint",
|
||
"prettier",
|
||
"react-hooks",
|
||
"sort-destructure-keys",
|
||
"cypress",
|
||
"jest"
|
||
],
|
||
"extends": [
|
||
"plugin:react/recommended", // Uses the recommended rules from @eslint-plugin-react
|
||
"plugin:@typescript-eslint/recommended",
|
||
"plugin:cypress/recommended",
|
||
// Note: Please keep this as the last config to make sure that this (and by extension our .prettierrc file) overrides all configuration above it
|
||
// https://www.npmjs.com/package/eslint-plugin-prettier#recommended-configuration
|
||
"plugin:prettier/recommended"
|
||
],
|
||
"parserOptions": {
|
||
"ecmaVersion": 2020, // Allows for the parsing of modern ECMAScript features
|
||
"sourceType": "module", // Allows for the use of imports
|
||
"ecmaFeatures": {
|
||
"jsx": true // Allows for the parsing of JSX
|
||
}
|
||
},
|
||
"rules": {
|
||
"@typescript-eslint/no-explicit-any": "off",
|
||
"@typescript-eslint/no-use-before-define": "off",
|
||
"@typescript-eslint/no-var-requires": "off",
|
||
"import/no-webpack-loader-syntax": "off",
|
||
"no-undef": "off",
|
||
"react/prop-types": "off",
|
||
"react/display-name": "off",
|
||
"@typescript-eslint/explicit-module-boundary-types": "off",
|
||
"cypress/no-unnecessary-waiting": "off",
|
||
"cypress/no-assigning-return-values": "off",
|
||
"@typescript-eslint/no-unused-vars": "error",
|
||
"jest/no-focused-tests": "error",
|
||
"jest/no-disabled-tests": "error",
|
||
// enforce `import type` for all type-only imports so the bundler knows to erase them
|
||
"@typescript-eslint/consistent-type-imports": "error",
|
||
"react-hooks/rules-of-hooks": "error",
|
||
"react/jsx-boolean-value": "error",
|
||
"react/self-closing-comp": "error",
|
||
"react/jsx-sort-props": "error",
|
||
"react/jsx-fragments": "error",
|
||
"react/jsx-no-useless-fragment": "error",
|
||
"sort-destructure-keys/sort-destructure-keys": [
|
||
"error",
|
||
{ "caseSensitive": false }
|
||
],
|
||
"no-console": "warn",
|
||
"no-debugger": "warn",
|
||
"@typescript-eslint/no-restricted-imports": [
|
||
"error",
|
||
{
|
||
"patterns": [
|
||
{
|
||
"group": ["@blueprintjs/core/lib/esnext/*"],
|
||
"message": "Reason: @blueprintjs/core has both lib/esnext and lib/esm directories which export the same components. To avoid duplicating components in the bundle, please import only from the lib/esm directory."
|
||
},
|
||
{
|
||
"group": ["*.svg"],
|
||
"importNames": ["ReactComponent"],
|
||
"message": "Reason: Please don’t import SVG icons statically. (They won’t always be needed, but they *will* always be present in the bundle and will increase the bundle size.) Instead, please either import them as SVG paths (e.g. import starIconUrl from './star.svg'), or use the importSvg wrapper from design-system-old (e.g. const StarIcon = importSvg(() => import('./star.svg')))."
|
||
},
|
||
{
|
||
"group": ["remixicon-react/*"],
|
||
"message": "Reason: Please don’t import Remix icons statically. (They won’t always be needed, but they *will* always be present in the bundle and will increase the bundle size.) Instead, please use the importRemixIcon wrapper from design-system-old (e.g. const StarIcon = importRemixIcon(() => import('remixicon-react/Star')))."
|
||
}
|
||
]
|
||
}
|
||
]
|
||
},
|
||
"settings": {
|
||
"import/resolver": {
|
||
"babel-module": {}
|
||
},
|
||
"react": {
|
||
"pragma": "React",
|
||
// Tells eslint-plugin-react to automatically detect the version of React to use
|
||
"version": "detect"
|
||
}
|
||
},
|
||
"env": {
|
||
"browser": true,
|
||
"node": true,
|
||
"cypress/globals": true,
|
||
"worker": true
|
||
}
|
||
}
|