2021-07-08 07:04:47 +00:00
|
|
|
import { createGlobalStyle } from "styled-components";
|
|
|
|
|
import { EditorTheme } from "components/editorComponents/CodeEditor/EditorConfig";
|
2023-01-23 03:50:47 +00:00
|
|
|
import { getTypographyByKey } from "design-system-old";
|
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 { Theme } from "constants/DefaultTheme";
|
2022-04-28 16:51:02 +00:00
|
|
|
import { LINT_TOOLTIP_JUSTIFIED_LEFT_CLASS } from "components/editorComponents/CodeEditor/constants";
|
2021-07-08 07:04:47 +00:00
|
|
|
|
|
|
|
|
export const CodemirrorHintStyles = createGlobalStyle<{
|
|
|
|
|
editorTheme: EditorTheme;
|
|
|
|
|
theme: Theme;
|
|
|
|
|
}>`
|
|
|
|
|
.CodeMirror-hints {
|
|
|
|
|
position: absolute;
|
|
|
|
|
z-index: 20;
|
|
|
|
|
overflow: hidden;
|
|
|
|
|
list-style: none;
|
|
|
|
|
margin-top: ${(props) => props.theme.spaces[3]}px;
|
|
|
|
|
padding: 0px 0px;
|
|
|
|
|
font-family: monospace;
|
|
|
|
|
max-height: 20em;
|
|
|
|
|
overflow-y: auto;
|
|
|
|
|
background: ${(props) =>
|
2022-01-29 07:26:19 +00:00
|
|
|
props.editorTheme === EditorTheme.LIGHT ? "#fafafa" : "#262626"};
|
|
|
|
|
box-shadow: 0px 0px 2px 2px #ebebeb;
|
|
|
|
|
border-radius: 1px;
|
2021-07-08 07:04:47 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
.CodeMirror-hint {
|
|
|
|
|
height: 24px;
|
|
|
|
|
color: ${(props) =>
|
|
|
|
|
props.editorTheme === EditorTheme.LIGHT ? "#090707" : "#FFFFFF"};
|
|
|
|
|
cursor: pointer;
|
|
|
|
|
display: flex;
|
|
|
|
|
min-width: 220px;
|
|
|
|
|
width: auto;
|
|
|
|
|
align-items: center;
|
|
|
|
|
font-size: 12px;
|
|
|
|
|
line-height: 15px;
|
|
|
|
|
letter-spacing: -0.24px;
|
|
|
|
|
&:hover {
|
|
|
|
|
background: ${(props) =>
|
2021-07-20 10:02:56 +00:00
|
|
|
props.editorTheme === EditorTheme.LIGHT ? "#E8E8E8" : "#157A96"};
|
2021-07-08 07:04:47 +00:00
|
|
|
border-radius: 0px;
|
2021-07-20 10:02:56 +00:00
|
|
|
color: #090707;
|
2021-07-08 07:04:47 +00:00
|
|
|
&:after {
|
2021-07-20 10:02:56 +00:00
|
|
|
color: #090707;
|
2021-07-08 07:04:47 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
.CodeMirror-command-header {
|
|
|
|
|
padding: 0 ${(props) => props.theme.spaces[3]}px;
|
|
|
|
|
color: #716e6e;
|
|
|
|
|
pointer-events: none !important;
|
|
|
|
|
font-family: ${(props) => props.theme.fonts.text};
|
2022-11-16 04:32:00 +00:00
|
|
|
${getTypographyByKey("p3")}
|
2021-07-15 14:38:31 +00:00
|
|
|
font-weight: 600;
|
2021-07-08 07:04:47 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
.CodeMirror-commands {
|
|
|
|
|
color: #4b4848;
|
|
|
|
|
position: relative;
|
|
|
|
|
padding: 0 ${(props) => props.theme.spaces[3]}px !important;
|
|
|
|
|
height: 25px;
|
|
|
|
|
font-family: ${(props) => props.theme.fonts.text};
|
2022-11-16 04:32:00 +00:00
|
|
|
${getTypographyByKey("p3")}
|
2021-09-22 16:59:47 +00:00
|
|
|
&.CodeMirror-hint-active {
|
2021-07-08 07:04:47 +00:00
|
|
|
.shortcut {
|
|
|
|
|
color: #ffffff;
|
|
|
|
|
}
|
2023-04-20 15:12:35 +00:00
|
|
|
.magic {
|
|
|
|
|
path {
|
|
|
|
|
fill: black;
|
|
|
|
|
}
|
|
|
|
|
}
|
2022-01-29 07:26:19 +00:00
|
|
|
.add-datasource-icon {
|
|
|
|
|
background: white;
|
|
|
|
|
}
|
2021-07-08 07:04:47 +00:00
|
|
|
}
|
|
|
|
|
.command-container {
|
|
|
|
|
display: flex;
|
|
|
|
|
align-items: center;
|
|
|
|
|
justify-content: space-between;
|
2022-01-29 07:26:19 +00:00
|
|
|
padding:5px 0;
|
2021-07-08 07:04:47 +00:00
|
|
|
flex: 1;
|
|
|
|
|
}
|
|
|
|
|
.command {
|
|
|
|
|
display: flex;
|
|
|
|
|
align-items: center;
|
2022-01-29 07:26:19 +00:00
|
|
|
> div {
|
|
|
|
|
padding: 0 2px;
|
|
|
|
|
img {
|
|
|
|
|
height: 14px;
|
|
|
|
|
width: 14px;
|
|
|
|
|
}
|
2021-07-08 07:04:47 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
.shortcut {
|
|
|
|
|
font-style: italic;
|
|
|
|
|
font-size: 10px;
|
|
|
|
|
color: #a9a7a7;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
.CodeMirror-hint-header {
|
|
|
|
|
padding-left: 8px;
|
|
|
|
|
color: #4B4848;
|
|
|
|
|
pointer-events: none !important;
|
|
|
|
|
font-weight: 600;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
.datasource-hint {
|
|
|
|
|
padding: 10px 20px 10px 10px !important;
|
|
|
|
|
display: block;
|
|
|
|
|
width: 500px;
|
|
|
|
|
height: 32px;
|
|
|
|
|
white-space: nowrap;
|
|
|
|
|
overflow: hidden;
|
|
|
|
|
text-overflow: ellipsis;
|
|
|
|
|
background: #FAFAFA;
|
|
|
|
|
color: black;
|
|
|
|
|
&.custom {
|
|
|
|
|
height: unset;
|
2022-07-08 14:31:12 +00:00
|
|
|
background-color: var(--appsmith-color-black-0);
|
2021-07-08 07:04:47 +00:00
|
|
|
width: 600px;
|
|
|
|
|
&:hover{
|
2022-07-08 14:31:12 +00:00
|
|
|
background-color: var(--appsmith-color-black-200);
|
2021-07-08 07:04:47 +00:00
|
|
|
color: black;
|
|
|
|
|
}
|
|
|
|
|
&.CodeMirror-hint-active {
|
2022-07-08 14:31:12 +00:00
|
|
|
background-color: var(--appsmith-color-black-200);
|
2021-07-08 07:04:47 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
&.invalid {
|
|
|
|
|
color: ${(props) => props.theme.colors.errorMessage};
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
.CodeMirror-Tern-completion {
|
|
|
|
|
display: flex;
|
|
|
|
|
padding-left: ${(props) => props.theme.spaces[11]}px !important;
|
|
|
|
|
&:hover{
|
|
|
|
|
background: ${(props) =>
|
2021-07-20 10:02:56 +00:00
|
|
|
props.editorTheme === EditorTheme.LIGHT ? "#E8E8E8" : "#157A96"};
|
|
|
|
|
color: #090707;
|
|
|
|
|
&:after {
|
|
|
|
|
color: #090707;
|
|
|
|
|
}
|
2021-07-08 07:04:47 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
.CodeMirror-Tern-completion:before {
|
|
|
|
|
left: 7px;
|
|
|
|
|
bottom: 6px;
|
|
|
|
|
height: 12px;
|
|
|
|
|
width: 12px;
|
|
|
|
|
border-radius: 0;
|
|
|
|
|
font-size: 10px;
|
|
|
|
|
line-height: 12px;
|
|
|
|
|
font-weight: normal;
|
|
|
|
|
text-align: center;
|
|
|
|
|
color: ${(props) => props.theme.colors.codeMirror.dataType.shortForm};
|
|
|
|
|
margin-right: ${(props) => props.theme.spaces[13]}px;
|
|
|
|
|
}
|
|
|
|
|
.CodeMirror-Tern-completion-fn:before {
|
|
|
|
|
background: ${(props) => props.theme.colors.dataTypeBg.function};
|
|
|
|
|
}
|
|
|
|
|
.CodeMirror-Tern-completion-object:before {
|
|
|
|
|
background: ${(props) => props.theme.colors.dataTypeBg.object};
|
|
|
|
|
}
|
|
|
|
|
.CodeMirror-Tern-completion-unknown:before {
|
|
|
|
|
background: ${(props) => props.theme.colors.dataTypeBg.unknown};
|
|
|
|
|
}
|
|
|
|
|
.CodeMirror-Tern-completion-array:before {
|
|
|
|
|
background: ${(props) => props.theme.colors.dataTypeBg.array};
|
|
|
|
|
}
|
|
|
|
|
.CodeMirror-Tern-completion-number:before, .CodeMirror-Tern-completion-string:before, .CodeMirror-Tern-completion-bool:before {
|
|
|
|
|
background: ${(props) => props.theme.colors.dataTypeBg.number};
|
|
|
|
|
}
|
|
|
|
|
.CodeMirror-Tern-completion:after {
|
|
|
|
|
display: flex;
|
|
|
|
|
justify-content: flex-end;
|
|
|
|
|
flex: 1;
|
|
|
|
|
padding-right: 10px;
|
|
|
|
|
font-style: italic;
|
|
|
|
|
font-weight: normal;
|
|
|
|
|
font-size: 10px;
|
|
|
|
|
line-height: 13px;
|
|
|
|
|
letter-spacing: -0.24px;
|
|
|
|
|
padding-left: 10px;
|
|
|
|
|
color: ${(props) => props.theme.colors.codeMirror.dataType.fullForm};
|
|
|
|
|
}
|
|
|
|
|
.CodeMirror-Tern-completion-fn:after {
|
|
|
|
|
content: "Function";
|
|
|
|
|
}
|
|
|
|
|
.CodeMirror-Tern-completion-object:after {
|
|
|
|
|
content: "Object";
|
|
|
|
|
}
|
|
|
|
|
.CodeMirror-Tern-completion-unknown:after {
|
|
|
|
|
content: "Unknown";
|
|
|
|
|
}
|
|
|
|
|
.CodeMirror-Tern-completion-array:after {
|
|
|
|
|
content: "Array";
|
|
|
|
|
}
|
|
|
|
|
.CodeMirror-Tern-completion-number:after {
|
|
|
|
|
content: "Number";
|
|
|
|
|
}
|
|
|
|
|
.CodeMirror-Tern-completion-string:after {
|
|
|
|
|
content: "String";
|
|
|
|
|
}
|
|
|
|
|
.CodeMirror-Tern-completion-bool:after {
|
|
|
|
|
content: "Boolean";
|
|
|
|
|
}
|
2021-10-26 08:56:10 +00:00
|
|
|
.CodeMirror-Tern-completion-keyword:before {
|
|
|
|
|
content: "K";
|
|
|
|
|
background: ${(props) => props.theme.colors.dataTypeBg.object};
|
|
|
|
|
}
|
|
|
|
|
.CodeMirror-Tern-completion-keyword[keyword]:after {
|
|
|
|
|
content: attr(keyword);
|
|
|
|
|
}
|
2021-07-08 07:04:47 +00:00
|
|
|
.CodeMirror-Tern-tooltip {
|
|
|
|
|
z-index: 20 !important;
|
|
|
|
|
}
|
|
|
|
|
li.CodeMirror-hint-active {
|
|
|
|
|
background: #6A86CE;
|
|
|
|
|
border-radius: 0px;
|
|
|
|
|
color: #fff;
|
|
|
|
|
&:after {
|
|
|
|
|
color: #fff;
|
|
|
|
|
}
|
2021-07-20 10:02:56 +00:00
|
|
|
&:hover {
|
|
|
|
|
background: #6A86CE;
|
|
|
|
|
color: #fff;
|
|
|
|
|
&:after {
|
|
|
|
|
color: #fff;
|
|
|
|
|
}
|
|
|
|
|
}
|
2021-07-08 07:04:47 +00:00
|
|
|
}
|
|
|
|
|
.CodeMirror-Tern-hint-doc {
|
|
|
|
|
display: none;
|
|
|
|
|
&.visible {
|
|
|
|
|
display: block;
|
|
|
|
|
background-color: ${(props) =>
|
|
|
|
|
props.editorTheme === EditorTheme.DARK ? "#23292e" : "#fff"} !important;
|
|
|
|
|
color: ${(props) =>
|
|
|
|
|
props.editorTheme === EditorTheme.DARK
|
|
|
|
|
? "#F4F4F4"
|
|
|
|
|
: "#1E242B"} !important;
|
|
|
|
|
max-height: 150px;
|
|
|
|
|
width: 250px;
|
|
|
|
|
font-size: 12px;
|
|
|
|
|
padding: 5px !important;
|
|
|
|
|
border: 1px solid !important;
|
|
|
|
|
border-color: ${(props) =>
|
|
|
|
|
props.editorTheme === EditorTheme.DARK
|
|
|
|
|
? "#23292e"
|
|
|
|
|
: "#DEDEDE"} !important;
|
|
|
|
|
box-shadow: 0px 4px 4px rgba(0, 0, 0, 0.12) !important;
|
|
|
|
|
overflow: scroll;
|
|
|
|
|
}
|
2021-08-26 04:45:17 +00:00
|
|
|
}
|
|
|
|
|
.CodeMirror-lint-tooltip {
|
|
|
|
|
border: none;
|
|
|
|
|
background: ${(props) =>
|
|
|
|
|
props.editorTheme === EditorTheme.DARK ? "#23292e" : "#fff"};
|
|
|
|
|
box-shadow: 0px 12px 28px -6px rgba(0, 0, 0, 0.32);
|
|
|
|
|
padding: 7px 12px;
|
|
|
|
|
border-radius: 0;
|
2022-11-16 04:32:00 +00:00
|
|
|
|
2022-04-28 16:51:02 +00:00
|
|
|
&.${LINT_TOOLTIP_JUSTIFIED_LEFT_CLASS}{
|
2022-02-10 17:40:36 +00:00
|
|
|
transform: translate(-100%);
|
|
|
|
|
}
|
2022-11-16 04:32:00 +00:00
|
|
|
|
2021-08-26 04:45:17 +00:00
|
|
|
}
|
|
|
|
|
.CodeMirror-lint-message {
|
|
|
|
|
margin-top: 5px;
|
|
|
|
|
margin-bottom: 5px;
|
|
|
|
|
font-family: ${(props) => props.theme.fonts.text};
|
|
|
|
|
color: #4B4848;
|
2023-03-08 14:41:30 +00:00
|
|
|
background-position: 0 2.8px;
|
|
|
|
|
padding-left: 20px;
|
2021-08-26 04:45:17 +00:00
|
|
|
}
|
|
|
|
|
.CodeMirror-lint-mark-warning{
|
2022-01-28 08:18:19 +00:00
|
|
|
background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAQAAAADCAYAAAC09K7GAAAAAXNSR0IArs4c6QAAAB1JREFUGFdjZICC/3sY/jO6MDAygvgwDpiGcWAqASvpC745SEL8AAAAAElFTkSuQmCC");
|
2021-07-08 07:04:47 +00:00
|
|
|
}
|
|
|
|
|
`;
|