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
|
|
|
import type { ReduxAction } from "@appsmith/constants/ReduxActionConstants";
|
|
|
|
|
import type { AppState } from "@appsmith/reducers";
|
2022-10-17 15:16:38 +00:00
|
|
|
import {
|
|
|
|
|
setApiPaneConfigSelectedTabIndex,
|
2022-11-25 03:47:00 +00:00
|
|
|
setApiRightPaneSelectedTab,
|
2022-10-17 15:16:38 +00:00
|
|
|
} from "actions/apiPaneActions";
|
2023-03-04 07:25:54 +00:00
|
|
|
import {
|
|
|
|
|
setAllEntityCollapsibleStates,
|
|
|
|
|
setAllSubEntityCollapsibleStates,
|
|
|
|
|
setCodeEditorHistory,
|
|
|
|
|
setExplorerSwitchIndex,
|
|
|
|
|
setFocusableInputField,
|
|
|
|
|
setPanelPropertiesState,
|
|
|
|
|
setWidgetSelectedPropertyTabIndex,
|
|
|
|
|
} from "actions/editorContextActions";
|
|
|
|
|
import {
|
|
|
|
|
getApiPaneConfigSelectedTabIndex,
|
|
|
|
|
getApiRightPaneSelectedTab,
|
|
|
|
|
} from "selectors/apiPaneSelectors";
|
2022-10-17 15:16:38 +00:00
|
|
|
import {
|
2022-12-08 07:21:58 +00:00
|
|
|
getAllEntityCollapsibleStates,
|
2022-10-17 15:16:38 +00:00
|
|
|
getAllPropertySectionState,
|
2022-12-08 07:21:58 +00:00
|
|
|
getAllSubEntityCollapsibleStates,
|
|
|
|
|
getCodeEditorHistory,
|
2023-02-03 08:47:01 +00:00
|
|
|
getExplorerSwitchIndex,
|
2022-12-15 14:15:46 +00:00
|
|
|
getFocusableInputField,
|
2023-01-28 02:17:06 +00:00
|
|
|
getPropertyPanelState,
|
2022-12-08 07:21:58 +00:00
|
|
|
getWidgetSelectedPropertyTabIndex,
|
2022-10-17 15:16:38 +00:00
|
|
|
} from "selectors/editorContextSelectors";
|
2022-12-05 05:58:17 +00:00
|
|
|
import {
|
|
|
|
|
getAllDatasourceCollapsibleState,
|
|
|
|
|
getSelectedWidgets,
|
|
|
|
|
isDatasourceInViewMode,
|
|
|
|
|
} from "selectors/ui";
|
2022-10-17 15:16:38 +00:00
|
|
|
|
|
|
|
|
import {
|
2023-03-04 07:25:54 +00:00
|
|
|
setAllDatasourceCollapsible,
|
|
|
|
|
setDatasourceViewMode,
|
|
|
|
|
} from "actions/datasourceActions";
|
|
|
|
|
import { updateExplorerWidthAction } from "actions/explorerActions";
|
2023-04-10 12:59:14 +00:00
|
|
|
import { setJsPaneConfigSelectedTabIndex } from "actions/jsPaneActions";
|
2023-03-04 07:25:54 +00:00
|
|
|
import {
|
|
|
|
|
setAllPropertySectionState,
|
|
|
|
|
setFocusablePropertyPaneField,
|
|
|
|
|
setPropertyPaneWidthAction,
|
|
|
|
|
setSelectedPropertyPanels,
|
|
|
|
|
} from "actions/propertyPaneActions";
|
2023-04-10 12:59:14 +00:00
|
|
|
import { setQueryPaneConfigSelectedTabIndex } from "actions/queryPaneActions";
|
2023-03-04 07:25:54 +00:00
|
|
|
import { selectWidgetInitAction } from "actions/widgetSelectionActions";
|
|
|
|
|
import {
|
|
|
|
|
DEFAULT_ENTITY_EXPLORER_WIDTH,
|
|
|
|
|
DEFAULT_PROPERTY_PANE_WIDTH,
|
|
|
|
|
} from "constants/AppConstants";
|
|
|
|
|
import { PluginPackageName } from "entities/Action";
|
|
|
|
|
import { FocusEntity } from "navigation/FocusEntity";
|
|
|
|
|
import { SelectionRequestType } from "sagas/WidgetSelectUtils";
|
|
|
|
|
import { getExplorerWidth } from "selectors/explorerSelector";
|
2023-04-10 12:59:14 +00:00
|
|
|
import { getJSPaneConfigSelectedTabIndex } from "selectors/jsPaneSelectors";
|
2022-12-08 07:21:58 +00:00
|
|
|
import {
|
2023-01-28 02:17:06 +00:00
|
|
|
getFocusablePropertyPaneField,
|
2022-12-08 07:21:58 +00:00
|
|
|
getPropertyPaneWidth,
|
|
|
|
|
getSelectedPropertyPanel,
|
|
|
|
|
} from "selectors/propertyPaneSelectors";
|
2023-04-10 12:59:14 +00:00
|
|
|
import { getQueryPaneConfigSelectedTabIndex } from "selectors/queryPaneSelectors";
|
|
|
|
|
import { getDebuggerContext } from "selectors/debuggerSelectors";
|
|
|
|
|
import { setDebuggerContext } from "actions/debuggerActions";
|
|
|
|
|
import { DefaultDebuggerContext } from "reducers/uiReducers/debuggerReducer";
|
2023-04-10 07:25:14 +00:00
|
|
|
import { NavigationMethod } from "../utils/history";
|
2022-10-17 15:16:38 +00:00
|
|
|
|
|
|
|
|
export enum FocusElement {
|
|
|
|
|
ApiPaneConfigTabs = "ApiPaneConfigTabs",
|
2022-12-08 07:21:58 +00:00
|
|
|
CodeEditorHistory = "CodeEditorHistory",
|
|
|
|
|
EntityCollapsibleState = "EntityCollapsibleState",
|
|
|
|
|
EntityExplorerWidth = "EntityExplorerWidth",
|
|
|
|
|
ExplorerSwitchIndex = "ExplorerSwitchIndex",
|
2022-12-02 03:06:22 +00:00
|
|
|
DatasourceViewMode = "DatasourceViewMode",
|
2022-12-05 05:58:17 +00:00
|
|
|
DatasourceAccordions = "DatasourceAccordions",
|
2023-04-10 12:59:14 +00:00
|
|
|
DebuggerContext = "DebuggerContext",
|
2022-11-25 03:47:00 +00:00
|
|
|
ApiRightPaneTabs = "ApiRightPaneTabs",
|
2022-10-17 15:16:38 +00:00
|
|
|
QueryPaneConfigTabs = "QueryPaneConfigTabs",
|
|
|
|
|
JSPaneConfigTabs = "JSPaneConfigTabs",
|
|
|
|
|
PropertySections = "PropertySections",
|
2022-12-16 17:22:47 +00:00
|
|
|
PropertyField = "PropertyField",
|
2022-10-17 15:16:38 +00:00
|
|
|
PropertyTabs = "PropertyTabs",
|
2022-12-08 07:21:58 +00:00
|
|
|
PropertyPanelContext = "PropertyPanelContext",
|
|
|
|
|
PropertyPaneWidth = "PropertyPaneWidth",
|
|
|
|
|
SelectedPropertyPanel = "SelectedPropertyPanel",
|
2022-10-17 15:16:38 +00:00
|
|
|
SelectedWidgets = "SelectedWidgets",
|
2022-12-08 07:21:58 +00:00
|
|
|
SubEntityCollapsibleState = "SubEntityCollapsibleState",
|
2022-12-15 14:15:46 +00:00
|
|
|
InputField = "InputField",
|
2022-10-17 15:16:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
type Config = {
|
|
|
|
|
name: FocusElement;
|
|
|
|
|
selector: (state: AppState) => unknown;
|
|
|
|
|
setter: (payload: any) => ReduxAction<any>;
|
|
|
|
|
defaultValue?: unknown;
|
|
|
|
|
subTypes?: Record<string, { defaultValue: unknown }>;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
export const FocusElementsConfig: Record<FocusEntity, Config[]> = {
|
|
|
|
|
[FocusEntity.NONE]: [],
|
2022-12-08 07:21:58 +00:00
|
|
|
[FocusEntity.PAGE]: [
|
|
|
|
|
{
|
|
|
|
|
name: FocusElement.CodeEditorHistory,
|
|
|
|
|
selector: getCodeEditorHistory,
|
|
|
|
|
setter: setCodeEditorHistory,
|
|
|
|
|
defaultValue: {},
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
name: FocusElement.EntityExplorerWidth,
|
|
|
|
|
selector: getExplorerWidth,
|
|
|
|
|
setter: updateExplorerWidthAction,
|
|
|
|
|
defaultValue: DEFAULT_ENTITY_EXPLORER_WIDTH,
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
name: FocusElement.EntityCollapsibleState,
|
|
|
|
|
selector: getAllEntityCollapsibleStates,
|
|
|
|
|
setter: setAllEntityCollapsibleStates,
|
|
|
|
|
defaultValue: {},
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
name: FocusElement.SubEntityCollapsibleState,
|
|
|
|
|
selector: getAllSubEntityCollapsibleStates,
|
|
|
|
|
setter: setAllSubEntityCollapsibleStates,
|
|
|
|
|
defaultValue: {},
|
|
|
|
|
},
|
2023-02-03 08:47:01 +00:00
|
|
|
{
|
|
|
|
|
name: FocusElement.ExplorerSwitchIndex,
|
|
|
|
|
selector: getExplorerSwitchIndex,
|
|
|
|
|
setter: setExplorerSwitchIndex,
|
|
|
|
|
defaultValue: 0,
|
|
|
|
|
},
|
2022-12-08 07:21:58 +00:00
|
|
|
{
|
|
|
|
|
name: FocusElement.PropertyPanelContext,
|
|
|
|
|
selector: getPropertyPanelState,
|
|
|
|
|
setter: setPanelPropertiesState,
|
|
|
|
|
defaultValue: {},
|
|
|
|
|
},
|
|
|
|
|
],
|
2022-10-17 15:16:38 +00:00
|
|
|
[FocusEntity.CANVAS]: [
|
|
|
|
|
{
|
|
|
|
|
name: FocusElement.PropertySections,
|
|
|
|
|
selector: getAllPropertySectionState,
|
|
|
|
|
setter: setAllPropertySectionState,
|
|
|
|
|
defaultValue: {},
|
|
|
|
|
},
|
2022-12-08 07:21:58 +00:00
|
|
|
{
|
|
|
|
|
name: FocusElement.SelectedPropertyPanel,
|
|
|
|
|
selector: getSelectedPropertyPanel,
|
|
|
|
|
setter: setSelectedPropertyPanels,
|
|
|
|
|
defaultValue: {},
|
|
|
|
|
},
|
2022-10-17 15:16:38 +00:00
|
|
|
{
|
|
|
|
|
name: FocusElement.SelectedWidgets,
|
|
|
|
|
selector: getSelectedWidgets,
|
2023-01-28 02:17:06 +00:00
|
|
|
setter: (widgetIds: string[]) =>
|
2023-04-10 07:25:14 +00:00
|
|
|
selectWidgetInitAction(
|
|
|
|
|
SelectionRequestType.Multiple,
|
|
|
|
|
widgetIds,
|
|
|
|
|
NavigationMethod.ContextSwitching,
|
|
|
|
|
),
|
2022-10-17 15:16:38 +00:00
|
|
|
defaultValue: [],
|
|
|
|
|
},
|
2022-12-08 07:21:58 +00:00
|
|
|
{
|
|
|
|
|
name: FocusElement.PropertyPaneWidth,
|
|
|
|
|
selector: getPropertyPaneWidth,
|
|
|
|
|
setter: setPropertyPaneWidthAction,
|
|
|
|
|
defaultValue: DEFAULT_PROPERTY_PANE_WIDTH,
|
|
|
|
|
},
|
2022-10-17 15:16:38 +00:00
|
|
|
],
|
2022-12-02 03:06:22 +00:00
|
|
|
[FocusEntity.DATASOURCE]: [
|
|
|
|
|
{
|
|
|
|
|
name: FocusElement.DatasourceViewMode,
|
|
|
|
|
selector: isDatasourceInViewMode,
|
|
|
|
|
setter: setDatasourceViewMode,
|
|
|
|
|
defaultValue: true,
|
|
|
|
|
},
|
2022-12-05 05:58:17 +00:00
|
|
|
{
|
|
|
|
|
name: FocusElement.DatasourceAccordions,
|
|
|
|
|
selector: getAllDatasourceCollapsibleState,
|
|
|
|
|
setter: setAllDatasourceCollapsible,
|
|
|
|
|
},
|
2022-12-02 03:06:22 +00:00
|
|
|
],
|
2022-10-17 15:16:38 +00:00
|
|
|
[FocusEntity.JS_OBJECT]: [
|
|
|
|
|
{
|
2022-12-15 14:15:46 +00:00
|
|
|
name: FocusElement.InputField,
|
|
|
|
|
selector: getFocusableInputField,
|
|
|
|
|
setter: setFocusableInputField,
|
2022-10-17 15:16:38 +00:00
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
name: FocusElement.JSPaneConfigTabs,
|
|
|
|
|
selector: getJSPaneConfigSelectedTabIndex,
|
|
|
|
|
setter: setJsPaneConfigSelectedTabIndex,
|
|
|
|
|
defaultValue: 0,
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
[FocusEntity.QUERY]: [
|
|
|
|
|
{
|
2022-12-15 14:15:46 +00:00
|
|
|
name: FocusElement.InputField,
|
|
|
|
|
selector: getFocusableInputField,
|
|
|
|
|
setter: setFocusableInputField,
|
2022-10-17 15:16:38 +00:00
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
name: FocusElement.QueryPaneConfigTabs,
|
|
|
|
|
selector: getQueryPaneConfigSelectedTabIndex,
|
|
|
|
|
setter: setQueryPaneConfigSelectedTabIndex,
|
|
|
|
|
defaultValue: 0,
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
[FocusEntity.PROPERTY_PANE]: [
|
|
|
|
|
{
|
|
|
|
|
name: FocusElement.PropertyTabs,
|
2022-12-08 07:21:58 +00:00
|
|
|
selector: getWidgetSelectedPropertyTabIndex,
|
|
|
|
|
setter: setWidgetSelectedPropertyTabIndex,
|
2022-10-17 15:16:38 +00:00
|
|
|
defaultValue: 0,
|
|
|
|
|
},
|
|
|
|
|
{
|
2022-12-16 17:22:47 +00:00
|
|
|
name: FocusElement.PropertyField,
|
|
|
|
|
selector: getFocusablePropertyPaneField,
|
|
|
|
|
setter: setFocusablePropertyPaneField,
|
2022-12-11 14:42:32 +00:00
|
|
|
defaultValue: "",
|
2022-10-17 15:16:38 +00:00
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
[FocusEntity.API]: [
|
|
|
|
|
{
|
|
|
|
|
name: FocusElement.ApiPaneConfigTabs,
|
|
|
|
|
selector: getApiPaneConfigSelectedTabIndex,
|
|
|
|
|
setter: setApiPaneConfigSelectedTabIndex,
|
|
|
|
|
defaultValue: 0,
|
|
|
|
|
subTypes: {
|
|
|
|
|
[PluginPackageName.GRAPHQL]: {
|
|
|
|
|
defaultValue: 2,
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
},
|
2022-12-15 14:15:46 +00:00
|
|
|
{
|
|
|
|
|
name: FocusElement.InputField,
|
|
|
|
|
selector: getFocusableInputField,
|
|
|
|
|
setter: setFocusableInputField,
|
|
|
|
|
},
|
2022-11-25 03:47:00 +00:00
|
|
|
{
|
|
|
|
|
name: FocusElement.ApiRightPaneTabs,
|
|
|
|
|
selector: getApiRightPaneSelectedTab,
|
|
|
|
|
setter: setApiRightPaneSelectedTab,
|
|
|
|
|
},
|
2022-10-17 15:16:38 +00:00
|
|
|
],
|
2023-04-10 12:59:14 +00:00
|
|
|
[FocusEntity.DEBUGGER]: [
|
|
|
|
|
{
|
|
|
|
|
name: FocusElement.DebuggerContext,
|
|
|
|
|
selector: getDebuggerContext,
|
|
|
|
|
setter: setDebuggerContext,
|
|
|
|
|
defaultValue: DefaultDebuggerContext,
|
|
|
|
|
},
|
|
|
|
|
],
|
2022-10-17 15:16:38 +00:00
|
|
|
};
|