## 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
7cbb12af88,
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>
148 lines
4.1 KiB
TypeScript
148 lines
4.1 KiB
TypeScript
import type { ReactNode, RefObject } from "react";
|
|
import React, { useRef, useEffect } from "react";
|
|
import { Overlay, Classes } from "@blueprintjs/core";
|
|
import styled from "styled-components";
|
|
import { getCanvasClassName } from "utils/generators";
|
|
import { Layers } from "constants/Layers";
|
|
import {
|
|
MODAL_PORTAL_CLASSNAME,
|
|
MODAL_PORTAL_OVERLAY_CLASSNAME,
|
|
} from "constants/WidgetConstants";
|
|
|
|
const Container = styled.div<{
|
|
width?: number;
|
|
height?: number;
|
|
top?: number;
|
|
left?: number;
|
|
bottom?: number;
|
|
right?: number;
|
|
zIndex?: number;
|
|
}>`
|
|
&&& {
|
|
.${Classes.OVERLAY} {
|
|
.${Classes.OVERLAY_BACKDROP} {
|
|
z-index: ${(props) => props.zIndex || 2 - 1};
|
|
}
|
|
position: fixed;
|
|
top: 0;
|
|
right: 0;
|
|
bottom: 0;
|
|
height: 100vh;
|
|
z-index: ${(props) => props.zIndex};
|
|
width: 100%;
|
|
display: flex;
|
|
justify-content: center;
|
|
align-items: center;
|
|
& .${Classes.OVERLAY_CONTENT} {
|
|
max-width: 95%;
|
|
width: ${(props) => (props.width ? `${props.width}px` : "auto")};
|
|
min-height: ${(props) => (props.height ? `${props.height}px` : "auto")};
|
|
background: white;
|
|
border-radius: ${(props) => props.theme.radii[0]}px;
|
|
top: ${(props) => props.top}px;
|
|
left: ${(props) => props.left}px;
|
|
bottom: ${(props) => props.bottom}px;
|
|
right: ${(props) => props.right}px;
|
|
}
|
|
}
|
|
}
|
|
`;
|
|
const Content = styled.div<{
|
|
height?: number;
|
|
scroll: boolean;
|
|
ref: RefObject<HTMLDivElement>;
|
|
}>`
|
|
overflow-y: ${(props) => (props.scroll ? "visible" : "hidden")};
|
|
overflow-x: hidden;
|
|
width: 100%;
|
|
height: ${(props) => (props.height ? `${props.height}px` : "auto")};
|
|
`;
|
|
|
|
export type ModalComponentProps = {
|
|
isOpen: boolean;
|
|
onClose: (e: any) => void;
|
|
onModalClose?: () => void;
|
|
children: ReactNode;
|
|
width?: number;
|
|
className?: string;
|
|
canOutsideClickClose: boolean;
|
|
canEscapeKeyClose: boolean;
|
|
overlayClassName?: string;
|
|
scrollContents: boolean;
|
|
height?: number;
|
|
top?: number;
|
|
left?: number;
|
|
bottom?: number;
|
|
right?: number;
|
|
hasBackDrop?: boolean;
|
|
zIndex?: number;
|
|
portalClassName?: string;
|
|
};
|
|
|
|
/* eslint-disable react/display-name */
|
|
export function ModalComponent(props: ModalComponentProps) {
|
|
const modalContentRef: RefObject<HTMLDivElement> =
|
|
useRef<HTMLDivElement>(null);
|
|
useEffect(() => {
|
|
return () => {
|
|
// handle modal close events when this component unmounts
|
|
// will be called in all cases :-
|
|
// escape key press, click out side, close click from other btn widget
|
|
if (props.onModalClose) props.onModalClose();
|
|
};
|
|
}, []);
|
|
useEffect(() => {
|
|
if (!props.scrollContents) {
|
|
modalContentRef.current?.scrollTo({ top: 0, behavior: "smooth" });
|
|
}
|
|
}, [props.scrollContents]);
|
|
return (
|
|
<Overlay
|
|
canEscapeKeyClose={false}
|
|
canOutsideClickClose={false}
|
|
enforceFocus={false}
|
|
hasBackdrop={false}
|
|
isOpen={props.isOpen}
|
|
onClose={props.onClose}
|
|
portalClassName={`${MODAL_PORTAL_CLASSNAME} ${props.portalClassName} ${MODAL_PORTAL_OVERLAY_CLASSNAME}`}
|
|
usePortal
|
|
>
|
|
<Container
|
|
bottom={props.bottom}
|
|
height={props.height}
|
|
left={props.left}
|
|
right={props.bottom}
|
|
top={props.top}
|
|
width={props.width}
|
|
zIndex={props.zIndex !== undefined ? props.zIndex : Layers.modalWidget}
|
|
>
|
|
<Overlay
|
|
canEscapeKeyClose={props.canEscapeKeyClose}
|
|
canOutsideClickClose={props.canOutsideClickClose}
|
|
className={props.overlayClassName}
|
|
enforceFocus={false}
|
|
hasBackdrop={
|
|
props.hasBackDrop !== undefined ? !!props.hasBackDrop : true
|
|
}
|
|
isOpen={props.isOpen}
|
|
onClose={props.onClose}
|
|
usePortal={false}
|
|
>
|
|
<div>
|
|
<Content
|
|
className={`${getCanvasClassName()} ${props.className}`}
|
|
height={props.height}
|
|
ref={modalContentRef}
|
|
scroll={props.scrollContents}
|
|
>
|
|
{props.children}
|
|
</Content>
|
|
</div>
|
|
</Overlay>
|
|
</Container>
|
|
</Overlay>
|
|
);
|
|
}
|
|
|
|
export default ModalComponent;
|