comment-variables 1.2.2 → 1.2.4

package/comments.config.js

@@ -45,7 +45,7 @@ const data = {
       // ownAliasKey: "LEVELONE#LEVELTWO#OWNALIASKEY", // errors, is its own key/alias
       // key: "key not allowed", // errors, "key", "value" and "placeholder" not allowed
       // value: "value not allowed", // errors, "key", "value" and "placeholder" not allowed
-      // placeholder: "placeholder not allowed", // errors, "key", "value" and "placeholder" not allowed
+      placeholder: "placeholder now allowed", // doesn't error, "placeholder" is now allowed
       // noConcat: "no" + "concat", // errors, unrecognized value
 
       // already error via regex, but now enhanced:

package/comments.config.json

@@ -20,6 +20,10 @@
       "composedVariableAlias": {
         "value": "Level three. Level three.",
         "key": "LEVELONE#LEVELTWO#COMPOSEDVARIABLEALIAS"
+      },
+      "placeholder": {
+        "value": "placeholder now allowed",
+        "key": "LEVELONE#LEVELTWO#PLACEHOLDER"
       }
     }
   },

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.2",
+  "version": "1.2.4",
   "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.6",
+    "comment-variables-resolve-config": "^1.14.9",
     "eslint": "^9.29.0"
   },
   "devDependencies": {