comment-variables 1.1.2 → 1.2.1

package/README.md

@@ -18,7 +18,7 @@ npm install -g comment-variables
 comment-variables
 ```
 
-Interacts with your root `comments.config.js` file's default exported object to print all the parameters you need to be aware of before running `compress` or `resolve`. Also acts as a dry run validation check. If no error is printed, it means you can run `compress` or `resolve` safely, as long as the printed parameters correspond to what you've expected from your defined config. (Additionally creates a resolved version of your config data as a JSON file. If no configuration file is found, a tutorial mode is triggered, generating a template config file for you.)
+Interacts with your root `comments.config.js` file's default exported object to print all the parameters you need to be aware of before running `compress` or `resolve`. Also acts as a dry run validation check. If no error is printed, it means you can run `compress` or `resolve` safely, as long as the printed parameters correspond to what you've expected from your defined config. (Additionally creates a resolved version of your config data as a JSON file, and as a .mjs file exporting both the typedef `ResolvedConfigData` and the object `resolvedConfigData`. If no configuration file is found, a tutorial mode is triggered, generating a template config file for you.)
 
 ```
 comment-variables placeholders
@@ -183,4 +183,4 @@ And yes, even comments within JavaScript and TypeScript blocks in Markdown files
 
 _Leverage the power of JavaScript to programmatically design your JavaScript comments._
 
-**The Comment Variables VS Code extension is available [here](https://comvar.lemonsqueezy.com/buy/8cccf252-283f-4e50-856f-1a09fe93837a?logo=0&discount=0).**
+**The Comment Variables VS Code extension is available [here](https://comvar.lemonsqueezy.com/buy/723b0220-ea5d-4b0a-835a-f0843e431639?logo=0&discount=0).**

package/comments.config.js

@@ -47,6 +47,15 @@ const data = {
       // value: "value not allowed", // errors, "key", "value" and "placeholder" not allowed
       // placeholder: "placeholder not allowed", // errors, "key", "value" and "placeholder" not allowed
       // noConcat: "no" + "concat", // errors, unrecognized value
+
+      // already error via regex, but now enhanced:
+      // "//": "key comment error 1",
+      // "/*": "key comment error 2",
+      // "*/": "key comment error 3",
+      // error directly in resolveConfig:
+      // "key comment error 1": "//",
+      // "key comment error 2": "/*",
+      // "key comment error 3": "*/",
     },
   },
   // for deving

package/library/index.js

@@ -149,9 +149,13 @@ skipDetails ||
 
 // ADDRESSES THE --lint-config-imports FLAG (lintConfigImports, no longer a flag), GIVEN THAT THE FILES IMPORTED BY THE CONFIG ARE IGNORED BY DEFAULT.
 
+// instantiate the JSON and .mjs path proactively
+const jsonPath = configPath.replace(/\.js$/, () => ".json");
+const mjsPath = configPath.replace(/\.js$/, () => ".mjs");
+
 const rawConfigPathIgnores = lintConfigImports
-  ? [configPath]
-  : rawConfigAndImportPaths;
+  ? [configPath, mjsPath]
+  : [...rawConfigAndImportPaths, mjsPath];
 
 // the ignore paths must be relative
 const configPathIgnores = rawConfigPathIgnores.map((e) =>
@@ -181,15 +185,23 @@ if (!makeResolvedConfigDataResults.success) {
 }
 
 const resolvedConfigData = makeResolvedConfigDataResults.resolvedConfigData;
-const jsonPath = resolveConfigResults.configPath.replace(
-  /\.js$/,
-  () => ".json"
-);
+
 const jsonData = JSON.stringify(resolvedConfigData, null, 2);
 fs.writeFileSync(jsonPath, jsonData, "utf8");
 
 console.log(`JSON resolved config data written to: \n${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
+)}`;
+fs.writeFileSync(mjsPath, mjsData, "utf8");
+
 // ADDRESSES THE CORE COMMANDS "resolve", "compress", AND "placeholders".
 
 switch (coreCommand) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comment-variables",
-  "version": "1.1.2",
+  "version": "1.2.1",
   "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.1",
+    "comment-variables-resolve-config": "^1.14.4",
     "eslint": "^9.29.0"
   },
   "devDependencies": {