@o3r/extractors 14.0.0-next.5 → 14.0.0-next.8

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 (20) hide show
  1. package/builders/aggregate-migration-scripts/index.js +1 -1
  2. package/package.json +16 -16
  3. package/schematics/cms-adapter/index.d.ts +2 -2
  4. package/schematics/cms-adapter/index.js +2 -2
  5. package/schematics/ng-update/v10-0/configuration-extractor-categories/configuration-extractor-categories.d.ts +1 -1
  6. package/schematics/ng-update/v10-0/configuration-extractor-categories/configuration-extractor-categories.js +1 -1
  7. package/src/core/comparator/package-managers-extractors/custom-npm-semver-resolver.js +1 -1
  8. package/src/core/comparator/package-managers-extractors/custom-npm-semver-resolver.js.map +1 -1
  9. package/src/core/comparator/package-managers-extractors/npm-file-extractor-helper.d.ts +1 -1
  10. package/src/core/comparator/package-managers-extractors/npm-file-extractor-helper.js +2 -2
  11. package/src/core/comparator/package-managers-extractors/npm-file-extractor-helper.js.map +1 -1
  12. package/src/core/comparator/package-managers-extractors/yarn2-file-extractor-helper.d.ts +1 -1
  13. package/src/core/comparator/package-managers-extractors/yarn2-file-extractor-helper.js +1 -1
  14. package/src/core/wrapper.d.ts +1 -1
  15. package/src/core/wrapper.js +1 -1
  16. package/src/utils/common.d.ts +3 -3
  17. package/src/utils/common.js +3 -3
  18. package/src/utils/config-doc.d.ts +6 -6
  19. package/src/utils/config-doc.d.ts.map +1 -1
  20. package/src/utils/config-doc.js +7 -7
package/builders/aggregate-migration-scripts/index.js CHANGED
@@ -52,7 +52,7 @@ const getLibrariesVersions = (migrationFiles) => {
52
52
  }
53
53
  // Sort and dedupe versions
54
54
  Object.entries(libraries).forEach(([libName, libVersions]) => {
55
- libVersions.sort((a, b) => semver.compare(a.appVersion, b.appVersion));
55
+ libVersions.toSorted((a, b) => semver.compare(a.appVersion, b.appVersion));
56
56
  libraries[libName] = libVersions.filter((libVersion, index) => index < 1 || libVersions[index - 1].libVersion !== libVersion.libVersion);
57
57
  });
58
58
  return libraries;
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@o3r/extractors",
3
3
  "main": "./src/public_api.js",
4
4
  "types": "./src/public_api.d.ts",
5
- "version": "14.0.0-next.5",
5
+ "version": "14.0.0-next.8",
6
6
  "publishConfig": {
7
7
  "access": "public"
8
8
  },
@@ -24,9 +24,9 @@
24
24
  "@angular-devkit/architect": ">=0.2000.0 <0.2100.0-0",
25
25
  "@angular-devkit/core": "^20.0.0",
26
26
  "@angular-devkit/schematics": "^20.0.0",
27
- "@o3r/core": "~14.0.0-next.5",
28
- "@o3r/schematics": "~14.0.0-next.5",
29
- "@o3r/telemetry": "~14.0.0-next.5",
27
+ "@o3r/core": "~14.0.0-next.8",
28
+ "@o3r/schematics": "~14.0.0-next.8",
29
+ "@o3r/telemetry": "~14.0.0-next.8",
30
30
  "@schematics/angular": "^20.0.0",
31
31
  "@yarnpkg/cli": "^4.0.0",
32
32
  "@yarnpkg/core": "^4.1.1",
@@ -35,7 +35,7 @@
35
35
  "@yarnpkg/plugin-pack": "^4.0.0",
36
36
  "globby": "^11.1.0",
37
37
  "semver": "^7.5.2",
38
- "type-fest": "^4.30.1",
38
+ "type-fest": "^5.3.1",
39
39
  "typescript": "^5.9.0"
40
40
  },
41
41
  "peerDependenciesMeta": {
@@ -72,7 +72,7 @@
72
72
  },
73
73
  "dependencies": {
74
74
  "@inquirer/confirm": "^5.1.0",
75
- "@microsoft/tsdoc": "~0.15.0",
75
+ "@microsoft/tsdoc": "~0.16.0",
76
76
  "jsonschema": "~1.5.0",
77
77
  "tslib": "^2.6.2",
78
78
  "typedoc": "~0.28.0"
@@ -97,13 +97,13 @@
97
97
  "@nx/eslint-plugin": "~21.6.0",
98
98
  "@nx/jest": "~21.6.0",
99
99
  "@nx/js": "~21.6.0",
100
- "@o3r/build-helpers": "~14.0.0-next.5",
101
- "@o3r/core": "~14.0.0-next.5",
102
- "@o3r/eslint-config": "~14.0.0-next.5",
103
- "@o3r/eslint-plugin": "~14.0.0-next.5",
104
- "@o3r/schematics": "~14.0.0-next.5",
105
- "@o3r/telemetry": "~14.0.0-next.5",
106
- "@o3r/test-helpers": "~14.0.0-next.5",
100
+ "@o3r/build-helpers": "~14.0.0-next.8",
101
+ "@o3r/core": "~14.0.0-next.8",
102
+ "@o3r/eslint-config": "~14.0.0-next.8",
103
+ "@o3r/eslint-plugin": "~14.0.0-next.8",
104
+ "@o3r/schematics": "~14.0.0-next.8",
105
+ "@o3r/telemetry": "~14.0.0-next.8",
106
+ "@o3r/test-helpers": "~14.0.0-next.8",
107
107
  "@schematics/angular": "~20.3.13",
108
108
  "@stylistic/eslint-plugin": "~5.6.0",
109
109
  "@swc/helpers": "~0.5.17",
@@ -124,9 +124,9 @@
124
124
  "eslint-plugin-import": "~2.32.0",
125
125
  "eslint-plugin-import-newlines": "~1.4.0",
126
126
  "eslint-plugin-jest": "~29.1.0",
127
- "eslint-plugin-jsdoc": "~54.7.0",
127
+ "eslint-plugin-jsdoc": "~61.5.0",
128
128
  "eslint-plugin-prefer-arrow": "~1.2.3",
129
- "eslint-plugin-unicorn": "~60.0.0",
129
+ "eslint-plugin-unicorn": "~62.0.0",
130
130
  "eslint-plugin-unused-imports": "~4.3.0",
131
131
  "globals": "^16.0.0",
132
132
  "globby": "^11.1.0",
@@ -143,7 +143,7 @@
143
143
  "rxjs": "^7.8.1",
144
144
  "semver": "^7.5.2",
145
145
  "ts-jest": "~29.4.0",
146
- "type-fest": "^4.30.1",
146
+ "type-fest": "^5.3.1",
147
147
  "typescript": "~5.9.2",
148
148
  "typescript-eslint": "~8.47.0",
149
149
  "typescript-json-schema": "^0.65.0",
package/schematics/cms-adapter/index.d.ts CHANGED
@@ -1,9 +1,9 @@
1
1
  import { Rule } from '@angular-devkit/schematics';
2
2
  /**
3
3
  * Update CMS adapter tools
4
- * @param options @see RuleFactory.options
4
+ * @param options {@link RuleFactory.options}
5
5
  * @param options.projectName
6
- * @param rootPath @see RuleFactory.rootPath
6
+ * @param rootPath {@link RuleFactory.rootPath}
7
7
  */
8
8
  export declare function updateCmsAdapter(options: {
9
9
  projectName?: string | undefined;
package/schematics/cms-adapter/index.js CHANGED
@@ -18,9 +18,9 @@ const updateIgnoredFiles = (tree) => (0, schematics_2.ignorePatterns)(tree, [{ d
18
18
  const ignoreMetadataFiles = (tree, _context) => updateIgnoredFiles(tree);
19
19
  /**
20
20
  * Update CMS adapter tools
21
- * @param options @see RuleFactory.options
21
+ * @param options {@link RuleFactory.options}
22
22
  * @param options.projectName
23
- * @param rootPath @see RuleFactory.rootPath
23
+ * @param rootPath {@link RuleFactory.rootPath}
24
24
  */
25
25
  function updateCmsAdapter(options, rootPath) {
26
26
  if (!options.projectName) {
package/schematics/ng-update/v10-0/configuration-extractor-categories/configuration-extractor-categories.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { Rule } from '@angular-devkit/schematics';
2
2
  /**
3
- * Replace the XML format to specify categories in the configuration extractor (<o3rCategories>) to JSDoc annotations (@o3rCategories)
3
+ * Replace the XML format to specify categories in the configuration extractor (<o3rCategories>) to JSDoc annotations (`@o3rCategories`)
4
4
  */
5
5
  export declare function updateConfigurationExtractorCategories(): Rule;
6
6
  //# sourceMappingURL=configuration-extractor-categories.d.ts.map
package/schematics/ng-update/v10-0/configuration-extractor-categories/configuration-extractor-categories.js CHANGED
@@ -26,7 +26,7 @@ const update = (tree) => {
26
26
  return tree;
27
27
  };
28
28
  /**
29
- * Replace the XML format to specify categories in the configuration extractor (<o3rCategories>) to JSDoc annotations (@o3rCategories)
29
+ * Replace the XML format to specify categories in the configuration extractor (<o3rCategories>) to JSDoc annotations (`@o3rCategories`)
30
30
  */
31
31
  function updateConfigurationExtractorCategories() {
32
32
  return update;
package/src/core/comparator/package-managers-extractors/custom-npm-semver-resolver.js CHANGED
@@ -36,7 +36,7 @@ class CustomNpmSemverResolver extends plugin_npm_1.NpmSemverResolver {
36
36
  const finalCandidates = noDeprecatedCandidates.length > 0
37
37
  ? noDeprecatedCandidates
38
38
  : candidates;
39
- finalCandidates.sort((a, b) => -a.compare(b));
39
+ finalCandidates.toSorted((a, b) => -a.compare(b));
40
40
  return finalCandidates.map((version) => {
41
41
  const versionLocator = core_1.structUtils.makeLocator(descriptor, `${PROTOCOL}${version.raw}`);
42
42
  const archiveUrl = registryData.versions[version.raw].dist.tarball;
package/src/core/comparator/package-managers-extractors/custom-npm-semver-resolver.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"custom-npm-semver-resolver.js","sourceRoot":"","sources":["../../../../../src/core/comparator/package-managers-extractors/custom-npm-semver-resolver.ts"],"names":[],"mappings":";;;AAAA,wCAMuB;AACvB,oDAI6B;AAC7B,mCAIgB;AAEhB;;GAEG;AACH,MAAM,QAAQ,GAAG,MAAM,CAAC;AAExB;;;GAGG;AACH,MAAa,uBAAwB,SAAQ,8BAAiB;IAC5D,kBAAkB;IACF,KAAK,CAAC,aAAa,CAAC,UAAsB,EAAE,aAAsC,EAAE,IAAoB;QACtH,MAAM,KAAK,GAAG,IAAI,cAAK,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9F,MAAM,YAAY,GAAG,MAAM,yBAAY,CAAC,kBAAkB,CAAC,UAAU,EAAE;YACrE,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,KAAK;YAC/B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAA,cAAK,EAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS;SAClD,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,gBAAS,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE;YACxF,IAAI,CAAC;gBACH,MAAM,SAAS,GAAG,IAAI,eAAM,CAAC,OAAO,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;gBACnE,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC1B,OAAO,SAAS,CAAC;gBACnB,CAAC;YACH,CAAC;YAAC,MAAM,CAAC,CAAA,CAAC;YAEV,OAAO,gBAAS,CAAC,YAAY,CAAC,IAAI,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,MAAM,sBAAsB,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC;QAE9G,yDAAyD;QACzD,MAAM,eAAe,GAAG,sBAAsB,CAAC,MAAM,GAAG,CAAC;YACvD,CAAC,CAAC,sBAAsB;YACxB,CAAC,CAAC,UAAU,CAAC;QAEf,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QAE9C,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YACrC,MAAM,cAAc,GAAG,kBAAW,CAAC,WAAW,CAAC,UAAU,EAAE,GAAG,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;YACxF,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;YAEnE,OAAO,6BAAgB,CAAC,wBAAwB,CAAC,cAAc,EAAE,UAAU,EAAE,EAAE,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;gBACzH,CAAC,CAAC,cAAc;gBAChB,CAAC,CAAC,kBAAW,CAAC,WAAW,CAAC,cAAc,EAAE,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAvCD,0DAuCC"}
1
+ {"version":3,"file":"custom-npm-semver-resolver.js","sourceRoot":"","sources":["../../../../../src/core/comparator/package-managers-extractors/custom-npm-semver-resolver.ts"],"names":[],"mappings":";;;AAAA,wCAMuB;AACvB,oDAI6B;AAC7B,mCAIgB;AAEhB;;GAEG;AACH,MAAM,QAAQ,GAAG,MAAM,CAAC;AAExB;;;GAGG;AACH,MAAa,uBAAwB,SAAQ,8BAAiB;IAC5D,kBAAkB;IACF,KAAK,CAAC,aAAa,CAAC,UAAsB,EAAE,aAAsC,EAAE,IAAoB;QACtH,MAAM,KAAK,GAAG,IAAI,cAAK,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9F,MAAM,YAAY,GAAG,MAAM,yBAAY,CAAC,kBAAkB,CAAC,UAAU,EAAE;YACrE,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,KAAK;YAC/B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAA,cAAK,EAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS;SAClD,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,gBAAS,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE;YACxF,IAAI,CAAC;gBACH,MAAM,SAAS,GAAG,IAAI,eAAM,CAAC,OAAO,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;gBACnE,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC1B,OAAO,SAAS,CAAC;gBACnB,CAAC;YACH,CAAC;YAAC,MAAM,CAAC,CAAA,CAAC;YAEV,OAAO,gBAAS,CAAC,YAAY,CAAC,IAAI,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,MAAM,sBAAsB,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC;QAE9G,yDAAyD;QACzD,MAAM,eAAe,GAAG,sBAAsB,CAAC,MAAM,GAAG,CAAC;YACvD,CAAC,CAAC,sBAAsB;YACxB,CAAC,CAAC,UAAU,CAAC;QAEf,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QAElD,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YACrC,MAAM,cAAc,GAAG,kBAAW,CAAC,WAAW,CAAC,UAAU,EAAE,GAAG,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;YACxF,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;YAEnE,OAAO,6BAAgB,CAAC,wBAAwB,CAAC,cAAc,EAAE,UAAU,EAAE,EAAE,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;gBACzH,CAAC,CAAC,cAAc;gBAChB,CAAC,CAAC,kBAAW,CAAC,WAAW,CAAC,cAAc,EAAE,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAvCD,0DAuCC"}
package/src/core/comparator/package-managers-extractors/npm-file-extractor-helper.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Retrieves the list of given files from an npm package using npm.
3
- * @param packageDescriptor Package descriptor using the npm semver format (i.e. @o3r/demo@^1.2.3)
3
+ * @param packageDescriptor Package descriptor using the npm semver format (i.e. `@o3r/demo@^1.2.3`)
4
4
  * @param paths Paths of the files to extract
5
5
  */
6
6
  export declare function getFilesFromRegistry(packageDescriptor: string, paths: string[]): Promise<Record<string, string>>;
package/src/core/comparator/package-managers-extractors/npm-file-extractor-helper.js CHANGED
@@ -21,7 +21,7 @@ function sanitizeInput(input) {
21
21
  }
22
22
  /**
23
23
  * Retrieves the list of given files from an npm package using npm.
24
- * @param packageDescriptor Package descriptor using the npm semver format (i.e. @o3r/demo@^1.2.3)
24
+ * @param packageDescriptor Package descriptor using the npm semver format (i.e. `@o3r/demo@^1.2.3`)
25
25
  * @param paths Paths of the files to extract
26
26
  */
27
27
  async function getFilesFromRegistry(packageDescriptor, paths) {
@@ -39,7 +39,7 @@ async function getFilesFromRegistry(packageDescriptor, paths) {
39
39
  const range = new semver.Range(packageRange, { includePrerelease: true });
40
40
  versions = versions.filter((v) => range.test(v));
41
41
  }
42
- versions.sort((a, b) => semver.compare(b, a));
42
+ versions.toSorted((a, b) => semver.compare(b, a));
43
43
  }
44
44
  const latestVersion = typeof versions === 'string' ? versions : versions[0];
45
45
  const npmPackCmd = runAndThrowOnError(`npm pack "${packageName}@${sanitizeInput(latestVersion)}" --pack-destination "${pathToPosix(tempDirPath)}"`, { shell: true, encoding: 'utf8' });
package/src/core/comparator/package-managers-extractors/npm-file-extractor-helper.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"npm-file-extractor-helper.js","sourceRoot":"","sources":["../../../../../src/core/comparator/package-managers-extractors/npm-file-extractor-helper.ts"],"names":[],"mappings":";;AA4CA,oDA8CC;AA1FD,2DAI4B;AAC5B,6CAEqB;AACrB,qCAKiB;AACjB,qCAEiB;AACjB,yCAImB;AAEnB,SAAS,kBAAkB,CAAC,OAAe,EAAE,YAAgD;IAC3F,MAAM,SAAS,GAAG,IAAA,8BAAS,EAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IACnD,IAAI,SAAS,CAAC,KAAK,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,WAAW,CAAC,IAAY;IAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,eAAG,CAAC,CAAC,IAAI,CAAC,iBAAK,CAAC,GAAG,CAAC,CAAC;AACzC,CAAC;AAED,SAAS,aAAa,CAAC,KAAa;IAClC,OAAO,KAAK,CAAC,OAAO,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;AAClD,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,oBAAoB,CAAC,iBAAyB,EAAE,KAAe;IACnF,MAAM,MAAM,GAAG,2CAAa,QAAQ,EAAC,CAAC;IACtC,MAAM,WAAW,GAAG,MAAM,GAAG,IAAA,yBAAW,EAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC7D,MAAM,WAAW,GAAG,IAAA,gBAAI,EAAC,IAAA,gBAAM,GAAE,EAAE,WAAW,CAAC,CAAC;IAChD,IAAI,cAAc,GAA8B,EAAE,CAAC;IACnD,IAAA,mBAAS,EAAC,WAAW,CAAC,CAAC;IACvB,MAAM,CAAC,EAAC,WAAW,EAAE,YAAY,CAAC,GAAG,aAAa,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAAC;IAEzG,IAAI,CAAC;QACH,MAAM,UAAU,GAAG,kBAAkB,CACnC,aAAa,WAAW,mBAAmB,EAC3C,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,CAClC,CAAC;QACF,IAAI,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,CAAsB,CAAC;QACzE,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC1E,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YACnD,CAAC;YACD,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAChD,CAAC;QACD,MAAM,aAAa,GAAG,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAE5E,MAAM,UAAU,GAAG,kBAAkB,CACnC,aAAa,WAAW,IAAI,aAAa,CAAC,aAAa,CAAC,yBAAyB,WAAW,CAAC,WAAW,CAAC,GAAG,EAC5G,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,CAClC,CAAC;QACF,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAEzC,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,IAAI,EAAE,EAAE;YACnD,2BAA2B;YAC3B,MAAM,SAAS,GAAG,iBAAK,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;YAChD,IAAA,8BAAS,EACP,cAAc,WAAW,CAAC,OAAO,CAAC,SAAS,WAAW,CAAC,WAAW,CAAC,MAAM,SAAS,GAAG,EACrF,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAE,CACpD,CAAC;YACF,MAAM,iBAAiB,GAAG,IAAA,gBAAI,EAAC,WAAW,EAAE,SAAS,CAAC,CAAC;YACvD,IAAI,IAAA,oBAAU,EAAC,iBAAiB,CAAC,EAAE,CAAC;gBAClC,YAAY,CAAC,IAAI,CAAC,GAAG,IAAA,sBAAY,EAAC,iBAAiB,CAAC,CAAC,QAAQ,EAAE,CAAC;YAClE,CAAC;YACD,OAAO,YAAY,CAAC;QACtB,CAAC,EAAE,cAAc,CAAC,CAAC;IACrB,CAAC;YAAS,CAAC;QACT,IAAA,gBAAM,EAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,cAAc,CAAC;AACxB,CAAC"}
1
+ {"version":3,"file":"npm-file-extractor-helper.js","sourceRoot":"","sources":["../../../../../src/core/comparator/package-managers-extractors/npm-file-extractor-helper.ts"],"names":[],"mappings":";;AA4CA,oDA8CC;AA1FD,2DAI4B;AAC5B,6CAEqB;AACrB,qCAKiB;AACjB,qCAEiB;AACjB,yCAImB;AAEnB,SAAS,kBAAkB,CAAC,OAAe,EAAE,YAAgD;IAC3F,MAAM,SAAS,GAAG,IAAA,8BAAS,EAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IACnD,IAAI,SAAS,CAAC,KAAK,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,WAAW,CAAC,IAAY;IAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,eAAG,CAAC,CAAC,IAAI,CAAC,iBAAK,CAAC,GAAG,CAAC,CAAC;AACzC,CAAC;AAED,SAAS,aAAa,CAAC,KAAa;IAClC,OAAO,KAAK,CAAC,OAAO,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;AAClD,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,oBAAoB,CAAC,iBAAyB,EAAE,KAAe;IACnF,MAAM,MAAM,GAAG,2CAAa,QAAQ,EAAC,CAAC;IACtC,MAAM,WAAW,GAAG,MAAM,GAAG,IAAA,yBAAW,EAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC7D,MAAM,WAAW,GAAG,IAAA,gBAAI,EAAC,IAAA,gBAAM,GAAE,EAAE,WAAW,CAAC,CAAC;IAChD,IAAI,cAAc,GAA8B,EAAE,CAAC;IACnD,IAAA,mBAAS,EAAC,WAAW,CAAC,CAAC;IACvB,MAAM,CAAC,EAAC,WAAW,EAAE,YAAY,CAAC,GAAG,aAAa,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAAC;IAEzG,IAAI,CAAC;QACH,MAAM,UAAU,GAAG,kBAAkB,CACnC,aAAa,WAAW,mBAAmB,EAC3C,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,CAClC,CAAC;QACF,IAAI,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,CAAsB,CAAC;QACzE,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC1E,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YACnD,CAAC;YACD,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACpD,CAAC;QACD,MAAM,aAAa,GAAG,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAE5E,MAAM,UAAU,GAAG,kBAAkB,CACnC,aAAa,WAAW,IAAI,aAAa,CAAC,aAAa,CAAC,yBAAyB,WAAW,CAAC,WAAW,CAAC,GAAG,EAC5G,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,CAClC,CAAC;QACF,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAEzC,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,IAAI,EAAE,EAAE;YACnD,2BAA2B;YAC3B,MAAM,SAAS,GAAG,iBAAK,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;YAChD,IAAA,8BAAS,EACP,cAAc,WAAW,CAAC,OAAO,CAAC,SAAS,WAAW,CAAC,WAAW,CAAC,MAAM,SAAS,GAAG,EACrF,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAE,CACpD,CAAC;YACF,MAAM,iBAAiB,GAAG,IAAA,gBAAI,EAAC,WAAW,EAAE,SAAS,CAAC,CAAC;YACvD,IAAI,IAAA,oBAAU,EAAC,iBAAiB,CAAC,EAAE,CAAC;gBAClC,YAAY,CAAC,IAAI,CAAC,GAAG,IAAA,sBAAY,EAAC,iBAAiB,CAAC,CAAC,QAAQ,EAAE,CAAC;YAClE,CAAC;YACD,OAAO,YAAY,CAAC;QACtB,CAAC,EAAE,cAAc,CAAC,CAAC;IACrB,CAAC;YAAS,CAAC;QACT,IAAA,gBAAM,EAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,cAAc,CAAC;AACxB,CAAC"}
package/src/core/comparator/package-managers-extractors/yarn2-file-extractor-helper.d.ts CHANGED
@@ -21,7 +21,7 @@ export declare class MultiResolver implements Resolver {
21
21
  /**
22
22
  * Retrieves the list of given files using yarn
23
23
  * from an npm package that is not present in the dependencies.
24
- * @param packageDescriptor Package descriptor using the npm semver format (i.e. @o3r/demo@^1.2.3)
24
+ * @param packageDescriptor Package descriptor using the npm semver format (i.e. `@o3r/demo@^1.2.3`)
25
25
  * @param paths Paths of the files to extract
26
26
  * @param cwd working directory
27
27
  */
package/src/core/comparator/package-managers-extractors/yarn2-file-extractor-helper.js CHANGED
@@ -120,7 +120,7 @@ async function fetchPackage(project, descriptor) {
120
120
  /**
121
121
  * Retrieves the list of given files using yarn
122
122
  * from an npm package that is not present in the dependencies.
123
- * @param packageDescriptor Package descriptor using the npm semver format (i.e. @o3r/demo@^1.2.3)
123
+ * @param packageDescriptor Package descriptor using the npm semver format (i.e. `@o3r/demo@^1.2.3`)
124
124
  * @param paths Paths of the files to extract
125
125
  * @param cwd working directory
126
126
  */
package/src/core/wrapper.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import type { BuilderWrapper } from '@o3r/telemetry';
2
2
  /**
3
3
  * Wrapper method of a builder to retrieve some metrics around the builder run
4
- * if @o3r/telemetry is installed
4
+ * if `@o3r/telemetry` is installed
5
5
  * @param builderFn
6
6
  */
7
7
  export declare const createBuilderWithMetricsIfInstalled: BuilderWrapper;
package/src/core/wrapper.js CHANGED
@@ -16,7 +16,7 @@ const isInCI = () => {
16
16
  };
17
17
  /**
18
18
  * Wrapper method of a builder to retrieve some metrics around the builder run
19
- * if @o3r/telemetry is installed
19
+ * if `@o3r/telemetry` is installed
20
20
  * @param builderFn
21
21
  */
22
22
  const createBuilderWithMetricsIfInstalled = (builderFn) => async (opts, ctx) => {
package/src/utils/common.d.ts CHANGED
@@ -20,18 +20,18 @@ export declare function checkInterfaceExtendsInterface(node: DocumentationNode,
20
20
  export declare function getReflectionDefaultValue(reflection: DeclarationReflection): string;
21
21
  /**
22
22
  * Get absolute path of a provided library
23
- * @param libraryName Library name (ex: @my-lib/components)
23
+ * @param libraryName Library name (ex: `@my-lib/components`)
24
24
  * @param executionDir
25
25
  */
26
26
  export declare function getLibraryModulePath(libraryName: string, executionDir?: string): string;
27
27
  /**
28
28
  * Get cms metadata files from the node_modules package of the provided library
29
- * @param modulePath Absolute path of the library (ex: my/absolute/path/@my-lib/components)
29
+ * @param modulePath Absolute path of the library (ex: `my/absolute/path/@my-lib/components`)
30
30
  */
31
31
  export declare function getLibraryCmsMetadataFileNames(modulePath: string): any;
32
32
  /**
33
33
  * Get cms metadata file paths from the node_modules package of the provided library
34
- * @param libraryName Library name (ex: @my-lib/components)
34
+ * @param libraryName Library name (ex: `@my-lib/components`)
35
35
  * @param executionDir
36
36
  */
37
37
  export declare function getLibraryCmsMetadata(libraryName: string, executionDir?: string): CmsMetadataData;
package/src/utils/common.js CHANGED
@@ -41,7 +41,7 @@ function getReflectionDefaultValue(reflection) {
41
41
  }
42
42
  /**
43
43
  * Get absolute path of a provided library
44
- * @param libraryName Library name (ex: @my-lib/components)
44
+ * @param libraryName Library name (ex: `@my-lib/components`)
45
45
  * @param executionDir
46
46
  */
47
47
  function getLibraryModulePath(libraryName, executionDir = process.cwd()) {
@@ -74,14 +74,14 @@ function getLibraryModulePath(libraryName, executionDir = process.cwd()) {
74
74
  }
75
75
  /**
76
76
  * Get cms metadata files from the node_modules package of the provided library
77
- * @param modulePath Absolute path of the library (ex: my/absolute/path/@my-lib/components)
77
+ * @param modulePath Absolute path of the library (ex: `my/absolute/path/@my-lib/components`)
78
78
  */
79
79
  function getLibraryCmsMetadataFileNames(modulePath) {
80
80
  return JSON.parse(fs.readFileSync(path.join(modulePath, 'package.json')).toString()).cmsMetadata || {};
81
81
  }
82
82
  /**
83
83
  * Get cms metadata file paths from the node_modules package of the provided library
84
- * @param libraryName Library name (ex: @my-lib/components)
84
+ * @param libraryName Library name (ex: `@my-lib/components`)
85
85
  * @param executionDir
86
86
  */
87
87
  function getLibraryCmsMetadata(libraryName, executionDir = process.cwd()) {
package/src/utils/config-doc.d.ts CHANGED
@@ -15,7 +15,7 @@ export interface ConfigDocInformation {
15
15
  restrictionKeys?: string[];
16
16
  /** Category (taken from `@o3rCategory` tag) */
17
17
  category?: string;
18
- /** Category (taken from @o3rCategories tag) */
18
+ /** Category (taken from `@o3rCategories` tag) */
19
19
  categories?: CategoryDescription[];
20
20
  /** Widget information (taken from `@o3rWidget` and `@o3rWidgetParam` tag) */
21
21
  widget?: ConfigPropertyWidget;
@@ -30,21 +30,21 @@ export declare function getDescriptionFromDocComment(docComment: DocComment): st
30
30
  /**
31
31
  * Get title from a given DocComment.
32
32
  *
33
- * The title is extracted from @title tag.
33
+ * The title is extracted from `@title` tag.
34
34
  * @param docComment The DocComment to get title from
35
35
  */
36
36
  export declare function getTitleFromDocComment(docComment: DocComment): string | undefined;
37
37
  /**
38
38
  * Get widget information from a given DocComment.
39
39
  *
40
- * The widget information are extracted from @o3rWidget and @o3rWidgetParam tag.
40
+ * The widget information are extracted from `@o3rWidget` and `@o3rWidgetParam` tag.
41
41
  * @param docText The tsdoc text to get widget information from
42
42
  */
43
43
  export declare function getWidgetInformationFromDocComment(docText: string): ConfigPropertyWidget | undefined;
44
44
  /**
45
45
  * Get tags from a given DocComment.
46
46
  *
47
- * The tags are extracted from @tags tag.
47
+ * The tags are extracted from `@tags` tag.
48
48
  * The following format should be matched.
49
49
  * @param docComment The DocComment to get tags from
50
50
  * @example
@@ -65,14 +65,14 @@ export declare function isO3rRequiredTagPresent(docText: string): boolean;
65
65
  /**
66
66
  * Get restriction keys from a given DocComment.
67
67
  *
68
- * The restriction keys extracted from @o3rRestrictionKey tag.
68
+ * The restriction keys extracted from `@o3rRestrictionKey` tag.
69
69
  * @param docComment The DocComment to get restriction keys from
70
70
  */
71
71
  export declare function getRestrictionKeysFromDocText(docComment: string): string[];
72
72
  /**
73
73
  * Get categories from a given DocComment.
74
74
  *
75
- * The categories are extracted from the @o3rCategories tags.
75
+ * The categories are extracted from the `@o3rCategories` tags.
76
76
  * @param docComment The DocComment to get categories from
77
77
  */
78
78
  export declare function getCategoriesFromDocText(docComment: string): CategoryDescription[] | undefined;
package/src/utils/config-doc.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"config-doc.d.ts","sourceRoot":"","sources":["../../../src/utils/config-doc.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAKX,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EACV,mBAAmB,EACnB,oBAAoB,EAErB,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AAOjC,yDAAyD;AACzD,MAAM,WAAW,oBAAoB;IACnC,kBAAkB;IAClB,WAAW,EAAE,MAAM,CAAC;IAEpB,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,oCAAoC;IACpC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB,6DAA6D;IAC7D,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,+CAA+C;IAC/C,UAAU,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAEnC,6EAA6E;IAC7E,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAE9B,kCAAkC;IAClC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAE3E;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,GAAG,SAAS,CAEjF;AAED;;;;;GAKG;AACH,wBAAgB,kCAAkC,CAAC,OAAO,EAAE,MAAM,GAAG,oBAAoB,GAAG,SAAS,CA6BpG;AAaD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,EAAE,GAAG,SAAS,CAGlF;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAEhE;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAG1E;AAaD;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,MAAM,GAAG,mBAAmB,EAAE,GAAG,SAAS,CAkB9F;AAED;;GAEG;AACH,qBAAa,eAAe;IAC1B,mBAAmB;IACnB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAc;;IAuB1C;;;;OAIG;IACI,sBAAsB,CAAC,MAAM,EAAE,EAAE,CAAC,UAAU,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,oBAAoB,GAAG,SAAS;CAmBtG"}
1
+ {"version":3,"file":"config-doc.d.ts","sourceRoot":"","sources":["../../../src/utils/config-doc.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAKX,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EACV,mBAAmB,EACnB,oBAAoB,EAErB,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AAOjC,yDAAyD;AACzD,MAAM,WAAW,oBAAoB;IACnC,kBAAkB;IAClB,WAAW,EAAE,MAAM,CAAC;IAEpB,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,oCAAoC;IACpC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB,6DAA6D;IAC7D,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,iDAAiD;IACjD,UAAU,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAEnC,6EAA6E;IAC7E,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAE9B,kCAAkC;IAClC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAE3E;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,GAAG,SAAS,CAEjF;AAED;;;;;GAKG;AACH,wBAAgB,kCAAkC,CAAC,OAAO,EAAE,MAAM,GAAG,oBAAoB,GAAG,SAAS,CA6BpG;AAaD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,EAAE,GAAG,SAAS,CAGlF;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAEhE;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAG1E;AAaD;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,MAAM,GAAG,mBAAmB,EAAE,GAAG,SAAS,CAkB9F;AAED;;GAEG;AACH,qBAAa,eAAe;IAC1B,mBAAmB;IACnB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAc;;IAuB1C;;;;OAIG;IACI,sBAAsB,CAAC,MAAM,EAAE,EAAE,CAAC,UAAU,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,oBAAoB,GAAG,SAAS;CAmBtG"}
package/src/utils/config-doc.js CHANGED
@@ -20,7 +20,7 @@ function getDescriptionFromDocComment(docComment) {
20
20
  /**
21
21
  * Get title from a given DocComment.
22
22
  *
23
- * The title is extracted from @title tag.
23
+ * The title is extracted from `@title` tag.
24
24
  * @param docComment The DocComment to get title from
25
25
  */
26
26
  function getTitleFromDocComment(docComment) {
@@ -29,7 +29,7 @@ function getTitleFromDocComment(docComment) {
29
29
  /**
30
30
  * Get widget information from a given DocComment.
31
31
  *
32
- * The widget information are extracted from @o3rWidget and @o3rWidgetParam tag.
32
+ * The widget information are extracted from `@o3rWidget` and `@o3rWidgetParam` tag.
33
33
  * @param docText The tsdoc text to get widget information from
34
34
  */
35
35
  function getWidgetInformationFromDocComment(docText) {
@@ -62,7 +62,7 @@ function getWidgetInformationFromDocComment(docText) {
62
62
  /**
63
63
  * Get label from a given DocComment.
64
64
  *
65
- * The label is extracted from @label tag.
65
+ * The label is extracted from `@label` tag.
66
66
  * @param docText The DocComment to get category from
67
67
  */
68
68
  function getLabelFromDocText(docText) {
@@ -72,7 +72,7 @@ function getLabelFromDocText(docText) {
72
72
  /**
73
73
  * Get tags from a given DocComment.
74
74
  *
75
- * The tags are extracted from @tags tag.
75
+ * The tags are extracted from `@tags` tag.
76
76
  * The following format should be matched.
77
77
  * @param docComment The DocComment to get tags from
78
78
  * @example
@@ -98,7 +98,7 @@ function isO3rRequiredTagPresent(docText) {
98
98
  /**
99
99
  * Get restriction keys from a given DocComment.
100
100
  *
101
- * The restriction keys extracted from @o3rRestrictionKey tag.
101
+ * The restriction keys extracted from `@o3rRestrictionKey` tag.
102
102
  * @param docComment The DocComment to get restriction keys from
103
103
  */
104
104
  function getRestrictionKeysFromDocText(docComment) {
@@ -108,7 +108,7 @@ function getRestrictionKeysFromDocText(docComment) {
108
108
  /**
109
109
  * Get category from a given DocComment.
110
110
  *
111
- * The category is extracted from @o3rCategory tag.
111
+ * The category is extracted from `@o3rCategory` tag.
112
112
  * @param docComment The DocComment to get category from
113
113
  */
114
114
  function getCategoryFromDocText(docComment) {
@@ -118,7 +118,7 @@ function getCategoryFromDocText(docComment) {
118
118
  /**
119
119
  * Get categories from a given DocComment.
120
120
  *
121
- * The categories are extracted from the @o3rCategories tags.
121
+ * The categories are extracted from the `@o3rCategories` tags.
122
122
  * @param docComment The DocComment to get categories from
123
123
  */
124
124
  function getCategoriesFromDocText(docComment) {