@code-pushup/create-cli 0.125.0 → 0.126.1

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 (4) hide show
  1. package/README.md +7 -0
  2. package/package.json +10 -9
  3. package/src/index.js +2 -1
  4. package/src/index.js.map +1 -1
package/README.md CHANGED
@@ -72,6 +72,13 @@ Each plugin exposes its own configuration keys that can be passed as CLI argumen
72
72
  | **`--lighthouse.urls`** | `string \| string[]` | `http://localhost:4200` | Target URL(s) (comma-separated) |
73
73
  | **`--lighthouse.categories`** | `('performance'` \| `'a11y'` \| `'best-practices'` \| `'seo')[]` | all | Lighthouse categories |
74
74
 
75
+ #### JSDocs
76
+
77
+ | Option | Type | Default | Description |
78
+ | ------------------------- | -------------------- | -------------------------------------------- | -------------------------------------- |
79
+ | **`--jsdocs.patterns`** | `string \| string[]` | `src/**/*.ts, src/**/*.js, !**/node_modules` | Source file patterns (comma-separated) |
80
+ | **`--jsdocs.categories`** | `boolean` | `true` | Add JSDocs categories |
81
+
75
82
  #### Axe
76
83
 
77
84
  | Option | Type | Default | Description |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@code-pushup/create-cli",
3
- "version": "0.125.0",
3
+ "version": "0.126.1",
4
4
  "license": "MIT",
5
5
  "bin": "./bin.js",
6
6
  "homepage": "https://github.com/code-pushup/cli/tree/main/packages/create-cli#readme",
@@ -26,14 +26,15 @@
26
26
  },
27
27
  "type": "module",
28
28
  "dependencies": {
29
- "@code-pushup/axe-plugin": "0.125.0",
30
- "@code-pushup/coverage-plugin": "0.125.0",
31
- "@code-pushup/eslint-plugin": "0.125.0",
32
- "@code-pushup/js-packages-plugin": "0.125.0",
33
- "@code-pushup/lighthouse-plugin": "0.125.0",
34
- "@code-pushup/models": "0.125.0",
35
- "@code-pushup/typescript-plugin": "0.125.0",
36
- "@code-pushup/utils": "0.125.0",
29
+ "@code-pushup/axe-plugin": "0.126.1",
30
+ "@code-pushup/coverage-plugin": "0.126.1",
31
+ "@code-pushup/eslint-plugin": "0.126.1",
32
+ "@code-pushup/js-packages-plugin": "0.126.1",
33
+ "@code-pushup/jsdocs-plugin": "0.126.1",
34
+ "@code-pushup/lighthouse-plugin": "0.126.1",
35
+ "@code-pushup/models": "0.126.1",
36
+ "@code-pushup/typescript-plugin": "0.126.1",
37
+ "@code-pushup/utils": "0.126.1",
37
38
  "@inquirer/prompts": "^8.0.0",
38
39
  "yaml": "^2.5.1",
39
40
  "yargs": "^17.7.2"
package/src/index.js CHANGED
@@ -5,12 +5,12 @@ import { axeSetupBinding } from '@code-pushup/axe-plugin';
5
5
  import { coverageSetupBinding } from '@code-pushup/coverage-plugin';
6
6
  import { eslintSetupBinding } from '@code-pushup/eslint-plugin';
7
7
  import { jsPackagesSetupBinding } from '@code-pushup/js-packages-plugin';
8
+ import { jsDocsSetupBinding } from '@code-pushup/jsdocs-plugin';
8
9
  import { lighthouseSetupBinding } from '@code-pushup/lighthouse-plugin';
9
10
  import { typescriptSetupBinding } from '@code-pushup/typescript-plugin';
10
11
  import { parsePluginSlugs, validatePluginSlugs } from './lib/setup/plugins.js';
11
12
  import { CI_PROVIDERS, CONFIG_FILE_FORMATS, SETUP_MODES, } from './lib/setup/types.js';
12
13
  import { runSetupWizard } from './lib/setup/wizard.js';
13
- // TODO: create, import and pass remaining plugin bindings (jsdocs)
14
14
  const bindings = [
15
15
  eslintSetupBinding,
16
16
  coverageSetupBinding,
@@ -18,6 +18,7 @@ const bindings = [
18
18
  typescriptSetupBinding,
19
19
  lighthouseSetupBinding,
20
20
  axeSetupBinding,
21
+ jsDocsSetupBinding,
21
22
  ];
22
23
  const argv = await yargs(hideBin(process.argv))
23
24
  .option('dry-run', {
package/src/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC/E,OAAO,EACL,YAAY,EACZ,mBAAmB,EAEnB,WAAW,GACZ,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,mEAAmE;AACnE,MAAM,QAAQ,GAAyB;IACrC,kBAAkB;IAClB,oBAAoB;IACpB,sBAAsB;IACtB,sBAAsB;IACtB,sBAAsB;IACtB,eAAe;CAChB,CAAC;AAEF,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;KAC5C,MAAM,CAAC,SAAS,EAAE;IACjB,IAAI,EAAE,SAAS;IACf,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,uCAAuC;CAClD,CAAC;KACD,MAAM,CAAC,KAAK,EAAE;IACb,KAAK,EAAE,GAAG;IACV,IAAI,EAAE,SAAS;IACf,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,+BAA+B;CAC1C,CAAC;KACD,MAAM,CAAC,eAAe,EAAE;IACvB,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,mBAAmB;IAC5B,QAAQ,EAAE,0DAA0D;CACrE,CAAC;KACD,MAAM,CAAC,SAAS,EAAE;IACjB,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,gEAAgE;IAC1E,MAAM,EAAE,gBAAgB;CACzB,CAAC;KACD,MAAM,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,WAAW;IACpB,QAAQ,EAAE,kDAAkD;CAC7D,CAAC;KACD,MAAM,CAAC,IAAI,EAAE;IACZ,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,YAAY;IACrB,QAAQ,EAAE,6CAA6C;CACxD,CAAC;KACD,KAAK,CAAC,MAAM,CAAC,EAAE;IACd,mBAAmB,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9C,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;KACD,KAAK,EAAE,CAAC;AAEX,MAAM,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC/E,OAAO,EACL,YAAY,EACZ,mBAAmB,EAEnB,WAAW,GACZ,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,MAAM,QAAQ,GAAyB;IACrC,kBAAkB;IAClB,oBAAoB;IACpB,sBAAsB;IACtB,sBAAsB;IACtB,sBAAsB;IACtB,eAAe;IACf,kBAAkB;CACnB,CAAC;AAEF,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;KAC5C,MAAM,CAAC,SAAS,EAAE;IACjB,IAAI,EAAE,SAAS;IACf,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,uCAAuC;CAClD,CAAC;KACD,MAAM,CAAC,KAAK,EAAE;IACb,KAAK,EAAE,GAAG;IACV,IAAI,EAAE,SAAS;IACf,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,+BAA+B;CAC1C,CAAC;KACD,MAAM,CAAC,eAAe,EAAE;IACvB,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,mBAAmB;IAC5B,QAAQ,EAAE,0DAA0D;CACrE,CAAC;KACD,MAAM,CAAC,SAAS,EAAE;IACjB,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,gEAAgE;IAC1E,MAAM,EAAE,gBAAgB;CACzB,CAAC;KACD,MAAM,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,WAAW;IACpB,QAAQ,EAAE,kDAAkD;CAC7D,CAAC;KACD,MAAM,CAAC,IAAI,EAAE;IACZ,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,YAAY;IACrB,QAAQ,EAAE,6CAA6C;CACxD,CAAC;KACD,KAAK,CAAC,MAAM,CAAC,EAAE;IACd,mBAAmB,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9C,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;KACD,KAAK,EAAE,CAAC;AAEX,MAAM,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC"}