refactor: Integrate `consistent-type-imports` in FE packages (no-changelog) #6060

ivov · 2023-04-21T13:54:33Z

https://linear.app/n8n/issue/N8N-6054/integrate-consistent-type-imports-in-fe-packages

e2e pass: https://github.com/n8n-io/n8n/actions/runs/4784768930

github-actions · 2023-04-21T13:59:00Z

Great PR! Please pay attention to the following items before merging:

Files matching packages/**:

If fixing bug, added test to cover scenario.
If addressing forum or Github issue, added link to description.

Files matching packages/**/*.ts:

Added unit tests to cover new or updated functionality.

Files matching **/*.vue:

Used composition API for all new components.
Added component or unit tests to cover functionality.

Files matching packages/design-system/**/*.vue:

Used design system tokens (colors, spacings...) where possible.
Updated Storybook with new component or updated functionality.

Make sure to check off this list before asking for review.

codecov · 2023-04-21T14:16:50Z

Codecov Report

Patch coverage: 92.41% and no project coverage change.

Comparison is base (feb2ba0) 18.59% compared to head (b380e61) 18.59%.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #6060   +/-   ##
=======================================
  Coverage   18.59%   18.59%           
=======================================
  Files        2585     2585           
  Lines      116668   116678   +10     
  Branches    18181    18181           
=======================================
+ Hits        21690    21697    +7     
- Misses      94340    94343    +3     
  Partials      638      638

Impacted Files	Coverage Δ
...n-system/src/components/N8nFormInput/validators.ts	`0.00% <0.00%> (ø)`
...ents/N8nNodeCreatorNode/NodeCreatorNode.stories.ts	`0.00% <0.00%> (ø)`
...ents/N8nRecycleScroller/RecycleScroller.stories.ts	`0.00% <0.00%> (ø)`
...m/src/components/N8nUsersList/UsersList.stories.ts	`0.00% <0.00%> (ø)`
packages/design-system/src/types/datatable.ts	`0.00% <0.00%> (ø)`
.../src/components/SettingsLogStreaming/Helpers.ee.ts	`0.00% <0.00%> (ø)`
...components/SettingsLogStreaming/descriptions.ee.ts	`0.00% <0.00%> (ø)`
packages/editor-ui/src/mixins/restApi.ts	`0.00% <0.00%> (ø)`
...tor-ui/src/plugins/codemirror/completions/types.ts	`0.00% <0.00%> (ø)`
packages/editor-ui/src/Interface.ts	`100.00% <100.00%> (ø)`
... and 83 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

github-actions · 2023-04-24T10:17:15Z

✅ All Cypress E2E specs passed

OlegIvaniv

Nice one! I found a few cases where we could adjust/remove imports. It seems like the linting is not triggered for imports which are not used

OlegIvaniv · 2023-04-24T10:16:10Z

packages/editor-ui/src/components/Node.vue

@@ -182,7 +182,8 @@ import { nodeHelpers } from '@/mixins/nodeHelpers';
 import { workflowHelpers } from '@/mixins/workflowHelpers';
 import { pinData } from '@/mixins/pinData';

-import { IDataObject, INodeTypeDescription, ITaskData, NodeHelpers } from 'n8n-workflow';
+import type { INodeTypeDescription, ITaskData } from 'n8n-workflow';
+import { IDataObject, NodeHelpers } from 'n8n-workflow';


IDataObject is type, but it's not used in the file

OlegIvaniv · 2023-04-24T10:16:21Z

packages/editor-ui/src/components/Node.vue

-	XYPosition,
-} from '@/Interface';
+import type { IExecutionsSummary, INodeUi, XYPosition } from '@/Interface';
+import { INodeUpdatePropertiesInformation } from '@/Interface';


INodeUpdatePropertiesInformation is type, but it's not used in the file

OlegIvaniv · 2023-04-24T10:17:10Z

packages/editor-ui/src/components/Node/NodeCreator/MainPanel.vue

-} from 'n8n-workflow';
-import {
+import type { INodeTypeDescription, INodeActionTypeDescription } from 'n8n-workflow';
+import { INodeTypeNameVersion } from 'n8n-workflow';


INodeTypeNameVersion is type but not used in this file

OlegIvaniv · 2023-04-24T10:18:53Z

packages/editor-ui/src/components/ParameterInput.vue

@@ -341,6 +339,7 @@ import {
 	INodePropertyCollection,
 	NodeParameterValueType,
 } from 'n8n-workflow';
+import { NodeHelpers, NodeParameterValue } from 'n8n-workflow';


NodeParameterValue is type but not used in the file

OlegIvaniv · 2023-04-24T10:19:39Z

packages/editor-ui/src/components/ParameterInputWrapper.vue

 	NodeParameterValue,
 	NodeParameterValueType,
 } from 'n8n-workflow';
-import { INodeUi, IUpdateInformation, TargetItem } from '@/Interface';
+import { IRunData, isResourceLocatorValue } from 'n8n-workflow';


IRunData is type but not used in the file

packages/editor-ui/src/stores/workflows.ts

packages/editor-ui/src/utils/typeGuards.ts

OlegIvaniv · 2023-04-24T10:34:49Z

packages/editor-ui/src/utils/typesUtils.ts

-import { Schema, Optional, Primitives } from '@/Interface';
+import type { IDataObject } from 'n8n-workflow';
+import { jsonParse } from 'n8n-workflow';
+import type { Schema, Optional, Primitives } from '@/Interface';
 import { isObj } from '@/utils/typeGuards';
 import { generatePath } from '@/utils/mappingUtils';
 import { DateTime } from 'luxon';


DateTime is a type but not used in this file

packages/editor-ui/src/utils/userUtils.ts

OlegIvaniv · 2023-04-24T10:35:43Z

packages/editor-ui/src/views/CredentialsView.vue

@@ -45,21 +45,22 @@

 <script lang="ts">
 import { showMessage } from '@/mixins/showMessage';
-import { ICredentialsResponse, ICredentialTypeMap, IUser } from '@/Interface';
+import type { ICredentialsResponse, ICredentialTypeMap } from '@/Interface';
+import { IUser } from '@/Interface';


This is a type but not used in the file

OlegIvaniv · 2023-04-24T10:40:28Z

packages/editor-ui/src/api/workflows.ts

-} from 'n8n-workflow';
+import type { IExecutionsCurrentSummaryExtended, IRestApiContext } from '@/Interface';
+import type { ExecutionFilters, ExecutionOptions, IDataObject } from 'n8n-workflow';
+import { ExecutionStatus, WorkflowExecuteMode } from 'n8n-workflow';


These are types but not used in the file

ivov · 2023-04-24T11:26:11Z

Nice one! I found a few cases where we could adjust/remove imports. It seems like the linting is not triggered for imports which are not used

Thanks for reviewing! Addressed in the two linked PRs above.

* master: refactor: Async functions don't need to explicitly return promises (no-changelog) (#6041) SSO/SAML : add Base URL to redirects in acsHandler (#5923) refactor: Integrate `consistent-type-imports` in FE packages (no-changelog) (#6060) fix(core): Skip license activation when instance was already activated (#6064) refactor(core): Setup decorator based RBAC (no-changelog) (#5787) # Conflicts: # packages/editor-ui/src/mixins/restApi.ts

* master: refactor(editor): Delete leftover restApi mixin file (no-changelog) (#6074) docs: Remove version notice from overhauled nodes (no-changelog) (#6071) refactor(editor): Combine type imports in `editor-ui` (no-changelog) (#6072) refactor: Async functions don't need to explicitly return promises (no-changelog) (#6041) SSO/SAML : add Base URL to redirects in acsHandler (#5923) refactor: Integrate `consistent-type-imports` in FE packages (no-changelog) (#6060) fix(core): Skip license activation when instance was already activated (#6064) refactor(core): Setup decorator based RBAC (no-changelog) (#5787) test: Add run linking tests (#6061) # Conflicts: # packages/editor-ui/src/components/ParameterInputWrapper.vue

…gelog) (n8n-io#6060) * 👕 Move `consistent-type-imports` to top level * 👕 Apply lintfixes * 👕 Apply more lintfixes * 👕 More lintfixes * 👕 More lintfixes

janober · 2023-05-02T10:16:48Z

Got released with [email protected]

ivov added 2 commits April 21, 2023 15:41

👕 Move consistent-type-imports to top level

efdcd21

👕 Apply lintfixes

31ba079

ivov mentioned this pull request Apr 21, 2023

refactor: Integrate consistent-type-imports in FE packages (no-changelog) #5951

Closed

🔀 Merge master

cd48789

n8n-assistant bot added core Enhancement outside /nodes-base and /editor-ui n8n team Authored by the n8n team ui Enhancement in /editor-ui or /design-system labels Apr 21, 2023

🔀 Merge master

6630af4

ivov added 5 commits April 21, 2023 16:30

👕 Apply more lintfixes

d907d56

🔀 Merge master

2036636

👕 More lintfixes

0a86c4f

🔀 Merge master

1630e00

👕 More lintfixes

b380e61

cstuncsik approved these changes Apr 24, 2023

View reviewed changes

ivov merged commit 57aab63 into master Apr 24, 2023

ivov deleted the n8n-6054-consistent-type-imports-in-fe branch April 24, 2023 10:18

OlegIvaniv requested changes Apr 24, 2023

View reviewed changes

OlegIvaniv reviewed Apr 24, 2023

View reviewed changes

This was referenced Apr 24, 2023

refactor(editor): Combine type imports in editor-ui (no-changelog) #6072

Merged

ci: Enforce no unused imports (no-changelog) #6073

Merged

janober added the Released label May 2, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: Integrate `consistent-type-imports` in FE packages (no-changelog) #6060

refactor: Integrate `consistent-type-imports` in FE packages (no-changelog) #6060

ivov commented Apr 21, 2023 •

edited

Loading

github-actions bot commented Apr 21, 2023

codecov bot commented Apr 21, 2023 •

edited

Loading

github-actions bot commented Apr 24, 2023

OlegIvaniv left a comment

OlegIvaniv Apr 24, 2023

OlegIvaniv Apr 24, 2023

OlegIvaniv Apr 24, 2023

OlegIvaniv Apr 24, 2023

OlegIvaniv Apr 24, 2023

OlegIvaniv Apr 24, 2023

OlegIvaniv Apr 24, 2023

OlegIvaniv Apr 24, 2023

ivov commented Apr 24, 2023

janober commented May 2, 2023

refactor: Integrate consistent-type-imports in FE packages (no-changelog) #6060

refactor: Integrate consistent-type-imports in FE packages (no-changelog) #6060

Conversation

ivov commented Apr 21, 2023 • edited Loading

github-actions bot commented Apr 21, 2023

codecov bot commented Apr 21, 2023 • edited Loading

Codecov Report

github-actions bot commented Apr 24, 2023

OlegIvaniv left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ivov commented Apr 24, 2023

janober commented May 2, 2023

refactor: Integrate `consistent-type-imports` in FE packages (no-changelog) #6060

refactor: Integrate `consistent-type-imports` in FE packages (no-changelog) #6060

ivov commented Apr 21, 2023 •

edited

Loading

codecov bot commented Apr 21, 2023 •

edited

Loading