feat: add 'platform' field to lib schematic

alternative to discussion in issue NativeScript#6
marckassay · Feb 25, 2022 · e578084 · e578084
1 parent 3536b9c
commit e578084
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 5 deletions.
diff --git a/packages/nx/src/generators/library/library.spec.ts b/packages/nx/src/generators/library/library.spec.ts
@@ -11,7 +11,7 @@ describe('lib', () => {
 
   describe('not nested', () => {
     it('should update workspace.json', async () => {
-      await library(tree, { name: 'myLib' });
+      await library(tree, { name: 'myLib', platform: 'nativescript' });
       const libName = `nativescript-my-lib`;
 
       expect(tree.exists(`libs/${libName}/tsconfig.json`)).toBeTruthy();
@@ -33,8 +33,31 @@ describe('lib', () => {
       });
     });
 
+    it(`should update workspace.json having an omitted 'platform' segment in name`, async () => {
+      await library(tree, { name: 'myLib', platform: 'none' });
+      const libName = `my-lib`;
+
+      expect(tree.exists(`libs/${libName}/tsconfig.json`)).toBeTruthy();
+      expect(tree.exists(`libs/${libName}/references.d.ts`)).toBeTruthy();
+
+      const tsconfig = readJson(tree, `libs/${libName}/tsconfig.json`);
+      expect(tsconfig.files).toEqual(['./references.d.ts']);
+      expect(tsconfig.include).toEqual(['**/*.ts']);
+
+      const projectConfig = readProjectConfiguration(tree, libName);
+      expect(projectConfig.root).toEqual(`libs/${libName}`);
+      expect(projectConfig.targets.build).toBeUndefined();
+      expect(projectConfig.targets.lint).toEqual({
+        executor: '@nrwl/linter:eslint',
+        options: {
+          lintFilePatterns: [`libs/${libName}/**/*.ts`],
+        },
+        outputs: ['{options.outputFile}'],
+      });
+    });
+
     it('groupByName: should update workspace.json', async () => {
-      await library(tree, { name: 'myLib', groupByName: true });
+      await library(tree, { name: 'myLib', groupByName: true, platform: 'nativescript' });
       const libName = `my-lib-nativescript`;
       const projectConfig = readProjectConfiguration(tree, libName);
 
@@ -50,7 +73,7 @@ describe('lib', () => {
     });
 
     it('should update root tsconfig.json', async () => {
-      await library(tree, { name: 'myLib' });
+      await library(tree, { name: 'myLib', platform: 'nativescript' });
       const libName = `nativescript-my-lib`;
       const tsconfigJson = readJson(tree, '/tsconfig.base.json');
       expect(tsconfigJson.compilerOptions.paths[`@proj/${libName}`]).toEqual([`libs/${libName}/src/index.ts`]);
@@ -62,7 +85,7 @@ describe('lib', () => {
         return json;
       });
 
-      await library(tree, { name: 'myLib' });
+      await library(tree, { name: 'myLib', platform: 'nativescript' });
       const libName = `nativescript-my-lib`;
       const tsconfigJson = readJson(tree, '/tsconfig.base.json');
       expect(tsconfigJson.compilerOptions.paths[`@proj/${libName}`]).toEqual([`libs/${libName}/src/index.ts`]);

diff --git a/packages/nx/src/generators/library/library.ts b/packages/nx/src/generators/library/library.ts
@@ -4,8 +4,10 @@ import { libraryGenerator } from '@nrwl/workspace';
 
 export function library(tree: Tree, options: any) {
 
+    options.platform = options.platform === 'none' ? undefined : options.platform;
+
     prerun(tree, options, true);
-    PluginHelpers.applyAppNamingConvention(tree, options, 'nativescript'),
+    PluginHelpers.applyAppNamingConvention(tree, options, options.platform),
     libraryGenerator(tree, options)
 
       // add extra files

diff --git a/packages/nx/src/generators/library/schema.d.ts b/packages/nx/src/generators/library/schema.d.ts
@@ -2,6 +2,11 @@ import { Linter } from '@nrwl/workspace/src/utils/lint';
 
 export interface Schema {
   name: string;
+  /**
+   * Should always be parsed with a string value, defaults to `'nativescript'`. However,
+   * if value is `'none'` value will be replaced with `undefined` after being parsed.
+   */
+  platform: string | undefined;
   directory?: string;
   skipTsConfig: boolean;
   skipFormat: boolean;

diff --git a/packages/nx/src/generators/library/schema.json b/packages/nx/src/generators/library/schema.json
@@ -20,6 +20,12 @@
       "x-prompt": "What name would you like to use for the library?",
       "pattern": "^[a-zA-Z]{1}.*$"
     },
+    "platform": {
+      "description": "An arbitrary value to be assigned to this library's folder name.",
+      "type": "string",
+      "default": "nativescript",
+      "x-prompt": "What platform does this NativeScript lib belong to?"
+    },
     "directory": {
       "type": "string",
       "description": "A directory where the lib is placed"