comment-variables 0.3.0 → 0.3.1

package/comments.config.js

@@ -3,18 +3,13 @@ const data = {
   levelOne: {
     levelTwo: {
       levelThree: "Level three.",
-      // levelthree: "Also level three.", // errors
-      // alsoLevelThree: "Level three.", // errors
-      levelThreeBis: "Level three bis.",
-      levelThreeTer: "Level three ter.",
-      levelThreeAlso: "Also level three here.",
-      levelThreeToo: "This too is level three.",
-      // test: "LEVELONE#LEVELTWO#LEVELTHREE", // errors
-      // [`level$Three#First
-      //   whitespace`]: `This is level three
-      // with whitespaces. `, // fails
-      // testing: 2, // fails
-      // ".'e": "",
+      // levelthree: "Also level three.", // errors, duplicate normalized key
+      // stillLevelThree: "LEVELONE#LEVELTWO#LEVELTHREE", // errors, value is also a normalized key
+      // alsoLevelThree: "Level three.", // errors, duplicate value
+      // tooLevelThree: 2, // errors, value is invalid
+      // $levelThree: "Dollar sign", // errors, key as "$" character
+      // "#levelThree": "Hashtag", // errors, key as "#" character
+      // ".levelThree": "Punctuation", // errors, key is invalid
     },
   },
   // for deving
@@ -22,7 +17,8 @@ const data = {
     definitions: Object.freeze({
       exitDueToFailure:
         "Terminates the whole process with a 'failure' code (1).",
-      escapeRegex: `Escapes all regex characters with a \`"\\"\` in a string to prepare it for use in a regex.`,
+      escapeRegex:
+        'Escapes all regex characters with a `"\\"` in a string to prepare it for use in a regex.',
       makeRuleResolve:
         "The utility that creates the resolve rule based on the flattened config data, used to transform $COMMENT#* placeholders into actual comments.",
       makeRuleCompress:

package/library/_commons/utilities/flows.js

@@ -64,7 +64,7 @@ const coreCommentsFlow = async (ruleName, ignores, flattenedConfigData) => {
   ]);
   await ESLint.outputFixes(results);
 
-  console.log({ results });
+  console.log("Results are:", results);
 
   const resolvedOrCompressed =
     ruleName === resolveRuleName

package/library/index.js

@@ -17,13 +17,12 @@ import {
 import { exitDueToFailure } from "./_commons/utilities/helpers.js";
 import { resolveConfig } from "./_commons/utilities/resolve-config.js";
 import { findAllImports } from "./_commons/utilities/find-all-imports.js";
-
 import {
   resolveCommentsFlow,
   compressCommentsFlow,
 } from "./_commons/utilities/flows.js";
 
-// ENSURES THE CLI TOOL ONLY RUN IN FOLDERS THAT POSSESS A package.json FILE AND A .git FOLDER.
+// ENSURES THE CLI TOOL ONLY RUNS IN FOLDERS THAT POSSESS A package.json FILE AND A .git FOLDER.
 
 if (!hasPackageJson) {
   console.error(
@@ -42,7 +41,7 @@ if (!hasGitFolder) {
 
 const commands = process.argv;
 
-// OBTAINS THE VALIDATED FLATTENED CONFIG, REVERSE FLATTENED CONFIG, AND CONFIG PATH.
+// OBTAINS THE VALIDATED FLATTENED CONFIG, REVERSE FLATTENED CONFIG, CONFIG PATH, AND PASSED IGNORES.
 
 // extracts the position of the --config flag
 const configFlagIndex = commands.indexOf(configFlag);
@@ -109,7 +108,6 @@ switch (coreCommand) {
   case "compress":
     await compressCommentsFlow(ignores, reversedFlattenedConfigData);
     break;
-  case undefined: // falls through the default
   default:
     if (coreCommand && !coreCommand.startsWith("--"))
       console.error(

package/package.json

@@ -1,19 +1,20 @@
 {
   "name": "comment-variables",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "A CLI tool for configuring, managing and maintaining JavaScript comments as JavaScript variables.",
   "bin": {
     "jscomments": "./library/index.js",
     "comment-variables": "./library/index.js"
   },
   "main": "library/index.js",
+  "files": [
+    "library",
+    "comments.config.js"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/LutherTS/jscomments.git"
   },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
   "keywords": [
     "cli",
     "javascript",