@code-pushup/jsdocs-plugin 0.126.0 → 0.126.2
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/package.json +3 -3
- package/src/lib/binding.js +18 -16
- package/src/lib/binding.js.map +1 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@code-pushup/jsdocs-plugin",
|
|
3
|
-
"version": "0.126.
|
|
3
|
+
"version": "0.126.2",
|
|
4
4
|
"description": "Code PushUp plugin for tracking documentation coverage 📚",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://github.com/code-pushup/cli/tree/main/packages/plugin-jsdocs#readme",
|
|
@@ -35,8 +35,8 @@
|
|
|
35
35
|
},
|
|
36
36
|
"type": "module",
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@code-pushup/models": "0.126.
|
|
39
|
-
"@code-pushup/utils": "0.126.
|
|
38
|
+
"@code-pushup/models": "0.126.2",
|
|
39
|
+
"@code-pushup/utils": "0.126.2",
|
|
40
40
|
"zod": "^4.2.1",
|
|
41
41
|
"ts-morph": "^24.0.0"
|
|
42
42
|
},
|
package/src/lib/binding.js
CHANGED
|
@@ -7,19 +7,21 @@ const DEFAULT_PATTERNS = [
|
|
|
7
7
|
'src/**/*.js',
|
|
8
8
|
'!**/node_modules',
|
|
9
9
|
];
|
|
10
|
-
const
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
10
|
+
const CATEGORIES = [
|
|
11
|
+
{
|
|
12
|
+
slug: 'docs',
|
|
13
|
+
title: 'Documentation',
|
|
14
|
+
description: 'Measures how much of your code is **documented**.',
|
|
15
|
+
refs: [
|
|
16
|
+
{
|
|
17
|
+
type: 'group',
|
|
18
|
+
plugin: PLUGIN_SLUG,
|
|
19
|
+
slug: 'documentation-coverage',
|
|
20
|
+
weight: 1,
|
|
21
|
+
},
|
|
22
|
+
],
|
|
23
|
+
},
|
|
24
|
+
];
|
|
23
25
|
export const jsDocsSetupBinding = {
|
|
24
26
|
slug: PLUGIN_SLUG,
|
|
25
27
|
title: PLUGIN_TITLE,
|
|
@@ -27,13 +29,13 @@ export const jsDocsSetupBinding = {
|
|
|
27
29
|
prompts: async () => [
|
|
28
30
|
{
|
|
29
31
|
key: 'jsdocs.patterns',
|
|
30
|
-
message: 'Source file patterns (comma-separated)',
|
|
32
|
+
message: 'Source file patterns (comma-separated):',
|
|
31
33
|
type: 'input',
|
|
32
34
|
default: DEFAULT_PATTERNS.join(', '),
|
|
33
35
|
},
|
|
34
36
|
{
|
|
35
37
|
key: 'jsdocs.categories',
|
|
36
|
-
message: 'Add
|
|
38
|
+
message: 'Add categories?',
|
|
37
39
|
type: 'confirm',
|
|
38
40
|
default: true,
|
|
39
41
|
},
|
|
@@ -45,7 +47,7 @@ export const jsDocsSetupBinding = {
|
|
|
45
47
|
{ moduleSpecifier: PACKAGE_NAME, defaultImport: 'jsDocsPlugin' },
|
|
46
48
|
],
|
|
47
49
|
pluginInit: formatPluginInit(options.patterns),
|
|
48
|
-
...(options.categories ? { categories:
|
|
50
|
+
...(options.categories ? { categories: CATEGORIES } : {}),
|
|
49
51
|
};
|
|
50
52
|
},
|
|
51
53
|
};
|
package/src/lib/binding.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"binding.js","sourceRoot":"","sources":["../../../src/lib/binding.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAM5C,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,WAAW,GACZ,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE3D,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAC3D,oBAAoB,CACkB,CAAC;AAEzC,MAAM,gBAAgB,GAA0B;IAC9C,aAAa;IACb,aAAa;IACb,kBAAkB;CACnB,CAAC;AAEF,MAAM,
|
|
1
|
+
{"version":3,"file":"binding.js","sourceRoot":"","sources":["../../../src/lib/binding.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAM5C,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,WAAW,GACZ,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE3D,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAC3D,oBAAoB,CACkB,CAAC;AAEzC,MAAM,gBAAgB,GAA0B;IAC9C,aAAa;IACb,aAAa;IACb,kBAAkB;CACnB,CAAC;AAEF,MAAM,UAAU,GAAqB;IACnC;QACE,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,eAAe;QACtB,WAAW,EAAE,mDAAmD;QAChE,IAAI,EAAE;YACJ;gBACE,IAAI,EAAE,OAAO;gBACb,MAAM,EAAE,WAAW;gBACnB,IAAI,EAAE,wBAAwB;gBAC9B,MAAM,EAAE,CAAC;aACV;SACF;KACF;CACF,CAAC;AAOF,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,IAAI,EAAE,WAAW;IACjB,KAAK,EAAE,YAAY;IACnB,WAAW,EAAE,YAAY;IACzB,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC;QACnB;YACE,GAAG,EAAE,iBAAiB;YACtB,OAAO,EAAE,yCAAyC;YAClD,IAAI,EAAE,OAAO;YACb,OAAO,EAAE,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC;SACrC;QACD;YACE,GAAG,EAAE,mBAAmB;YACxB,OAAO,EAAE,iBAAiB;YAC1B,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;SACd;KACF;IACD,cAAc,EAAE,CAAC,OAAqC,EAAE,EAAE;QACxD,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;QACtC,OAAO;YACL,OAAO,EAAE;gBACP,EAAE,eAAe,EAAE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE;aACjE;YACD,UAAU,EAAE,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC;YAC9C,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC1D,CAAC;IACJ,CAAC;CAC2B,CAAC;AAE/B,SAAS,YAAY,CAAC,OAAqC;IACzD,OAAO;QACL,QAAQ,EAAE,mBAAmB,CAC3B,OAAO,EACP,iBAAiB,EACjB,gBAAgB,CAAC,CAAC,CAAC,CACpB;QACD,UAAU,EAAE,aAAa,CAAC,OAAO,EAAE,mBAAmB,CAAC;KACxD,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,CAAC,KAAK,EAAE,GAAG,IAAI,CAAwB;IAC/D,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,CAAC,gBAAgB,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IACD,OAAO;QACL,gBAAgB;QAChB,GAAG,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC;QACpD,KAAK;KACN,CAAC;AACJ,CAAC"}
|