comment-variables 2.3.1 → 2.3.4

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/README.md CHANGED
@@ -20,7 +20,7 @@ npm install -g comment-variables@latest
20
20
 
21
21
  ## Commands
22
22
 
23
- **`comment-variables` (aliases `jscomments`/`comvar`) comes with four commands in this initial release:**
23
+ **`comment-variables` (aliases `jscomments`) comes with four commands in this initial release:**
24
24
 
25
25
  ```
26
26
  comment-variables
@@ -1,6 +1,6 @@
1
1
  // The Comment Variables config template generated in case no config file has been found.
2
2
 
3
- /* variants */
3
+ /* variants and labels */
4
4
 
5
5
  const EN = "en";
6
6
  const ENGLISH = "English";
@@ -49,9 +49,12 @@ const myIgnoresOnly = false; // can be omitted
49
49
 
50
50
  /* composedVariablesExclusives */
51
51
 
52
- const enComposedVariablesExclusives = ["EN#COMMENTS#YES"];
53
-
54
- const frComposedVariablesExclusives = ["FR#COMMENTS#YES"];
52
+ const enComposedVariablesExclusives = /** @type {string[]} */ ([
53
+ "EN#COMMENTS#YES",
54
+ ]);
55
+ const frComposedVariablesExclusives = /** @type {string[]} */ ([
56
+ "FR#COMMENTS#YES",
57
+ ]);
55
58
 
56
59
  const composedVariablesExclusives = [
57
60
  ...enComposedVariablesExclusives,
@@ -75,7 +78,7 @@ const variations = Object.freeze({
75
78
  // Defines the behavior of the error handling in case of variations that do not match one-to-one with the reference variation. If `true`, allows incomplete variations data to remain. If `false`, errors and guides the fixing of missing variations data (while ignoring composed variables exclusives).
76
79
  allowIncompleteVariations: true,
77
80
  // Defines which variants' `#PUBLIC#` Comment Variables should be publicly available, by default through `comments.public.mjs` and `comments.public.json`.
78
- // public: [EN, FR] // v3
81
+ // public: [EN, FR] // can be omitted, otherwise must first include `variations.referenceVariant` as its first element // v3
79
82
  });
80
83
 
81
84
  // /* libraries */
package/package.json CHANGED
@@ -1,11 +1,10 @@
1
1
  {
2
2
  "name": "comment-variables",
3
- "version": "2.3.1",
3
+ "version": "2.3.4",
4
4
  "description": "A CLI tool for configuring, managing and maintaining JavaScript comments as JavaScript variables.",
5
5
  "bin": {
6
6
  "comment-variables": "./library/index.js",
7
- "jscomments": "./library/index.js",
8
- "comvar": "./library/index.js"
7
+ "jscomments": "./library/index.js"
9
8
  },
10
9
  "main": "library/index.js",
11
10
  "files": [
@@ -32,7 +31,7 @@
32
31
  "type": "module",
33
32
  "dependencies": {
34
33
  "@eslint/markdown": "^6.5.0",
35
- "comment-variables-resolve-config": "^2.3.1",
34
+ "comment-variables-resolve-config": "^2.3.4",
36
35
  "eslint": "^9.29.0",
37
36
  "prompts": "^2.4.2"
38
37
  },