@snyk/error-catalog-nodejs-public 5.30.0 → 5.30.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/package.json +1 -1
  2. package/src/catalogs/CLI-error-catalog.d.ts +8 -2
  3. package/src/catalogs/CLI-error-catalog.js +15 -5
  4. package/src/catalogs/CLI-error-catalog.js.map +1 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@snyk/error-catalog-nodejs-public",
3
- "version": "5.30.0",
3
+ "version": "5.30.1",
4
4
  "type": "commonjs",
5
5
  "author": "snyk.io",
6
6
  "license": "Apache-2.0",
package/src/catalogs/CLI-error-catalog.d.ts CHANGED
@@ -18,6 +18,9 @@ import { ProblemError } from '../problem-error';
18
18
  * @class
19
19
  * @name ConfigEnvironmentFailedError
20
20
  * @description The specified environment cannot be used. As a result, the configuration remains unchanged.Provide the correct specifications for the environment and try again.
21
+ *
22
+ * See more:
23
+ * - [https://docs.snyk.io/snyk-cli/commands/config-environment](https://docs.snyk.io/snyk-cli/commands/config-environment)
21
24
  * @summary Unable to set environment
22
25
  * @category CLI
23
26
  * @param {string} details the specific details that causes this error
@@ -32,10 +35,13 @@ export declare class ConfigEnvironmentFailedError extends ProblemError {
32
35
  /**
33
36
  * @class
34
37
  * @name ConfigEnvironmentConsistencyIssueError
35
- * @description There are different ways of configuring the CLI, for example via Environment Variables or configuration file.
38
+ * @description You can configure the CLI in different ways, for example via Environment Variables or configuration file.
36
39
  * If one parameter is configured multiple times, it is probably unintentional and might cause unexpected behaviour.
37
40
  * Review configured environment variables and ensure that everything is intentional. If so, you can skip this check by using --no-check.
38
- * @summary Possible inconsistent configuration detected
41
+ *
42
+ * See more:
43
+ * - [https://docs.snyk.io/snyk-cli/commands/config-environment](https://docs.snyk.io/snyk-cli/commands/config-environment)
44
+ * @summary Possible inconsistent configuration
39
45
  * @category CLI
40
46
  * @param {string} details the specific details that causes this error
41
47
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
package/src/catalogs/CLI-error-catalog.js CHANGED
@@ -22,6 +22,9 @@ const problem_error_1 = require("../problem-error");
22
22
  * @class
23
23
  * @name ConfigEnvironmentFailedError
24
24
  * @description The specified environment cannot be used. As a result, the configuration remains unchanged.Provide the correct specifications for the environment and try again.
25
+ *
26
+ * See more:
27
+ * - [https://docs.snyk.io/snyk-cli/commands/config-environment](https://docs.snyk.io/snyk-cli/commands/config-environment)
25
28
  * @summary Unable to set environment
26
29
  * @category CLI
27
30
  * @param {string} details the specific details that causes this error
@@ -40,7 +43,9 @@ class ConfigEnvironmentFailedError extends problem_error_1.ProblemError {
40
43
  level: 'error',
41
44
  classification: types_1.Classification.ACTIONABLE,
42
45
  instance,
43
- }, details, Object.assign({ links: [] }, additionalData), cause, logs);
46
+ }, details, Object.assign({ links: [
47
+ 'https://docs.snyk.io/snyk-cli/commands/config-environment',
48
+ ] }, additionalData), cause, logs);
44
49
  this.name = this.constructor.name;
45
50
  }
46
51
  }
@@ -48,10 +53,13 @@ exports.ConfigEnvironmentFailedError = ConfigEnvironmentFailedError;
48
53
  /**
49
54
  * @class
50
55
  * @name ConfigEnvironmentConsistencyIssueError
51
- * @description There are different ways of configuring the CLI, for example via Environment Variables or configuration file.
56
+ * @description You can configure the CLI in different ways, for example via Environment Variables or configuration file.
52
57
  * If one parameter is configured multiple times, it is probably unintentional and might cause unexpected behaviour.
53
58
  * Review configured environment variables and ensure that everything is intentional. If so, you can skip this check by using --no-check.
54
- * @summary Possible inconsistent configuration detected
59
+ *
60
+ * See more:
61
+ * - [https://docs.snyk.io/snyk-cli/commands/config-environment](https://docs.snyk.io/snyk-cli/commands/config-environment)
62
+ * @summary Possible inconsistent configuration
55
63
  * @category CLI
56
64
  * @param {string} details the specific details that causes this error
57
65
  * @param {Classification} classification the error classification determining if the error is user-actionable or not
@@ -62,14 +70,16 @@ exports.ConfigEnvironmentFailedError = ConfigEnvironmentFailedError;
62
70
  class ConfigEnvironmentConsistencyIssueError extends problem_error_1.ProblemError {
63
71
  constructor(details, additionalData, cause, instance, logs) {
64
72
  super({
65
- title: 'Possible inconsistent configuration detected',
73
+ title: 'Possible inconsistent configuration',
66
74
  type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-cli-0002',
67
75
  status: 200,
68
76
  errorCode: 'SNYK-CLI-0002',
69
77
  level: 'error',
70
78
  classification: types_1.Classification.ACTIONABLE,
71
79
  instance,
72
- }, details, Object.assign({ links: [] }, additionalData), cause, logs);
80
+ }, details, Object.assign({ links: [
81
+ 'https://docs.snyk.io/snyk-cli/commands/config-environment',
82
+ ] }, additionalData), cause, logs);
73
83
  this.name = this.constructor.name;
74
84
  }
75
85
  }
package/src/catalogs/CLI-error-catalog.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"CLI-error-catalog.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/catalogs/CLI-error-catalog.ts"],"names":[],"mappings":";;;AAAA,oCAA0C;AAC1C,oDAAgD;AAEhD;;;;;;;;;;;GAWG;AACH,MAAa,4BAA6B,SAAQ,4BAAY;IAC5D,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,2BAA2B;YAClC,IAAI,EAAE,iEAAiE;YACvE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,eAAe;YAC1B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA5BD,oEA4BC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAa,sCAAuC,SAAQ,4BAAY;IACtE,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,8CAA8C;YACrD,IAAI,EAAE,iEAAiE;YACvE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,eAAe;YAC1B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA5BD,wFA4BC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAa,sBAAuB,SAAQ,4BAAY;IACtD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,6BAA6B;YACpC,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,yBAAyB;aACxB,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,wDA8BC"}
1
+ {"version":3,"file":"CLI-error-catalog.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/catalogs/CLI-error-catalog.ts"],"names":[],"mappings":";;;AAAA,oCAA0C;AAC1C,oDAAgD;AAEhD;;;;;;;;;;;;;;GAcG;AACH,MAAa,4BAA6B,SAAQ,4BAAY;IAC5D,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,2BAA2B;YAClC,IAAI,EAAE,iEAAiE;YACvE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,eAAe;YAC1B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,2DAA2D;aAC1D,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,oEA8BC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,sCAAuC,SAAQ,4BAAY;IACtE,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,qCAAqC;YAC5C,IAAI,EAAE,iEAAiE;YACvE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,eAAe;YAC1B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,2DAA2D;aAC1D,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,wFA8BC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAa,sBAAuB,SAAQ,4BAAY;IACtD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,6BAA6B;YACpC,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,yBAAyB;aACxB,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,wDA8BC"}