comment-variables 1.1.1 → 1.1.3

package/README.md

@@ -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

@@ -106,6 +106,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/comments.config.json

@@ -155,6 +155,11 @@
         "value": "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.",
         "key": "JSDOC#CONSTANTS#SORTEDREVERSEDFLATTENEDCONFIGDATA",
         "placeholder": "$COMMENT#JSDOC#CONSTANTS#SORTEDREVERSEDFLATTENEDCONFIGDATA"
+      },
+      "composedVariablesExclusivesSet": {
+        "value": "A local Set out of composed variables exclusives for speed.",
+        "key": "JSDOC#CONSTANTS#COMPOSEDVARIABLESEXCLUSIVESSET",
+        "placeholder": "$COMMENT#JSDOC#CONSTANTS#COMPOSEDVARIABLESEXCLUSIVESSET"
       }
     }
   }

package/library/_commons/constants/bases.js

@@ -3,11 +3,6 @@ import path from "path";
 
 import { cwd } from "comment-variables-resolve-config";
 
-// rule names (now inside "comment-variables-resolve-config")
-// export const resolveRuleName = "resolve";
-// export const compressRuleName = "compress";
-// export const placeholdersRuleName = "placeholders"; // rule?
-
 // to prevent accidental changes
 export const hasPackageJson = fs.existsSync(path.join(cwd, "package.json"));
 // to prevent irreversible changes

package/library/_commons/rules/compress.js

@@ -16,7 +16,7 @@ const makeRule = (reversedFlattenedConfigData, composedVariablesExclusives) => {
     reversedFlattenedConfigData
   ).sort(([a], [b]) => b.length - a.length);
 
-  // makes a set out of composed variables exclusives
+  /** A local Set out of composed variables exclusives for speed. */
   const composedVariablesExclusivesSet = new Set(composedVariablesExclusives);
 
   /** @type {import('@typescript-eslint/utils').TSESLint.RuleModule<typeof placeholderMessageId, []>} */
@@ -49,7 +49,6 @@ const makeRule = (reversedFlattenedConfigData, composedVariablesExclusives) => {
           commentKey,
         ] of sortedReversedFlattenedConfigData) {
           // NEW
-          // if (composedVariablesExclusives.some((e) => commentKey === e))
           if (composedVariablesExclusivesSet.has(commentKey)) continue;
 
           const pattern = makeIsolatedStringRegex(resolvedValue);

package/library/_commons/rules/resolve.js

@@ -15,7 +15,7 @@ const makeRule = (
   composedVariablesExclusives,
   aliases_flattenedKeys
 ) => {
-  // makes a set out of composed variables exclusives
+  /** A local Set out of composed variables exclusives for speed. */
   const composedVariablesExclusivesSet = new Set(composedVariablesExclusives);
 
   /** @type {import('@typescript-eslint/utils').TSESLint.RuleModule<typeof placeholderMessageId, []>} */
@@ -58,11 +58,8 @@ const makeRule = (
           const replacement = flattenedConfigData[key];
 
           // NEW
-          // The idea is that only comment variables... Okay.
-          // The issue is that having a pattern is way too powerful, and can lead to unplanned inconsistencies. It is true that doing it instance by instance, comment variable by comment variable, is painstaking. But it's the more secure in order to fix an issue that is essentially purely cosmetic.
-          // Also, focusing exclusively on comment variables and barring aliases (and composed) solves many issues at once and can be checked within resolveConfig. // Done.
-
-          // if (replacement && composedVariablesExclusives.some((e) => key === e))
+          // The issue is that having patterns instead of the exact keys is way too powerful, effectively slow, and can lead to unplanned inconsistencies. It is true that doing it instance by instance, comment variable by comment variable, is painstaking. But it's the more secure in order to fix an issue that is essentially purely cosmetic.
+          // Also, focusing exclusively on comment variables and barring aliases (and composed) solves many issues at once, notably by covering aliases in one go.
           if (replacement && composedVariablesExclusivesSet.has(key)) continue;
 
           if (replacement) {

package/library/_commons/utilities/flows.js

@@ -33,6 +33,7 @@ const coreCommentsFlow = async (
   ruleName,
   ignores,
   flattenedConfigData,
+  // NEW
   composedVariablesExclusives,
   aliases_flattenedKeys
 ) => {
@@ -50,6 +51,7 @@ const coreCommentsFlow = async (
             rules: {
               [ruleName]: ruleNames_makeRules[ruleName](
                 flattenedConfigData,
+                // NEW
                 composedVariablesExclusives,
                 aliases_flattenedKeys
               ),
@@ -115,6 +117,7 @@ const coreCommentsFlow = async (
 export const resolveCommentsFlow = async (
   ignores,
   flattenedConfigData,
+  // NEW
   composedVariablesExclusives,
   aliases_flattenedKeys
 ) =>
@@ -122,6 +125,7 @@ export const resolveCommentsFlow = async (
     resolveRuleName,
     ignores,
     flattenedConfigData,
+    // NEW
     composedVariablesExclusives,
     aliases_flattenedKeys
   );
@@ -138,12 +142,14 @@ export const resolveCommentsFlow = async (
 export const compressCommentsFlow = async (
   ignores,
   reversedFlattenedConfigData,
+  // NEW
   composedVariablesExclusives
 ) =>
   coreCommentsFlow(
     compressRuleName,
     ignores,
     reversedFlattenedConfigData,
+    // NEW
     composedVariablesExclusives
   );
 

package/library/index.js

@@ -198,6 +198,7 @@ switch (coreCommand) {
     await resolveCommentsFlow(
       ignores,
       flattenedConfigData,
+      // NEW
       composedVariablesExclusives,
       aliases_flattenedKeys
     );
@@ -207,6 +208,7 @@ switch (coreCommand) {
     await compressCommentsFlow(
       ignores,
       reversedFlattenedConfigData,
+      // NEW
       composedVariablesExclusives
     );
     break;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comment-variables",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "A CLI tool for configuring, managing and maintaining JavaScript comments as JavaScript variables.",
   "bin": {
     "comment-variables": "./library/index.js",