2023-05-19 18:37:06 +00:00
|
|
|
import * as React from "react";
|
|
|
|
|
import styled from "styled-components";
|
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 { TextInputProps } from "design-system-old";
|
2023-05-19 18:37:06 +00:00
|
|
|
import type { ContainerOrientation } from "constants/WidgetConstants";
|
|
|
|
|
import { Input, Icon } from "design-system";
|
2022-07-14 05:00:30 +00:00
|
|
|
import useInteractionAnalyticsEvent from "utils/hooks/useInteractionAnalyticsEvent";
|
Property Pane Controls
- Fixes #121, #122, #123, #124, #90, #46, #65, #100, #101, #68, #102
2019-10-24 05:24:45 +00:00
|
|
|
|
2023-10-11 07:35:24 +00:00
|
|
|
interface ControlWrapperProps {
|
2019-11-05 05:09:50 +00:00
|
|
|
orientation?: ContainerOrientation;
|
2020-06-19 07:30:11 +00:00
|
|
|
isAction?: boolean;
|
2023-10-11 07:35:24 +00:00
|
|
|
}
|
2019-11-05 05:09:50 +00:00
|
|
|
|
|
|
|
|
export const ControlWrapper = styled.div<ControlWrapperProps>`
|
2020-12-24 04:32:25 +00:00
|
|
|
display: ${(props) =>
|
|
|
|
|
props.orientation === "HORIZONTAL" ? "flex" : "block"};
|
2019-11-07 10:33:04 +00:00
|
|
|
justify-content: space-between;
|
2020-02-26 12:44:56 +00:00
|
|
|
align-items: center;
|
2020-12-24 04:32:25 +00:00
|
|
|
flex-direction: ${(props) =>
|
2020-06-10 13:41:26 +00:00
|
|
|
props.orientation === "VERTICAL" ? "column" : "row"};
|
2022-09-05 04:52:39 +00:00
|
|
|
padding-top: 4px;
|
|
|
|
|
&:not(:last-of-type) {
|
|
|
|
|
padding-bottom: 4px;
|
|
|
|
|
}
|
Property Pane Controls
- Fixes #121, #122, #123, #124, #90, #46, #65, #100, #101, #68, #102
2019-10-24 05:24:45 +00:00
|
|
|
& > label {
|
2020-12-24 04:32:25 +00:00
|
|
|
margin-bottom: ${(props) => props.theme.spaces[1]}px;
|
Property Pane Controls
- Fixes #121, #122, #123, #124, #90, #46, #65, #100, #101, #68, #102
2019-10-24 05:24:45 +00:00
|
|
|
}
|
2019-10-24 11:47:35 +00:00
|
|
|
&&& > label:first-of-type {
|
|
|
|
|
display: block;
|
|
|
|
|
}
|
|
|
|
|
&&& > label {
|
|
|
|
|
display: inline-block;
|
2020-06-10 13:41:26 +00:00
|
|
|
}
|
2022-05-04 09:45:57 +00:00
|
|
|
&:focus-within .reset-button {
|
|
|
|
|
display: block;
|
|
|
|
|
}
|
Property Pane Controls
- Fixes #121, #122, #123, #124, #90, #46, #65, #100, #101, #68, #102
2019-10-24 05:24:45 +00:00
|
|
|
`;
|
|
|
|
|
|
2019-12-06 13:16:08 +00:00
|
|
|
export const StyledDynamicInput = styled.div`
|
2020-04-15 11:42:11 +00:00
|
|
|
width: 100%;
|
2019-12-06 13:16:08 +00:00
|
|
|
&&& {
|
|
|
|
|
input {
|
|
|
|
|
border: none;
|
2020-12-24 04:32:25 +00:00
|
|
|
color: ${(props) => props.theme.colors.textOnDarkBG};
|
|
|
|
|
background: ${(props) => props.theme.colors.paneInputBG};
|
2019-12-06 13:16:08 +00:00
|
|
|
&:focus {
|
|
|
|
|
border: none;
|
2020-12-24 04:32:25 +00:00
|
|
|
color: ${(props) => props.theme.colors.textOnDarkBG};
|
|
|
|
|
background: ${(props) => props.theme.colors.paneInputBG};
|
2019-12-06 13:16:08 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
`;
|
|
|
|
|
|
2020-05-22 05:15:41 +00:00
|
|
|
export const FieldWrapper = styled.div`
|
|
|
|
|
position: relative;
|
|
|
|
|
width: 100%;
|
|
|
|
|
`;
|
2021-02-16 10:29:08 +00:00
|
|
|
|
2023-05-19 18:37:06 +00:00
|
|
|
export const StyledIcon = styled(Icon)`
|
2021-02-16 10:29:08 +00:00
|
|
|
padding: 0;
|
|
|
|
|
position: absolute;
|
|
|
|
|
margin-right: 15px;
|
|
|
|
|
cursor: move;
|
|
|
|
|
z-index: 1;
|
|
|
|
|
left: 4px;
|
2023-05-19 18:37:06 +00:00
|
|
|
top: 50%;
|
|
|
|
|
transform: translateY(-50%);
|
2021-11-02 04:33:21 +00:00
|
|
|
`;
|
2022-07-14 07:02:35 +00:00
|
|
|
|
|
|
|
|
/* Used in Draggable List Card component in Property pane */
|
|
|
|
|
export const StyledActionContainer = styled.div`
|
|
|
|
|
position: absolute;
|
|
|
|
|
right: 0px;
|
|
|
|
|
margin-right: 10px;
|
|
|
|
|
display: flex;
|
2022-09-16 04:30:16 +00:00
|
|
|
`;
|
|
|
|
|
|
|
|
|
|
export const StyledNavigateToFieldWrapper = styled.div`
|
|
|
|
|
display: flex;
|
|
|
|
|
justify-content: space-between;
|
|
|
|
|
height: auto;
|
|
|
|
|
`;
|
|
|
|
|
|
|
|
|
|
export const StyledDividerContainer = styled.div`
|
|
|
|
|
width: 1%;
|
|
|
|
|
margin-top: 9px;
|
|
|
|
|
`;
|
|
|
|
|
|
|
|
|
|
export const StyledNavigateToFieldsContainer = styled.div`
|
|
|
|
|
width: 95%;
|
2022-07-14 07:02:35 +00:00
|
|
|
`;
|
2023-05-19 18:37:06 +00:00
|
|
|
|
|
|
|
|
export const InputGroup = React.forwardRef((props: TextInputProps, ref) => {
|
|
|
|
|
let inputRef = React.useRef<HTMLInputElement>(null);
|
|
|
|
|
const wrapperRef = React.useRef<HTMLInputElement>(null);
|
|
|
|
|
const { dispatchInteractionAnalyticsEvent } =
|
|
|
|
|
useInteractionAnalyticsEvent<HTMLInputElement>(false, wrapperRef);
|
|
|
|
|
|
|
|
|
|
if (ref) inputRef = ref as React.RefObject<HTMLInputElement>;
|
|
|
|
|
|
|
|
|
|
React.useEffect(() => {
|
|
|
|
|
window.addEventListener("keydown", handleKeydown);
|
|
|
|
|
return () => {
|
|
|
|
|
window.removeEventListener("keydown", handleKeydown);
|
|
|
|
|
};
|
|
|
|
|
}, []);
|
|
|
|
|
|
|
|
|
|
const handleKeydown = (e: KeyboardEvent) => {
|
|
|
|
|
switch (e.key) {
|
|
|
|
|
case "Enter":
|
|
|
|
|
case " ":
|
|
|
|
|
if (document.activeElement === wrapperRef?.current) {
|
|
|
|
|
dispatchInteractionAnalyticsEvent({ key: e.key });
|
|
|
|
|
inputRef?.current?.focus();
|
|
|
|
|
e.preventDefault();
|
|
|
|
|
}
|
|
|
|
|
break;
|
|
|
|
|
case "Escape":
|
|
|
|
|
if (document.activeElement === inputRef?.current) {
|
|
|
|
|
dispatchInteractionAnalyticsEvent({ key: e.key });
|
|
|
|
|
wrapperRef?.current?.focus();
|
|
|
|
|
e.preventDefault();
|
|
|
|
|
}
|
|
|
|
|
break;
|
|
|
|
|
case "Tab":
|
|
|
|
|
if (document.activeElement === wrapperRef?.current) {
|
|
|
|
|
dispatchInteractionAnalyticsEvent({
|
|
|
|
|
key: `${e.shiftKey ? "Shift+" : ""}${e.key}`,
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
return (
|
|
|
|
|
<div className="w-full" ref={wrapperRef} tabIndex={0}>
|
|
|
|
|
<Input ref={inputRef} {...props} size="md" tabIndex={-1} />
|
|
|
|
|
</div>
|
|
|
|
|
);
|
|
|
|
|
});
|