comment-variables 1.2.4 → 1.2.5
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 +14 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# comment-variables
|
|
2
2
|
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- <picture>
|
|
6
|
+
<source media="(prefers-color-scheme: dark)" srcset="./assets/README/name-dark-default.png">
|
|
7
|
+
<source media="(prefers-color-scheme: light)" srcset="./assets/README/name-light.png">
|
|
8
|
+
<img alt="Logo and name for the Comment Variables ecosystem." src="./assets/README/name-dark-default.png">
|
|
9
|
+
</picture> -->
|
|
10
|
+
|
|
3
11
|
A CLI tool for configuring, managing and maintaining JavaScript comments as JavaScript variables, via a `comments.config.js` file at the root of your project.
|
|
4
12
|
|
|
5
13
|
|
|
@@ -127,6 +135,8 @@ const data = {
|
|
|
127
135
|
"The flattened config data, with `$COMMENT` placeholders as keys and actual comments as values." /* $COMMENT#JSDOC#PARAMS#FLATTENEDCONFIGDATA */,
|
|
128
136
|
reversedFlattenedConfigData:
|
|
129
137
|
"The reversed flattened config data, with actual comments as keys and `$COMMENT` placeholders as values." /* $COMMENT#JSDOC#PARAMS#REVERSEDFLATTENEDCONFIGDATA */,
|
|
138
|
+
composedVariablesExclusives:
|
|
139
|
+
"The array of comment variables keys (implying their aliases as well) exclusively used to craft composed variables, that should be ignored by both the `resolve` and the `compress` commands." /* $COMMENT#JSDOC#PARAMS#COMPOSEDVARIABLESEXCLUSIVES */,
|
|
130
140
|
aliases_flattenedKeys:
|
|
131
141
|
"The dictionary that connects aliases to their original flattened keys in case an encountered placeholder is actually an alias." /* $COMMENT#JSDOC#PARAMS#ALIASES_FLATTENEDKEYS */,
|
|
132
142
|
ruleName:
|
|
@@ -145,6 +155,8 @@ const data = {
|
|
|
145
155
|
'The array of paths linked to the config file, (named "ignores" given it is ignored by the "compress" and "resolve" commands).' /* $COMMENT#JSDOC#PARAMS#CONFIGPATHIGNORES */,
|
|
146
156
|
originalFlattenedConfigData:
|
|
147
157
|
"The original flattened config data, before changes to aliases variables and composed variables are applied." /* $COMMENT#JSDOC#PARAMS#ORIGINALFLATTENEDCONFIGDATA */,
|
|
158
|
+
relativeMjsPath:
|
|
159
|
+
'The relative path of the generated `.mjs` file to be ignored in the "placeholders" process.' /* $COMMENT#JSDOC#PARAMS#RELATIVEMJSPATH */,
|
|
148
160
|
}),
|
|
149
161
|
returns: Object.freeze({
|
|
150
162
|
exitDueToFailure:
|
|
@@ -157,6 +169,8 @@ const data = {
|
|
|
157
169
|
constants: Object.freeze({
|
|
158
170
|
sortedReversedFlattenedConfigData:
|
|
159
171
|
"The whole `reversedFlattenedConfigData` turned from an object to an array of key-value arrays sorted by the descending length of each key to prevent partial replacements." /* $COMMENT#JSDOC#CONSTANTS#SORTEDREVERSEDFLATTENEDCONFIGDATA */,
|
|
172
|
+
composedVariablesExclusivesSet:
|
|
173
|
+
"A local Set out of composed variables exclusives for speed." /* $COMMENT#JSDOC#CONSTANTS#COMPOSEDVARIABLESEXCLUSIVESSET */,
|
|
160
174
|
}),
|
|
161
175
|
}),
|
|
162
176
|
};
|
package/package.json
CHANGED