@ng-doc/builder 15.6.0 → 15.7.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 (39) hide show
  1. package/browser/schema.json +1 -20
  2. package/dev-server/schema.json +1 -20
  3. package/engine/.cache/apps/ng-doc/src/app/docs/develop/ng-doc.page.js +22362 -3804
  4. package/engine/builder.js +1 -1
  5. package/engine/builder.js.map +1 -1
  6. package/engine/entities/abstractions/route.entity.js +2 -4
  7. package/engine/entities/abstractions/route.entity.js.map +1 -1
  8. package/engine/entities/api-page.entity.js +6 -6
  9. package/engine/entities/api-page.entity.js.map +1 -1
  10. package/engine/entities/category.entity.d.ts +1 -0
  11. package/engine/entities/category.entity.js +6 -0
  12. package/engine/entities/category.entity.js.map +1 -1
  13. package/engine/entities/page.entity.js +5 -7
  14. package/engine/entities/page.entity.js.map +1 -1
  15. package/engine/post-processors/html-plugins/autolink-headings.ts +40 -0
  16. package/engine/post-processors/html-plugins/keywords-processor.ts +124 -0
  17. package/engine/post-processors/html-plugins/slugger.d.ts +7 -0
  18. package/engine/post-processors/html-plugins/slugger.js +25 -0
  19. package/engine/post-processors/html-plugins/slugger.js.map +1 -0
  20. package/engine/post-processors/html-plugins/slugger.ts +26 -0
  21. package/engine/post-processors/html-post-processor.js +3 -1
  22. package/engine/post-processors/html-post-processor.js.map +1 -1
  23. package/helpers/create-builder-context.js +12 -5
  24. package/helpers/create-builder-context.js.map +1 -1
  25. package/helpers/load-config.d.ts +7 -0
  26. package/helpers/load-config.js +23 -0
  27. package/helpers/load-config.js.map +1 -0
  28. package/helpers/marked.js +1 -1
  29. package/helpers/marked.js.map +1 -1
  30. package/interfaces/builder-context.d.ts +2 -2
  31. package/interfaces/configuration.d.ts +43 -0
  32. package/interfaces/configuration.js +3 -0
  33. package/interfaces/configuration.js.map +1 -0
  34. package/interfaces/index.d.ts +1 -0
  35. package/interfaces/index.js +1 -0
  36. package/interfaces/index.js.map +1 -1
  37. package/interfaces/schema.d.ts +3 -33
  38. package/package.json +8 -4
  39. package/engine/entities/abstractions/import.cjs +0 -9
@@ -0,0 +1 @@
1
+ {"version":3,"file":"configuration.js","sourceRoot":"","sources":["../../../../libs/builder/interfaces/configuration.ts"],"names":[],"mappings":""}
@@ -2,6 +2,7 @@ export * from './action-output';
2
2
  export * from './asset';
3
3
  export * from './builder-context';
4
4
  export * from './built-output';
5
+ export * from './configuration';
5
6
  export * from './keyword-map';
6
7
  export * from './page-index';
7
8
  export * from './path-anchor';
@@ -5,6 +5,7 @@ tslib_1.__exportStar(require("./action-output"), exports);
5
5
  tslib_1.__exportStar(require("./asset"), exports);
6
6
  tslib_1.__exportStar(require("./builder-context"), exports);
7
7
  tslib_1.__exportStar(require("./built-output"), exports);
8
+ tslib_1.__exportStar(require("./configuration"), exports);
8
9
  tslib_1.__exportStar(require("./keyword-map"), exports);
9
10
  tslib_1.__exportStar(require("./page-index"), exports);
10
11
  tslib_1.__exportStar(require("./path-anchor"), exports);
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/builder/interfaces/index.ts"],"names":[],"mappings":";;;AAAA,0DAAgC;AAChC,kDAAwB;AACxB,4DAAkC;AAClC,yDAA+B;AAC/B,wDAA8B;AAC9B,uDAA6B;AAC7B,wDAA8B;AAC9B,6DAAmC;AACnC,wDAA8B;AAC9B,mDAAyB"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/builder/interfaces/index.ts"],"names":[],"mappings":";;;AAAA,0DAAgC;AAChC,kDAAwB;AACxB,4DAAkC;AAClC,yDAA+B;AAC/B,0DAAgC;AAChC,wDAA8B;AAC9B,uDAA6B;AAC7B,wDAA8B;AAC9B,6DAAmC;AACnC,wDAA8B;AAC9B,mDAAyB"}
@@ -1,39 +1,9 @@
1
- import { NgDocGlobalKeyword } from './keyword-map';
2
- import { NgDocRepoConfig } from './repo-config';
1
+ import { NgDocConfiguration } from './configuration';
3
2
  export interface NgDocSchema {
4
3
  browserTarget: string;
5
4
  main: string;
6
- ngDoc?: NgDocConfiguration;
7
- }
8
- /**
9
- * NgDoc configuration interface, that configure NgDoc library
10
- */
11
- export interface NgDocConfiguration {
12
- /**
13
- * List of paths to your documentation location (e.g. "src/app")
14
- */
15
- pages?: string | string[];
16
5
  /**
17
- * Route prefix uses to add some additional route segment before documentation pages,
18
- * you can use it e.g. to wrap documentation with additional route like "docs".
6
+ * @deprecated Please use `ng-doc.config.js` file instead. Check our configuration guide for more details.
19
7
  */
20
- routePrefix?: string;
21
- /**
22
- * Tag for of the current target, you can use it in conjunction with the `onlyForTags` field in your pages to
23
- * hide pages for certain documentation builds
24
- */
25
- tag?: string;
26
- /**
27
- * List of the global keywords, to create link to foreign websites
28
- */
29
- keywords?: Record<string, NgDocGlobalKeyword>;
30
- /**
31
- * The repository configuration.
32
- * If it is defined, Ngoc will use it to display the "Suggest edits" button, and "View source" button, on each page.
33
- */
34
- repoConfig?: NgDocRepoConfig;
35
- /**
36
- * The path to the tsconfig file (NgDoc uses tsconfig of you application by default, but you can override it)
37
- */
38
- tsConfig?: string;
8
+ ngDoc?: NgDocConfiguration;
39
9
  }
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@ng-doc/builder",
3
- "version": "15.6.0",
3
+ "version": "15.7.0",
4
4
  "type": "commonjs",
5
5
  "builders": "./builders.json",
6
6
  "schematics": "./schematics/collection.json",
7
7
  "dependencies": {
8
- "@ng-doc/core": "15.6.0",
8
+ "@ng-doc/core": "15.7.0",
9
9
  "@angular-devkit/architect": ">=0.1500.0",
10
10
  "chokidar": "^3.5.3",
11
11
  "minimatch": "^5.1.0",
@@ -21,11 +21,15 @@
21
21
  "rehype": "^9.0.1",
22
22
  "rehype-format": "^3.1.0",
23
23
  "rehype-highlight": "^4.1.0",
24
- "rehype-slug": "^4.0.0",
24
+ "hast-util-to-string": "^1.0.4",
25
+ "github-slugger": "^1.5.0",
26
+ "hast-util-heading-rank": "^1.0.1",
25
27
  "highlight.js": "^11.5.1",
26
28
  "raw-loader": "^4.0.2",
27
29
  "esbuild": "^0.17.8",
28
- "@microsoft/tsdoc": "^0.14.2"
30
+ "@microsoft/tsdoc": "^0.14.2",
31
+ "cosmiconfig": "^8.1.0",
32
+ "cosmiconfig-typescript-loader": "^4.3.0"
29
33
  },
30
34
  "publishConfig": {
31
35
  "access": "public"
@@ -1,9 +0,0 @@
1
- /**
2
- *
3
- * @param path
4
- */
5
- function importModule(path) {
6
- return import(path)
7
- }
8
-
9
- module.exports = {importModule};