@ng-doc/builder 16.9.0 → 16.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/browser/index.js +2 -1
- package/browser/index.js.map +1 -1
- package/browser/schema.json +7 -1
- package/dev-server/index.js +2 -1
- package/dev-server/index.js.map +1 -1
- package/dev-server/schema.json +7 -1
- package/helpers/create-builder-context.d.ts +5 -5
- package/helpers/create-builder-context.js +6 -6
- package/helpers/create-builder-context.js.map +1 -1
- package/helpers/load-config.d.ts +3 -2
- package/helpers/load-config.js +4 -3
- package/helpers/load-config.js.map +1 -1
- package/interfaces/schema.d.ts +3 -0
- package/package.json +4 -3
- package/schematics/category/files/ng-doc.category.ts.template +1 -1
package/browser/index.js
CHANGED
|
@@ -17,10 +17,11 @@ const helpers_1 = require("../helpers");
|
|
|
17
17
|
* @returns Observable of BrowserBuilderOutput
|
|
18
18
|
*/
|
|
19
19
|
function runBrowser(options, context) {
|
|
20
|
+
var _a;
|
|
20
21
|
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
21
22
|
const browserTarget = options.browserTarget ? (0, architect_1.targetFromTargetString)(options.browserTarget) : null;
|
|
22
23
|
const targetOptions = browserTarget ? yield context.getTargetOptions(browserTarget) : options;
|
|
23
|
-
const builderContext = (0, helpers_1.createBuilderContext)(targetOptions, context);
|
|
24
|
+
const builderContext = (0, helpers_1.createBuilderContext)(targetOptions, context, (_a = options.ngDoc) === null || _a === void 0 ? void 0 : _a.config);
|
|
24
25
|
const runner = (0, build_ng_doc_1.buildNgDoc)(builderContext);
|
|
25
26
|
yield (0, rxjs_1.firstValueFrom)(runner.pipe((0, operators_1.first)()));
|
|
26
27
|
return builderContext.config.angularBuilder === 'esbuild'
|
package/browser/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/builder/browser/index.ts"],"names":[],"mappings":";;;;AAAA,yDAMmC;AACnC,gFAAuF;AACvF,gGAA+F;AAC/F,+BAAgD;AAChD,8CAAqC;AAErC,yDAAkD;AAClD,wCAAgD;AAGhD;;;;;;GAMG;AACH,SAAsB,UAAU,CAAC,OAAoB,EAAE,OAAuB
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/builder/browser/index.ts"],"names":[],"mappings":";;;;AAAA,yDAMmC;AACnC,gFAAuF;AACvF,gGAA+F;AAC/F,+BAAgD;AAChD,8CAAqC;AAErC,yDAAkD;AAClD,wCAAgD;AAGhD;;;;;;GAMG;AACH,SAAsB,UAAU,CAAC,OAAoB,EAAE,OAAuB;;;QAC7E,MAAM,aAAa,GAAkB,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,IAAA,kCAAsB,EAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAClH,MAAM,aAAa,GAAQ,aAAa,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAE,OAAe,CAAC;QAC5G,MAAM,cAAc,GAAwB,IAAA,8BAAoB,EAAC,aAAa,EAAE,OAAO,EAAE,MAAA,OAAO,CAAC,KAAK,0CAAE,MAAM,CAAC,CAAC;QAChH,MAAM,MAAM,GAAqB,IAAA,yBAAU,EAAC,cAAc,CAAC,CAAC;QAE5D,MAAM,IAAA,qBAAc,EAAC,MAAM,CAAC,IAAI,CAAC,IAAA,iBAAK,GAAE,CAAC,CAAC,CAAC;QAE3C,OAAO,cAAc,CAAC,MAAM,CAAC,cAAc,KAAK,SAAS;YACxD,CAAC,CAAC,IAAA,6BAAiB,EAAC,IAAA,qCAAmB,EAAC,OAAc,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE;YAC7E,CAAC,CAAC,MAAM,IAAA,6BAAmB,EAAC,OAAc,EAAE,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC;;CAClE;AAXD,gCAWC;AAED,6DAA6D;AAC7D,aAAa;AACb,kBAAe,IAAA,yBAAa,EAAC,UAAU,CAAC,CAAC"}
|
package/browser/schema.json
CHANGED
package/dev-server/index.js
CHANGED
|
@@ -17,7 +17,8 @@ const helpers_1 = require("../helpers");
|
|
|
17
17
|
function runDevServer(options, context) {
|
|
18
18
|
const browserTarget = options.browserTarget ? (0, architect_1.targetFromTargetString)(options.browserTarget) : null;
|
|
19
19
|
return (browserTarget ? (0, rxjs_1.from)(context.getTargetOptions(browserTarget)) : (0, rxjs_1.of)(options)).pipe((0, operators_1.switchMap)((targetOptions) => {
|
|
20
|
-
|
|
20
|
+
var _a;
|
|
21
|
+
const builderContext = (0, helpers_1.createBuilderContext)(targetOptions, context, (_a = options.ngDoc) === null || _a === void 0 ? void 0 : _a.config);
|
|
21
22
|
const runner = (0, build_ng_doc_1.buildNgDoc)(builderContext).pipe((0, operators_1.shareReplay)(1));
|
|
22
23
|
if (builderContext.config.angularBuilder === 'esbuild') {
|
|
23
24
|
// This is a hack to make sure that the dev server uses the esbuild builder
|
package/dev-server/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/builder/dev-server/index.ts"],"names":[],"mappings":";;;;AAAA,yDAAwG;AAExG,sFAAkH;AAClH,+BAAyD;AACzD,8CAAkE;AAElE,yDAAkD;AAClD,wCAAgD;AAGhD;;;;;GAKG;AACH,SAAgB,YAAY,CAAC,OAAoB,EAAE,OAAuB;IACzE,MAAM,aAAa,GAAkB,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,IAAA,kCAAsB,EAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAElH,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,IAAA,SAAE,EAAC,OAAyB,CAAC,CAAC,CAAC,IAAI,CAC1G,IAAA,qBAAS,EAAC,CAAC,aAAkB,EAAE,EAAE
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/builder/dev-server/index.ts"],"names":[],"mappings":";;;;AAAA,yDAAwG;AAExG,sFAAkH;AAClH,+BAAyD;AACzD,8CAAkE;AAElE,yDAAkD;AAClD,wCAAgD;AAGhD;;;;;GAKG;AACH,SAAgB,YAAY,CAAC,OAAoB,EAAE,OAAuB;IACzE,MAAM,aAAa,GAAkB,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,IAAA,kCAAsB,EAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAElH,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,IAAA,SAAE,EAAC,OAAyB,CAAC,CAAC,CAAC,IAAI,CAC1G,IAAA,qBAAS,EAAC,CAAC,aAAkB,EAAE,EAAE;;QAChC,MAAM,cAAc,GAAwB,IAAA,8BAAoB,EAAC,aAAa,EAAE,OAAO,EAAE,MAAA,OAAO,CAAC,KAAK,0CAAE,MAAM,CAAC,CAAC;QAChH,MAAM,MAAM,GAAqB,IAAA,yBAAU,EAAC,cAAc,CAAC,CAAC,IAAI,CAAC,IAAA,uBAAW,EAAC,CAAC,CAAC,CAAC,CAAC;QAEjF,IAAI,cAAc,CAAC,MAAM,CAAC,cAAc,KAAK,SAAS,EAAE;YACvD,2EAA2E;YAC3E,2EAA2E;YAC3E,yEAAyE;YACzE,oKAAoK;YACpK,OAAO,CAAC,uBAAuB,GAAG,GAAS,EAAE,wDAAC,OAAA,+CAA+C,CAAA,GAAA,CAAC;SAC9F;QAED,OAAO,MAAM,CAAC,IAAI,CACjB,IAAA,iBAAK,GAAE,EACP,IAAA,qBAAS,EAAC,GAAG,EAAE,CACd,IAAA,oBAAa,EAAC,CAAC,MAAM,EAAE,IAAA,gCAAmB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAClE,IAAA,eAAG,EAAC,CAAC,CAAC,CAAC,EAAE,eAAe,CAAiC,EAAE,EAAE,CAAC,eAAe,CAAC,CAC9E,CACD,CACD,CAAC;IACH,CAAC,CAAC,CACF,CAAC;AACH,CAAC;AA1BD,oCA0BC;AAED,6DAA6D;AAC7D,aAAa;AACb,kBAAe,IAAA,yBAAa,EAAC,YAAY,CAAC,CAAC"}
|
package/dev-server/schema.json
CHANGED
|
@@ -97,7 +97,13 @@
|
|
|
97
97
|
"description": "Enable and define the file watching poll time period in milliseconds."
|
|
98
98
|
},
|
|
99
99
|
"ngDoc": {
|
|
100
|
-
"type": "object"
|
|
100
|
+
"type": "object",
|
|
101
|
+
"properties": {
|
|
102
|
+
"config": {
|
|
103
|
+
"type": "string",
|
|
104
|
+
"optional": true
|
|
105
|
+
}
|
|
106
|
+
}
|
|
101
107
|
}
|
|
102
108
|
},
|
|
103
109
|
"additionalProperties": true,
|
|
@@ -2,10 +2,10 @@ import { BuilderContext } from '@angular-devkit/architect';
|
|
|
2
2
|
import { json } from '@angular-devkit/core';
|
|
3
3
|
import { NgDocBuilderContext } from '../interfaces';
|
|
4
4
|
/**
|
|
5
|
+
* Creates builder context, with all the necessary information for the builder to work
|
|
5
6
|
*
|
|
6
|
-
* @param targetOptions
|
|
7
|
-
* @param
|
|
8
|
-
* @param
|
|
9
|
-
* @param project
|
|
7
|
+
* @param targetOptions - Target options
|
|
8
|
+
* @param context - Builder context
|
|
9
|
+
* @param configFilePath - Path to the configuration file if it exists
|
|
10
10
|
*/
|
|
11
|
-
export declare function createBuilderContext(targetOptions: json.JsonObject, context: BuilderContext): NgDocBuilderContext;
|
|
11
|
+
export declare function createBuilderContext(targetOptions: json.JsonObject, context: BuilderContext, configFilePath?: string): NgDocBuilderContext;
|
|
@@ -6,16 +6,16 @@ const core_1 = require("@ng-doc/core");
|
|
|
6
6
|
const path = tslib_1.__importStar(require("path"));
|
|
7
7
|
const load_config_1 = require("./load-config");
|
|
8
8
|
/**
|
|
9
|
+
* Creates builder context, with all the necessary information for the builder to work
|
|
9
10
|
*
|
|
10
|
-
* @param targetOptions
|
|
11
|
-
* @param
|
|
12
|
-
* @param
|
|
13
|
-
* @param project
|
|
11
|
+
* @param targetOptions - Target options
|
|
12
|
+
* @param context - Builder context
|
|
13
|
+
* @param configFilePath - Path to the configuration file if it exists
|
|
14
14
|
*/
|
|
15
|
-
function createBuilderContext(targetOptions, context) {
|
|
15
|
+
function createBuilderContext(targetOptions, context, configFilePath) {
|
|
16
16
|
var _a, _b, _c, _d, _e, _f;
|
|
17
17
|
const projectRoot = path.dirname(targetOptions['main']);
|
|
18
|
-
const [configPath, config] = (0, load_config_1.loadConfig)(projectRoot);
|
|
18
|
+
const [configPath, config] = (0, load_config_1.loadConfig)(configFilePath !== null && configFilePath !== void 0 ? configFilePath : projectRoot, !configFilePath);
|
|
19
19
|
const buildPath = path.join(context.workspaceRoot, (_a = config.outDir) !== null && _a !== void 0 ? _a : '', '.ng-doc', (_c = (_b = context.target) === null || _b === void 0 ? void 0 : _b.project) !== null && _c !== void 0 ? _c : 'app');
|
|
20
20
|
return {
|
|
21
21
|
tsConfig: (_d = config === null || config === void 0 ? void 0 : config.tsConfig) !== null && _d !== void 0 ? _d : String(targetOptions['tsConfig']),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"create-builder-context.js","sourceRoot":"","sources":["../../../../libs/builder/helpers/create-builder-context.ts"],"names":[],"mappings":";;;;AAEA,uCAAqD;AACrD,mDAA6B;AAG7B,+CAAyC;AAEzC;;;;;;GAMG;AACH,SAAgB,oBAAoB,CACnC,aAA8B,EAC9B,OAAuB;;IAEvB,MAAM,WAAW,GAAW,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAW,CAAC,CAAC;IAC1E,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,GAAiC,IAAA,wBAAU,EAAC,WAAW,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"create-builder-context.js","sourceRoot":"","sources":["../../../../libs/builder/helpers/create-builder-context.ts"],"names":[],"mappings":";;;;AAEA,uCAAqD;AACrD,mDAA6B;AAG7B,+CAAyC;AAEzC;;;;;;GAMG;AACH,SAAgB,oBAAoB,CACnC,aAA8B,EAC9B,OAAuB,EACvB,cAAuB;;IAEvB,MAAM,WAAW,GAAW,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAW,CAAC,CAAC;IAC1E,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,GAAiC,IAAA,wBAAU,EAAC,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,WAAW,EAAE,CAAC,cAAc,CAAC,CAAC;IACtH,MAAM,SAAS,GAAW,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,MAAA,MAAM,CAAC,MAAM,mCAAI,EAAE,EAAE,SAAS,EAAE,MAAA,MAAA,OAAO,CAAC,MAAM,0CAAE,OAAO,mCAAI,KAAK,CAAC,CAAC;IAE7H,OAAO;QACN,QAAQ,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,mCAAI,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC/D,MAAM;QACN,OAAO;QACP,mBAAmB,EAAE,MAAC,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAG,qBAAqB,CAAoB,mCAAI,KAAK;QACxF,UAAU,EAAE,CAAA,MAAA,MAAM,CAAC,KAAK,0CAAE,MAAM,EAAC,CAAC,CAAC,IAAA,cAAO,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;QACxE,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC;QAC1C,WAAW,EAAE,CAAC,UAAU,CAAC;QACzB,SAAS;QACT,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC;QACpC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC;KAC1C,CAAC;AACH,CAAC;AArBD,oDAqBC"}
|
package/helpers/load-config.d.ts
CHANGED
|
@@ -2,6 +2,7 @@ import { NgDocConfiguration } from '../interfaces';
|
|
|
2
2
|
/**
|
|
3
3
|
* Loads configuration from global configuration file
|
|
4
4
|
*
|
|
5
|
-
* @param
|
|
5
|
+
* @param path - Path to the configuration file
|
|
6
|
+
* @param search - Whether to search for the configuration file or not
|
|
6
7
|
*/
|
|
7
|
-
export declare function loadConfig(
|
|
8
|
+
export declare function loadConfig(path: string, search?: boolean): [string, NgDocConfiguration];
|
package/helpers/load-config.js
CHANGED
|
@@ -6,9 +6,10 @@ const cosmiconfig_typescript_loader_1 = require("cosmiconfig-typescript-loader")
|
|
|
6
6
|
/**
|
|
7
7
|
* Loads configuration from global configuration file
|
|
8
8
|
*
|
|
9
|
-
* @param
|
|
9
|
+
* @param path - Path to the configuration file
|
|
10
|
+
* @param search - Whether to search for the configuration file or not
|
|
10
11
|
*/
|
|
11
|
-
function loadConfig(
|
|
12
|
+
function loadConfig(path, search = true) {
|
|
12
13
|
var _a, _b;
|
|
13
14
|
const moduleName = 'ng-doc';
|
|
14
15
|
const explorerSync = (0, cosmiconfig_1.cosmiconfigSync)(moduleName, {
|
|
@@ -17,7 +18,7 @@ function loadConfig(searchFrom) {
|
|
|
17
18
|
'.ts': (0, cosmiconfig_typescript_loader_1.TypeScriptLoader)(),
|
|
18
19
|
},
|
|
19
20
|
});
|
|
20
|
-
const searchedFor = explorerSync.search(
|
|
21
|
+
const searchedFor = search ? explorerSync.search(path) : explorerSync.load(path);
|
|
21
22
|
return [(_a = searchedFor === null || searchedFor === void 0 ? void 0 : searchedFor.filepath) !== null && _a !== void 0 ? _a : '', (_b = searchedFor === null || searchedFor === void 0 ? void 0 : searchedFor.config) !== null && _b !== void 0 ? _b : {}];
|
|
22
23
|
}
|
|
23
24
|
exports.loadConfig = loadConfig;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"load-config.js","sourceRoot":"","sources":["../../../../libs/builder/helpers/load-config.ts"],"names":[],"mappings":";;;AAAA,6CAAgE;AAEhE,iFAA+D;AAI/D
|
|
1
|
+
{"version":3,"file":"load-config.js","sourceRoot":"","sources":["../../../../libs/builder/helpers/load-config.ts"],"names":[],"mappings":";;;AAAA,6CAAgE;AAEhE,iFAA+D;AAI/D;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,IAAY,EAAE,SAAkB,IAAI;;IAC9D,MAAM,UAAU,GAAW,QAAQ,CAAC;IAEpC,MAAM,YAAY,GAAuB,IAAA,6BAAe,EAAC,UAAU,EAAE;QACpE,YAAY,EAAE,CAAC,GAAG,UAAU,YAAY,CAAC;QACzC,OAAO,EAAE;YACR,KAAK,EAAE,IAAA,gDAAgB,GAAE;SACzB;KACD,CAAC,CAAC;IACH,MAAM,WAAW,GAA6B,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAE3G,OAAO,CAAC,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,QAAQ,mCAAI,EAAE,EAAE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,mCAAI,EAAE,CAAC,CAAC;AACjE,CAAC;AAZD,gCAYC"}
|
package/interfaces/schema.d.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ng-doc/builder",
|
|
3
|
-
"version": "16.
|
|
3
|
+
"version": "16.10.0",
|
|
4
4
|
"type": "commonjs",
|
|
5
5
|
"builders": "./builders.json",
|
|
6
6
|
"schematics": "./schematics/collection.json",
|
|
7
7
|
"dependencies": {
|
|
8
|
-
"@ng-doc/core": "16.
|
|
9
|
-
"@ng-doc/utils": "16.
|
|
8
|
+
"@ng-doc/core": "16.10.0",
|
|
9
|
+
"@ng-doc/utils": "16.10.0",
|
|
10
10
|
"@angular-devkit/architect": ">=0.1600.0",
|
|
11
|
+
"@angular-devkit/build-angular": ">=16.0.0",
|
|
11
12
|
"chokidar": "3.5.3",
|
|
12
13
|
"minimatch": "9.0.1",
|
|
13
14
|
"rxjs": "^7.0.0",
|
|
@@ -7,7 +7,7 @@ const <%= categoryName %>: NgDocCategory = {
|
|
|
7
7
|
category: <%= parentCategoryName %>,<% } %><% if (expanded) { %>
|
|
8
8
|
expanded: <%= expanded %>,<% } %><% if (expandable) { %>
|
|
9
9
|
expandable: <%= expandable %>,<% } %><% if (order) { %>
|
|
10
|
-
order:
|
|
10
|
+
order: <%= order %>,<% } %>
|
|
11
11
|
};
|
|
12
12
|
|
|
13
13
|
export default <%= categoryName %>;
|