import { getProjects, readJson, Tree, updateJson } from '@nrwl/devkit'; import { createTreeWithEmptyWorkspace } from '@nrwl/devkit/testing'; import libraryGenerator from './library'; import { Linter } from '@nrwl/linter'; import { Schema } from './schema'; describe('lib', () => { let appTree: Tree; const defaultSchema: Schema = { name: 'myLib', linter: Linter.EsLint, skipFormat: false, skipTsConfig: false, unitTestRunner: 'jest', strict: true, }; beforeEach(() => { appTree = createTreeWithEmptyWorkspace(); appTree.write('.gitignore', ''); }); describe('not nested', () => { it('should update workspace.json', async () => { await libraryGenerator(appTree, defaultSchema); const workspaceJson = readJson(appTree, '/workspace.json'); expect(workspaceJson.projects['my-lib'].root).toEqual('libs/my-lib'); expect(workspaceJson.projects['my-lib'].architect.build).toBeUndefined(); expect(workspaceJson.projects['my-lib'].architect.lint).toEqual({ builder: '@nrwl/linter:eslint', outputs: ['{options.outputFile}'], options: { lintFilePatterns: ['libs/my-lib/**/*.{ts,tsx,js,jsx}'], }, }); }); it('should update nx.json', async () => { await libraryGenerator(appTree, { ...defaultSchema, tags: 'one,two' }); const nxJson = readJson(appTree, '/nx.json'); expect(nxJson.projects).toEqual({ 'my-lib': { tags: ['one', 'two'], }, }); }); it('should update tsconfig.base.json', async () => { await libraryGenerator(appTree, defaultSchema); const tsconfigJson = readJson(appTree, '/tsconfig.base.json'); expect(tsconfigJson.compilerOptions.paths['@proj/my-lib']).toEqual([ 'libs/my-lib/src/index.ts', ]); }); it('should update root tsconfig.base.json (no existing path mappings)', async () => { updateJson(appTree, 'tsconfig.base.json', (json) => { json.compilerOptions.paths = undefined; return json; }); await libraryGenerator(appTree, defaultSchema); const tsconfigJson = readJson(appTree, '/tsconfig.base.json'); expect(tsconfigJson.compilerOptions.paths['@proj/my-lib']).toEqual([ 'libs/my-lib/src/index.ts', ]); }); it('should create a local tsconfig.json', async () => { await libraryGenerator(appTree, defaultSchema); const tsconfigJson = readJson(appTree, 'libs/my-lib/tsconfig.json'); expect(tsconfigJson.references).toEqual([ { path: './tsconfig.lib.json', }, { path: './tsconfig.spec.json', }, ]); expect( tsconfigJson.compilerOptions.forceConsistentCasingInFileNames ).toEqual(true); expect(tsconfigJson.compilerOptions.strict).toEqual(true); expect(tsconfigJson.compilerOptions.noImplicitReturns).toEqual(true); expect(tsconfigJson.compilerOptions.noFallthroughCasesInSwitch).toEqual( true ); }); it('should extend the local tsconfig.json with tsconfig.spec.json', async () => { await libraryGenerator(appTree, defaultSchema); const tsconfigJson = readJson(appTree, 'libs/my-lib/tsconfig.spec.json'); expect(tsconfigJson.extends).toEqual('./tsconfig.json'); }); it('should extend the local tsconfig.json with tsconfig.lib.json', async () => { await libraryGenerator(appTree, defaultSchema); const tsconfigJson = readJson(appTree, 'libs/my-lib/tsconfig.lib.json'); expect(tsconfigJson.extends).toEqual('./tsconfig.json'); }); }); describe('nested', () => { it('should update nx.json', async () => { await libraryGenerator(appTree, { ...defaultSchema, directory: 'myDir', tags: 'one', }); const nxJson = readJson(appTree, '/nx.json'); expect(nxJson.projects).toEqual({ 'my-dir-my-lib': { tags: ['one'], }, }); await libraryGenerator(appTree, { ...defaultSchema, name: 'myLib2', directory: 'myDir', tags: 'one,two', }); const nxJson2 = readJson(appTree, '/nx.json'); expect(nxJson2.projects).toEqual({ 'my-dir-my-lib': { tags: ['one'], }, 'my-dir-my-lib2': { tags: ['one', 'two'], }, }); }); it('should update workspace.json', async () => { await libraryGenerator(appTree, { ...defaultSchema, directory: 'myDir' }); const workspaceJson = readJson(appTree, '/workspace.json'); expect(workspaceJson.projects['my-dir-my-lib'].root).toEqual( 'libs/my-dir/my-lib' ); expect(workspaceJson.projects['my-dir-my-lib'].architect.lint).toEqual({ builder: '@nrwl/linter:eslint', outputs: ['{options.outputFile}'], options: { lintFilePatterns: ['libs/my-dir/my-lib/**/*.{ts,tsx,js,jsx}'], }, }); }); it('should update tsconfig.base.json', async () => { await libraryGenerator(appTree, { ...defaultSchema, directory: 'myDir' }); const tsconfigJson = readJson(appTree, '/tsconfig.base.json'); expect(tsconfigJson.compilerOptions.paths['@proj/my-dir/my-lib']).toEqual( ['libs/my-dir/my-lib/src/index.ts'] ); expect( tsconfigJson.compilerOptions.paths['my-dir-my-lib/*'] ).toBeUndefined(); }); it('should create a local tsconfig.json', async () => { await libraryGenerator(appTree, { ...defaultSchema, directory: 'myDir' }); const tsconfigJson = readJson( appTree, 'libs/my-dir/my-lib/tsconfig.json' ); expect(tsconfigJson.references).toEqual([ { path: './tsconfig.lib.json', }, { path: './tsconfig.spec.json', }, ]); }); }); describe('--unit-test-runner none', () => { it('should not generate test configuration', async () => { await libraryGenerator(appTree, { ...defaultSchema, unitTestRunner: 'none', }); expect(appTree.exists('libs/my-lib/tsconfig.spec.json')).toBeFalsy(); expect(appTree.exists('libs/my-lib/jest.config.js')).toBeFalsy(); const workspaceJson = readJson(appTree, 'workspace.json'); expect(workspaceJson.projects['my-lib'].architect.test).toBeUndefined(); expect(workspaceJson.projects['my-lib'].architect.lint) .toMatchInlineSnapshot(` Object { "builder": "@nrwl/linter:eslint", "options": Object { "lintFilePatterns": Array [ "libs/my-lib/**/*.{ts,tsx,js,jsx}", ], }, "outputs": Array [ "{options.outputFile}", ], } `); }); }); describe('--buildable', () => { it('should have a builder defined', async () => { await libraryGenerator(appTree, { ...defaultSchema, buildable: true, }); const workspaceJson = getProjects(appTree); expect(workspaceJson.get('my-lib').targets.build).toBeDefined(); }); }); describe('--publishable', () => { it('should add build architect', async () => { await libraryGenerator(appTree, { ...defaultSchema, publishable: true, importPath: '@proj/my-lib', }); const workspaceJson = getProjects(appTree); expect(workspaceJson.get('my-lib').targets.build).toMatchObject({ executor: '@nrwl/web:package', outputs: ['{options.outputPath}'], options: { external: ['react/jsx-runtime'], entryFile: 'libs/my-lib/src/index.ts', outputPath: 'dist/libs/my-lib', project: 'libs/my-lib/package.json', tsConfig: 'libs/my-lib/tsconfig.lib.json', rollupConfig: '@nrwl/react/plugins/bundle-rollup', }, }); }); it('should fail if no importPath is provided with publishable', async () => { expect.assertions(1); try { await libraryGenerator(appTree, { ...defaultSchema, directory: 'myDir', publishable: true, }); } catch (e) { expect(e.message).toContain( 'For publishable libs you have to provide a proper "--importPath" which needs to be a valid npm package name (e.g. my-awesome-lib or @myorg/my-lib)' ); } }); it('should add package.json and .babelrc', async () => { await libraryGenerator(appTree, { ...defaultSchema, publishable: true, importPath: '@proj/my-lib', }); const packageJson = readJson(appTree, '/libs/my-lib/package.json'); expect(packageJson.name).toEqual('@proj/my-lib'); expect(appTree.exists('/libs/my-lib/.babelrc')); }); }); describe('--js', () => { it('should generate JS files', async () => { await libraryGenerator(appTree, { ...defaultSchema, js: true, }); expect(appTree.exists('/libs/my-lib/src/index.js')).toBe(true); }); }); describe('--importPath', () => { it('should update the package.json & tsconfig with the given import path', async () => { await libraryGenerator(appTree, { ...defaultSchema, publishable: true, directory: 'myDir', importPath: '@myorg/lib', }); const packageJson = readJson(appTree, 'libs/my-dir/my-lib/package.json'); const tsconfigJson = readJson(appTree, '/tsconfig.base.json'); expect(packageJson.name).toBe('@myorg/lib'); expect( tsconfigJson.compilerOptions.paths[packageJson.name] ).toBeDefined(); }); it('should fail if the same importPath has already been used', async () => { await libraryGenerator(appTree, { ...defaultSchema, name: 'myLib1', publishable: true, importPath: '@myorg/lib', }); try { await libraryGenerator(appTree, { ...defaultSchema, name: 'myLib2', publishable: true, importPath: '@myorg/lib', }); } catch (e) { expect(e.message).toContain( 'You already have a library using the import path' ); } expect.assertions(1); }); }); describe('--no-strict', () => { it('should not add options for strict mode', async () => { await libraryGenerator(appTree, { ...defaultSchema, strict: false, }); const tsconfigJson = readJson(appTree, '/libs/my-lib/tsconfig.json'); expect( tsconfigJson.compilerOptions.forceConsistentCasingInFileNames ).not.toBeDefined(); expect(tsconfigJson.compilerOptions.strict).not.toBeDefined(); expect(tsconfigJson.compilerOptions.noImplicitReturns).not.toBeDefined(); expect( tsconfigJson.compilerOptions.noFallthroughCasesInSwitch ).not.toBeDefined(); }); }); });