2022-03-13 17:21:04 +00:00
|
|
|
import 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 { ButtonVariant } from "components/constants";
|
|
|
|
|
import type { RenderMode } from "constants/WidgetConstants";
|
|
|
|
|
import { RenderModes } from "constants/WidgetConstants";
|
2022-03-13 17:21:04 +00:00
|
|
|
import { buttonHoverActiveStyles } from "./utils";
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
We have this Bug in Firefox where we are unable to drag
|
|
|
|
|
buttons - https://bugzilla.mozilla.org/show_bug.cgi?id=568313
|
|
|
|
|
|
|
|
|
|
We found a solution here - https://stackoverflow.com/a/43888410
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
We are adding a wrapper in Canvas mode to the Button and once
|
|
|
|
|
we deploy it we remove the wrapper altogether.
|
2022-05-03 05:25:31 +00:00
|
|
|
Because we are adding a wrapper we also need to duplicate any
|
2022-03-13 17:21:04 +00:00
|
|
|
:hover, :active & :focus styles and pass onClick to the wrapper.
|
2022-05-03 05:25:31 +00:00
|
|
|
We could have checked for firefox browser using window.navigator
|
2022-03-13 17:21:04 +00:00
|
|
|
but we wanted our widget to be pure and have similar experience
|
|
|
|
|
in all the Browsers.
|
|
|
|
|
*/
|
|
|
|
|
|
2022-04-04 10:42:51 +00:00
|
|
|
/*
|
|
|
|
|
For the Button Widget we don't remove the DragContainer
|
|
|
|
|
because of the Tooltip issue -
|
|
|
|
|
https://github.com/appsmithorg/appsmith/pull/12372
|
|
|
|
|
For this reason we pass the showInAllModes prop.
|
|
|
|
|
*/
|
|
|
|
|
|
2022-03-13 17:21:04 +00:00
|
|
|
export type ButtonContainerProps = {
|
|
|
|
|
buttonColor?: string;
|
|
|
|
|
buttonVariant?: ButtonVariant;
|
|
|
|
|
disabled?: boolean;
|
|
|
|
|
loading?: boolean;
|
|
|
|
|
style?: React.CSSProperties;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const ButtonContainer = styled.div<ButtonContainerProps>`
|
|
|
|
|
cursor: ${({ disabled }) => (disabled ? "not-allowed" : "pointer")};
|
|
|
|
|
height: 100%;
|
|
|
|
|
|
|
|
|
|
& > button {
|
|
|
|
|
width: 100%;
|
|
|
|
|
height: 100%;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
position: relative;
|
|
|
|
|
&:after {
|
|
|
|
|
content: "";
|
|
|
|
|
top: 0;
|
|
|
|
|
left: 0;
|
|
|
|
|
right: 0;
|
|
|
|
|
bottom: 0;
|
|
|
|
|
position: absolute;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
&:hover > button,
|
|
|
|
|
&:active > button {
|
|
|
|
|
${buttonHoverActiveStyles}
|
|
|
|
|
}
|
|
|
|
|
`;
|
|
|
|
|
|
|
|
|
|
type DragContainerProps = ButtonContainerProps & {
|
|
|
|
|
children?: React.ReactNode;
|
|
|
|
|
onClick?: (event: React.MouseEvent<HTMLElement, MouseEvent>) => void;
|
|
|
|
|
renderMode?: RenderMode;
|
2022-04-04 07:13:04 +00:00
|
|
|
showInAllModes?: boolean;
|
2022-03-13 17:21:04 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
export function DragContainer(props: DragContainerProps) {
|
2022-04-04 07:13:04 +00:00
|
|
|
if (props.renderMode === RenderModes.CANVAS || props.showInAllModes) {
|
2022-03-13 17:21:04 +00:00
|
|
|
return (
|
|
|
|
|
<ButtonContainer
|
|
|
|
|
buttonColor={props.buttonColor}
|
|
|
|
|
buttonVariant={props.buttonVariant}
|
|
|
|
|
disabled={props.disabled}
|
|
|
|
|
loading={props.loading}
|
2022-03-18 09:29:34 +00:00
|
|
|
onClick={(event) => {
|
|
|
|
|
if (props.disabled) return;
|
2022-05-03 05:25:31 +00:00
|
|
|
if (props.loading) return;
|
2022-03-18 09:29:34 +00:00
|
|
|
if (props.onClick) {
|
|
|
|
|
props.onClick(event);
|
|
|
|
|
}
|
|
|
|
|
}}
|
2022-03-13 17:21:04 +00:00
|
|
|
style={props.style}
|
|
|
|
|
>
|
|
|
|
|
{props.children}
|
|
|
|
|
</ButtonContainer>
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// eslint-disable-next-line react/jsx-no-useless-fragment
|
|
|
|
|
return <>{props.children}</>;
|
|
|
|
|
}
|