## 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>
196 lines
4.5 KiB
TypeScript
196 lines
4.5 KiB
TypeScript
import {
|
|
ADMIN_SETTINGS_PATH,
|
|
GEN_TEMPLATE_FORM_ROUTE,
|
|
GEN_TEMPLATE_URL,
|
|
getViewerCustomPath,
|
|
getViewerPath,
|
|
TEMPLATES_PATH,
|
|
} from "constants/routes";
|
|
import { APP_MODE } from "entities/App";
|
|
import urlBuilder from "entities/URLRedirect/URLAssembly";
|
|
import type {
|
|
ApplicationPayload,
|
|
Page,
|
|
} from "@appsmith/constants/ReduxActionConstants";
|
|
|
|
export type URLBuilderParams = {
|
|
suffix?: string;
|
|
branch?: string;
|
|
hash?: string;
|
|
params?: Record<string, any>;
|
|
pageId: string;
|
|
persistExistingParams?: boolean;
|
|
};
|
|
|
|
export const fillPathname = (
|
|
pathname: string,
|
|
application: ApplicationPayload,
|
|
page: Page,
|
|
) => {
|
|
const replaceValue = page.customSlug
|
|
? getViewerCustomPath(page.customSlug, page.pageId)
|
|
: getViewerPath(application.slug, page.slug, page.pageId);
|
|
|
|
return pathname.replace(
|
|
`/applications/${application.id}/pages/${page.pageId}`,
|
|
replaceValue,
|
|
);
|
|
};
|
|
|
|
export function getQueryStringfromObject(
|
|
params: Record<string, string> = {},
|
|
): string {
|
|
const paramKeys = Object.keys(params);
|
|
const queryParams: string[] = [];
|
|
if (paramKeys) {
|
|
paramKeys.forEach((paramKey: string) => {
|
|
const value = params[paramKey];
|
|
if (paramKey && value) {
|
|
queryParams.push(`${paramKey}=${value}`);
|
|
}
|
|
});
|
|
}
|
|
return queryParams.length ? "?" + queryParams.join("&") : "";
|
|
}
|
|
|
|
export const datasourcesEditorURL = (props: URLBuilderParams): string =>
|
|
urlBuilder.build({
|
|
...props,
|
|
suffix: "datasource",
|
|
});
|
|
|
|
export const datasourcesEditorIdURL = (
|
|
props: URLBuilderParams & {
|
|
datasourceId: string;
|
|
},
|
|
): string => {
|
|
return urlBuilder.build({
|
|
...props,
|
|
suffix: `datasource/${props.datasourceId}`,
|
|
});
|
|
};
|
|
|
|
export const jsCollectionIdURL = (
|
|
props: URLBuilderParams & {
|
|
collectionId: string;
|
|
// Pass a function name to set the cursor directly on the function
|
|
functionName?: string;
|
|
},
|
|
): string => {
|
|
return urlBuilder.build({
|
|
...props,
|
|
suffix: `jsObjects/${props.collectionId}`,
|
|
hash: props.functionName,
|
|
});
|
|
};
|
|
|
|
export const integrationEditorURL = (
|
|
props: URLBuilderParams & { selectedTab: string },
|
|
): string => {
|
|
const suffixPath = props.suffix ? `/${props.suffix}` : "";
|
|
return urlBuilder.build({
|
|
...props,
|
|
suffix: `datasources/${props.selectedTab}${suffixPath}`,
|
|
});
|
|
};
|
|
|
|
export const queryEditorIdURL = (
|
|
props: URLBuilderParams & {
|
|
queryId: string;
|
|
},
|
|
): string =>
|
|
urlBuilder.build({
|
|
...props,
|
|
suffix: `queries/${props.queryId}`,
|
|
});
|
|
|
|
export const apiEditorIdURL = (
|
|
props: URLBuilderParams & {
|
|
apiId: string;
|
|
},
|
|
): string =>
|
|
urlBuilder.build({
|
|
...props,
|
|
suffix: `api/${props.apiId}`,
|
|
});
|
|
|
|
export const curlImportPageURL = (props: URLBuilderParams): string =>
|
|
urlBuilder.build({
|
|
...props,
|
|
suffix: "api/curl/curl-import",
|
|
});
|
|
|
|
export const providerTemplatesURL = (
|
|
props: URLBuilderParams & {
|
|
providerId: string;
|
|
},
|
|
): string =>
|
|
urlBuilder.build({
|
|
...props,
|
|
suffix: `api/provider/${props.providerId}`,
|
|
});
|
|
|
|
export const saasEditorDatasourceIdURL = (
|
|
props: URLBuilderParams & {
|
|
pluginPackageName: string;
|
|
datasourceId: string;
|
|
},
|
|
): string =>
|
|
urlBuilder.build({
|
|
...props,
|
|
suffix: `saas/${props.pluginPackageName}/datasources/${props.datasourceId}`,
|
|
});
|
|
|
|
export const saasEditorApiIdURL = (
|
|
props: URLBuilderParams & {
|
|
pluginPackageName: string;
|
|
apiId: string;
|
|
},
|
|
): string =>
|
|
urlBuilder.build({
|
|
...props,
|
|
suffix: `saas/${props.pluginPackageName}/api/${props.apiId}`,
|
|
});
|
|
|
|
export const generateTemplateFormURL = (props: URLBuilderParams): string =>
|
|
urlBuilder.build({
|
|
...props,
|
|
suffix: `${GEN_TEMPLATE_URL}${GEN_TEMPLATE_FORM_ROUTE}`,
|
|
});
|
|
|
|
export const onboardingCheckListUrl = (props: URLBuilderParams): string =>
|
|
urlBuilder.build({
|
|
...props,
|
|
suffix: "checklist",
|
|
});
|
|
|
|
export const builderURL = (props: URLBuilderParams): string => {
|
|
return urlBuilder.build(props);
|
|
};
|
|
|
|
export const widgetURL = (
|
|
props: URLBuilderParams & { selectedWidgets: string[] },
|
|
) => {
|
|
return urlBuilder.build({
|
|
...props,
|
|
suffix: `widgets/${props.selectedWidgets.join(",")}`,
|
|
});
|
|
};
|
|
|
|
export const viewerURL = (props: URLBuilderParams): string => {
|
|
return urlBuilder.build(props, APP_MODE.PUBLISHED);
|
|
};
|
|
|
|
export function adminSettingsCategoryUrl({
|
|
category,
|
|
selected,
|
|
}: {
|
|
category: string;
|
|
selected?: string;
|
|
}) {
|
|
return `${ADMIN_SETTINGS_PATH}/${category}${selected ? "/" + selected : ""}`;
|
|
}
|
|
|
|
export const templateIdUrl = ({ id }: { id: string }): string =>
|
|
`${TEMPLATES_PATH}/${id}`;
|