## 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>
* faet: Add menu items source for menu widget
* feat: Add configuration panel for dynamic menu items
* feat: Pass down items from sourceData to menu items widget
* feat: Take menu items config from property pane for dynamic menu items
* fix: Change all onMenuItemClick to onClick for dynamic menu items
* feat: Create MenuComputeValue property control to add support for {{currentItem}} binding in menu widget
* feat: Add JS toggles for style properties for menu widget
* feat: onClick now supports currentItem for menu button widget
* feat: Add currentItem autocomplete, move property pane config to separate files for menu button widget
* feat: WIP - Add Dynamic Menu Items for Table Widget
* Revert "feat: WIP - Add Dynamic Menu Items for Table Widget"
This reverts commit 271f96211c8612bc6f073a1aab7467993b9d7e36.
* fix: remove current item label by default for dynamic menu items in menu button
* feat: Add source data max length 10 validation for dynamic menu items in menu button
* feat: Add migrations for Dynamic Menu Items for Menu Button Widget
* feat: Add cypress test for dynamic menu items for menu button
* test: Update DSLMigration test with menu button widget tests
* fix: Update MenuButtonWidget migration
* fix: DSL migrations for menu button dynmaic items
* fix: Style validations for menu widget
* feat: Add more descriptive help text for configure menu items in menu button widget
* feat: Change menu items source property type from dropdown to icon tabs
* fix: Cy test for menu button widget to select menu items source from button tabs instead of dropdown
* feat: Make ConfigureMenuItemsControl a Generic/reusable OpenNextPanelWithButtonControl
* refactor: Change MenuComputeValue to MenuButtonDynamicItemsControl
* refactor: Merge TABLE_PROPERTY and MENU_PROPERTY into one ARRAY_AND_ANY_PROPERTY
* fix: Don't polute Menu Button DSL with properties for dynamic menu items until the source is static
* style: Change color of curly braces hint in currentItem autocomplete to make it more readable
* fix: remove unused import
* refactor: Move child config panels to a different file, style: Change help text and placeholder for a few properties for Dynamic menu items - menu button
* refactor: Change event autocomplete function name, use fast equal
* refactor: Change source data validation function name and use camelCase throughout
* refactor: Validation function for source data
* refactor: Create different type for menuItems and configureMenuItems and reuse them property config
* feat: refactor: move get items to widget instead of component
* pref: Visible items to be calculated when menu button is clicked
* refactor: replace !("menuItemsSource" in child) with in migration
* refactor: Change controlType name from OPEN_NEXT_PANEL_WITH_BUTTON to OPEN_CONFIG_PANEL, use generic names inside OpenNextPanelWithButtonControl.tsx
* refactor: Minor cleanup at MenuButtonDynamicItemsControl.tsx
* refactor: Minor cleanup at MenuButtonDynamicItemsControl.tsx
* fix: Change constant used in migration to a static value
* test: Add tests for validations and helper for menu button
* test: Add more Cypress tests for dynamic-menu-items
* fix: Minor refactor at onclick handler and MenuButtonDynamicItemsControl
* refactor: Rename ARRAY_AND_ANY_PROPERTY to ARRAY_TYPE_OR_TYPE
* feat: Move initial source data and keys generation inside an update hook
* refactor: Rename ARRAY_TYPE_OR_TYPE to ARRAY_OF_TYPE_OR_TYPE
* refactor: Minor code refactor in MenuButtonWidget/widget/index.tsx
* refactor: Change OpenNextPanelWithButtonControl with OpenConfigPanelControl
* feat: Use traverseDSLAndMigrate for dynamic menu items migration
* style: Minor code hygiene changes here and there for dynamic menu items
* style: Minor code hygiene changes here and there for dynamic menu items
* style: remove any type for visible items inside dynamic menu items
* refactor: Change type MenuItems to MenuItem
* feat: Add support for dynamic menu items (menu button) inside list widget
* fix: updateMenuItemsSource hook not working when changing from DYNAMIC to STATIC menu items source
* fix: Avoid empty icon name from rendering inside button and menu item
* style: Fix a couple of code callouts
* fix: Update import from TernServer to CodemirrorTernService
* style: fix minor code callouts here and there
* fix: Add check for configureMenuItems.config
* fix: Add wait time after addOption click for DynamicHeight_Auto_Height_spec.js
* fix: Increase the wait time for DynamicHeight_Auto_Height_spec.js to 200ms
Co-authored-by: Aishwarya UR <aishwarya@appsmith.com>
* refactor admin settings feature
* separated save-restart bar to separate component
* created new CE dir to facilitate code split
* created separate ee dir and exporting everything we have in ce file.
* little mod
* minor fix
* splitting settings types config
* using object literals for category types instead of enums
* CE: support use of component for each category
* minor style fix
* authentication page UI changes implemented
* github signup doc url added back
* removed comments
* routing updates
* made subcategories listing in left pane optional
* added muted saml to auth listing
* added breadcrumbs and enabled button
* created separate component for auth page and auth config
* added callout and disconnect components
* updated breadcrumbs component
* minor updates to common components
* updated warning callout and added icon
* ce: test cases fixed
* updated test file name
* warning banner callout added on auth page
* updated callout banner for form login
* CE: Split config files
* CE: moved the window declaration in EE file as its dependency will be updated in EE
* CE: Splitting ApiConstants and SocialLogin constants
* CE: split login page
* CE: moved getSocialLoginButtonProps func to EE file as it's dependencies will be updated in EE
* added key icon
* CE: created a factory class to share social auths list
* Minor style fix for social btns
* Updated the third party auth styles
* Small fixes to styling
* ce: splitting forms constants
* breadcrumbs implemented for all pages in admin settings
* Settings breadcrumbs separated
* splitted settings breadcrumbs between ce and ee
* renamed default import
* minor style fix
* added login form config.
* updated login/signup pages to use form login disabled config
* removed common functionality outside
* implemented breadcrumb component from scratch without using blueprint
* removed unwanted code
* Small style update
* updated breadcrumb categories file name and breadcrumb icon
* added cypress tests for admin settings auth page
* added comments
* update locator for upgrade button
* added link for intercom on upgrade button
* removed unnecessary file
* minor style fix
* style fix for auth option cards
* split messages constant
* fixed imports for message constants splitting.
* added message constants
* updated unit test cases
* fixed messages import in cypress index
* fixed messages import again, cypress fails to read re-exported objs.
* added OIDC auth method on authentication page
* updated import statements from ee to @appsmith
* removed dead code
* updated read more link UI
* PR comments fixes
* some UI fixes
* used color and fonts from theme
* fixed some imports
* fixed some imports
* removed warning imports
* updated OIDC logo and auth method desc copies
* css changes
* css changes
* css changes
* updated cypress test for breadcrumb
* moved callout component to ads as calloutv2
* UI changes for form fields
* updated css for spacing between form fields
* added sub-text on auth pages
* added active class for breadcrumb item
* added config for disable signup toggle and fixed UI issues of restart banner
* fixed admin settings page bugs
* assigned true as default state for signup
* fixed messages import statements
* updated code for PR comments related suggestions
* reverted file path change in cypress support
* updated cypress test
* updated cypress test
Co-authored-by: Ankita Kinger <ankita@appsmith.com>
