refactor(rules): moved rules from utils to rules directory

Author: xmlking

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

@@ -8,7 +8,7 @@ import {
   Tree
 } from '@angular-devkit/schematics';
 import { getWorkspace } from '@schematics/angular/utility/config';
-import { addDomainToLintingRules } from '../utils/update-linting-rules';
+import { addDomainToLintingRules } from '../rules';
 import { DomainOptions } from './schema';
 
 export default function(options: DomainOptions): Rule {

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

@@ -9,9 +9,11 @@ import {
   Tree,
   url
 } from '@angular-devkit/schematics';
-import { addExportsToBarrel } from '../utils/add-exports-to-barrel';
-import { readWorkspaceName } from '../utils/read-workspace-name';
-import { addImportsToModule } from './rules/add-imports-to-module';
+import {
+  addExportsToBarrel,
+  addNgxsImportsToModule,
+  readWorkspaceName
+} from '../rules';
 import { EntityOptions } from './schema';
 
 export default function(options: EntityOptions): Rule {
@@ -35,7 +37,7 @@ export default function(options: EntityOptions): Rule {
         `./lib/services/${strings.dasherize(options.name)}.service`,
         `./lib/state/${strings.dasherize(options.name)}.state`
       ]),
-      addImportsToModule(options)
+      addNgxsImportsToModule(options)
     ]);
   };
 }

libs/ddd/src/schematics/ng-add/index.ts

@@ -1,7 +1,6 @@
 import { chain, Rule } from '@angular-devkit/schematics';
-import { addNgRxToPackageJson } from '../utils/add-ngxs-to-package-json';
-import { initLintingRules } from '../utils/update-linting-rules';
+import { addNgxsToPackageJson, initLintingRules } from '../rules';
 
 export default function(): Rule {
-  return chain([initLintingRules(), addNgRxToPackageJson()]);
+  return chain([initLintingRules(), addNgxsToPackageJson()]);
 }

libs/ddd/src/schematics/utils/add-exports-to-barrel.ts renamed to libs/ddd/src/schematics/rules/add-exports-to-barrel.ts

@@ -4,9 +4,9 @@ import { addImportToModule } from '@nrwl/angular/src/utils/ast-utils';
 import { insert, toClassName } from '@nrwl/workspace';
 import { insertImport } from '@nrwl/workspace/src/utils/ast-utils';
 import * as ts from 'typescript';
-import { EntityOptions } from '../schema';
+import { EntityOptions } from '../entity/schema';
 
-export function addImportsToModule(options: EntityOptions): Rule {
+export function addNgxsImportsToModule(options: EntityOptions): Rule {
   return (host: Tree) => {
     const stateName = `${toClassName(options.name)}State`;
     const storeForFeature = `NgxsModule.forFeature([${stateName}])`;

libs/ddd/src/schematics/entity/rules/add-imports-to-module.ts renamed to libs/ddd/src/schematics/rules/add-ngxs-imports-to-module.ts

@@ -2,7 +2,7 @@ import { Rule } from '@angular-devkit/schematics';
 import { addDepsToPackageJson } from '@nrwl/workspace/src/utils/ast-utils';
 
 const ngxsVersion = '3.6.2';
-export function addNgRxToPackageJson(): Rule {
+export function addNgxsToPackageJson(): Rule {
   return addDepsToPackageJson(
     {
       '@ngxs/devtools-plugin': ngxsVersion,

libs/ddd/src/schematics/utils/add-ngxs-to-package-json.ts renamed to libs/ddd/src/schematics/rules/add-ngxs-to-package-json.ts

@@ -0,0 +1,8 @@
+export { addExportsToBarrel } from './add-exports-to-barrel';
+export { addNgxsImportsToModule } from './add-ngxs-imports-to-module';
+export { addNgxsToPackageJson } from './add-ngxs-to-package-json';
+export { readWorkspaceName } from './read-workspace-name';
+export {
+  addDomainToLintingRules,
+  initLintingRules
+} from './update-linting-rules';

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

@@ -1,4 +1,4 @@
-import { Rule, Tree, SchematicContext  } from '@angular-devkit/schematics';
+import { Rule, Tree, SchematicContext } from '@angular-devkit/schematics';
 
 export function checkRuleExists(rules: object, context: SchematicContext) {
   if (!rules['rules']) {
@@ -17,35 +17,43 @@ export function checkRuleExists(rules: object, context: SchematicContext) {
   }
 
   if (!rules['rules']['nx-enforce-module-boundaries'][1]['depConstraints']) {
-    context.logger.info('tslint.json: nx-enforce-module-boundaries.1.depConstraints expected.');
+    context.logger.info(
+      'tslint.json: nx-enforce-module-boundaries.1.depConstraints expected.'
+    );
     return false;
   }
 
-  if (!Array.isArray(rules['rules']['nx-enforce-module-boundaries'][1]['depConstraints'])) {
-    context.logger.info('tslint.json: nx-enforce-module-boundaries.1.depConstraints expected to be an array.');
+  if (
+    !Array.isArray(
+      rules['rules']['nx-enforce-module-boundaries'][1]['depConstraints']
+    )
+  ) {
+    context.logger.info(
+      'tslint.json: nx-enforce-module-boundaries.1.depConstraints expected to be an array.'
+    );
     return false;
   }
 
   return true;
 }
 
-
 export function addDomainToLintingRules(domainName: string): Rule {
   return (host: Tree, context: SchematicContext) => {
     const text = host.read('tslint.json').toString();
     const rules = JSON.parse(text);
 
     if (!checkRuleExists(rules, context)) return;
 
-    const depConst = rules['rules']['nx-enforce-module-boundaries'][1]['depConstraints'];
+    const depConst =
+      rules['rules']['nx-enforce-module-boundaries'][1]['depConstraints'];
     depConst.push({
-      'sourceTag': `domain:${domainName}`,
-      'onlyDependOnLibsWithTags': [`domain:${domainName}`, 'domain:shared']
+      sourceTag: `domain:${domainName}`,
+      onlyDependOnLibsWithTags: [`domain:${domainName}`, 'domain:shared']
     });
 
     const newText = JSON.stringify(rules, undefined, 2);
     host.overwrite('tslint.json', newText);
-  }
+  };
 }
 
 export function initLintingRules(): Rule {
@@ -55,15 +63,19 @@ export function initLintingRules(): Rule {
 
     if (!checkRuleExists(rules, context)) return;
 
-    const depConst = rules['rules']['nx-enforce-module-boundaries'][1]['depConstraints'] as Array<object>;
+    const depConst = rules['rules']['nx-enforce-module-boundaries'][1][
+      'depConstraints'
+    ] as Array<object>;
 
-    const jokerIndex = depConst.findIndex(entry =>
-      entry['sourceTag']
-        && entry['sourceTag'] === '*'
-        && entry['onlyDependOnLibsWithTags']
-        && Array.isArray(entry['onlyDependOnLibsWithTags'])
-        && entry['onlyDependOnLibsWithTags'].length > 0
-        && entry['onlyDependOnLibsWithTags'][0] === '*');
+    const jokerIndex = depConst.findIndex(
+      entry =>
+        entry['sourceTag'] &&
+        entry['sourceTag'] === '*' &&
+        entry['onlyDependOnLibsWithTags'] &&
+        Array.isArray(entry['onlyDependOnLibsWithTags']) &&
+        entry['onlyDependOnLibsWithTags'].length > 0 &&
+        entry['onlyDependOnLibsWithTags'][0] === '*'
+    );
 
     if (jokerIndex !== -1) {
       depConst.splice(jokerIndex, 1);
@@ -90,31 +102,31 @@ export function initLintingRules(): Rule {
     });
 
     depConst.push({
-      'sourceTag': 'type:api',
-      'onlyDependOnLibsWithTags': ['type:ui', 'type:domain-logic', 'type:util']
+      sourceTag: 'type:api',
+      onlyDependOnLibsWithTags: ['type:ui', 'type:domain-logic', 'type:util']
     });
 
     depConst.push({
-      'sourceTag': 'type:feature',
-      'onlyDependOnLibsWithTags': ['type:ui', 'type:domain-logic', 'type:util']
+      sourceTag: 'type:feature',
+      onlyDependOnLibsWithTags: ['type:ui', 'type:domain-logic', 'type:util']
     });
 
     depConst.push({
-      'sourceTag': 'type:ui',
-      'onlyDependOnLibsWithTags': ['type:domain-logic', 'type:util']
+      sourceTag: 'type:ui',
+      onlyDependOnLibsWithTags: ['type:domain-logic', 'type:util']
     });
 
     depConst.push({
-      'sourceTag': 'domain-logic',
-      'onlyDependOnLibsWithTags': ['type:util']
+      sourceTag: 'domain-logic',
+      onlyDependOnLibsWithTags: ['type:util']
     });
 
     depConst.push({
-      'sourceTag': 'domain:shared',
-      'onlyDependOnLibsWithTags': ['domain:shared']
+      sourceTag: 'domain:shared',
+      onlyDependOnLibsWithTags: ['domain:shared']
     });
 
     const newText = JSON.stringify(rules, undefined, 2);
     host.overwrite('tslint.json', newText);
-  }
+  };
 }