@ng-doc/builder 17.3.2 → 17.5.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.
Files changed (11) hide show
  1. package/engine/nunjucks/filters.d.ts +1 -1
  2. package/engine/nunjucks/filters.js +2 -1
  3. package/engine/nunjucks/filters.js.map +1 -1
  4. package/helpers/typescript/exclude-by-ts-docs-tags.d.ts +7 -0
  5. package/helpers/typescript/exclude-by-ts-docs-tags.js +18 -0
  6. package/helpers/typescript/exclude-by-ts-docs-tags.js.map +1 -0
  7. package/helpers/typescript/index.d.ts +1 -0
  8. package/helpers/typescript/index.js +1 -0
  9. package/helpers/typescript/index.js.map +1 -1
  10. package/package.json +3 -3
  11. package/templates/api/class.html.nunj +4 -4
package/engine/nunjucks/filters.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export { accessorPresentation, constructorPresentation, declarationImport, displayReturnType, displayType, extractDocs, extractParameterDocs, extractSeeDocs, extractSelectors, filterByScope, filterByStatic, filterUselessMembers, firstNodeWithComment, functionPresentation, getAccessorChain, getClassAccessors, getClassMethods, getClassProperties, getDeclarationType, getImplementedMember, getInheritedParent, getInterfaceAccessors, getInterfaceMethods, getInterfaceProperties, getMemberParent, getMethodChain, getOverriddenMember, getPropertyChain, groupAccessors, markdownToHtml, methodPresentation, noEmpty, noLineBreaks, notEmptyAssets, sortByNodesName, sortNavigationEntities, toTemplateString, typeAliasPresentation, variablePresentation, } from '../../helpers';
1
+ export { accessorPresentation, constructorPresentation, declarationImport, displayReturnType, displayType, excludeByTsDocsTags, extractDocs, extractParameterDocs, extractSeeDocs, extractSelectors, filterByScope, filterByStatic, filterUselessMembers, firstNodeWithComment, functionPresentation, getAccessorChain, getClassAccessors, getClassMethods, getClassProperties, getDeclarationType, getImplementedMember, getInheritedParent, getInterfaceAccessors, getInterfaceMethods, getInterfaceProperties, getMemberParent, getMethodChain, getOverriddenMember, getPropertyChain, groupAccessors, markdownToHtml, methodPresentation, noEmpty, noLineBreaks, notEmptyAssets, sortByNodesName, sortNavigationEntities, toTemplateString, typeAliasPresentation, variablePresentation, } from '../../helpers';
2
2
  export { isRoute, kebabCase, objectKeys, unique } from '@ng-doc/core';
package/engine/nunjucks/filters.js CHANGED
@@ -1,13 +1,14 @@
1
1
  "use strict";
2
2
  /* Just re-export filters from this file, they will be included to the template renderer automatically */
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.unique = exports.objectKeys = exports.kebabCase = exports.isRoute = exports.variablePresentation = exports.typeAliasPresentation = exports.toTemplateString = exports.sortNavigationEntities = exports.sortByNodesName = exports.notEmptyAssets = exports.noLineBreaks = exports.noEmpty = exports.methodPresentation = exports.markdownToHtml = exports.groupAccessors = exports.getPropertyChain = exports.getOverriddenMember = exports.getMethodChain = exports.getMemberParent = exports.getInterfaceProperties = exports.getInterfaceMethods = exports.getInterfaceAccessors = exports.getInheritedParent = exports.getImplementedMember = exports.getDeclarationType = exports.getClassProperties = exports.getClassMethods = exports.getClassAccessors = exports.getAccessorChain = exports.functionPresentation = exports.firstNodeWithComment = exports.filterUselessMembers = exports.filterByStatic = exports.filterByScope = exports.extractSelectors = exports.extractSeeDocs = exports.extractParameterDocs = exports.extractDocs = exports.displayType = exports.displayReturnType = exports.declarationImport = exports.constructorPresentation = exports.accessorPresentation = void 0;
4
+ exports.unique = exports.objectKeys = exports.kebabCase = exports.isRoute = exports.variablePresentation = exports.typeAliasPresentation = exports.toTemplateString = exports.sortNavigationEntities = exports.sortByNodesName = exports.notEmptyAssets = exports.noLineBreaks = exports.noEmpty = exports.methodPresentation = exports.markdownToHtml = exports.groupAccessors = exports.getPropertyChain = exports.getOverriddenMember = exports.getMethodChain = exports.getMemberParent = exports.getInterfaceProperties = exports.getInterfaceMethods = exports.getInterfaceAccessors = exports.getInheritedParent = exports.getImplementedMember = exports.getDeclarationType = exports.getClassProperties = exports.getClassMethods = exports.getClassAccessors = exports.getAccessorChain = exports.functionPresentation = exports.firstNodeWithComment = exports.filterUselessMembers = exports.filterByStatic = exports.filterByScope = exports.extractSelectors = exports.extractSeeDocs = exports.extractParameterDocs = exports.extractDocs = exports.excludeByTsDocsTags = exports.displayType = exports.displayReturnType = exports.declarationImport = exports.constructorPresentation = exports.accessorPresentation = void 0;
5
5
  var helpers_1 = require("../../helpers");
6
6
  Object.defineProperty(exports, "accessorPresentation", { enumerable: true, get: function () { return helpers_1.accessorPresentation; } });
7
7
  Object.defineProperty(exports, "constructorPresentation", { enumerable: true, get: function () { return helpers_1.constructorPresentation; } });
8
8
  Object.defineProperty(exports, "declarationImport", { enumerable: true, get: function () { return helpers_1.declarationImport; } });
9
9
  Object.defineProperty(exports, "displayReturnType", { enumerable: true, get: function () { return helpers_1.displayReturnType; } });
10
10
  Object.defineProperty(exports, "displayType", { enumerable: true, get: function () { return helpers_1.displayType; } });
11
+ Object.defineProperty(exports, "excludeByTsDocsTags", { enumerable: true, get: function () { return helpers_1.excludeByTsDocsTags; } });
11
12
  Object.defineProperty(exports, "extractDocs", { enumerable: true, get: function () { return helpers_1.extractDocs; } });
12
13
  Object.defineProperty(exports, "extractParameterDocs", { enumerable: true, get: function () { return helpers_1.extractParameterDocs; } });
13
14
  Object.defineProperty(exports, "extractSeeDocs", { enumerable: true, get: function () { return helpers_1.extractSeeDocs; } });
package/engine/nunjucks/filters.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"filters.js","sourceRoot":"","sources":["../../../../../libs/builder/engine/nunjucks/filters.ts"],"names":[],"mappings":";AAAA,yGAAyG;;;AAEzG,yCAwCuB;AAvCtB,+GAAA,oBAAoB,OAAA;AACpB,kHAAA,uBAAuB,OAAA;AACvB,4GAAA,iBAAiB,OAAA;AACjB,4GAAA,iBAAiB,OAAA;AACjB,sGAAA,WAAW,OAAA;AACX,sGAAA,WAAW,OAAA;AACX,+GAAA,oBAAoB,OAAA;AACpB,yGAAA,cAAc,OAAA;AACd,2GAAA,gBAAgB,OAAA;AAChB,wGAAA,aAAa,OAAA;AACb,yGAAA,cAAc,OAAA;AACd,+GAAA,oBAAoB,OAAA;AACpB,+GAAA,oBAAoB,OAAA;AACpB,+GAAA,oBAAoB,OAAA;AACpB,2GAAA,gBAAgB,OAAA;AAChB,4GAAA,iBAAiB,OAAA;AACjB,0GAAA,eAAe,OAAA;AACf,6GAAA,kBAAkB,OAAA;AAClB,6GAAA,kBAAkB,OAAA;AAClB,+GAAA,oBAAoB,OAAA;AACpB,6GAAA,kBAAkB,OAAA;AAClB,gHAAA,qBAAqB,OAAA;AACrB,8GAAA,mBAAmB,OAAA;AACnB,iHAAA,sBAAsB,OAAA;AACtB,0GAAA,eAAe,OAAA;AACf,yGAAA,cAAc,OAAA;AACd,8GAAA,mBAAmB,OAAA;AACnB,2GAAA,gBAAgB,OAAA;AAChB,yGAAA,cAAc,OAAA;AACd,yGAAA,cAAc,OAAA;AACd,6GAAA,kBAAkB,OAAA;AAClB,kGAAA,OAAO,OAAA;AACP,uGAAA,YAAY,OAAA;AACZ,yGAAA,cAAc,OAAA;AACd,0GAAA,eAAe,OAAA;AACf,iHAAA,sBAAsB,OAAA;AACtB,2GAAA,gBAAgB,OAAA;AAChB,gHAAA,qBAAqB,OAAA;AACrB,+GAAA,oBAAoB,OAAA;AAErB,qCAAsE;AAA7D,+FAAA,OAAO,OAAA;AAAE,iGAAA,SAAS,OAAA;AAAE,kGAAA,UAAU,OAAA;AAAE,8FAAA,MAAM,OAAA"}
1
+ {"version":3,"file":"filters.js","sourceRoot":"","sources":["../../../../../libs/builder/engine/nunjucks/filters.ts"],"names":[],"mappings":";AAAA,yGAAyG;;;AAEzG,yCAyCuB;AAxCtB,+GAAA,oBAAoB,OAAA;AACpB,kHAAA,uBAAuB,OAAA;AACvB,4GAAA,iBAAiB,OAAA;AACjB,4GAAA,iBAAiB,OAAA;AACjB,sGAAA,WAAW,OAAA;AACX,8GAAA,mBAAmB,OAAA;AACnB,sGAAA,WAAW,OAAA;AACX,+GAAA,oBAAoB,OAAA;AACpB,yGAAA,cAAc,OAAA;AACd,2GAAA,gBAAgB,OAAA;AAChB,wGAAA,aAAa,OAAA;AACb,yGAAA,cAAc,OAAA;AACd,+GAAA,oBAAoB,OAAA;AACpB,+GAAA,oBAAoB,OAAA;AACpB,+GAAA,oBAAoB,OAAA;AACpB,2GAAA,gBAAgB,OAAA;AAChB,4GAAA,iBAAiB,OAAA;AACjB,0GAAA,eAAe,OAAA;AACf,6GAAA,kBAAkB,OAAA;AAClB,6GAAA,kBAAkB,OAAA;AAClB,+GAAA,oBAAoB,OAAA;AACpB,6GAAA,kBAAkB,OAAA;AAClB,gHAAA,qBAAqB,OAAA;AACrB,8GAAA,mBAAmB,OAAA;AACnB,iHAAA,sBAAsB,OAAA;AACtB,0GAAA,eAAe,OAAA;AACf,yGAAA,cAAc,OAAA;AACd,8GAAA,mBAAmB,OAAA;AACnB,2GAAA,gBAAgB,OAAA;AAChB,yGAAA,cAAc,OAAA;AACd,yGAAA,cAAc,OAAA;AACd,6GAAA,kBAAkB,OAAA;AAClB,kGAAA,OAAO,OAAA;AACP,uGAAA,YAAY,OAAA;AACZ,yGAAA,cAAc,OAAA;AACd,0GAAA,eAAe,OAAA;AACf,iHAAA,sBAAsB,OAAA;AACtB,2GAAA,gBAAgB,OAAA;AAChB,gHAAA,qBAAqB,OAAA;AACrB,+GAAA,oBAAoB,OAAA;AAErB,qCAAsE;AAA7D,+FAAA,OAAO,OAAA;AAAE,iGAAA,SAAS,OAAA;AAAE,kGAAA,UAAU,OAAA;AAAE,8FAAA,MAAM,OAAA"}
package/helpers/typescript/exclude-by-ts-docs-tags.d.ts ADDED
@@ -0,0 +1,7 @@
1
+ import { JSDocableNode } from 'ts-morph';
2
+ /**
3
+ *
4
+ * @param nodes
5
+ * @param tags
6
+ */
7
+ export declare function excludeByTsDocsTags<T extends JSDocableNode>(nodes: T[], tags: string | string[]): T[];
package/helpers/typescript/exclude-by-ts-docs-tags.js ADDED
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.excludeByTsDocsTags = void 0;
4
+ const core_1 = require("@ng-doc/core");
5
+ /**
6
+ *
7
+ * @param nodes
8
+ * @param tags
9
+ */
10
+ function excludeByTsDocsTags(nodes, tags) {
11
+ return nodes.filter((node) => {
12
+ return !node
13
+ .getJsDocs()
14
+ .some((jsDoc) => jsDoc.getTags().some((tag) => (0, core_1.asArray)(tags).includes(tag.getTagName())));
15
+ });
16
+ }
17
+ exports.excludeByTsDocsTags = excludeByTsDocsTags;
18
+ //# sourceMappingURL=exclude-by-ts-docs-tags.js.map
package/helpers/typescript/exclude-by-ts-docs-tags.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"exclude-by-ts-docs-tags.js","sourceRoot":"","sources":["../../../../../libs/builder/helpers/typescript/exclude-by-ts-docs-tags.ts"],"names":[],"mappings":";;;AAAA,uCAAuC;AAGvC;;;;GAIG;AACH,SAAgB,mBAAmB,CAClC,KAAU,EACV,IAAuB;IAEvB,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAO,EAAE,EAAE;QAC/B,OAAO,CAAC,IAAI;aACV,SAAS,EAAE;aACX,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC;IAC5F,CAAC,CAAC,CAAC;AACJ,CAAC;AATD,kDASC"}
package/helpers/typescript/index.d.ts CHANGED
@@ -3,6 +3,7 @@ export * from './class';
3
3
  export * from './create-project';
4
4
  export * from './declaration-import';
5
5
  export * from './display-type';
6
+ export * from './exclude-by-ts-docs-tags';
6
7
  export * from './filter-by-scope';
7
8
  export * from './filter-by-static';
8
9
  export * from './first-node-with-comment';
package/helpers/typescript/index.js CHANGED
@@ -6,6 +6,7 @@ tslib_1.__exportStar(require("./class"), exports);
6
6
  tslib_1.__exportStar(require("./create-project"), exports);
7
7
  tslib_1.__exportStar(require("./declaration-import"), exports);
8
8
  tslib_1.__exportStar(require("./display-type"), exports);
9
+ tslib_1.__exportStar(require("./exclude-by-ts-docs-tags"), exports);
9
10
  tslib_1.__exportStar(require("./filter-by-scope"), exports);
10
11
  tslib_1.__exportStar(require("./filter-by-static"), exports);
11
12
  tslib_1.__exportStar(require("./first-node-with-comment"), exports);
package/helpers/typescript/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../libs/builder/helpers/typescript/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B;AAC3B,kDAAwB;AACxB,2DAAiC;AACjC,+DAAqC;AACrC,yDAA+B;AAC/B,4DAAkC;AAClC,6DAAmC;AACnC,oEAA0C;AAC1C,+EAAqD;AACrD,sDAA4B;AAC5B,mDAAyB;AACzB,mDAAyB;AACzB,iDAAuB;AACvB,qDAA2B"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../libs/builder/helpers/typescript/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B;AAC3B,kDAAwB;AACxB,2DAAiC;AACjC,+DAAqC;AACrC,yDAA+B;AAC/B,oEAA0C;AAC1C,4DAAkC;AAClC,6DAAmC;AACnC,oEAA0C;AAC1C,+EAAqD;AACrD,sDAA4B;AAC5B,mDAAyB;AACzB,mDAAyB;AACzB,iDAAuB;AACvB,qDAA2B"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ng-doc/builder",
3
- "version": "17.3.2",
3
+ "version": "17.5.0",
4
4
  "type": "commonjs",
5
5
  "builders": "./builders.json",
6
6
  "schematics": "./schematics/collection.json",
@@ -11,8 +11,8 @@
11
11
  ]
12
12
  },
13
13
  "dependencies": {
14
- "@ng-doc/core": "17.3.2",
15
- "@ng-doc/utils": "17.3.2",
14
+ "@ng-doc/core": "17.5.0",
15
+ "@ng-doc/utils": "17.5.0",
16
16
  "@angular-devkit/architect": ">=0.1700.0",
17
17
  "@angular-devkit/build-angular": ">=17.0.0",
18
18
  "chokidar": "3.5.3",
package/templates/api/class.html.nunj CHANGED
@@ -32,10 +32,10 @@
32
32
  {% endblock %}
33
33
 
34
34
  {% block overview %}
35
- {%- set constructors = declaration.getConstructors() | filterByScope("public") -%}
36
- {%- set allProperties = declaration | getClassProperties | filterByScope(["public", "protected"]) | filterUselessMembers | sortByNodesName -%}
37
- {%- set allMethods = declaration | getClassMethods | filterByScope(["public", "protected"]) | filterUselessMembers | sortByNodesName -%}
38
- {%- set allAccessors = declaration | getClassAccessors | filterByScope(["public", "protected"]) | filterUselessMembers | sortByNodesName -%}
35
+ {%- set constructors = declaration.getConstructors() | filterByScope("public") | excludeByTsDocsTags('internal') -%}
36
+ {%- set allProperties = declaration | getClassProperties | excludeByTsDocsTags('internal') | filterByScope(["public", "protected"]) | filterUselessMembers | sortByNodesName -%}
37
+ {%- set allMethods = declaration | getClassMethods | excludeByTsDocsTags('internal') | filterByScope(["public", "protected"]) | filterUselessMembers | sortByNodesName -%}
38
+ {%- set allAccessors = declaration | getClassAccessors | excludeByTsDocsTags('internal') | filterByScope(["public", "protected"]) | filterUselessMembers | sortByNodesName -%}
39
39
 
40
40
  {%- set staticProperties = allProperties | filterByStatic(true) -%}
41
41
  {%- set staticAccessors = allAccessors | filterByStatic(true) -%}