2020-01-23 07:53:36 +00:00
|
|
|
import React from "react";
|
2023-01-13 11:05:59 +00:00
|
|
|
import styled from "styled-components";
|
2020-01-23 07:53:36 +00:00
|
|
|
|
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";
|
2020-01-23 07:53:36 +00:00
|
|
|
import { generateReactKey } from "utils/generators";
|
2020-02-18 10:41:52 +00:00
|
|
|
import { InputText } from "components/propertyControls/InputTextControl";
|
2022-09-16 04:30:16 +00:00
|
|
|
import ActionCreator from "components/editorComponents/ActionCreator";
|
2023-05-19 18:37:06 +00:00
|
|
|
import { Button } from "design-system";
|
2022-09-16 04:30:16 +00:00
|
|
|
|
2020-01-23 07:53:36 +00:00
|
|
|
export interface ColumnAction {
|
2021-09-01 09:50:23 +00:00
|
|
|
label?: string;
|
2020-01-23 07:53:36 +00:00
|
|
|
id: string;
|
2020-02-18 10:41:52 +00:00
|
|
|
dynamicTrigger: string;
|
2020-01-23 07:53:36 +00:00
|
|
|
}
|
2023-05-19 18:37:06 +00:00
|
|
|
const StyledDeleteButton = styled(Button)`
|
2020-04-03 06:56:13 +00:00
|
|
|
padding: 5px 0px;
|
2020-01-23 07:53:36 +00:00
|
|
|
position: absolute;
|
2020-06-03 04:44:11 +00:00
|
|
|
right: 0px;
|
2020-01-23 07:53:36 +00:00
|
|
|
cursor: pointer;
|
2020-03-30 08:55:52 +00:00
|
|
|
top: 0px;
|
|
|
|
|
`;
|
|
|
|
|
|
2020-06-03 04:44:11 +00:00
|
|
|
const InputTextWrapper = styled.div`
|
|
|
|
|
margin-bottom: 8px;
|
|
|
|
|
width: calc(100% - 30px);
|
|
|
|
|
`;
|
|
|
|
|
|
2020-04-03 06:56:13 +00:00
|
|
|
const Wrapper = styled.div`
|
|
|
|
|
margin-bottom: 8px;
|
2020-01-23 07:53:36 +00:00
|
|
|
`;
|
|
|
|
|
|
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
|
|
|
class ColumnActionSelectorControl extends BaseControl<ColumnActionSelectorControlProps> {
|
2020-01-23 07:53:36 +00:00
|
|
|
render() {
|
2023-07-28 04:02:00 +00:00
|
|
|
const { propertyName, widgetProperties } = this.props;
|
2020-01-23 07:53:36 +00:00
|
|
|
return (
|
2021-04-28 10:28:39 +00:00
|
|
|
<>
|
2020-01-23 07:53:36 +00:00
|
|
|
{this.props.propertyValue &&
|
2020-02-18 10:41:52 +00:00
|
|
|
this.props.propertyValue.map((columnAction: ColumnAction) => {
|
|
|
|
|
return (
|
|
|
|
|
<div
|
|
|
|
|
key={columnAction.id}
|
|
|
|
|
style={{
|
|
|
|
|
position: "relative",
|
|
|
|
|
}}
|
|
|
|
|
>
|
2020-06-03 04:44:11 +00:00
|
|
|
<InputTextWrapper>
|
2020-04-03 06:56:13 +00:00
|
|
|
<InputText
|
2021-04-28 10:28:39 +00:00
|
|
|
evaluatedValue={columnAction.label}
|
2021-09-01 09:50:23 +00:00
|
|
|
label={columnAction.label || ""}
|
2020-04-03 06:56:13 +00:00
|
|
|
onChange={this.updateColumnActionLabel.bind(
|
|
|
|
|
this,
|
|
|
|
|
columnAction,
|
|
|
|
|
)}
|
2021-03-15 12:17:56 +00:00
|
|
|
theme={this.props.theme}
|
2021-09-01 09:50:23 +00:00
|
|
|
value={columnAction.label as string}
|
2020-04-03 06:56:13 +00:00
|
|
|
/>
|
2020-06-03 04:44:11 +00:00
|
|
|
</InputTextWrapper>
|
2020-04-03 06:56:13 +00:00
|
|
|
<Wrapper>
|
2020-04-20 05:42:46 +00:00
|
|
|
<ActionCreator
|
2023-04-06 16:49:12 +00:00
|
|
|
action={this.props.label}
|
|
|
|
|
additionalControlData={{}}
|
2020-04-03 06:56:13 +00:00
|
|
|
onValueChange={this.updateColumnActionFunction.bind(
|
|
|
|
|
this,
|
|
|
|
|
columnAction,
|
|
|
|
|
)}
|
2023-07-28 04:02:00 +00:00
|
|
|
propertyName={propertyName}
|
2021-04-28 10:28:39 +00:00
|
|
|
value={columnAction.dynamicTrigger}
|
2023-07-28 04:02:00 +00:00
|
|
|
widgetName={widgetProperties.widgetName}
|
|
|
|
|
widgetType={widgetProperties.type}
|
2020-04-03 06:56:13 +00:00
|
|
|
/>
|
|
|
|
|
</Wrapper>
|
2023-05-19 18:37:06 +00:00
|
|
|
<StyledDeleteButton
|
|
|
|
|
isIconButton
|
|
|
|
|
kind="tertiary"
|
2020-02-18 10:41:52 +00:00
|
|
|
onClick={this.removeColumnAction.bind(this, columnAction)}
|
2023-05-19 18:37:06 +00:00
|
|
|
size="sm"
|
|
|
|
|
startIcon="delete-bin-line"
|
2020-02-18 10:41:52 +00:00
|
|
|
/>
|
|
|
|
|
</div>
|
|
|
|
|
);
|
|
|
|
|
})}
|
2021-03-15 12:17:56 +00:00
|
|
|
|
2023-05-19 18:37:06 +00:00
|
|
|
<Button
|
|
|
|
|
kind="secondary"
|
2020-01-23 07:53:36 +00:00
|
|
|
onClick={this.addColumnAction}
|
2023-05-19 18:37:06 +00:00
|
|
|
size="md"
|
|
|
|
|
startIcon="plus"
|
|
|
|
|
>
|
|
|
|
|
New Button
|
|
|
|
|
</Button>
|
2021-04-28 10:28:39 +00:00
|
|
|
</>
|
2020-01-23 07:53:36 +00:00
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
2020-02-18 10:41:52 +00:00
|
|
|
updateColumnActionLabel = (
|
|
|
|
|
columnAction: ColumnAction,
|
|
|
|
|
newValue: React.ChangeEvent<HTMLTextAreaElement> | string,
|
|
|
|
|
) => {
|
|
|
|
|
let value = newValue;
|
|
|
|
|
if (typeof newValue !== "string") {
|
|
|
|
|
value = newValue.target.value;
|
2020-01-23 07:53:36 +00:00
|
|
|
}
|
2020-02-18 10:41:52 +00:00
|
|
|
const update = this.props.propertyValue.map((a: ColumnAction) => {
|
|
|
|
|
if (a.id === columnAction.id) return { ...a, label: value };
|
|
|
|
|
return a;
|
|
|
|
|
});
|
|
|
|
|
this.updateProperty(this.props.propertyName, update);
|
2020-01-23 07:53:36 +00:00
|
|
|
};
|
|
|
|
|
|
2020-02-18 10:41:52 +00:00
|
|
|
updateColumnActionFunction = (
|
|
|
|
|
columnAction: ColumnAction,
|
|
|
|
|
newValue: string,
|
|
|
|
|
) => {
|
|
|
|
|
const update = this.props.propertyValue.map((a: ColumnAction) => {
|
|
|
|
|
if (a.id === columnAction.id) return { ...a, dynamicTrigger: newValue };
|
|
|
|
|
return a;
|
|
|
|
|
});
|
|
|
|
|
this.updateProperty(this.props.propertyName, update);
|
2020-01-23 07:53:36 +00:00
|
|
|
};
|
|
|
|
|
|
2020-02-18 10:41:52 +00:00
|
|
|
removeColumnAction = (columnAction: ColumnAction) => {
|
|
|
|
|
const update = this.props.propertyValue.filter(
|
|
|
|
|
(a: ColumnAction) => a.id !== columnAction.id,
|
|
|
|
|
);
|
|
|
|
|
this.updateProperty(this.props.propertyName, update);
|
2020-01-23 07:53:36 +00:00
|
|
|
};
|
|
|
|
|
addColumnAction = () => {
|
|
|
|
|
const columnActions = this.props.propertyValue || [];
|
2020-02-18 10:41:52 +00:00
|
|
|
const update = columnActions.concat([
|
|
|
|
|
{
|
|
|
|
|
label: "Action",
|
|
|
|
|
id: generateReactKey(),
|
|
|
|
|
actionPayloads: [],
|
|
|
|
|
},
|
|
|
|
|
]);
|
2020-01-23 07:53:36 +00:00
|
|
|
|
2020-02-18 10:41:52 +00:00
|
|
|
this.updateProperty(this.props.propertyName, update);
|
2020-01-23 07:53:36 +00:00
|
|
|
};
|
|
|
|
|
|
2020-04-14 05:35:16 +00:00
|
|
|
static getControlType() {
|
2020-01-23 07:53:36 +00:00
|
|
|
return "COLUMN_ACTION_SELECTOR";
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export type ColumnActionSelectorControlProps = ControlProps;
|
|
|
|
|
|
2020-02-18 10:41:52 +00:00
|
|
|
export default ColumnActionSelectorControl;
|