@nx-dotnet/core - npm Package Compare versions

Comparing version 0.3.0-dev.4 to 0.3.0-dev.5

CHANGELOG.md

@@ -0,12 +1,17 @@
+# [0.3.0-dev.5](https://github.com/nx-dotnet/nx-dotnet/compare/v0.3.0-dev.4...v0.3.0-dev.5) (2021-05-01)
+
+
+### Features
+
+* **core:** support for single version principle [#6](https://github.com/nx-dotnet/nx-dotnet/issues/6) ([#32](https://github.com/nx-dotnet/nx-dotnet/issues/32)) ([81301b6](https://github.com/nx-dotnet/nx-dotnet/commit/81301b6eedac4f36962ab56294f3048434381374))
+
 # [0.3.0-dev.4](https://github.com/nx-dotnet/nx-dotnet/compare/v0.3.0-dev.3...v0.3.0-dev.4) (2021-04-29)
 
-
 ### Bug Fixes
 
-* **repo:** update .releaserc to commit package.json version back ([dea86e3](https://github.com/nx-dotnet/nx-dotnet/commit/dea86e3c2015ede2c10c508f8c79f2877ed9ee4d))
+- **repo:** update .releaserc to commit package.json version back ([dea86e3](https://github.com/nx-dotnet/nx-dotnet/commit/dea86e3c2015ede2c10c508f8c79f2877ed9ee4d))
 
-
 ### Features
 
-* **core:** schematic for adding npm package [#5](https://github.com/nx-dotnet/nx-dotnet/issues/5) ([b97c097](https://github.com/nx-dotnet/nx-dotnet/commit/b97c0972f1cbc87045e9047bf0222e90d3940cfe)), closes [#6](https://github.com/nx-dotnet/nx-dotnet/issues/6)
+- **core:** schematic for adding npm package [#5](https://github.com/nx-dotnet/nx-dotnet/issues/5) ([b97c097](https://github.com/nx-dotnet/nx-dotnet/commit/b97c0972f1cbc87045e9047bf0222e90d3940cfe)), closes [#6](https://github.com/nx-dotnet/nx-dotnet/issues/6)
 
@@ -13,0 +18,0 @@ ## [0.2.1](https://github.com/nx-dotnet/nx-dotnet/compare/v0.2.0...v0.2.1) (2021-04-27)

package.json

@@ -8,11 +8,12 @@ {
   "dependencies": {
-    "@nx-dotnet/dotnet": "0.3.0-dev.4",
-    "@nx-dotnet/utils": "0.3.0-dev.4",
+    "@nx-dotnet/dotnet": "0.3.0-dev.5",
+    "@nx-dotnet/utils": "0.3.0-dev.5",
     "glob": "^7.1.6",
     "rimraf": "^3.0.2",
     "xmldoc": "^1.1.2",
-    "chokidar": "^3.5.1"
+    "chokidar": "^3.5.1",
+    "inquirer": "^8.0.0"
   },
   "license": "MIT",
-  "version": "0.3.0-dev.4",
+  "version": "0.3.0-dev.5",
   "keywords": [
@@ -19,0 +20,0 @@ "Nx",

src/executors/build/executor.spec.ts

@@ -48,4 +48,4 @@ import { ExecutorContext } from '@nrwl/devkit';
 
-  afterEach(() => {
-    return rimraf(root);
+  afterEach(async () => {
+    await rimraf(root);
   });
@@ -60,3 +60,3 @@
       expect(e.message).toMatch(
-        "Unable to find a build-able project within project's source directory!"
+        "Unable to find a build-able project within project's source directory!",
       );
@@ -85,3 +85,3 @@ }
       expect(e.message).toMatch(
-        "More than one build-able projects are contained within the project's source directory!"
+        "More than one build-able projects are contained within the project's source directory!",
       );
@@ -102,3 +102,3 @@ }
     expect(
-      (dotnetClient as jest.Mocked<DotNetClient>).build
+      (dotnetClient as jest.Mocked<DotNetClient>).build,
     ).toHaveBeenCalled();
@@ -105,0 +105,0 @@ expect(res.success).toBeTruthy();

src/generators/app/generator.spec.ts

@@ -43,5 +43,5 @@ import { Tree } from '@nrwl/devkit';
       dotnetClient,
-      'application'
+      'application',
     );
   });
 });

src/generators/init/generator.js

@@ -5,13 +5,13 @@ "use strict";
 const devkit_1 = require("@nrwl/devkit");
+const utils_1 = require("@nx-dotnet/utils");
 function default_1(host) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        const initialized = host.isFile('nx-dotnet.config.js');
-        if (initialized) {
-            return;
-        }
-        host.write('nx-dotnet.config.js', `
-module.exports = {
-
-}
-  `);
+        const initialized = host.isFile(utils_1.CONFIG_FILE_PATH);
+        const configObject = initialized
+            ? devkit_1.readJson(host, utils_1.CONFIG_FILE_PATH)
+            : {
+                nugetPackages: {},
+            };
+        configObject.nugetPackages = configObject.nugetPackages || {};
+        host.write(utils_1.CONFIG_FILE_PATH, JSON.stringify(configObject, null, 2));
         updateNxJson(host);
@@ -18,0 +18,0 @@ updateGitIgnore(host);

src/generators/init/generator.spec.ts

@@ -1,4 +0,6 @@
-import { Tree } from '@nrwl/devkit';
+import { readJson, Tree } from '@nrwl/devkit';
 import { createTreeWithEmptyWorkspace } from '@nrwl/devkit/testing';
 
+import { CONFIG_FILE_PATH, NxDotnetConfig } from '@nx-dotnet/utils';
+
 import generator from './generator';
@@ -13,5 +15,5 @@
 
-  it('should run successfully', async () => {
+  it('should create config', async () => {
     await generator(appTree);
-    const config = appTree.isFile('nx-dotnet.config.js');
+    const config = appTree.isFile(CONFIG_FILE_PATH);
     expect(config).toBeTruthy();
@@ -26,2 +28,8 @@ });
   });
+
+  it('should put dependency array inside config', async () => {
+    await generator(appTree);
+    const config: NxDotnetConfig = readJson(appTree, CONFIG_FILE_PATH);
+    expect(config.nugetPackages).toBeDefined();
+  });
 });

src/generators/lib/generator.spec.ts

@@ -43,5 +43,5 @@ import { Tree } from '@nrwl/devkit';
       dotnetClient,
-      'library'
+      'library',
     );
   });
 });

src/generators/nuget-reference/generator.d.ts

 import { Tree } from '@nrwl/devkit';
 import { DotNetClient } from '@nx-dotnet/dotnet';
 import { NugetReferenceGeneratorSchema } from './schema';
-export default function (host: Tree, options: NugetReferenceGeneratorSchema, dotnetClient?: DotNetClient): Promise<{
-    success: boolean;
-}>;
+export default function (host: Tree, options: NugetReferenceGeneratorSchema, dotnetClient?: DotNetClient): Promise<void>;

src/generators/nuget-reference/generator.js

@@ -7,2 +7,4 @@ "use strict";
 const utils_1 = require("@nx-dotnet/utils");
+const resolve_version_mismatch_1 = require("../utils/resolve-version-mismatch");
+const update_dependency_version_1 = require("../utils/update-dependency-version");
 function default_1(host, options, dotnetClient = new dotnet_1.DotNetClient(dotnet_1.dotnetFactory())) {
@@ -12,11 +14,28 @@ return tslib_1.__awaiter(this, void 0, void 0, function* () {
         const projectFilePath = yield utils_1.getProjectFileForNxProject(project);
-        dotnetClient.addPackageReference(projectFilePath, options.packageName, Object.keys(options)
-            .filter((x) => x !== 'packageName' && x !== 'project')
-            .map((x) => ({
-            flag: x,
-            value: options[x],
-        })));
-        return {
-            success: true,
-        };
+        const config = utils_1.readConfig(host);
+        const configuredPkgVersion = config.nugetPackages[options.packageName];
+        const resolvedVersion = yield resolve_version_mismatch_1.resolveVersionMismatch(options.version, configuredPkgVersion, options.allowVersionMismatch);
+        config.nugetPackages[options.packageName] = resolvedVersion;
+        if (resolvedVersion !== options.version &&
+            resolvedVersion !== utils_1.ALLOW_MISMATCH) {
+            options.version = resolvedVersion;
+        }
+        try {
+            dotnetClient.addPackageReference(projectFilePath, options.packageName, Object.keys(options)
+                .filter((x) => x !== 'packageName' && x !== 'project')
+                .map((x) => ({
+                flag: x,
+                value: options[x],
+            })));
+            utils_1.updateConfig(host, config);
+            if (resolvedVersion !== utils_1.ALLOW_MISMATCH &&
+                resolvedVersion !== configuredPkgVersion &&
+                resolvedVersion) {
+                update_dependency_version_1.updateDependencyVersions(host, options.packageName, resolvedVersion);
+            }
+        }
+        catch (e) {
+            console.warn('Config not updated since dotnet failed to add dependency!');
+            throw e;
+        }
     });
@@ -23,0 +42,0 @@ }

src/generators/nuget-reference/generator.spec.ts

@@ -0,22 +1,70 @@
+import { Tree } from '@nrwl/devkit';
 import { createTreeWithEmptyWorkspace } from '@nrwl/devkit/testing';
-import { Tree, readProjectConfiguration } from '@nrwl/devkit';
 
+import { prompt } from 'inquirer';
+
+import { DotNetClient, mockDotnetFactory } from '@nx-dotnet/dotnet';
+import { updateConfig } from '@nx-dotnet/utils';
+
 import generator from './generator';
 import { NugetReferenceGeneratorSchema } from './schema';
 
+import PromptUI = require('inquirer/lib/ui/prompt');
+
+jest.mock('../../../../dotnet/src/lib/core/dotnet.client');
+jest.mock('../../../../utils/src/lib/utility-functions/workspace');
+jest.mock('inquirer');
+
 describe('nuget-reference generator', () => {
   let appTree: Tree;
+
   const options: NugetReferenceGeneratorSchema = {
     packageName: 'test',
     project: 'test',
+    allowVersionMismatch: false,
   };
 
+  let dotnetClient: DotNetClient;
+
   beforeEach(() => {
     appTree = createTreeWithEmptyWorkspace();
+    appTree.write(
+      'workspace.json',
+      JSON.stringify({
+        projects: {
+          test: {},
+        },
+      }),
+    );
+    appTree.write(
+      'nx.json',
+      JSON.stringify({
+        projects: {
+          test: {
+            tags: [],
+          },
+        },
+      }),
+    );
+
+    updateConfig(appTree, { nugetPackages: {} });
+    (prompt as jest.MockedFunction<typeof prompt>)
+      .mockReset()
+      .mockImplementation((async () => {
+        return {};
+      }) as () => Promise<unknown> & { ui: PromptUI });
+
+    dotnetClient = new DotNetClient(mockDotnetFactory());
   });
 
-  it('should run successfully', async () => {
-    // await generator(appTree, options);
-    expect(true).toBeTruthy();
+  it('runs calls dotnet add package reference', async () => {
+    await generator(appTree, options, dotnetClient);
+    const mock = dotnetClient as jest.Mocked<DotNetClient>;
+    expect(mock.addPackageReference).toHaveBeenCalledTimes(1);
   });
+
+  it('only prompts user once on version mismatch / miss', async () => {
+    await generator(appTree, options, dotnetClient);
+    expect(prompt).toHaveBeenCalledTimes(1);
+  });
 });

src/generators/nuget-reference/schema.d.ts

@@ -10,2 +10,3 @@ export interface NugetReferenceGeneratorSchema {
   noRestore?: boolean;
+  allowVersionMismatch: boolean;
 }

src/generators/nuget-reference/schema.json

@@ -52,2 +52,7 @@ {
       "description": "Adds a package reference without performing a restore preview and compatibility check."
+    },
+    "allowVersionMismatch": {
+      "type": "boolean",
+      "description": "Ignores single version principle for this package across all apps in the workspace",
+      "default": false
     }
@@ -54,0 +59,0 @@ },

src/generators/sync/generator.d.ts

 import { Tree } from '@nrwl/devkit';
-import { SyncGeneratorSchema } from './schema';
-export default function (host: Tree, options: SyncGeneratorSchema): Promise<void>;
+export default function (host: Tree): Promise<void>;

src/generators/sync/generator.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const devkit_1 = require("@nrwl/devkit");
-const path = require("path");
-function normalizeOptions(host, options) {
-    const name = devkit_1.names(options.name).fileName;
-    const projectDirectory = options.directory
-        ? `${devkit_1.names(options.directory).fileName}/${name}`
-        : name;
-    const projectName = projectDirectory.replace(new RegExp('/', 'g'), '-');
-    const projectRoot = `${devkit_1.getWorkspaceLayout(host).libsDir}/${projectDirectory}`;
-    const parsedTags = options.tags
-        ? options.tags.split(',').map((s) => s.trim())
-        : [];
-    return Object.assign(Object.assign({}, options), { projectName,
-        projectRoot,
-        projectDirectory,
-        parsedTags });
-}
-function addFiles(host, options) {
-    const templateOptions = Object.assign(Object.assign(Object.assign({}, options), devkit_1.names(options.name)), { offsetFromRoot: devkit_1.offsetFromRoot(options.projectRoot), template: '' });
-    devkit_1.generateFiles(host, path.join(__dirname, 'files'), options.projectRoot, templateOptions);
-}
-function default_1(host, options) {
+const utils_1 = require("@nx-dotnet/utils");
+const resolve_version_mismatch_1 = require("../utils/resolve-version-mismatch");
+const update_dependency_version_1 = require("../utils/update-dependency-version");
+function default_1(host) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        const normalizedOptions = normalizeOptions(host, options);
-        devkit_1.addProjectConfiguration(host, normalizedOptions.projectName, {
-            root: normalizedOptions.projectRoot,
-            projectType: 'library',
-            sourceRoot: `${normalizedOptions.projectRoot}/src`,
-            targets: {
-                build: {
-                    executor: '@nx-dotnet/core:build',
-                },
-            },
-            tags: normalizedOptions.parsedTags,
-        });
-        addFiles(host, normalizedOptions);
-        yield devkit_1.formatFiles(host);
+        const config = utils_1.readConfig(host);
+        const projects = utils_1.getNxDotnetProjects(host);
+        for (const [projectName, configuration] of projects.entries()) {
+            const projectFiles = utils_1.getProjectFilesForProject(host, configuration);
+            for (const f of projectFiles) {
+                const xmldoc = utils_1.readXml(host, f);
+                console.log(`Scanning packages for ${projectName} (${f})`);
+                yield utils_1.iterateChildrenByPath(xmldoc, 'ItemGroup.PackageReference', (reference) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                    const pkg = reference.attr['Include'];
+                    const version = reference.attr['Version'];
+                    const configuredVersion = config.nugetPackages[pkg];
+                    if (version &&
+                        version !== configuredVersion &&
+                        configuredVersion !== utils_1.ALLOW_MISMATCH) {
+                        const resolved = yield resolve_version_mismatch_1.resolveVersionMismatch(version, configuredVersion, false);
+                        // console.log('Resolved:', resolved)
+                        config.nugetPackages[pkg] = resolved;
+                        if (resolved !== utils_1.ALLOW_MISMATCH) {
+                            update_dependency_version_1.updateDependencyVersions(host, pkg, resolved);
+                        }
+                    }
+                }));
+            }
+        }
+        utils_1.updateConfig(host, config);
     });
@@ -42,0 +35,0 @@ }

src/generators/sync/generator.spec.ts

@@ -0,19 +1,38 @@
+import { Tree } from '@nrwl/devkit';
 import { createTreeWithEmptyWorkspace } from '@nrwl/devkit/testing';
-import { Tree, readProjectConfiguration } from '@nrwl/devkit';
 
+import { prompt } from 'inquirer';
+
+import { updateConfig, getNxDotnetProjects } from '@nx-dotnet/utils';
+
 import generator from './generator';
-import { SyncGeneratorSchema } from './schema';
 
+import PromptUI = require('inquirer/lib/ui/prompt');
+
+jest.mock('../../../../dotnet/src/lib/core/dotnet.client');
+jest.mock('../../../../utils/src/lib/utility-functions/workspace');
+jest.mock('inquirer');
+
 describe('sync generator', () => {
   let appTree: Tree;
-  const options: SyncGeneratorSchema = { name: 'test' };
 
   beforeEach(() => {
     appTree = createTreeWithEmptyWorkspace();
+    updateConfig(appTree, { nugetPackages: {} });
+
+    (prompt as jest.MockedFunction<typeof prompt>)
+      .mockReset()
+      .mockImplementation((async () => {
+        return {};
+      }) as () => Promise<unknown> & { ui: PromptUI });
+
+    (getNxDotnetProjects as jest.MockedFunction<typeof getNxDotnetProjects>)
+      .mockReset()
+      .mockImplementation(() => new Map());
   });
 
   it('should run successfully', async () => {
-    // await generator(appTree, options);
+    await generator(appTree);
     expect(true).toBeTruthy();
   });
 });

src/generators/sync/schema.json

@@ -7,24 +7,3 @@ {
   "type": "object",
-  "properties": {
-    "name": {
-      "type": "string",
-      "description": "",
-      "$default": {
-        "$source": "argv",
-        "index": 0
-      },
-      "x-prompt": "What name would you like to use?"
-    },
-    "tags": {
-      "type": "string",
-      "description": "Add tags to the project (used for linting)",
-      "alias": "t"
-    },
-    "directory": {
-      "type": "string",
-      "description": "A directory where the project is placed",
-      "alias": "d"
-    }
-  },
-  "required": ["name"]
+  "properties": {}
 }

src/generators/utils/generate-project.js

@@ -25,3 +25,3 @@ "use strict";
         : [];
-    parsedTags.push('nx-dotnet');
+    parsedTags.push(utils_1.NXDOTNET_TAG);
     const npmScope = devkit_1.names(devkit_1.readWorkspaceConfiguration(host).npmScope).className;
@@ -28,0 +28,0 @@ const featureScope = projectDirectory

src/generators/utils/generate-project.spec.ts

@@ -13,3 +13,3 @@ import { readProjectConfiguration, Tree } from '@nrwl/devkit';
 } from '@nx-dotnet/dotnet';
-import { findProjectFileInPath, rimraf } from '@nx-dotnet/utils';
+import { findProjectFileInPath, NXDOTNET_TAG, rimraf } from '@nx-dotnet/utils';
 
@@ -46,2 +46,8 @@ import { NxDotnetProjectGeneratorSchema } from '../../models';
 
+  it('should tag nx-dotnet projects', async () => {
+    await GenerateProject(appTree, options, dotnetClient, 'library');
+    const config = readProjectConfiguration(appTree, options.name);
+    expect(config.tags).toContain(NXDOTNET_TAG);
+  });
+
   it('should not include serve target for libraries', async () => {
@@ -101,3 +107,3 @@ await GenerateProject(appTree, options, dotnetClient, 'library');
       new DotNetClient(dotnetFactory()),
-      'library'
+      'library',
     );
@@ -107,3 +113,3 @@ const config = readProjectConfiguration(appTree, 'test');
     const projectXml = new XmlDocument(
-      readFileSync(projectFilePath).toString()
+      readFileSync(projectFilePath).toString(),
     );
@@ -110,0 +116,0 @@ const outputPath = projectXml

No alert changes

Improved metrics

Total package byte prevSize

104818

11.19%

Number of package files

95

6.74%

Lines of code

1765

8.82%

Worsened metrics

Dependency count

7

16.67%

Dependency changes

• + Added

  inquirer@^8.0.0

• + Added

  @nx-dotnet/dotnet@0.3.0-dev.5
  (transitive)

• + Added

  @nx-dotnet/utils@0.3.0-dev.5
  (transitive)

• + Added

  ansi-escapes@4.3.2
  (transitive)

• + Added

  ansi-regex@5.0.1
  (transitive)

• + Added

  ansi-styles@4.3.0
  (transitive)

• + Added

  base64-js@1.5.1
  (transitive)

• + Added

  bl@4.1.0
  (transitive)

• + Added

  buffer@5.7.1
  (transitive)

• + Added

  chalk@4.1.2
  (transitive)

• + Added

  chardet@0.7.0
  (transitive)

• + Added

  cli-cursor@3.1.0
  (transitive)

• + Added

  cli-spinners@2.9.2
  (transitive)

• + Added

  cli-width@3.0.0
  (transitive)

• + Added

  clone@1.0.4
  (transitive)

• + Added

  color-convert@2.0.1
  (transitive)

• + Added

  color-name@1.1.4
  (transitive)

• + Added

  defaults@1.0.4
  (transitive)

• + Added

  emoji-regex@8.0.0
  (transitive)

• + Added

  escape-string-regexp@1.0.5
  (transitive)

• + Added

  external-editor@3.1.0
  (transitive)

• + Added

  figures@3.2.0
  (transitive)

• + Added

  has-flag@4.0.0
  (transitive)

• + Added

  iconv-lite@0.4.24
  (transitive)

• + Added

  ieee754@1.2.1
  (transitive)

• + Added

  inquirer@8.2.6
  (transitive)

• + Added

  is-fullwidth-code-point@3.0.0
  (transitive)

• + Added

  is-interactive@1.0.0
  (transitive)

• + Added

  is-unicode-supported@0.1.0
  (transitive)

• + Added

  lodash@4.17.21
  (transitive)

• + Added

  log-symbols@4.1.0
  (transitive)

• + Added

  mimic-fn@2.1.0
  (transitive)

• + Added

  mute-stream@0.0.8
  (transitive)

• + Added

  onetime@5.1.2
  (transitive)

• + Added

  ora@5.4.1
  (transitive)

• + Added

  os-tmpdir@1.0.2
  (transitive)

• + Added

  readable-stream@3.6.2
  (transitive)

• + Added

  restore-cursor@3.1.0
  (transitive)

• + Added

  run-async@2.4.1
  (transitive)

• + Added

  rxjs@7.8.2
  (transitive)

• + Added

  safe-buffer@5.2.1
  (transitive)

• + Added

  safer-buffer@2.1.2
  (transitive)

• + Added

  signal-exit@3.0.7
  (transitive)

• + Added

  string-width@4.2.3
  (transitive)

• + Added

  string_decoder@1.3.0
  (transitive)

• + Added

  strip-ansi@6.0.1
  (transitive)

• + Added

  supports-color@7.2.0
  (transitive)

• + Added

  through@2.3.8
  (transitive)

• + Added

  tmp@0.0.33
  (transitive)

• + Added

  tslib@2.8.1
  (transitive)

• + Added

  type-fest@0.21.3
  (transitive)

• + Added

  util-deprecate@1.0.2
  (transitive)

• + Added

  wcwidth@1.0.1
  (transitive)

• + Added

  wrap-ansi@6.2.0
  (transitive)

• - Removed

  @nx-dotnet/dotnet@0.3.0-dev.4
  (transitive)

• - Removed

  @nx-dotnet/utils@0.3.0-dev.4
  (transitive)

• Updated

  @nx-dotnet/dotnet@0.3.0-dev.5

• Updated

  @nx-dotnet/utils@0.3.0-dev.5