2023-04-26 07:18:16 +00:00
|
|
|
import type { AppState } from "@appsmith/reducers";
|
2023-03-04 07:25:54 +00:00
|
|
|
import { FLEXBOX_PADDING, GridDefaults } from "constants/WidgetConstants";
|
|
|
|
|
import { createSelector } from "reselect";
|
2023-05-11 04:45:14 +00:00
|
|
|
import { getCanvasAndMetaWidgets } from "sagas/selectors";
|
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 {
|
2023-03-04 07:25:54 +00:00
|
|
|
AlignmentColumnInfo,
|
|
|
|
|
FlexBoxAlignmentColumnInfo,
|
2023-10-02 19:41:05 +00:00
|
|
|
} from "layoutSystems/autolayout/utils/types";
|
2023-09-11 15:55:11 +00:00
|
|
|
import { getAlignmentColumnInfo } from "layoutSystems/autolayout/utils/AutoLayoutUtils";
|
2023-04-07 13:51:35 +00:00
|
|
|
import { getIsAutoLayoutMobileBreakPoint } from "./editorSelectors";
|
2023-10-02 19:41:05 +00:00
|
|
|
import type {
|
|
|
|
|
FlexLayer,
|
|
|
|
|
LayerChild,
|
|
|
|
|
} from "layoutSystems/autolayout/utils/types";
|
2023-04-07 13:51:35 +00:00
|
|
|
|
|
|
|
|
export const getIsCurrentlyConvertingLayout = (state: AppState) =>
|
|
|
|
|
state.ui.layoutConversion.isConverting;
|
2023-03-04 07:25:54 +00:00
|
|
|
|
|
|
|
|
export const getFlexLayers = (parentId: string) => {
|
2023-05-11 04:45:14 +00:00
|
|
|
return createSelector(getCanvasAndMetaWidgets, (widgets): FlexLayer[] => {
|
2023-03-04 07:25:54 +00:00
|
|
|
const parent = widgets[parentId];
|
|
|
|
|
if (!parent) return [];
|
|
|
|
|
return parent?.flexLayers || [];
|
|
|
|
|
});
|
|
|
|
|
};
|
|
|
|
|
|
2023-05-03 04:26:52 +00:00
|
|
|
export const getSnapshotUpdatedTime = (state: AppState) =>
|
|
|
|
|
state.ui.layoutConversion.snapshotDetails?.lastUpdatedTime;
|
|
|
|
|
|
2023-03-04 07:25:54 +00:00
|
|
|
export const getLayerIndex = (widgetId: string, parentId: string) => {
|
|
|
|
|
return createSelector(
|
|
|
|
|
getFlexLayers(parentId),
|
|
|
|
|
(layers: FlexLayer[]): number => {
|
|
|
|
|
if (!layers) return -1;
|
|
|
|
|
const selectedLayer = layers.find((layer: FlexLayer) =>
|
|
|
|
|
layer.children.some((child: LayerChild) => child.id === widgetId),
|
|
|
|
|
);
|
|
|
|
|
if (!selectedLayer) return -1;
|
|
|
|
|
return selectedLayer.children?.findIndex(
|
|
|
|
|
(child: LayerChild) => child.id === widgetId,
|
|
|
|
|
);
|
|
|
|
|
},
|
|
|
|
|
);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
export const isCurrentCanvasDragging = (widgetId: string) => {
|
|
|
|
|
return createSelector(
|
|
|
|
|
(state: AppState) => state.ui.widgetDragResize.dragDetails,
|
|
|
|
|
(dragDetails): boolean => {
|
|
|
|
|
return dragDetails?.draggedOn === widgetId;
|
|
|
|
|
},
|
|
|
|
|
);
|
|
|
|
|
};
|
|
|
|
|
|
2023-04-07 13:51:35 +00:00
|
|
|
export const getTotalTopOffset = (widgetId: string) => {
|
|
|
|
|
return createSelector(
|
2023-05-11 04:45:14 +00:00
|
|
|
getCanvasAndMetaWidgets,
|
2023-04-07 13:51:35 +00:00
|
|
|
getIsAutoLayoutMobileBreakPoint,
|
|
|
|
|
(widgets, isMobile): number => {
|
|
|
|
|
let widget = widgets[widgetId];
|
|
|
|
|
if (!widget) return 0;
|
|
|
|
|
let offset = 0;
|
|
|
|
|
while (widget.parentId) {
|
|
|
|
|
const parent = widgets[widget.parentId];
|
|
|
|
|
const top =
|
|
|
|
|
isMobile && parent.mobileTopRow !== undefined
|
|
|
|
|
? parent.mobileTopRow
|
|
|
|
|
: parent.topRow;
|
|
|
|
|
offset += top * GridDefaults.DEFAULT_GRID_ROW_HEIGHT + FLEXBOX_PADDING;
|
2023-04-26 17:39:11 +00:00
|
|
|
if (parent.type === "TABS_WIDGET" && parent?.shouldShowTabs)
|
|
|
|
|
offset += GridDefaults.DEFAULT_GRID_ROW_HEIGHT * 4; // 4 rows for tabs header
|
2023-04-07 13:51:35 +00:00
|
|
|
widget = parent;
|
|
|
|
|
}
|
|
|
|
|
return offset;
|
|
|
|
|
},
|
|
|
|
|
);
|
|
|
|
|
};
|
|
|
|
|
|
2023-03-04 07:25:54 +00:00
|
|
|
export const getParentOffsetTop = (widgetId: string) =>
|
2023-04-07 13:51:35 +00:00
|
|
|
createSelector(
|
2023-05-11 04:45:14 +00:00
|
|
|
getCanvasAndMetaWidgets,
|
2023-04-07 13:51:35 +00:00
|
|
|
getIsAutoLayoutMobileBreakPoint,
|
|
|
|
|
(widgets, isMobile): number => {
|
|
|
|
|
const widget = widgets[widgetId];
|
|
|
|
|
if (!widget || !widget.parentId) return 0;
|
|
|
|
|
const parent = widgets[widget.parentId];
|
|
|
|
|
const top =
|
|
|
|
|
isMobile && parent.mobileTopRow !== undefined
|
|
|
|
|
? parent.mobileTopRow
|
|
|
|
|
: parent.topRow;
|
|
|
|
|
return top * GridDefaults.DEFAULT_GRID_ROW_HEIGHT + FLEXBOX_PADDING;
|
|
|
|
|
},
|
|
|
|
|
);
|
|
|
|
|
|
2023-03-04 07:25:54 +00:00
|
|
|
export const getAlignmentColumns = (widgetId: string, layerIndex: number) =>
|
|
|
|
|
createSelector(
|
2023-05-11 04:45:14 +00:00
|
|
|
getCanvasAndMetaWidgets,
|
2023-04-07 13:51:35 +00:00
|
|
|
getIsAutoLayoutMobileBreakPoint,
|
2023-03-04 07:25:54 +00:00
|
|
|
getFlexLayers(widgetId),
|
|
|
|
|
(widgets, isMobile, flexLayers): AlignmentColumnInfo => {
|
|
|
|
|
const layer: FlexLayer = flexLayers[layerIndex];
|
|
|
|
|
return getAlignmentColumnInfo(widgets, layer, isMobile);
|
|
|
|
|
},
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
export const getColumnsForAllLayers = (widgetId: string) =>
|
|
|
|
|
createSelector(
|
2023-05-11 04:45:14 +00:00
|
|
|
getCanvasAndMetaWidgets,
|
2023-04-07 13:51:35 +00:00
|
|
|
getIsAutoLayoutMobileBreakPoint,
|
2023-03-04 07:25:54 +00:00
|
|
|
getFlexLayers(widgetId),
|
|
|
|
|
(widgets, isMobile, flexLayers): FlexBoxAlignmentColumnInfo => {
|
|
|
|
|
const res: { [key: number]: AlignmentColumnInfo } = {};
|
|
|
|
|
if (!flexLayers || !flexLayers.length) return res;
|
|
|
|
|
for (const [index, layer] of flexLayers.entries()) {
|
|
|
|
|
const info = getAlignmentColumnInfo(widgets, layer, isMobile);
|
|
|
|
|
res[index] = info;
|
|
|
|
|
}
|
|
|
|
|
return res;
|
|
|
|
|
},
|
|
|
|
|
);
|