build: add typescript project references #4055

mohanraj-r · 2022-04-22T02:47:23Z

What does this PR do?

Make use of Typescript project references to declare internal mono-repo package dependencies
- Have a common config at root
- Packages inherit and override as necessary
Inherit from tsconfig/bases
- Update es target/lib to node14
Refactors post compile steps (webpack, copy files) present in certain packages to separate npm scripts so they can be invoked after tsc build
Adds separate tsconfig files for ts-loader used to process Typescript files in Webpack as
- tsc build requires non-ts files (e.g. json) to be explicitly included and ts-loader seems to be having an issue processing include directives (ts-loader from webpack not including or excluding files TypeStrong/ts-loader#1402).
- ts-loader doesn't seem to process extends correctly (Project References won't work if extends config file TypeStrong/ts-loader#1035)
Should result in faster compile
- Incremental smart compilation with watch mode with a single compile/watch command for the entire project instead of running compile/watch for each individual package which is not optimal
- Clean compiled output selectively and quickly without having to remove out dirs and recompile all packages

What does this PR doesn't do?

Remove 'out' from import paths of internal mono-repo packages (e.g. '@salesforce/salesforcedx-utils-vscode/out/src/cli')
- Jump to Type defs of TS classes should work (e.g. SfdxCommandBuilder)
Update target up from es6 or update vscode version (build: add typescript project references #4055 (comment))

What issues does this PR fix or reference?

@ W-10706475@

Functionality Before

Typescript project config was duplicated per package with no reuse and no references.

Functionality After

Typescript project configs are reused with a common config and project references have been added.

QA Notes

Given that this affects how all packages are compiled, perform E2E testing with VSIX files
- Compare size of VSIX files with develop/main

from https://github.com/tsconfig/bases/

tsconfig.json

package.json

as it has issues with the tsconfig used by tsc build with project ref

tsconfig.common.json

mohanraj-r · 2022-04-23T02:22:47Z

Failing with various flavours of the following error - Need to debug/fix

Failed to parse file: C:\Users\circleci\project\packages\salesforcedx-vscode-core\out\src\sfdxProject\sfdxPackageDirectories.js

Transformation error; return original code

Error: Line 13: Unexpected identifier
    at constructError (C:\Users\circleci\project\packages\salesforcedx-test-utils-vscode\node_modules\esprima\esprima.js:2407:21)

packages/salesforcedx-sobjects-faux-generator/package.json

packages/salesforcedx-sobjects-faux-generator/tsconfig.webpack.json

gbockus-sf · 2022-04-26T00:46:12Z

packages/salesforcedx-visualforce-markup-language-server/tsconfig.json

+    "noImplicitAny": false,
+    // Generating Type Definitions from Javascript is blocked by requiring private name
+    // https://github.com/microsoft/TypeScript/issues/37832
+    // "allowJs": true, // for the beautify js files


would we ever uncomment this?

There are about a half-dozen failures in a couple of packages due to this check. So yes if we can clean them up we can have this enabled. Another way is to have this only in the packages that are failing and have it enabled globally.

Created a WI and linked

Sorry misread as question about noUnusedLocals in the tsconfig common json.
For allowJs guess as long as we have the beautify JS src files checked in (not sure if there is a third party lib that can be imported instead that has been created since) and the TSC issue is open. This is in case someone wonders why are the JS files being copied over instead of being run through tsc. Updated comment.

gbockus-sf

Great work! I didn't QE with changes (well I did a compile before the last set of commits), but this seems like a build task so if it build it builds. If there are any steps required for local dev for this to start working you might call it out in slack after it merges.

mohanraj-r · 2022-04-27T18:54:26Z

@gbockus-sf If/when you have a moment can you please review the recent (mostly doc) changes.

mohanraj-r · 2022-04-28T01:42:13Z

Extension sizes using https://github.com/lcampos/circleci-to-vscode

$ du -sh ~/.vscode-insiders/extensions/
491M    

$ du -sh ~/.vscode-insiders/extensions/salesforce.*
 88K    salesforce.salesforcedx-vscode-54.10.0
 57M    salesforce.salesforcedx-vscode-apex-54.10.0
5.3M    salesforce.salesforcedx-vscode-apex-debugger-54.10.0
 34M    salesforce.salesforcedx-vscode-apex-replay-debugger-54.10.0
153M    salesforce.salesforcedx-vscode-core-54.10.0
 28K    salesforce.salesforcedx-vscode-expanded-54.10.0
 42M    salesforce.salesforcedx-vscode-lightning-54.10.0
159M    salesforce.salesforcedx-vscode-lwc-54.10.0
 24M    salesforce.salesforcedx-vscode-soql-54.10.0
 18M    salesforce.salesforcedx-vscode-visualforce-54.10.0

Comparing with VSIX files from a recent build on develop it can be noticed that the size hasn't changed significantly

$ du -sh ~/.vscode-insiders/extensions/
485M    

$ du -sh ~/.vscode-insiders/extensions/salesforce.*
 88K    salesforce.salesforcedx-vscode-54.10.0
 56M    salesforce.salesforcedx-vscode-apex-54.10.0
4.7M    salesforce.salesforcedx-vscode-apex-debugger-54.10.0
 33M    salesforce.salesforcedx-vscode-apex-replay-debugger-54.10.0
150M    salesforce.salesforcedx-vscode-core-54.10.0
 28K    salesforce.salesforcedx-vscode-expanded-54.10.0
 41M    salesforce.salesforcedx-vscode-lightning-54.10.0
159M    salesforce.salesforcedx-vscode-lwc-54.10.0
 24M    salesforce.salesforcedx-vscode-soql-54.10.0
 18M    salesforce.salesforcedx-vscode-visualforce-54.10.0

gbockus-sf

Great work

regenerate package lock file to fix merge conflicts

mohanraj-r added 8 commits April 20, 2022 20:46

build: add typescript project references

ac079d0

test: add check for typescript proj refs

b70f3c6

build: add compile scripts, fix tsconfig in packages

25a4eae

refactor: extract common tsconfig into common config

bf7f9cd

build: add post compile step to deal with JS files and test artifacts

a25d302

build: add tsconfig for node 14

a6828fa

from https://github.com/tsconfig/bases/

refactor: common tsconfig to reuse node 14 base config

580495b

refactor: remove tsc clean from existing clean script

9d7556b

mohanraj-r requested a review from a team as a code owner April 22, 2022 02:47

mohanraj-r requested review from jeffb-sfdc and gbockus-sf April 22, 2022 02:47

mohanraj-r self-assigned this Apr 22, 2022

gbockus-sf reviewed Apr 22, 2022

View reviewed changes

tsconfig.json Show resolved Hide resolved

gbockus-sf reviewed Apr 22, 2022

View reviewed changes

package.json Outdated Show resolved Hide resolved

Mohan Raj Rajamanickam added 3 commits April 22, 2022 12:36

docs: add info about new compile scripts

c66653a

fix(compile): add packages that use webpack to compile step

2dae190

fix: add separate tsconfig for ts-loader / webpack

14ee6d6

as it has issues with the tsconfig used by tsc build with project ref

mohanraj-r commented Apr 23, 2022

View reviewed changes

tsconfig.common.json Outdated Show resolved Hide resolved

fix(soql): add tsconfig for webpack / ts-loader

b27f02c

mohanraj-r and others added 5 commits April 22, 2022 19:22

Merge branch 'develop' into mohanraj-r/typescript-project-ref-enable

352d068

build: revert to es6 target in tsconfig

3d61170

build: refactor post compile webpack and file copy steps

3dec188

docs: update info about limitations of compile watch mode

cff7b38

refactor: remove unnecessary tsconfig webpack config files

c076518

mohanraj-r requested a review from gbockus-sf April 25, 2022 22:40

gbockus-sf reviewed Apr 26, 2022

View reviewed changes

packages/salesforcedx-sobjects-faux-generator/package.json Show resolved Hide resolved

gbockus-sf reviewed Apr 26, 2022

View reviewed changes

packages/salesforcedx-sobjects-faux-generator/tsconfig.webpack.json Show resolved Hide resolved

gbockus-sf reviewed Apr 26, 2022

View reviewed changes

gbockus-sf approved these changes Apr 26, 2022

View reviewed changes

mohanraj-r added 3 commits April 25, 2022 19:23

docs: link work items to TODO items

6e7e80b

Merge branch 'develop' into mohanraj-r/typescript-project-ref-enable

6cfd6bc

docs: update comment about copying js files

761cd60

mohanraj-r mentioned this pull request Apr 28, 2022

build(salesforcedx-vscode): update node to v16 and switch from npm to yarn #4042

Closed

68 tasks

gbockus-sf approved these changes May 3, 2022

View reviewed changes

Mohan Raj Rajamanickam and others added 2 commits May 3, 2022 10:46

Merge branch 'develop' into mohanraj-r/typescript-project-ref-enable

25bfccf

regenerate package lock file to fix merge conflicts

Merge branch 'develop' into mohanraj-r/typescript-project-ref-enable

58e53fd

mohanraj-r merged commit 264ab2f into develop May 3, 2022

mohanraj-r deleted the mohanraj-r/typescript-project-ref-enable branch May 3, 2022 18:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

build: add typescript project references #4055

build: add typescript project references #4055

mohanraj-r commented Apr 22, 2022 •

edited

Loading

mohanraj-r commented Apr 23, 2022

gbockus-sf Apr 26, 2022

mohanraj-r Apr 26, 2022

mohanraj-r Apr 26, 2022

mohanraj-r Apr 26, 2022

gbockus-sf left a comment

mohanraj-r commented Apr 27, 2022

mohanraj-r commented Apr 28, 2022 •

edited

Loading

gbockus-sf left a comment

build: add typescript project references #4055

build: add typescript project references #4055

Conversation

mohanraj-r commented Apr 22, 2022 • edited Loading

What does this PR do?

What does this PR doesn't do?

What issues does this PR fix or reference?

Functionality Before

Functionality After

QA Notes

mohanraj-r commented Apr 23, 2022

gbockus-sf Apr 26, 2022

Choose a reason for hiding this comment

mohanraj-r Apr 26, 2022

Choose a reason for hiding this comment

mohanraj-r Apr 26, 2022

Choose a reason for hiding this comment

mohanraj-r Apr 26, 2022

Choose a reason for hiding this comment

gbockus-sf left a comment

Choose a reason for hiding this comment

mohanraj-r commented Apr 27, 2022

mohanraj-r commented Apr 28, 2022 • edited Loading

gbockus-sf left a comment

Choose a reason for hiding this comment

mohanraj-r commented Apr 22, 2022 •

edited

Loading

mohanraj-r commented Apr 28, 2022 •

edited

Loading