@ng-doc/builder 15.0.0-beta.16 → 15.0.0-beta.18

package/helpers/create-builder-context.d.ts

@@ -6,5 +6,6 @@ import { NgDocBuilderContext, NgDocSchema } from '../interfaces';
  * @param targetOptions
  * @param options
  * @param context
+ * @param project
  */
 export declare function createBuilderContext(targetOptions: json.JsonObject, options: NgDocSchema, context: BuilderContext): NgDocBuilderContext;

package/helpers/create-builder-context.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createBuilderContext = void 0;
 const tslib_1 = require("tslib");
+const core_1 = require("@ng-doc/core");
 const path = tslib_1.__importStar(require("path"));
 const engine_1 = require("../engine");
 /**
@@ -9,15 +10,17 @@ const engine_1 = require("../engine");
  * @param targetOptions
  * @param options
  * @param context
+ * @param project
  */
 function createBuilderContext(targetOptions, options, context) {
-    var _a, _b, _c;
+    var _a, _b, _c, _d, _e, _f;
     const buildPath = path.join(context.workspaceRoot, '.ng-doc', (_b = (_a = context.target) === null || _a === void 0 ? void 0 : _a.project) !== null && _b !== void 0 ? _b : 'app');
     return {
         tsConfig: String(targetOptions['tsConfig']),
         options,
         context,
         inlineStyleLanguage: (_c = targetOptions === null || targetOptions === void 0 ? void 0 : targetOptions['inlineStyleLanguage']) !== null && _c !== void 0 ? _c : 'CSS',
+        pagesPaths: ((_e = (_d = options.ngDoc) === null || _d === void 0 ? void 0 : _d.pages) === null || _e === void 0 ? void 0 : _e.length) ? (0, core_1.asArray)((_f = options.ngDoc) === null || _f === void 0 ? void 0 : _f.pages) : [path.dirname(options.main)],
         assetsPath: engine_1.GENERATED_ASSETS_PATH,
         buildPath,
         apiPath: path.join(buildPath, 'api'),

package/helpers/create-builder-context.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-builder-context.js","sourceRoot":"","sources":["../../../../libs/builder/helpers/create-builder-context.ts"],"names":[],"mappings":";;;;AAGA,mDAA6B;AAE7B,sCAAgD;AAGhD;;;;;GAKG;AACH,SAAgB,oBAAoB,CAAC,aAA8B,EAAE,OAAoB,EAAE,OAAuB;;IACjH,MAAM,SAAS,GAAW,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,SAAS,EAAE,MAAA,MAAA,OAAO,CAAC,MAAM,0CAAE,OAAO,mCAAI,KAAK,CAAC,CAAC;IAExG,OAAO;QACN,QAAQ,EAAE,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC3C,OAAO;QACP,OAAO;QACP,mBAAmB,EAAE,MAAC,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAG,qBAAqB,CAAoB,mCAAI,KAAK;QACxF,UAAU,EAAE,8BAAqB;QACjC,SAAS;QACT,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC;QACpC,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC;KAC5C,CAAA;AACF,CAAC;AAbD,oDAaC"}
+{"version":3,"file":"create-builder-context.js","sourceRoot":"","sources":["../../../../libs/builder/helpers/create-builder-context.ts"],"names":[],"mappings":";;;;AAEA,uCAAqD;AACrD,mDAA6B;AAE7B,sCAAgD;AAGhD;;;;;;GAMG;AACH,SAAgB,oBAAoB,CACnC,aAA8B,EAC9B,OAAoB,EACpB,OAAuB;;IAEvB,MAAM,SAAS,GAAW,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,SAAS,EAAE,MAAA,MAAA,OAAO,CAAC,MAAM,0CAAE,OAAO,mCAAI,KAAK,CAAC,CAAC;IAExG,OAAO;QACN,QAAQ,EAAE,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC3C,OAAO;QACP,OAAO;QACP,mBAAmB,EAAE,MAAC,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAG,qBAAqB,CAAoB,mCAAI,KAAK;QACxF,UAAU,EAAE,CAAA,MAAA,MAAA,OAAO,CAAC,KAAK,0CAAE,KAAK,0CAAE,MAAM,EAAC,CAAC,CAAC,IAAA,cAAO,EAAC,MAAA,OAAO,CAAC,KAAK,0CAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACvG,UAAU,EAAE,8BAAqB;QACjC,SAAS;QACT,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC;QACpC,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC;KAC5C,CAAC;AACH,CAAC;AAlBD,oDAkBC"}

package/interfaces/builder-context.d.ts

@@ -6,6 +6,7 @@ export interface NgDocBuilderContext {
     options: NgDocSchema;
     context: BuilderContext;
     inlineStyleLanguage: NgDocStyleType;
+    pagesPaths: string[];
     assetsPath: string;
     buildPath: string;
     apiPath: string;

package/interfaces/schema.d.ts

@@ -1,7 +1,8 @@
 import { NgDocGlobalKeyword } from './keyword-map';
 export interface NgDocSchema {
     browserTarget: string;
-    ngDoc: NgDocConfiguration;
+    main: string;
+    ngDoc?: NgDocConfiguration;
 }
 /**
  * NgDoc configuration interface, that configure NgDoc library
@@ -10,7 +11,7 @@ export interface NgDocConfiguration {
     /**
      * List of paths to your documentation location (e.g. "src/app")
      */
-    pages: string | string[];
+    pages?: string | string[];
     /**
      * Route prefix uses to add some additional route segment before documentation pages,
      * you can use it e.g. to wrap documentation with additional route like "docs".
@@ -20,7 +21,7 @@ export interface NgDocConfiguration {
      * Tag for of the current target, you can use it in conjunction with the `onlyForTags` field in your pages to
      * hide pages for certain documentation builds
      */
-    tag: string;
+    tag?: string;
     /**
      * List of the global keywords, to create link to foreign websites
      */

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@ng-doc/builder",
-  "version": "15.0.0-beta.16",
+  "version": "15.0.0-beta.18",
   "type": "commonjs",
   "builders": "./builders.json",
   "schematics": "./schematics/collection.json",
   "dependencies": {
-    "@ng-doc/core": "15.0.0-beta.16",
+    "@ng-doc/core": "15.0.0-beta.18",
     "@angular-devkit/architect": ">=0.1500.0",
     "chokidar": "^3.5.3",
     "minimatch": "^5.1.0",
@@ -30,5 +30,25 @@
     "access": "public"
   },
   "main": "./index.js",
-  "types": "./index.d.ts"
+  "types": "./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/dependencies/files/ng-doc.dependencies.ts.template

@@ -1,5 +1,5 @@
-import {NgDocDependencies} from '@ng-doc/core';
-import {NgDocPageModule} from './ng-doc.module';
+import {NgDocDependencies} from '@ng-doc/core';<% if (module) { %>
+import {<%= pageName %>Module} from './ng-doc.module';<% } %>
 
 const <%= pageName %>Dependencies: NgDocDependencies = {<% if (module) { %>
 	module: <%= pageName %>Module,<% } %>