feat: automatically updating tsconfig.json's paths mapping for core workspaces.
#587
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,280 @@ | ||
| import * as path from 'path'; | ||
| import * as fs from 'fs-extra'; | ||
| import { shared } from '@salesforce/lightning-lsp-common'; | ||
| import { readAsTextDocument } from './test-utils'; | ||
| import TSConfigPathIndexer from '../typescript/tsconfig-path-indexer'; | ||
| import { collectImportsForDocument } from '../typescript/imports'; | ||
| import { TextDocument } from 'vscode-languageserver-textdocument'; | ||
|
|
||
| const { WorkspaceType } = shared; | ||
| const TEST_WORKSPACE_PARENT_DIR = path.resolve('../..'); | ||
| const CORE_ROOT = path.resolve(TEST_WORKSPACE_PARENT_DIR, 'test-workspaces', 'core-like-workspace', 'coreTS', 'core'); | ||
|
|
||
| const tsConfigForce = path.resolve(CORE_ROOT, 'ui-force-components', 'tsconfig.json'); | ||
| const tsConfigGlobal = path.resolve(CORE_ROOT, 'ui-global-components', 'tsconfig.json'); | ||
|
|
||
| function readTSConfigFile(tsconfigPath: string): object { | ||
| if (!fs.pathExistsSync(tsconfigPath)) { | ||
| return null; | ||
| } | ||
| return JSON.parse(fs.readFileSync(tsconfigPath, 'utf8')); | ||
| } | ||
|
|
||
| function restoreTSConfigFiles(): void { | ||
| const tsconfig = { | ||
| extends: '../tsconfig.json', | ||
| compilerOptions: { | ||
| paths: {}, | ||
| }, | ||
| }; | ||
| const tsconfigPaths = [tsConfigForce, tsConfigGlobal]; | ||
| for (const tsconfigPath of tsconfigPaths) { | ||
| fs.writeJSONSync(tsconfigPath, tsconfig, { | ||
| spaces: 4, | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| function createTextDocumentFromString(content: string, uri?: string): TextDocument { | ||
| return TextDocument.create(uri ? uri : 'mockUri', 'typescript', 0, content); | ||
| } | ||
|
|
||
| beforeEach(async () => { | ||
| restoreTSConfigFiles(); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| jest.restoreAllMocks(); | ||
| restoreTSConfigFiles(); | ||
| }); | ||
|
|
||
| describe('TSConfigPathIndexer', () => { | ||
| describe('new', () => { | ||
| it('initializes with the root of a core root dir', () => { | ||
| const expectedPath: string = path.resolve('../../test-workspaces/core-like-workspace/coreTS/core'); | ||
| const tsconfigPathIndexer = new TSConfigPathIndexer([CORE_ROOT]); | ||
| expect(tsconfigPathIndexer.coreModulesWithTSConfig.length).toEqual(2); | ||
| expect(tsconfigPathIndexer.coreModulesWithTSConfig[0]).toEqual(path.resolve(expectedPath, 'ui-force-components')); | ||
| expect(tsconfigPathIndexer.coreModulesWithTSConfig[1]).toEqual(path.resolve(expectedPath, 'ui-global-components')); | ||
| expect(tsconfigPathIndexer.workspaceType).toEqual(WorkspaceType.CORE_ALL); | ||
| expect(tsconfigPathIndexer.coreRoot).toEqual(expectedPath); | ||
| }); | ||
|
|
||
| it('initializes with the root of a core project dir', () => { | ||
| const expectedPath: string = path.resolve('../../test-workspaces/core-like-workspace/coreTS/core'); | ||
| const tsconfigPathIndexer = new TSConfigPathIndexer([path.resolve(CORE_ROOT, 'ui-force-components')]); | ||
| expect(tsconfigPathIndexer.coreModulesWithTSConfig.length).toEqual(1); | ||
| expect(tsconfigPathIndexer.coreModulesWithTSConfig[0]).toEqual(path.resolve(expectedPath, 'ui-force-components')); | ||
| expect(tsconfigPathIndexer.workspaceType).toEqual(WorkspaceType.CORE_PARTIAL); | ||
| expect(tsconfigPathIndexer.coreRoot).toEqual(expectedPath); | ||
| }); | ||
| }); | ||
|
|
||
| describe('instance methods', () => { | ||
| describe('init', () => { | ||
| it('no-op on sfdx workspace root', async () => { | ||
| const tsconfigPathIndexer = new TSConfigPathIndexer([path.resolve(TEST_WORKSPACE_PARENT_DIR, 'test-workspaces', 'sfdx-workspace')]); | ||
| const spy = jest.spyOn(tsconfigPathIndexer, 'componentEntries', 'get'); | ||
| await tsconfigPathIndexer.init(); | ||
| expect(spy).not.toHaveBeenCalled(); | ||
| expect(tsconfigPathIndexer.coreRoot).toBeUndefined(); | ||
| }); | ||
|
|
||
| it('generates paths mappings for all modules on core', async () => { | ||
| const tsconfigPathIndexer = new TSConfigPathIndexer([CORE_ROOT]); | ||
| await tsconfigPathIndexer.init(); | ||
| const tsConfigForceObj = readTSConfigFile(tsConfigForce); | ||
| expect(tsConfigForceObj).toEqual({ | ||
| extends: '../tsconfig.json', | ||
| compilerOptions: { | ||
| paths: { | ||
| 'clients/context-library-lwc': ['./modules/clients/context-library-lwc/context-library-lwc'], | ||
| 'force/input-phone': ['./modules/force/input-phone/input-phone'], | ||
| }, | ||
| }, | ||
| }); | ||
| const tsConfigGlobalObj = readTSConfigFile(tsConfigGlobal); | ||
| expect(tsConfigGlobalObj).toEqual({ | ||
| extends: '../tsconfig.json', | ||
| compilerOptions: { | ||
| paths: { | ||
| 'one/app-nav-bar': ['./modules/one/app-nav-bar/app-nav-bar'], | ||
| }, | ||
| }, | ||
| }); | ||
| }); | ||
|
|
||
| it('removes paths mapping for deleted module on core', async () => { | ||
| const oldTSConfig = { | ||
| extends: '../tsconfig.json', | ||
| compilerOptions: { | ||
| paths: { | ||
| 'force/deleted': ['./modules/force/deleted/deleted'], | ||
| 'one/deleted': ['../ui-global-components/modules/one/deleted/deleted'], | ||
| }, | ||
| }, | ||
| }; | ||
| fs.writeJSONSync(tsConfigForce, oldTSConfig, { | ||
| spaces: 4, | ||
| }); | ||
| const tsconfigPathIndexer = new TSConfigPathIndexer([CORE_ROOT]); | ||
| await tsconfigPathIndexer.init(); | ||
| const tsConfigForceObj = readTSConfigFile(tsConfigForce); | ||
| expect(tsConfigForceObj).toEqual({ | ||
| extends: '../tsconfig.json', | ||
| compilerOptions: { | ||
| paths: { | ||
| 'clients/context-library-lwc': ['./modules/clients/context-library-lwc/context-library-lwc'], | ||
| 'force/input-phone': ['./modules/force/input-phone/input-phone'], | ||
| }, | ||
| }, | ||
| }); | ||
| }); | ||
|
|
||
| it('keep existing path mapping for any js cmp', async () => { | ||
| const oldTSConfig = { | ||
| extends: '../tsconfig.json', | ||
| compilerOptions: { | ||
| paths: { | ||
| 'force/input-phone-js': ['./modules/force/input-phone-js/input-phone-js'], | ||
| }, | ||
| }, | ||
| }; | ||
| fs.writeJSONSync(tsConfigForce, oldTSConfig, { | ||
| spaces: 4, | ||
| }); | ||
| const tsconfigPathIndexer = new TSConfigPathIndexer([CORE_ROOT]); | ||
| await tsconfigPathIndexer.init(); | ||
| const tsConfigForceObj = readTSConfigFile(tsConfigForce); | ||
| expect(tsConfigForceObj).toEqual({ | ||
| extends: '../tsconfig.json', | ||
| compilerOptions: { | ||
| paths: { | ||
| 'clients/context-library-lwc': ['./modules/clients/context-library-lwc/context-library-lwc'], | ||
| 'force/input-phone': ['./modules/force/input-phone/input-phone'], | ||
| 'force/input-phone-js': ['./modules/force/input-phone-js/input-phone-js'], | ||
| }, | ||
| }, | ||
| }); | ||
| }); | ||
|
|
||
| it('update existing path mapping for cross-namespace cmp', async () => { | ||
| const oldTSConfig = { | ||
| extends: '../tsconfig.json', | ||
| compilerOptions: { | ||
| paths: { | ||
| 'one/app-nav-bar': ['../ui-global-components/modules/one/deletedOldPath/deletedOldPath'], | ||
| }, | ||
| }, | ||
| }; | ||
| fs.writeJSONSync(tsConfigForce, oldTSConfig, { | ||
| spaces: 4, | ||
| }); | ||
| const tsconfigPathIndexer = new TSConfigPathIndexer([CORE_ROOT]); | ||
| await tsconfigPathIndexer.init(); | ||
| const tsConfigForceObj = readTSConfigFile(tsConfigForce); | ||
| expect(tsConfigForceObj).toEqual({ | ||
| extends: '../tsconfig.json', | ||
| compilerOptions: { | ||
| paths: { | ||
| 'clients/context-library-lwc': ['./modules/clients/context-library-lwc/context-library-lwc'], | ||
| 'force/input-phone': ['./modules/force/input-phone/input-phone'], | ||
| 'one/app-nav-bar': ['../ui-global-components/modules/one/app-nav-bar/app-nav-bar'], | ||
| }, | ||
| }, | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| describe('updateTSConfigFileForDocument', () => { | ||
| it('no-op on sfdx workspace root', async () => { | ||
| const tsconfigPathIndexer = new TSConfigPathIndexer([path.resolve(TEST_WORKSPACE_PARENT_DIR, 'test-workspaces', 'sfdx-workspace')]); | ||
| await tsconfigPathIndexer.init(); | ||
| const filePath = path.resolve(CORE_ROOT, 'ui-force-components', 'modules', 'force', 'input-phone', 'input-phone.ts'); | ||
| const spy = jest.spyOn(tsconfigPathIndexer as any, 'addNewPathMapping'); | ||
| await tsconfigPathIndexer.updateTSConfigFileForDocument(readAsTextDocument(filePath)); | ||
| expect(spy).not.toHaveBeenCalled(); | ||
| expect(tsconfigPathIndexer.coreRoot).toBeUndefined(); | ||
| }); | ||
|
|
||
| it('updates tsconfig for all imports', async () => { | ||
| const tsconfigPathIndexer = new TSConfigPathIndexer([CORE_ROOT]); | ||
| await tsconfigPathIndexer.init(); | ||
| const filePath = path.resolve(CORE_ROOT, 'ui-force-components', 'modules', 'force', 'input-phone', 'input-phone.ts'); | ||
| await tsconfigPathIndexer.updateTSConfigFileForDocument(readAsTextDocument(filePath)); | ||
| const tsConfigForceObj = readTSConfigFile(tsConfigForce); | ||
| expect(tsConfigForceObj).toEqual({ | ||
| extends: '../tsconfig.json', | ||
| compilerOptions: { | ||
| paths: { | ||
| 'one/app-nav-bar': ['../ui-global-components/modules/one/app-nav-bar/app-nav-bar'], | ||
| 'clients/context-library-lwc': ['./modules/clients/context-library-lwc/context-library-lwc'], | ||
| 'force/input-phone': ['./modules/force/input-phone/input-phone'], | ||
| }, | ||
| }, | ||
| }); | ||
| }); | ||
|
|
||
| it('do not update tsconfig for import that is not found', async () => { | ||
| const tsconfigPathIndexer = new TSConfigPathIndexer([CORE_ROOT]); | ||
| await tsconfigPathIndexer.init(); | ||
| const fileContent = ` | ||
| import { util } from 'ns/notFound'; | ||
| `; | ||
| const filePath = path.resolve(CORE_ROOT, 'ui-force-components', 'modules', 'force', 'input-phone', 'input-phone.ts'); | ||
| await tsconfigPathIndexer.updateTSConfigFileForDocument(createTextDocumentFromString(fileContent, filePath)); | ||
| const tsConfigForceObj = readTSConfigFile(tsConfigForce); | ||
| expect(tsConfigForceObj).toEqual({ | ||
| extends: '../tsconfig.json', | ||
| compilerOptions: { | ||
| paths: { | ||
| 'clients/context-library-lwc': ['./modules/clients/context-library-lwc/context-library-lwc'], | ||
| 'force/input-phone': ['./modules/force/input-phone/input-phone'], | ||
| }, | ||
| }, | ||
| }); | ||
| }); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| describe('imports', () => { | ||
| describe('collectImportsForDocument', () => { | ||
| it('should exclude special imports', async () => { | ||
| const document = createTextDocumentFromString(` | ||
| import {api} from 'lwc'; | ||
| import {obj1} from './abc'; | ||
| import {obj2} from '../xyz'; | ||
| import {obj3} from 'lightning/confirm'; | ||
| import {obj4} from '@salesforce/label/x'; | ||
| import {obj5} from 'x.html'; | ||
| import {obj6} from 'y.css'; | ||
| import {obj7} from 'namespace/cmpName'; | ||
| `); | ||
| const imports = await collectImportsForDocument(document); | ||
| expect(imports.size).toEqual(1); | ||
|
There was a problem hiding this comment.
|
||
| expect(imports.has('namespace/cmpName')); | ||
| }); | ||
|
|
||
| it('should work for partial file content', async () => { | ||
| const document = createTextDocumentFromString(` | ||
| import from | ||
| `); | ||
| const imports = await collectImportsForDocument(document); | ||
| expect(imports.size).toEqual(0); | ||
| }); | ||
|
|
||
| it('dynamic imports', async () => { | ||
| const document = createTextDocumentFromString(` | ||
| const { | ||
| default: myDefault, | ||
| foo, | ||
| bar, | ||
| } = await import("force/wireUtils"); | ||
| `); | ||
| const imports = await collectImportsForDocument(document); | ||
| expect(imports.size).toEqual(1); | ||
| expect(imports.has('force/wireUtils')); | ||
| }); | ||
| }); | ||
| }); | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure I understand why this is outside of the namespace root.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is to test that if a ts file that is outside of the VSCode workspace is modified, we do not update tsconfig.json. Here the context workspace root is
CORE_PROJECT_ROOTwhich isui-global-componentsso if a file inui-force-componentsis modified the return value ofisLWCTypeScriptshould be false. I'll add an inline comment to explain this.