2022-02-04 10:59:54 +00:00
|
|
|
import React from "react";
|
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 { ControlProps } from "./BaseControl";
|
|
|
|
|
import BaseControl from "./BaseControl";
|
2021-07-13 08:05:09 +00:00
|
|
|
import { generateReactKey } from "utils/generators";
|
2022-03-17 10:19:17 +00:00
|
|
|
import orderBy from "lodash/orderBy";
|
|
|
|
|
import isString from "lodash/isString";
|
|
|
|
|
import isUndefined from "lodash/isUndefined";
|
2022-12-08 07:21:58 +00:00
|
|
|
import { DraggableListControl } from "pages/Editor/PropertyPane/DraggableListControl";
|
2022-10-05 11:03:42 +00:00
|
|
|
import { DraggableListCard } from "components/propertyControls/DraggableListCard";
|
2024-08-09 14:20:29 +00:00
|
|
|
import { Button } from "@appsmith/ads";
|
2021-07-13 08:05:09 +00:00
|
|
|
|
2023-10-11 07:35:24 +00:00
|
|
|
interface State {
|
2022-02-04 10:59:54 +00:00
|
|
|
focusedIndex: number | null;
|
2023-10-11 07:35:24 +00:00
|
|
|
}
|
2021-07-13 08:05:09 +00:00
|
|
|
|
2022-02-04 10:59:54 +00:00
|
|
|
class MenuItemsControl extends BaseControl<ControlProps, State> {
|
|
|
|
|
constructor(props: ControlProps) {
|
|
|
|
|
super(props);
|
2021-07-13 08:05:09 +00:00
|
|
|
|
2022-02-04 10:59:54 +00:00
|
|
|
this.state = {
|
|
|
|
|
focusedIndex: null,
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
componentDidUpdate(prevProps: ControlProps): void {
|
|
|
|
|
//on adding a new column last column should get focused
|
|
|
|
|
if (
|
|
|
|
|
prevProps.propertyValue &&
|
|
|
|
|
this.props.propertyValue &&
|
|
|
|
|
Object.keys(prevProps.propertyValue).length + 1 ===
|
|
|
|
|
Object.keys(this.props.propertyValue).length
|
|
|
|
|
) {
|
|
|
|
|
this.updateFocus(Object.keys(this.props.propertyValue).length - 1, true);
|
|
|
|
|
}
|
|
|
|
|
}
|
2024-07-31 15:41:28 +00:00
|
|
|
// TODO: Fix this the next time the file is edited
|
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
2021-07-13 08:05:09 +00:00
|
|
|
updateItems = (items: Array<Record<string, any>>) => {
|
2024-07-31 15:41:28 +00:00
|
|
|
// TODO: Fix this the next time the file is edited
|
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
2022-03-17 10:19:17 +00:00
|
|
|
const menuItems = items.reduce((obj: any, each: any, index) => {
|
2021-07-13 08:05:09 +00:00
|
|
|
obj[each.id] = {
|
|
|
|
|
...each,
|
|
|
|
|
index,
|
|
|
|
|
};
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2021-07-13 08:05:09 +00:00
|
|
|
return obj;
|
|
|
|
|
}, {});
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2021-07-13 08:05:09 +00:00
|
|
|
this.updateProperty(this.props.propertyName, menuItems);
|
|
|
|
|
};
|
|
|
|
|
|
2022-03-17 10:19:17 +00:00
|
|
|
getMenuItems = () => {
|
2021-07-13 08:05:09 +00:00
|
|
|
const menuItems: Array<{
|
|
|
|
|
id: string;
|
|
|
|
|
label: string;
|
2022-03-17 10:19:17 +00:00
|
|
|
isDisabled: boolean;
|
|
|
|
|
isVisible: boolean;
|
|
|
|
|
widgetId: string;
|
|
|
|
|
}> =
|
|
|
|
|
isString(this.props.propertyValue) ||
|
|
|
|
|
isUndefined(this.props.propertyValue)
|
|
|
|
|
? []
|
|
|
|
|
: Object.values(this.props.propertyValue);
|
|
|
|
|
|
|
|
|
|
return orderBy(menuItems, ["index"], ["asc"]);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
onEdit = (index: number) => {
|
|
|
|
|
const menuItems = this.getMenuItems();
|
2021-07-13 08:05:09 +00:00
|
|
|
const targetMenuItem = menuItems[index];
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2021-07-13 08:05:09 +00:00
|
|
|
this.props.openNextPanel({
|
|
|
|
|
index,
|
|
|
|
|
...targetMenuItem,
|
|
|
|
|
propPaneId: this.props.widgetProperties.widgetId,
|
|
|
|
|
});
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
render() {
|
|
|
|
|
return (
|
2023-05-19 18:37:06 +00:00
|
|
|
<div className="flex flex-col gap-1">
|
2022-12-08 07:21:58 +00:00
|
|
|
<DraggableListControl
|
2021-07-13 08:05:09 +00:00
|
|
|
deleteOption={this.deleteOption}
|
2022-02-04 10:59:54 +00:00
|
|
|
fixedHeight={370}
|
|
|
|
|
focusedIndex={this.state.focusedIndex}
|
2021-07-13 08:05:09 +00:00
|
|
|
itemHeight={45}
|
2022-03-17 10:19:17 +00:00
|
|
|
items={this.getMenuItems()}
|
2021-07-13 08:05:09 +00:00
|
|
|
onEdit={this.onEdit}
|
2022-12-08 07:21:58 +00:00
|
|
|
propertyPath={this.props.dataTreePath}
|
2024-07-31 15:41:28 +00:00
|
|
|
// TODO: Fix this the next time the file is edited
|
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
2022-12-08 07:21:58 +00:00
|
|
|
renderComponent={(props: any) =>
|
2022-02-04 10:59:54 +00:00
|
|
|
DraggableListCard({
|
|
|
|
|
...props,
|
|
|
|
|
isDelete: true,
|
|
|
|
|
placeholder: "Menu item label",
|
|
|
|
|
})
|
|
|
|
|
}
|
2021-07-13 08:05:09 +00:00
|
|
|
toggleVisibility={this.toggleVisibility}
|
2022-02-04 10:59:54 +00:00
|
|
|
updateFocus={this.updateFocus}
|
2021-07-13 08:05:09 +00:00
|
|
|
updateItems={this.updateItems}
|
|
|
|
|
updateOption={this.updateOption}
|
|
|
|
|
/>
|
2023-05-19 18:37:06 +00:00
|
|
|
|
|
|
|
|
<Button
|
|
|
|
|
className="self-end t--add-menu-item-btn"
|
|
|
|
|
kind="tertiary"
|
|
|
|
|
onClick={this.addOption}
|
|
|
|
|
startIcon="plus"
|
|
|
|
|
>
|
|
|
|
|
Add new menu item
|
|
|
|
|
</Button>
|
|
|
|
|
</div>
|
2021-07-13 08:05:09 +00:00
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
toggleVisibility = (index: number) => {
|
2022-03-17 10:19:17 +00:00
|
|
|
const menuItems = this.getMenuItems();
|
2021-07-13 08:05:09 +00:00
|
|
|
const isVisible = menuItems[index].isVisible === true ? false : true;
|
|
|
|
|
const updatedMenuItems = menuItems.map((item, itemIndex) => {
|
|
|
|
|
if (index === itemIndex) {
|
|
|
|
|
return {
|
|
|
|
|
...item,
|
|
|
|
|
isVisible: isVisible,
|
|
|
|
|
};
|
|
|
|
|
}
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2021-07-13 08:05:09 +00:00
|
|
|
return item;
|
|
|
|
|
});
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2021-07-13 08:05:09 +00:00
|
|
|
this.updateProperty(this.props.propertyName, updatedMenuItems);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
deleteOption = (index: number) => {
|
2022-03-17 10:19:17 +00:00
|
|
|
const menuItemsArray = this.getMenuItems();
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2022-03-17 10:19:17 +00:00
|
|
|
if (menuItemsArray.length === 1) return;
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2024-07-31 15:41:28 +00:00
|
|
|
// TODO: Fix this the next time the file is edited
|
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
2022-03-17 13:28:56 +00:00
|
|
|
const updatedArray = menuItemsArray.filter((eachItem: any, i: number) => {
|
|
|
|
|
return i !== index;
|
|
|
|
|
});
|
|
|
|
|
const updatedObj = updatedArray.reduce(
|
2024-07-31 15:41:28 +00:00
|
|
|
// TODO: Fix this the next time the file is edited
|
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
2022-03-17 13:28:56 +00:00
|
|
|
(obj: any, each: any, index: number) => {
|
|
|
|
|
obj[each.id] = {
|
|
|
|
|
...each,
|
|
|
|
|
index,
|
|
|
|
|
};
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2022-03-17 13:28:56 +00:00
|
|
|
return obj;
|
|
|
|
|
},
|
|
|
|
|
{},
|
|
|
|
|
);
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2022-03-17 13:28:56 +00:00
|
|
|
this.updateProperty(this.props.propertyName, updatedObj);
|
2021-07-13 08:05:09 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
updateOption = (index: number, updatedLabel: string) => {
|
2022-03-17 10:19:17 +00:00
|
|
|
const menuItemsArray = this.getMenuItems();
|
2021-07-13 08:05:09 +00:00
|
|
|
const itemId = menuItemsArray[index].id;
|
2024-09-18 16:35:28 +00:00
|
|
|
|
2021-07-13 08:05:09 +00:00
|
|
|
this.updateProperty(
|
|
|
|
|
`${this.props.propertyName}.${itemId}.label`,
|
|
|
|
|
updatedLabel,
|
|
|
|
|
);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
addOption = () => {
|
2021-10-06 12:57:05 +00:00
|
|
|
let menuItems = this.props.propertyValue || [];
|
2022-03-17 10:19:17 +00:00
|
|
|
const menuItemsArray = this.getMenuItems();
|
2021-07-13 08:05:09 +00:00
|
|
|
const newMenuItemId = generateReactKey({ prefix: "menuItem" });
|
2024-04-18 09:03:37 +00:00
|
|
|
|
2021-07-13 08:05:09 +00:00
|
|
|
menuItems = {
|
|
|
|
|
...menuItems,
|
|
|
|
|
[newMenuItemId]: {
|
|
|
|
|
id: newMenuItemId,
|
2022-03-17 10:19:17 +00:00
|
|
|
index: menuItemsArray.length,
|
2024-04-18 09:03:37 +00:00
|
|
|
label: "Menu Item",
|
2021-07-13 08:05:09 +00:00
|
|
|
widgetId: generateReactKey(),
|
|
|
|
|
isDisabled: false,
|
|
|
|
|
isVisible: true,
|
|
|
|
|
},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
this.updateProperty(this.props.propertyName, menuItems);
|
|
|
|
|
};
|
|
|
|
|
|
2022-02-04 10:59:54 +00:00
|
|
|
updateFocus = (index: number, isFocused: boolean) => {
|
|
|
|
|
this.setState({ focusedIndex: isFocused ? index : null });
|
|
|
|
|
};
|
|
|
|
|
|
2021-07-13 08:05:09 +00:00
|
|
|
static getControlType() {
|
|
|
|
|
return "MENU_ITEMS";
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export default MenuItemsControl;
|