feat: provide packages from x-promt

let users select the tools to install by using x-prompt or provide the
option
`packages=<list='commitlint'|'commitizen'|'husky'|'standard-version'>`
This is currently blocked by angular/angular-cli#16104

BREAKING CHANGE: `--husky=<false|true>`, `--commitizen=<false|true>`, `--standardVersion=<false|true>` are not supported anymore| use `--packages=commitizen,husky,commitlint,standard-version` instead.
By default all packaged will be added.

relates to #11

Author: d-koppenhagen

src/ng-add/index.ts

@@ -19,31 +19,34 @@ import { getPackageJson, overwritePackageJson } from '../utils';
 export default (options: Schema): Rule => {
   return chain([
     addDependencies(options),
-    addCommitlintConfigFile(options),
-    addDependency(options.husky) ? addHuskyConfig(options) : noop(),
-    addDependency(options.commitizen) ? addCommitizenConfig(options) : noop(),
-    addDependency(options.standardVersion) ? addNpmRunScript(options) : noop(),
-    addDependency(options.standardVersion) && options.issuePrefix
+    options.packages.includes('commitlint') ? addCommitlintConfigFile(options) : noop(),
+    options.packages.includes('husky') ? addHuskyConfig(options) : noop(),
+    options.packages.includes('commitizen') ? addCommitizenConfig(options) : noop(),
+    options.packages.includes('standard-version') ? addNpmRunScript(options) : noop(),
+    options.packages.includes('standard-version') && options.issuePrefix
       ? standardVersionConfig(options)
       : noop(),
     options.skipInstall ? noop() : installDependencies,
   ]);
 };
 
-const addDependency = (configForDependency: boolean | undefined) => {
-  return configForDependency === true || typeof configForDependency === 'undefined';
-};
-
 const addDependencies = (options: Schema) => (tree: Tree, context: SchematicContext) => {
   context.logger.info('Added npm packages as dev dependencies');
   const packageJson = getPackageJson(tree);
 
-  let devDepsToAdd: { [key: string]: string } = {
-    '@commitlint/cli': '^8.2.0',
-    '@commitlint/config-conventional': '^8.2.0',
-  };
+  let devDepsToAdd: { [key: string]: string } = {};
+
+  if (options.packages.includes('commitlint')) {
+    devDepsToAdd = {
+      ...devDepsToAdd,
+      '@commitlint/cli': '^8.2.0',
+      '@commitlint/config-conventional': '^8.2.0',
+    };
+  } else {
+    context.logger.info('- Skips adding commitlint');
+  }
 
-  if (addDependency(options.commitizen)) {
+  if (options.packages.includes('commitizen')) {
     devDepsToAdd = {
       ...devDepsToAdd,
       commitizen: '^4.0.3',
@@ -53,7 +56,7 @@ const addDependencies = (options: Schema) => (tree: Tree, context: SchematicCont
     context.logger.info('- Skips adding commitizen');
   }
 
-  if (addDependency(options.husky)) {
+  if (options.packages.includes('husky')) {
     devDepsToAdd = {
       ...devDepsToAdd,
       husky: '^3.0.9',
@@ -62,7 +65,7 @@ const addDependencies = (options: Schema) => (tree: Tree, context: SchematicCont
     context.logger.info('- Skips adding husky');
   }
 
-  if (addDependency(options.standardVersion)) {
+  if (options.packages.includes('standard-version')) {
     devDepsToAdd = {
       ...devDepsToAdd,
       'standard-version': '^7.0.0',

src/ng-add/index_spec.ts

@@ -16,6 +16,7 @@ describe('ngx-semantic-version schematic', () => {
   const project = 'foo';
   const defaultOptions: Schema = {
     skipInstall: false,
+    packages: ['commitlint', 'commitizen', 'husky', 'standard-version'],
   };
 
   let appTree: UnitTestTree;
@@ -75,10 +76,17 @@ describe('ngx-semantic-version schematic', () => {
     });
   });
 
-  describe(`when disabling 'husky'`, () => {
+  describe(`when not using 'husky'`, () => {
     beforeEach(async () => {
       appTree = await schematicRunner
-        .runSchematicAsync('ng-add', { ...defaultOptions, husky: false }, appTree)
+        .runSchematicAsync(
+          'ng-add',
+          {
+            ...defaultOptions,
+            packages: ['commitlint', 'commitizen', 'standard-version'],
+          },
+          appTree,
+        )
         .toPromise();
     });
 
@@ -97,10 +105,40 @@ describe('ngx-semantic-version schematic', () => {
     });
   });
 
+  describe(`when disabling 'commitlint'`, () => {
+    beforeEach(async () => {
+      appTree = await schematicRunner
+        .runSchematicAsync(
+          'ng-add',
+          {
+            ...defaultOptions,
+            packages: ['commitizen', 'husky', 'standard-version'],
+          },
+          appTree,
+        )
+        .toPromise();
+    });
+
+    it(`should not add 'commitlint' to the project`, () => {
+      const packageJson = JSON.parse(getFileContent(appTree, PACKAGE_JSON_PATH));
+      const { devDependencies } = packageJson;
+      expect(appTree.files).toContain(PACKAGE_JSON_PATH);
+      expect(devDependencies['@commitlint/cli']).not.toBeDefined();
+      expect(devDependencies['@commitlint/config-conventional']).not.toBeDefined();
+    });
+  });
+
   describe(`when disabling 'commitizen'`, () => {
     beforeEach(async () => {
       appTree = await schematicRunner
-        .runSchematicAsync('ng-add', { ...defaultOptions, commitizen: false }, appTree)
+        .runSchematicAsync(
+          'ng-add',
+          {
+            ...defaultOptions,
+            packages: ['commitlint', 'husky', 'standard-version'],
+          },
+          appTree,
+        )
         .toPromise();
     });
 
@@ -122,7 +160,14 @@ describe('ngx-semantic-version schematic', () => {
   describe(`when disabling 'standard-version'`, () => {
     beforeEach(async () => {
       appTree = await schematicRunner
-        .runSchematicAsync('ng-add', { ...defaultOptions, standardVersion: false }, appTree)
+        .runSchematicAsync(
+          'ng-add',
+          {
+            ...defaultOptions,
+            packages: ['commitlint', 'commitizen', 'husky'],
+          },
+          appTree,
+        )
         .toPromise();
     });
 

src/ng-add/schema.json

@@ -5,26 +5,22 @@
   "description": "configure commitlint, husky, commitizen and standard-version configuration",
   "type": "object",
   "properties": {
+    "packages": {
+      "type": "array",
+      "description": "select the packages that should to be installed and configured",
+      "default": ["commitlint", "commitizen", "husky", "standard-version"],
+      "x-prompt": {
+        "message": "What packages do you want to be installed and configured?",
+        "type": "list",
+        "multiselect": true,
+        "items": ["commitlint", "commitizen", "husky", "standard-version"]
+      }
+    },
     "skipInstall": {
       "type": "boolean",
       "description": "Skip installing the npm packages",
       "default": false
     },
-    "commitizen": {
-      "type": "boolean",
-      "description": "Do not install and configure commitizen",
-      "default": true
-    },
-    "husky": {
-      "type": "boolean",
-      "description": "Do not install and configure husky",
-      "default": true
-    },
-    "standardVersion": {
-      "type": "boolean",
-      "description": "Do not install and configure standard-version",
-      "default": true
-    },
     "issuePrefix": {
       "type": "string",
       "description": "configure an issue prefix that should be checked by each commit",
@@ -36,5 +32,5 @@
       "default": false
     }
   },
-  "required": []
+  "required": ["packages"]
 }