feat: configure sfdx workspace to write tsconfig files
#591
Conversation
| @@ -130,6 +131,15 @@ export default class Server { | |||
| }; | |||
| } | |||
|
|
|||
| async onInitialized(): Promise<void> { | |||
| // The config value comes from salesforcedx-vscode/salesforcedx-vscode-lwc | |||
| const hasTsEnabled = await this.connection.workspace.getConfiguration('salesforcedx-vscode-lwc.preview.typeScriptSupport'); | |||
There was a problem hiding this comment.
The entire feature is gated behind this feature flag, which hasn't been implemented in salesforcedx-vscode yet.
There is a follow-up PR to implement the flag, in the meantime, I've tested locally that when the config value is enabled it works correctly.
There was a problem hiding this comment.
After discussing with the team, we should remove the tsconfig.json if salesforcedx-vscode-lwc.preview.typeScriptSupport = false.
| @@ -80,6 +80,7 @@ export default class Server { | |||
|
|
|||
| constructor() { | |||
| this.connection.onInitialize(this.onInitialize.bind(this)); | |||
| this.connection.onInitialized(this.onInitialized.bind(this)); | |||
There was a problem hiding this comment.
Looks like config values are not available during onInitialize which is why I'm using onInitialized instead.
Once the feature is GA, we can move everything back to onInitialize.
| const tsConfigTemplate = await fs.readFile(utils.getSfdxResource('tsconfig-sfdx.json'), 'utf8'); | ||
| const forceignore = path.join(this.workspaceRoots[0], '.forceignore'); | ||
| // TODO: We should only be looking through modules that have TS files | ||
| const modulesDirs = await this.getModulesDirs(); |
There was a problem hiding this comment.
In a follow-up PR I plan to only check for lwc directories that actually have TS files.
For now, I'm writing to all lwc directories.
There was a problem hiding this comment.
We should also only be generating either a jsconfig.json or a tsconfig.json but not both, this can be done once we've moved to GA.
packages/lightning-lsp-common/src/resources/sfdx/tsconfig-sfdx.base.json
Outdated
Show resolved
Hide resolved
….base.json Co-authored-by: Will Harney <62956339+wjhsf@users.noreply.github.com>
mingxuanzhangsfdx
requested review from
mingxuanzhangsfdx
and removed request for
a team and
peternhale
|
NIT: In order to pass the step
|
| const relativeWorkspaceRoot = utils.relativePath(path.dirname(tsConfigPath), this.workspaceRoots[0]); | ||
| const tsConfigContent = this.processTemplate(tsConfigTemplate, { project_root: relativeWorkspaceRoot }); | ||
| this.updateConfigFile(tsConfigPath, tsConfigContent); | ||
| await this.updateForceIgnoreFile(forceignore); |
There was a problem hiding this comment.
What is the point here to call this.updateForceIgnoreFile? The file you are adding is tsconfig.json here. but the function is to add jsconfig and eslintrc into ignore file. Are you trying to ignore the tsconfig.json files?
There was a problem hiding this comment.
nvm I saw the PR you created
There was a problem hiding this comment.
This is the same behavior as with jsconfig.json, if the language server detects a tsconfig.json it will add it to the ignore file.
What does this PR do?
This PR adds the ability for the language server to generate a
tsconfig.jsonin addition to thejsconfig.json.The language server will generate a
tsconfig.sfdx.jsonfile in the.sfdxdirectory and atsconfig.jsonin eachlwcdirectory.The feature is gated behind a feature flag that will be implemented in the
salesforcedx-vscoderepository.What issues does this PR fix or reference?
@W-15644075@