Merge branch 'master' into feat/nx-11

Author: manfredsteyer

.cz-config.js

@@ -0,0 +1,65 @@
+module.exports = {
+  types: [
+    { value: 'feat', name: 'feat:     A new feature' },
+    { value: 'fix', name: 'fix:      A bug fix' },
+    { value: 'docs', name: 'docs:     Documentation only changes' },
+    {
+      value: 'cleanup',
+      name:
+        'cleanup:  A code change that neither fixes a bug nor adds a feature',
+    },
+    {
+      value: 'chore',
+      name: "chore:    Other changes that don't modify src or test files",
+    },
+  ],
+
+  scopes: [
+    { name: 'schematics', description: 'anything related to the ddd schematics' },
+    { name: 'repo', description: 'anything making improvements on the repo' },
+    { name: 'misc', description: 'misc stuff' },
+  ],
+
+  allowTicketNumber: true,
+  isTicketNumberRequired: false,
+  ticketNumberPrefix: 'TICKET-',
+  ticketNumberRegExp: '\\d{1,5}',
+
+  // it needs to match the value for field type. Eg.: 'fix'
+  /*
+  scopeOverrides: {
+    fix: [
+      {name: 'merge'},
+      {name: 'style'},
+      {name: 'e2eTest'},
+      {name: 'unitTest'}
+    ]
+  },
+  */
+  // override the messages, defaults are as follows
+  messages: {
+    type: "Select the type of change that you're committing:",
+    scope: '\nDenote the SCOPE of this change (optional):',
+    // used if allowCustomScopes is true
+    customScope: 'Denote the SCOPE of this change:',
+    subject:
+      'Write a SHORT, IMPERATIVE (lowercase) description of the change:\n',
+    body:
+      'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
+    breaking: 'List any BREAKING CHANGES (optional):\n',
+    footer:
+      'List any ISSUES CLOSED by this change (optional). E.g.: #31, #34:\n',
+    confirmCommit: 'Are you sure you want to proceed with the commit above?',
+  },
+
+  allowCustomScopes: false,
+  allowBreakingChanges: ['feat', 'fix'],
+  // skip any questions you want
+  skipQuestions: ['ticketNumber'],
+
+  // limit subject length
+  subjectLimit: 100,
+  // breaklineChar: '|', // It is supported for fields body and footer.
+  // footerPrefix : 'ISSUES CLOSED:'
+  // askForBreakingChangeFirst : true, // default is false
+};

apps/ddd-e2e/jest.config.js

@@ -1,5 +1,5 @@
 module.exports = {
   name: 'ddd-e2e',
   preset: '../../jest.config.js',
-  coverageDirectory: '../../coverage/appsddd-e2e'
+  coverageDirectory: '../../coverage/appsddd-e2e',
 };

apps/ddd-e2e/tests/ddd.test.ts

@@ -3,10 +3,10 @@ import {
   ensureNxProject,
   readJson,
   runNxCommandAsync,
-  uniq
+  uniq,
 } from '@nrwl/nx-plugin/testing';
 describe('ddd e2e', () => {
-  it('should create ddd', async done => {
+  it('should create ddd', async (done) => {
     const plugin = uniq('ddd');
     ensureNxProject('@angular-architects/ddd', 'dist/libs/ddd');
     await runNxCommandAsync(`generate @angular-architects/ddd:ddd ${plugin}`);
@@ -18,7 +18,7 @@ describe('ddd e2e', () => {
   });
 
   describe('--directory', () => {
-    it('should create src in the specified directory', async done => {
+    it('should create src in the specified directory', async (done) => {
       const plugin = uniq('ddd');
       ensureNxProject('@angular-architects/ddd', 'dist/libs/ddd');
       await runNxCommandAsync(
@@ -32,7 +32,7 @@ describe('ddd e2e', () => {
   });
 
   describe('--tags', () => {
-    it('should add tags to nx.json', async done => {
+    it('should add tags to nx.json', async (done) => {
       const plugin = uniq('ddd');
       ensureNxProject('@angular-architects/ddd', 'dist/libs/ddd');
       await runNxCommandAsync(

libs/ddd/README.md

@@ -14,11 +14,11 @@ The generated access restrictions prevent unwanted access between libraries resp
 - ⚙️ Generating feature libraries including a feature components using the facades
 - 🙅‍♂️ Adding linting rules for access restrictions between domains as proposed by Nrwl
 - 🙅‍♀️ Adding linting rules for access restrictions between layers as proposed by Nrwl (supports tslint and eslint)
-- 🔥 Optionally generates skeleton for NGRX and integrates it into the DDD design (``--ngrx`` switch)
+- 🔥 Optionally generates skeleton for NGRX and integrates it into the DDD design (`--ngrx` switch)
 
 ### Features Overview Video
-<a href="https://www.youtube.com/watch?v=39JLXMEE7Ds" target="_blank">![Screenshot of Overview Video](https://i.imgur.com/VlTRE80.png)</a>
 
+<a href="https://www.youtube.com/watch?v=39JLXMEE7Ds" target="_blank">![Screenshot of Overview Video](https://i.imgur.com/VlTRE80.png)</a>
 
 ## Usage
 
@@ -38,16 +38,15 @@ ng g @angular-architects/ddd:feature cancel --domain booking
 ng g @angular-architects/ddd:feature manage --domain boarding
 ```
 
-For NGRX support, just add the ``--ngrx`` switch:
+For NGRX support, just add the `--ngrx` switch:
 
 ```
 ng g @angular-architects/ddd:domain booking --addApp --ngrx
 ng g @angular-architects/ddd:feature search --domain booking --entity flight --ngrx
 [...]
 ```
 
-
-This example assumes that you have an app ``flight-app`` in place.
+This example assumes that you have an app `flight-app` in place.
 
 These schematics also wire up the individual libs. To see the result, create a dependency graph:
 
@@ -57,7 +56,7 @@ npm run dep-graph
 
 ![dependency graph](https://github.com/angular-architects/nx-ddd-plugin/blob/master/libs/ddd/assets/ddd.png?raw=true)
 
-To see that the skeleton works end-to-end, call the generated feature component in your ``app.component.html``:
+To see that the skeleton works end-to-end, call the generated feature component in your `app.component.html`:
 
 ```html
 <booking-search></booking-search>
@@ -79,7 +78,7 @@ The domain layer is subdivided into three parts:
 
 ### Generated Structure for Domain Library
 
-- **application:** Contains application services. This is a DDD term for what we call facades in Angular nowadays. They orchestrate everything for a use case given so that a feature component only needs to communicate with one such facade. Also, it hides details for state management. While the generates facades just use a ``BehaviorSubject``, feel free to add a library like NGRX underneath. As such a modifications changes nothing from the component's perspective, you can use facades to introduce NGRX later on demand.
+- **application:** Contains application services. This is a DDD term for what we call facades in Angular nowadays. They orchestrate everything for a use case given so that a feature component only needs to communicate with one such facade. Also, it hides details for state management. While the generates facades just use a `BehaviorSubject`, feel free to add a library like NGRX underneath. As such a modifications changes nothing from the component's perspective, you can use facades to introduce NGRX later on demand.
 - **entities:** Client-side data model including logic operating on it (like validations).
 - **infrastructure:** Services for communicating with the backend.
 
@@ -102,6 +101,7 @@ see https://github.com/angular-architects/ddd-demo
 - [Our eBook on Angular and architectures](https://leanpub.com/enterprise-angular)
 - [Thomas Burlison's article about facades in Angular](https://medium.com/@thomasburlesonIA/push-based-architectures-with-rxjs-81b327d7c32d)
 
-## More 
+## More
+
 - [Angular Architecture Workshop](https://www.angulararchitects.io/en/angular-workshops/advanced-angular-enterprise-architecture-incl-ivy/)
 - [Follow us on Twitter](https://twitter.com/ManfredSteyer)

libs/ddd/collection.json

@@ -28,4 +28,4 @@
       "description": "adds a utility library to a domain or as a shared library"
     }
   }
-}
+}

libs/ddd/node_modules/.yarn-integrity

@@ -1,6 +1,6 @@
 {
   "name": "@angular-architects/ddd",
-  "version": "1.1.0",
+  "version": "1.2.2",
   "license": "MIT",
   "author": "Manfred Steyer",
   "description": "Nx plugin for structuring a monorepo with domains and layers",

libs/ddd/package.json

@@ -0,0 +1,46 @@
+import { Tree } from '@angular-devkit/schematics';
+import { SchematicTestRunner } from '@angular-devkit/schematics/testing';
+import { NxJson, readJsonInTree } from '@nrwl/workspace';
+import { createEmptyWorkspace } from '@nrwl/workspace/testing';
+import { join } from 'path';
+
+describe('domain', () => {
+  let appTree: Tree;
+
+  const testRunner = new SchematicTestRunner(
+    '@angular-architects/ddd',
+    join(__dirname, '../../../collection.json')
+  );
+
+  function runSchematic<SchemaOptions = any>(
+    schematicName: string,
+    options: SchemaOptions,
+    tree: Tree
+  ) {
+    return testRunner
+      .runSchematicAsync(schematicName, options, tree)
+      .toPromise();
+  }
+
+  beforeEach(() => {
+    appTree = Tree.empty();
+    appTree = createEmptyWorkspace(appTree);
+  });
+
+  /**
+  it('should ........', async () => {
+    const tree = await runSchematic<UiOptions>(
+      'ui',
+      { name: 'form-components', shared: true },
+      appTree
+    );
+
+    const nxJson = readJsonInTree<NxJson>(tree, '/nx.json');
+    expect(nxJson.projects).toEqual({
+      '........': {
+        tags: ['domain:abcdefg', 'type:xyz'],
+      },
+    });
+  });
+  */
+});

libs/ddd/src/schematics/domain/index.spec.ts

@@ -19,52 +19,70 @@ import {
 } from '../rules';
 
 export default function (options: DomainOptions): Rule {
-  const libFolder = strings.dasherize(options.name);
+  const appName = strings.dasherize(options.name);
+  const appNameAndDirectory = options.appDirectory
+    ? `${options.appDirectory}/${appName}`
+    : appName;
+  const appNameAndDirectoryDasherized = strings
+    .dasherize(appNameAndDirectory)
+    .split('/')
+    .join('-');
+  const appFolderPath = `apps/${appNameAndDirectory}`;
+  const appModuleFolder = `${appFolderPath}/src/app`;
+  const appModuleFilepath = `${appModuleFolder}/app.module.ts`;
+
+  const libName = strings.dasherize(options.name);
+  const libNameAndDirectory = options.directory
+    ? `${libName}/${options.directory}`
+    : libName;
+  const libNameAndDirectoryDasherized = strings
+    .dasherize(libNameAndDirectory)
+    .split('/')
+    .join('-');
+  const libFolderPath = `libs/${libNameAndDirectory}`;
+  const libLibFolder = `${libFolderPath}/domain/src/lib`;
 
   const templateSource = apply(url('./files'), [
     template({}),
-    move(`libs/${libFolder}/domain/src/lib`),
+    move(`${libLibFolder}`),
   ]);
 
-  const appFolderName = strings.dasherize(options.name);
-  const appPath = `apps/${appFolderName}/src/app`;
-  const appModulePath = `${appPath}/app.module.ts`;
-
   if (options.ngrx && !options.addApp) {
     throw new Error(
       `The 'ngrx' option may only be used when the 'addApp' option is used.`
-    )
+    );
   }
 
   return chain([
     externalSchematic('@nrwl/angular', 'lib', {
       name: 'domain',
-      directory: options.name,
-      tags: `domain:${options.name},type:domain-logic`,
+      directory: libNameAndDirectory,
+      tags: `domain:${libName},type:domain-logic`,
       style: 'scss',
-      prefix: options.name,
+      prefix: libName,
       publishable: options.type === 'publishable',
       buildable: options.type === 'buildable',
     }),
-    addDomainToLintingRules(options.name),
+    addDomainToLintingRules(libName),
     mergeWith(templateSource),
     !options.addApp
       ? noop()
       : externalSchematic('@nrwl/angular', 'app', {
-          name: options.name,
-          tags: `domain:${options.name},type:app`,
+          name: appName,
+          directory: options.appDirectory,
+          tags: `domain:${appName},type:app`,
           style: 'scss',
         }),
     options.addApp && options.ngrx
       ? chain([
           externalSchematic('@ngrx/schematics', 'store', {
-            project: options.name,
+            project: appNameAndDirectoryDasherized,
             root: true,
             minimal: true,
             module: 'app.module.ts',
             name: 'state',
           }),
-          addNgrxImportsToApp(appModulePath),
+          addNgrxImportsToApp(appModuleFilepath),
           addNgRxToPackageJson(),
         ])
       : noop(),

libs/ddd/src/schematics/domain/index.ts

@@ -5,13 +5,21 @@
   "properties": {
     "name": {
       "type": "string",
-      "description": "Domain name",
+      "description": "Grouping name for the Domain",
       "x-prompt": "What is the name of the domain?",
       "$default": {
         "$source": "argv",
         "index": 0
       }
     },
+    "appDirectory": {
+      "type": "string",
+      "description": "Grouping folder within the apps directory"
+    },
+    "directory": {
+      "type": "string",
+      "description": "Subpath of the domain within libs directory"
+    },
     "addApp": {
       "type": "boolean",
       "description": "Add an app for the domain?",