2023-05-11 05:26:03 +00:00
|
|
|
// This file is a base for all package-specific ESLint configurations
|
2020-12-10 05:22:19 +00:00
|
|
|
{
|
2023-05-11 05:26:03 +00:00
|
|
|
"$schema": "http://json.schemastore.org/eslintrc",
|
2023-03-03 06:47:35 +00:00
|
|
|
"root": true,
|
2020-12-10 05:22:19 +00:00
|
|
|
"parser": "@typescript-eslint/parser",
|
2023-05-11 05:26:03 +00:00
|
|
|
"plugins": [
|
|
|
|
|
"react",
|
|
|
|
|
"@typescript-eslint",
|
|
|
|
|
"prettier",
|
|
|
|
|
"react-hooks",
|
|
|
|
|
"sort-destructure-keys",
|
|
|
|
|
"cypress"
|
|
|
|
|
],
|
2020-12-10 05:22:19 +00:00
|
|
|
"extends": [
|
|
|
|
|
"plugin:react/recommended", // Uses the recommended rules from @eslint-plugin-react
|
|
|
|
|
"plugin:@typescript-eslint/recommended",
|
2020-12-24 04:32:25 +00:00
|
|
|
"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"
|
2020-12-10 05:22:19 +00:00
|
|
|
],
|
|
|
|
|
"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": {
|
2023-03-23 11:32:18 +00:00
|
|
|
"@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",
|
chore: upgrade to prettier v2 + enforce import types (#21013)Co-authored-by: Satish Gandham <hello@satishgandham.com> Co-authored-by: Satish Gandham <satish.iitg@gmail.com>
## Description
This PR upgrades Prettier to v2 + enforces TypeScript’s [`import
type`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html#type-only-imports-and-export)
syntax where applicable. It’s submitted as a separate PR so we can merge
it easily.
As a part of this PR, we reformat the codebase heavily:
- add `import type` everywhere where it’s required, and
- re-format the code to account for Prettier 2’s breaking changes:
https://prettier.io/blog/2020/03/21/2.0.0.html#breaking-changes
This PR is submitted against `release` to make sure all new code by team
members will adhere to new formatting standards, and we’ll have fewer
conflicts when merging `bundle-optimizations` into `release`. (I’ll
merge `release` back into `bundle-optimizations` once this PR is
merged.)
### Why is this needed?
This PR is needed because, for the Lodash optimization from
https://github.com/appsmithorg/appsmith/commit/7cbb12af886621256224be0c93e6a465dd710ad3,
we need to use `import type`. Otherwise, `babel-plugin-lodash` complains
that `LoDashStatic` is not a lodash function.
However, just using `import type` in the current codebase will give you
this:
<img width="962" alt="Screenshot 2023-03-08 at 17 45 59"
src="https://user-images.githubusercontent.com/2953267/223775744-407afa0c-e8b9-44a1-90f9-b879348da57f.png">
That’s because Prettier 1 can’t parse `import type` at all. To parse it,
we need to upgrade to Prettier 2.
### Why enforce `import type`?
Apart from just enabling `import type` support, this PR enforces
specifying `import type` everywhere it’s needed. (Developers will get
immediate TypeScript and ESLint errors when they forget to do so.)
I’m doing this because I believe `import type` improves DX and makes
refactorings easier.
Let’s say you had a few imports like below. Can you tell which of these
imports will increase the bundle size? (Tip: it’s not all of them!)
```ts
// app/client/src/workers/Linting/utils.ts
import { Position } from "codemirror";
import { LintError as JSHintError, LintOptions } from "jshint";
import { get, isEmpty, isNumber, keys, last, set } from "lodash";
```
It’s pretty hard, right?
What about now?
```ts
// app/client/src/workers/Linting/utils.ts
import type { Position } from "codemirror";
import type { LintError as JSHintError, LintOptions } from "jshint";
import { get, isEmpty, isNumber, keys, last, set } from "lodash";
```
Now, it’s clear that only `lodash` will be bundled.
This helps developers to see which imports are problematic, but it
_also_ helps with refactorings. Now, if you want to see where
`codemirror` is bundled, you can just grep for `import \{.*\} from
"codemirror"` – and you won’t get any type-only imports.
This also helps (some) bundlers. Upon transpiling, TypeScript erases
type-only imports completely. In some environment (not ours), this makes
the bundle smaller, as the bundler doesn’t need to bundle type-only
imports anymore.
## Type of change
- Chore (housekeeping or task changes that don't impact user perception)
## How Has This Been Tested?
This was tested to not break the build.
### 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
- [x] 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
- [x] 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:
- [ ] Test plan has been approved by relevant developers
- [ ] Test plan has been peer reviewed by QA
- [ ] Cypress test cases have been added and approved by either SDET or
manual QA
- [ ] Organized project review call with relevant stakeholders after
Round 1/2 of QA
- [ ] Added Test Plan Approved label after reveiwing all Cypress test
---------
Co-authored-by: Satish Gandham <hello@satishgandham.com>
Co-authored-by: Satish Gandham <satish.iitg@gmail.com>
2023-03-16 11:41:47 +00:00
|
|
|
// enforce `import type` for all type-only imports so the bundler knows to erase them
|
|
|
|
|
"@typescript-eslint/consistent-type-imports": "error",
|
2020-12-10 05:22:19 +00:00
|
|
|
"react-hooks/rules-of-hooks": "error",
|
2021-04-28 10:28:39 +00:00
|
|
|
"react/jsx-boolean-value": "error",
|
|
|
|
|
"react/self-closing-comp": "error",
|
|
|
|
|
"react/jsx-sort-props": "error",
|
|
|
|
|
"react/jsx-fragments": "error",
|
2021-05-04 14:15:29 +00:00
|
|
|
"react/jsx-no-useless-fragment": "error",
|
2023-05-11 05:26:03 +00:00
|
|
|
"sort-destructure-keys/sort-destructure-keys": [
|
|
|
|
|
"error",
|
|
|
|
|
{ "caseSensitive": false }
|
|
|
|
|
],
|
2021-11-25 10:52:40 +00:00
|
|
|
"no-console": "warn",
|
|
|
|
|
"no-debugger": "warn"
|
2020-12-10 05:22:19 +00:00
|
|
|
},
|
|
|
|
|
"settings": {
|
2021-11-05 05:49:19 +00:00
|
|
|
"import/resolver": {
|
|
|
|
|
"babel-module": {}
|
|
|
|
|
},
|
2020-12-10 05:22:19 +00:00
|
|
|
"react": {
|
|
|
|
|
"pragma": "React",
|
|
|
|
|
// Tells eslint-plugin-react to automatically detect the version of React to use
|
2021-01-04 10:16:08 +00:00
|
|
|
"version": "detect"
|
2020-12-10 05:22:19 +00:00
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"env": {
|
|
|
|
|
"browser": true,
|
|
|
|
|
"node": true,
|
2021-01-04 10:16:08 +00:00
|
|
|
"cypress/globals": true,
|
|
|
|
|
"worker": true
|
2020-12-10 05:22:19 +00:00
|
|
|
}
|
|
|
|
|
}
|