comment-variables 1.2.3 → 1.2.5

package/README.md

@@ -1,5 +1,13 @@
 # comment-variables
 
+![Name and logo for the Comment Variables ecosystem, dark default variant.](./assets/README/name-dark-default.png)
+
+<!-- <picture>
+  <source media="(prefers-color-scheme: dark)" srcset="./assets/README/name-dark-default.png">
+  <source media="(prefers-color-scheme: light)" srcset="./assets/README/name-light.png">
+  <img alt="Logo and name for the Comment Variables ecosystem." src="./assets/README/name-dark-default.png">
+</picture> -->
+
 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.
 
 ![Intro example of going back and forth between Comment Variables placeholders and actual comments using comment-variables's resolve and compress commands.](./assets/README/example.gif)
@@ -127,6 +135,8 @@ const data = {
         "The flattened config data, with `$COMMENT` placeholders as keys and actual comments as values." /* $COMMENT#JSDOC#PARAMS#FLATTENEDCONFIGDATA */,
       reversedFlattenedConfigData:
         "The reversed flattened config data, with actual comments as keys and `$COMMENT` placeholders as values." /* $COMMENT#JSDOC#PARAMS#REVERSEDFLATTENEDCONFIGDATA */,
+      composedVariablesExclusives:
+        "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 */,
       aliases_flattenedKeys:
         "The dictionary that connects aliases to their original flattened keys in case an encountered placeholder is actually an alias." /* $COMMENT#JSDOC#PARAMS#ALIASES_FLATTENEDKEYS */,
       ruleName:
@@ -145,6 +155,8 @@ const data = {
         '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 */,
       originalFlattenedConfigData:
         "The original flattened config data, before changes to aliases variables and composed variables are applied." /* $COMMENT#JSDOC#PARAMS#ORIGINALFLATTENEDCONFIGDATA */,
+      relativeMjsPath:
+        'The relative path of the generated `.mjs` file to be ignored in the "placeholders" process.' /* $COMMENT#JSDOC#PARAMS#RELATIVEMJSPATH */,
     }),
     returns: Object.freeze({
       exitDueToFailure:
@@ -157,6 +169,8 @@ const data = {
     constants: Object.freeze({
       sortedReversedFlattenedConfigData:
         "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 */,
+      composedVariablesExclusivesSet:
+        "A local Set out of composed variables exclusives for speed." /* $COMMENT#JSDOC#CONSTANTS#COMPOSEDVARIABLESEXCLUSIVESSET */,
     }),
   }),
 };

package/generate.template.js

@@ -32,4 +32,4 @@ const config = {
 
 export default config;
 
-// Once you've grasped these concepts, simply rename this file and its JSON counterpart to `comments.config.js` and `comments.config.json` respectively and you're good to go. (If you're using the extension, make sure to run VS Code's "Developer: Reload Window" command for the extension to operate based on your new `comments.config.js` file.)
+// Once you've grasped these concepts, simply rename this file, its JSON counterpart and its `.mjs` counterpart to `comments.config.js`, `comments.config.json` and `comments.config.mjs` respectively and you're good to go. (If you're using the extension, make sure to run VS Code's "Developer: Reload Window" command for the extension to operate based on your new `comments.config.js` file.)

package/library/index.js

@@ -16,6 +16,10 @@ import resolveConfig, {
   cwd,
   knownIgnores,
   makeResolvedConfigData,
+  makeJsonData,
+  makeMjsData,
+  makeJsonPathLog,
+  makeMjsPathLog,
 } from "comment-variables-resolve-config";
 
 import { hasPackageJson, hasGitFolder } from "./_commons/constants/bases.js";
@@ -187,23 +191,17 @@ if (!makeResolvedConfigDataResults.success) {
 
 const resolvedConfigData = makeResolvedConfigDataResults.resolvedConfigData;
 
-const jsonData = JSON.stringify(resolvedConfigData, null, 2);
+const jsonData = makeJsonData(resolvedConfigData);
 fs.writeFileSync(jsonPath, jsonData, "utf8");
 
-console.log(`JSON resolved config data written to: \n${jsonPath}`);
+console.log(makeJsonPathLog(jsonPath));
 
 // NEW!! comments.config.mjs to directly access resolvedConfigData.
 
-const mjsData = `/** @typedef {${JSON.stringify(
-  resolvedConfigData
-)}} ResolvedConfigData */\n\n/** @type {ResolvedConfigData} */\nexport const resolvedConfigData = ${JSON.stringify(
-  resolvedConfigData,
-  null,
-  2
-)}`;
+const mjsData = makeMjsData(resolvedConfigData);
 fs.writeFileSync(mjsPath, mjsData, "utf8");
 
-console.log(`MJS resolved config data written to: \n${mjsPath}`);
+console.log(makeMjsPathLog(mjsPath));
 
 // ADDRESSES THE CORE COMMANDS "resolve", "compress", AND "placeholders".
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comment-variables",
-  "version": "1.2.3",
+  "version": "1.2.5",
   "description": "A CLI tool for configuring, managing and maintaining JavaScript comments as JavaScript variables.",
   "bin": {
     "comment-variables": "./library/index.js",
@@ -30,7 +30,7 @@
   "type": "module",
   "dependencies": {
     "@eslint/markdown": "^6.5.0",
-    "comment-variables-resolve-config": "^1.14.7",
+    "comment-variables-resolve-config": "^1.14.9",
     "eslint": "^9.29.0"
   },
   "devDependencies": {