@ng-doc/add 15.0.0-beta.15 → 15.0.0-beta.17

package/README.md

@@ -1,11 +1,40 @@
-# add
+[![GitHub Workflow Status][build-shield]][build-url]
+[![NPM][npm-shield]][npm-url]
+[![MIT License][license-shield]][license-url]
 
-This library was generated with [Nx](https://nx.dev).
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://github.com/skoropadas/ng-doc">
+    <img src="apps/ng-doc/src/assets/images/ng-doc.svg" alt="Logo" height="100px">
+  </a>
 
-## Building
+<h3 align="center">NgDoc</h3>
 
-Run `nx build add` to build the library.
+  <p align="center">
+    Create documentation faster than ever!
+    <br />
+    <a href="https://ng-doc.com/"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+	<a href="https://ng-doc.com/getting-started/roadmap">Roadmap</a>
+    ·
+    <a href="https://github.com/skoropadas/ng-doc/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/skoropadas/ng-doc/issues">Request Feature</a>
+  </p>
+</div>
 
-## Running unit tests
+<!-- ABOUT THE PROJECT -->
 
-Run `nx test add` to execute the unit tests via [Jest](https://jestjs.io).
+## About The Project
+
+This library is a part of NgDoc project, that uses to create documentation
+for Angular projects, please check our [repo](https://github.com/skoropadas/ng-doc) for more details.
+
+[npm-shield]: https://img.shields.io/npm/v/@ng-doc/builder.svg?style=for-the-badge
+[npm-url]: https://www.npmjs.com/package/@ng-doc/builder
+[license-shield]: https://img.shields.io/github/license/skoropadas/ng-doc.svg?style=for-the-badge
+[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt
+[build-shield]: https://img.shields.io/github/actions/workflow/status/skoropadas/ng-doc/release.yml?style=for-the-badge&branch=release
+[build-url]: https://github.com/skoropadas/ng-doc/actions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ng-doc/add",
-  "version": "15.0.0-beta.15",
+  "version": "15.0.0-beta.17",
   "type": "commonjs",
   "schematics": "./schematics/collection.json",
   "ng-add": {
@@ -15,5 +15,25 @@
     "ng-morph": "^2.1.1"
   },
   "main": "./schematics/index.js",
-  "types": "./schematics/index.d.ts"
+  "types": "./schematics/index.d.ts",
+  "keywords": [
+    "angular",
+    "documentation",
+    "generator",
+    "builder",
+    "guides",
+    "api",
+    "demo",
+    "ng-doc"
+  ],
+  "author": "Skoropad Aleksandr <alex@skoropad.dev>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/skoropadas/ng-doc.git"
+  },
+  "bugs": {
+    "url": "https://github.com/skoropadas/ng-doc/issues"
+  },
+  "homepage": "https://ng-doc.com/",
+  "license": "MIT"
 }

package/schematics/ng-add/index.js

@@ -7,6 +7,7 @@ const ng_morph_1 = require("ng-morph");
 const version_1 = require("./constants/version");
 const add_assets_1 = require("./steps/add-assets");
 const add_git_ignore_1 = require("./steps/add-git-ignore");
+const add_js_dependencies_1 = require("./steps/add-js-dependencies");
 const add_layout_1 = require("./steps/add-layout");
 const add_ng_doc_modules_1 = require("./steps/add-ng-doc-modules");
 const add_styles_1 = require("./steps/add-styles");
@@ -40,6 +41,7 @@ function ngAddSetupProject(options) {
         (0, replace_builders_1.replaceBuilders)(options),
         (0, add_styles_1.addStyles)(options),
         (0, add_assets_1.addAssets)(options),
+        (0, add_js_dependencies_1.addJsDependencies)(options),
         (0, add_ng_doc_modules_1.addNgDocModules)(options),
         (0, add_layout_1.addLayout)(options),
         (0, add_tsconfig_paths_1.addTsconfigPaths)(options),

package/schematics/ng-add/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../libs/add/schematics/ng-add/index.ts"],"names":[],"mappings":";;;AAAA,2DAA+E;AAC/E,4DAA0F;AAC1F,uCAAgH;AAEhH,iDAAmD;AAEnD,mDAA6C;AAC7C,2DAAoD;AACpD,mDAA6C;AAC7C,mEAA2D;AAC3D,mDAA6C;AAC7C,mEAA4D;AAC5D,+DAAyD;AACzD,uEAA+D;AAE/D;;;GAGG;AACH,SAAgB,KAAK,CAAC,OAAe;IACpC,OAAO,CAAC,IAAU,EAAE,OAAyB,EAAE,EAAE;QAChD,IAAA,2BAAgB,EAAC,IAAA,wBAAa,EAAC,IAAI,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;QAErE,IAAA,mCAAwB,EAAC,IAAI,EAAE,EAAC,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,wBAAc,EAAC,CAAC,CAAC;QAC/E,IAAA,mCAAwB,EAAC,IAAI,EAAE,EAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,wBAAc,EAAC,CAAC,CAAC;QACnF,IAAA,mCAAwB,EAAC,IAAI,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,wBAAc,EAAC,CAAC,CAAC;QAClF,IAAA,mCAAwB,EAAC,IAAI,EAAE,EAAC,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,wBAAc,EAAC,CAAC,CAAC;QAChF,IAAA,sCAA2B,EAAC,IAAI,EAAE,aAAa,CAAC,CAAC;QAEjD,OAAO,CAAC,OAAO,CAAC,IAAI,8BAAsB,EAAE,EAAE;YAC7C,OAAO,CAAC,OAAO,CAAC,IAAI,wBAAgB,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC;SACtE,CAAC,CAAC;IACJ,CAAC,CAAC;AACH,CAAC;AAdD,sBAcC;AAED;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,OAAe;IAChD,OAAO,IAAA,kBAAK,EAAC;QACZ,IAAA,kCAAe,EAAC,OAAO,CAAC;QACxB,IAAA,sBAAS,EAAC,OAAO,CAAC;QAClB,IAAA,sBAAS,EAAC,OAAO,CAAC;QAClB,IAAA,oCAAe,EAAC,OAAO,CAAC;QACxB,IAAA,sBAAS,EAAC,OAAO,CAAC;QAClB,IAAA,qCAAgB,EAAC,OAAO,CAAC;QACzB,IAAA,wCAAiB,EAAC,OAAO,CAAC;QAC1B,IAAA,6BAAY,GAAE;KACd,CAAC,CAAC;AACJ,CAAC;AAXD,8CAWC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../libs/add/schematics/ng-add/index.ts"],"names":[],"mappings":";;;AAAA,2DAA+E;AAC/E,4DAA0F;AAC1F,uCAAgH;AAEhH,iDAAmD;AAEnD,mDAA6C;AAC7C,2DAAoD;AACpD,qEAA8D;AAC9D,mDAA6C;AAC7C,mEAA2D;AAC3D,mDAA6C;AAC7C,mEAA4D;AAC5D,+DAAyD;AACzD,uEAA+D;AAE/D;;;GAGG;AACH,SAAgB,KAAK,CAAC,OAAe;IACpC,OAAO,CAAC,IAAU,EAAE,OAAyB,EAAE,EAAE;QAChD,IAAA,2BAAgB,EAAC,IAAA,wBAAa,EAAC,IAAI,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;QAErE,IAAA,mCAAwB,EAAC,IAAI,EAAE,EAAC,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,wBAAc,EAAC,CAAC,CAAC;QAC/E,IAAA,mCAAwB,EAAC,IAAI,EAAE,EAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,wBAAc,EAAC,CAAC,CAAC;QACnF,IAAA,mCAAwB,EAAC,IAAI,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,wBAAc,EAAC,CAAC,CAAC;QAClF,IAAA,mCAAwB,EAAC,IAAI,EAAE,EAAC,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,wBAAc,EAAC,CAAC,CAAC;QAChF,IAAA,sCAA2B,EAAC,IAAI,EAAE,aAAa,CAAC,CAAC;QAEjD,OAAO,CAAC,OAAO,CAAC,IAAI,8BAAsB,EAAE,EAAE;YAC7C,OAAO,CAAC,OAAO,CAAC,IAAI,wBAAgB,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC;SACtE,CAAC,CAAC;IACJ,CAAC,CAAC;AACH,CAAC;AAdD,sBAcC;AAED;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,OAAe;IAChD,OAAO,IAAA,kBAAK,EAAC;QACZ,IAAA,kCAAe,EAAC,OAAO,CAAC;QACxB,IAAA,sBAAS,EAAC,OAAO,CAAC;QAClB,IAAA,sBAAS,EAAC,OAAO,CAAC;QAClB,IAAA,uCAAiB,EAAC,OAAO,CAAC;QAC1B,IAAA,oCAAe,EAAC,OAAO,CAAC;QACxB,IAAA,sBAAS,EAAC,OAAO,CAAC;QAClB,IAAA,qCAAgB,EAAC,OAAO,CAAC;QACzB,IAAA,wCAAiB,EAAC,OAAO,CAAC;QAC1B,IAAA,6BAAY,GAAE;KACd,CAAC,CAAC;AACJ,CAAC;AAZD,8CAYC"}

package/schematics/ng-add/steps/add-assets.js

@@ -21,17 +21,11 @@ function addAssets(options) {
             }
             const targetOptions = (0, schematics_1.getProjectTargetOptions)(project, 'build');
             const assets = targetOptions['assets'];
-            const jsDependencies = targetOptions['allowedCommonJsDependencies'];
             if (!assets) {
                 targetOptions['assets'] = assets_1.NG_DOC_ASSETS;
                 return;
             }
-            if (!jsDependencies) {
-                targetOptions['allowedCommonJsDependencies'] = ['@ng-doc/core'];
-                return;
-            }
             targetOptions['assets'] = Array.from(new Set([...assets_1.NG_DOC_ASSETS, ...assets]));
-            targetOptions['allowedCommonJsDependencies'] = Array.from(new Set([...jsDependencies, '@ng-doc/core']));
         });
     };
 }

package/schematics/ng-add/steps/add-assets.js.map

@@ -1 +1 @@
-{"version":3,"file":"add-assets.js","sourceRoot":"","sources":["../../../../../../libs/add/schematics/ng-add/steps/add-assets.ts"],"names":[],"mappings":";;;AAAA,wDAAgE;AAGhE,qEAA8G;AAE9G,gDAAkD;AAElD,sDAAgD;AAEhD;;;;GAIG;AACH,SAAgB,SAAS,CAAC,OAAe;IACxC,OAAO,KAAK,EAAE,IAAU,EAAE,OAAyB,EAAE,EAAE;QACtD,OAAO,IAAA,2BAAe,EAAC,CAAC,SAA8B,EAAE,EAAE;YACzD,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;YAEvD,MAAM,OAAO,GAAkC,IAAA,wBAAU,EAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAE9E,IAAI,CAAC,OAAO,EAAE;gBACb,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;gBAC5D,OAAO;aACP;YAED,MAAM,aAAa,GAA8B,IAAA,oCAAuB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAE3F,MAAM,MAAM,GAA0B,aAAa,CAAC,QAAQ,CAA0B,CAAC;YACvF,MAAM,cAAc,GAA0B,aAAa,CAAC,6BAA6B,CAA0B,CAAC;YAEpH,IAAI,CAAC,MAAM,EAAE;gBACZ,aAAa,CAAC,QAAQ,CAAC,GAAG,sBAAa,CAAC;gBACxC,OAAO;aACP;YAED,IAAI,CAAC,cAAc,EAAE;gBACpB,aAAa,CAAC,6BAA6B,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;gBAChE,OAAO;aACP;YAED,aAAa,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,sBAAa,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YAC7E,aAAa,CAAC,6BAA6B,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;QACzG,CAAC,CAAC,CAAC;IACJ,CAAC,CAAA;AACF,CAAC;AA/BD,8BA+BC"}
+{"version":3,"file":"add-assets.js","sourceRoot":"","sources":["../../../../../../libs/add/schematics/ng-add/steps/add-assets.ts"],"names":[],"mappings":";;;AAAA,wDAAgE;AAGhE,qEAA8G;AAE9G,gDAAkD;AAElD,sDAAgD;AAEhD;;;;GAIG;AACH,SAAgB,SAAS,CAAC,OAAe;IACxC,OAAO,KAAK,EAAE,IAAU,EAAE,OAAyB,EAAE,EAAE;QACtD,OAAO,IAAA,2BAAe,EAAC,CAAC,SAA8B,EAAE,EAAE;YACzD,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;YAEvD,MAAM,OAAO,GAAkC,IAAA,wBAAU,EAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAE9E,IAAI,CAAC,OAAO,EAAE;gBACb,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;gBAC5D,OAAO;aACP;YAED,MAAM,aAAa,GAA8B,IAAA,oCAAuB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAE3F,MAAM,MAAM,GAA0B,aAAa,CAAC,QAAQ,CAA0B,CAAC;YAEvF,IAAI,CAAC,MAAM,EAAE;gBACZ,aAAa,CAAC,QAAQ,CAAC,GAAG,sBAAa,CAAC;gBACxC,OAAO;aACP;YAED,aAAa,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,sBAAa,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QAC9E,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC;AACH,CAAC;AAxBD,8BAwBC"}

package/schematics/ng-add/steps/add-js-dependencies.d.ts

@@ -0,0 +1,8 @@
+import { Rule } from '@angular-devkit/schematics';
+import { Schema } from '../schema';
+/**
+ *
+ * @param options
+ * @param context
+ */
+export declare function addJsDependencies(options: Schema): Rule;

package/schematics/ng-add/steps/add-js-dependencies.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addJsDependencies = void 0;
+const schematics_1 = require("@angular/cdk/schematics");
+const workspace_1 = require("@schematics/angular/utility/workspace");
+const get_project_1 = require("../utils/get-project");
+/**
+ *
+ * @param options
+ * @param context
+ */
+function addJsDependencies(options) {
+    return async (tree, context) => {
+        return (0, workspace_1.updateWorkspace)((workspace) => {
+            context.logger.info(`[INFO]: Adding @ng-doc/core to allowedCommonJsDependencies...`);
+            const project = (0, get_project_1.getProject)(options, workspace);
+            if (!project) {
+                context.logger.warn(`[WARNING]: Target project not found.`);
+                return;
+            }
+            const targetOptions = (0, schematics_1.getProjectTargetOptions)(project, 'build');
+            const jsDependencies = targetOptions['allowedCommonJsDependencies'];
+            if (!jsDependencies) {
+                targetOptions['allowedCommonJsDependencies'] = ['@ng-doc/core'];
+                return;
+            }
+            targetOptions['allowedCommonJsDependencies'] = Array.from(new Set([...jsDependencies, '@ng-doc/core']));
+        });
+    };
+}
+exports.addJsDependencies = addJsDependencies;
+//# sourceMappingURL=add-js-dependencies.js.map

package/schematics/ng-add/steps/add-js-dependencies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-js-dependencies.js","sourceRoot":"","sources":["../../../../../../libs/add/schematics/ng-add/steps/add-js-dependencies.ts"],"names":[],"mappings":";;;AAAA,wDAAgE;AAGhE,qEAA8G;AAG9G,sDAAgD;AAEhD;;;;GAIG;AACH,SAAgB,iBAAiB,CAAC,OAAe;IAChD,OAAO,KAAK,EAAE,IAAU,EAAE,OAAyB,EAAE,EAAE;QACtD,OAAO,IAAA,2BAAe,EAAC,CAAC,SAA8B,EAAE,EAAE;YACzD,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,+DAA+D,CAAC,CAAC;YAErF,MAAM,OAAO,GAAkC,IAAA,wBAAU,EAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAE9E,IAAI,CAAC,OAAO,EAAE;gBACb,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;gBAC5D,OAAO;aACP;YAED,MAAM,aAAa,GAA8B,IAAA,oCAAuB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAE3F,MAAM,cAAc,GAA0B,aAAa,CAAC,6BAA6B,CAE7E,CAAC;YAEb,IAAI,CAAC,cAAc,EAAE;gBACpB,aAAa,CAAC,6BAA6B,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;gBAChE,OAAO;aACP;YAED,aAAa,CAAC,6BAA6B,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;QACzG,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC;AACH,CAAC;AA1BD,8CA0BC"}