2021-08-12 05:45:38 +00:00
|
|
|
import React from "react";
|
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 { WidgetCardProps } from "widgets/BaseWidget";
|
2019-09-09 10:30:22 +00:00
|
|
|
import styled from "styled-components";
|
2021-06-17 13:26:54 +00:00
|
|
|
import { useWidgetDragResize } from "utils/hooks/dragResizeHooks";
|
2020-03-03 07:02:53 +00:00
|
|
|
import AnalyticsUtil from "utils/AnalyticsUtil";
|
2020-03-27 09:02:11 +00:00
|
|
|
import { generateReactKey } from "utils/generators";
|
2021-06-17 13:26:54 +00:00
|
|
|
import { useWidgetSelection } from "utils/hooks/useWidgetSelection";
|
2021-09-09 15:10:22 +00:00
|
|
|
import { IconWrapper } from "constants/IconConstants";
|
2019-08-29 11:22:09 +00:00
|
|
|
|
2019-09-06 09:30:22 +00:00
|
|
|
type CardProps = {
|
|
|
|
|
details: WidgetCardProps;
|
2019-09-09 10:30:22 +00:00
|
|
|
};
|
2019-08-26 12:41:21 +00:00
|
|
|
|
2019-08-29 11:22:09 +00:00
|
|
|
export const Wrapper = styled.div`
|
2019-08-26 12:41:21 +00:00
|
|
|
padding: 10px 5px 10px 5px;
|
2023-05-19 18:37:06 +00:00
|
|
|
border-radius: var(--ads-v2-border-radius);
|
Feature/entity browse (#220)
# New Feature: Entity Explorer
- Entities are actions (apis and queries), datasources, pages, and widgets
- With this new feature, all entities in the application will be available
to view in the new entity explorer sidebar
- All existing application features from the api sidebar, query sidebar, datasource sidebar and pages sidebar
now are avialable on the entity explorer sidebar
- Users are now able to quickly switch to any entity in the application from the entity explorer sidebar.
- Users can also search all entities in the application from the new sidebar. Use cmd + f or ctrl + f to focus on the search input
- Users can rename entities from the new sidebar
- Users can also perform contextual actions on these entities like set a page as home page, copy/move actions, delete entity, etc from the context menu available alongside the entities in the sidebar
- Users can view the properties of the entities in the sidebar, as well as copy bindings to use in the application.
2020-08-10 08:52:45 +00:00
|
|
|
border: none;
|
2021-04-23 05:43:13 +00:00
|
|
|
position: relative;
|
2023-05-19 18:37:06 +00:00
|
|
|
color: var(--ads-v2-color-fg);
|
2019-11-13 11:34:11 +00:00
|
|
|
height: 72px;
|
|
|
|
|
display: flex;
|
|
|
|
|
align-items: center;
|
|
|
|
|
justify-content: center;
|
2023-05-19 18:37:06 +00:00
|
|
|
cursor: grab;
|
|
|
|
|
img {
|
|
|
|
|
cursor: grab;
|
|
|
|
|
}
|
2023-01-28 02:17:06 +00:00
|
|
|
|
2019-09-06 09:30:22 +00:00
|
|
|
& > div {
|
|
|
|
|
display: flex;
|
|
|
|
|
flex-direction: column;
|
|
|
|
|
align-items: center;
|
|
|
|
|
justify-content: center;
|
|
|
|
|
}
|
2023-01-28 02:17:06 +00:00
|
|
|
|
2019-09-09 10:30:22 +00:00
|
|
|
&:hover {
|
2023-05-19 18:37:06 +00:00
|
|
|
background: var(--ads-v2-color-bg-subtle);
|
2019-09-06 09:30:22 +00:00
|
|
|
}
|
2023-01-28 02:17:06 +00:00
|
|
|
|
2019-09-06 09:30:22 +00:00
|
|
|
& i {
|
2020-12-24 04:32:25 +00:00
|
|
|
font-family: ${(props) => props.theme.fonts.text};
|
|
|
|
|
font-size: ${(props) => props.theme.fontSizes[7]}px;
|
2019-08-26 12:41:21 +00:00
|
|
|
}
|
|
|
|
|
`;
|
2019-09-06 09:30:22 +00:00
|
|
|
|
2021-04-23 05:43:13 +00:00
|
|
|
export const BetaLabel = styled.div`
|
|
|
|
|
font-size: 10px;
|
2023-05-19 18:37:06 +00:00
|
|
|
background: var(--ads-v2-color-bg-emphasis);
|
2021-04-23 05:43:13 +00:00
|
|
|
margin-top: 3px;
|
|
|
|
|
padding: 2px 4px;
|
|
|
|
|
border-radius: 3px;
|
|
|
|
|
position: absolute;
|
|
|
|
|
top: 0;
|
|
|
|
|
right: -2%;
|
|
|
|
|
`;
|
|
|
|
|
|
2019-08-29 11:22:09 +00:00
|
|
|
export const IconLabel = styled.h5`
|
2021-10-04 15:34:37 +00:00
|
|
|
min-height: 32px;
|
2019-08-26 12:41:21 +00:00
|
|
|
text-align: center;
|
|
|
|
|
margin: 0;
|
2023-05-19 18:37:06 +00:00
|
|
|
/* text-transform: uppercase; */
|
2020-12-24 04:32:25 +00:00
|
|
|
font-weight: ${(props) => props.theme.fontWeights[1]};
|
2019-08-26 12:41:21 +00:00
|
|
|
flex-shrink: 1;
|
2023-05-19 18:37:06 +00:00
|
|
|
font-size: 11px;
|
2020-12-24 04:32:25 +00:00
|
|
|
line-height: ${(props) => props.theme.lineHeights[2]}px;
|
2023-01-28 02:17:06 +00:00
|
|
|
|
Feature/entity browse (#220)
# New Feature: Entity Explorer
- Entities are actions (apis and queries), datasources, pages, and widgets
- With this new feature, all entities in the application will be available
to view in the new entity explorer sidebar
- All existing application features from the api sidebar, query sidebar, datasource sidebar and pages sidebar
now are avialable on the entity explorer sidebar
- Users are now able to quickly switch to any entity in the application from the entity explorer sidebar.
- Users can also search all entities in the application from the new sidebar. Use cmd + f or ctrl + f to focus on the search input
- Users can rename entities from the new sidebar
- Users can also perform contextual actions on these entities like set a page as home page, copy/move actions, delete entity, etc from the context menu available alongside the entities in the sidebar
- Users can view the properties of the entities in the sidebar, as well as copy bindings to use in the application.
2020-08-10 08:52:45 +00:00
|
|
|
&::selection {
|
|
|
|
|
background: none;
|
|
|
|
|
}
|
2019-08-26 12:41:21 +00:00
|
|
|
`;
|
|
|
|
|
|
2021-04-28 10:28:39 +00:00
|
|
|
function WidgetCard(props: CardProps) {
|
2021-08-12 05:45:38 +00:00
|
|
|
const { setDraggingNewWidget } = useWidgetDragResize();
|
2021-05-18 18:29:39 +00:00
|
|
|
const { deselectAll } = useWidgetSelection();
|
2019-09-26 11:11:28 +00:00
|
|
|
|
2021-08-12 05:45:38 +00:00
|
|
|
const onDragStart = (e: any) => {
|
|
|
|
|
e.preventDefault();
|
|
|
|
|
e.stopPropagation();
|
|
|
|
|
AnalyticsUtil.logEvent("WIDGET_CARD_DRAG", {
|
|
|
|
|
widgetType: props.details.type,
|
2021-09-09 15:10:22 +00:00
|
|
|
widgetName: props.details.displayName,
|
2021-08-12 05:45:38 +00:00
|
|
|
});
|
|
|
|
|
setDraggingNewWidget &&
|
|
|
|
|
setDraggingNewWidget(true, {
|
|
|
|
|
...props.details,
|
|
|
|
|
widgetId: generateReactKey(),
|
|
|
|
|
});
|
2023-01-28 02:17:06 +00:00
|
|
|
deselectAll();
|
2021-08-12 05:45:38 +00:00
|
|
|
};
|
2021-09-09 15:10:22 +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
|
|
|
const type = `${props.details.type.split("_").join("").toLowerCase()}`;
|
2022-01-25 13:56:52 +00:00
|
|
|
const className = `t--widget-card-draggable-${type}`;
|
2019-08-26 12:41:21 +00:00
|
|
|
return (
|
2022-01-25 13:56:52 +00:00
|
|
|
<Wrapper
|
|
|
|
|
className={className}
|
|
|
|
|
data-guided-tour-id={`widget-card-${type}`}
|
|
|
|
|
draggable
|
|
|
|
|
onDragStart={onDragStart}
|
|
|
|
|
>
|
2021-08-12 05:45:38 +00:00
|
|
|
<div>
|
2021-09-09 15:10:22 +00:00
|
|
|
<IconWrapper>
|
2021-11-23 08:01:46 +00:00
|
|
|
<img className="w-6 h-6" src={props.details.icon} />
|
2021-09-09 15:10:22 +00:00
|
|
|
</IconWrapper>
|
|
|
|
|
<IconLabel>{props.details.displayName}</IconLabel>
|
2021-08-12 05:45:38 +00:00
|
|
|
{props.details.isBeta && <BetaLabel>Beta</BetaLabel>}
|
|
|
|
|
</div>
|
|
|
|
|
</Wrapper>
|
2019-09-09 10:30:22 +00:00
|
|
|
);
|
2021-04-28 10:28:39 +00:00
|
|
|
}
|
2019-08-26 12:41:21 +00:00
|
|
|
|
2019-09-09 10:30:22 +00:00
|
|
|
export default WidgetCard;
|