comment-variables 0.3.1 → 0.4.1

package/README.md

@@ -1 +1,155 @@
-(jscomments in the making)
+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.
+
+```
+npm install -g comment-variables
+```
+
+## Commands
+
+**`comment-variables` comes with three commands in this initial release:**
+
+```
+comment-variables
+```
+
+Interacts with your `comments.config.js` 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 the printed parameters correspond to what you've expected from your defined config.
+
+```
+comment-variables compress
+```
+
+Scans your line and block comments for values defined in your `comments.config.js` (like `"This is a comment"`) to turn them into their corresponding `$COMMENT#*` tokens defined in your `comments.config.js`. (`"This is a comment."` => $COMMENT#COMMENT)
+
+```
+comment-variables resolve
+```
+
+Scans your line and block comments for `$COMMENT#*` tokens (like $COMMENT#COMMENT) to turn them into their corresponding values defined in your `comments.config.js`. ($COMMENT#COMMENT => This is a comment.)
+
+_The `compress` and `resolve` commands are entirely reversible._
+
+## Flags
+
+**The CLI tool also comes with three flags initially:**
+
+```
+comment-variables --config <your-config.js>
+```
+
+Pass a different file as your config instead of the default `comments.config.js` (like `comment-variables --config your-config.js`).
+
+```
+comment-variables --lint-config-imports
+```
+
+By default, `comment-variables` excludes your config file and all the (JavaScript/TypeScript) files it recursively imports. This flag cancels this mechanism, linting config imports. (The config file however still remains excluded from linting.)
+
+```
+comment-variables --my-ignores-only
+```
+
+By default, `comment-variables` includes a preset list of ignored folders ("node_modules", ".next", ".react-router"...). This flag cancels this mechanism so that you can have full control over your ignored files and folders.
+
+_All three flags can be composed together, and with any of the three commands:_
+
+```
+comment-variables --config your-config.js
+comment-variables compress --config your-config.js --lint-config-imports
+comment-variables resolve --config your-config.js --lint-config-imports --my-ignores-only
+```
+
+## **`comments.config.js`**
+
+A `comments.config.js` file looks like this. (This is the config file I'm using to manage my JavaScript comments in this library.)
+
+```js
+const data = {
+  jsDoc: Object.freeze({
+    definitions: Object.freeze({
+      exitDueToFailure:
+        "Terminates the whole process with a 'failure' code (1).", // $COMMENT#JSDOC#DEFINITIONS#EXITDUETOFAILURE
+      escapeRegex:
+        'Escapes all regex characters with a `"\\"` in a string to prepare it for use in a regex.', // $COMMENT#JSDOC#DEFINITIONS#ESCAPEREGEX
+      makeRuleResolve:
+        "The utility that creates the resolve rule based on the flattened config data, used to transform $COMMENT#* placeholders into actual comments.", // $COMMENT#JSDOC#DEFINITIONS#MAKERULERESOLVE
+      makeRuleCompress:
+        "The utility that creates the compress rule based on the reversed flattened config data, used to transform actual comments into $COMMENT#* placeholders.", // $COMMENT#JSDOC#DEFINITIONS#MAKERULECOMPRESS
+      coreCommentsFlow:
+        "The core flow at the heart of resolving and compressing comments.", // $COMMENT#JSDOC#DEFINITIONS#CORECOMMENTSFLOW
+      resolveCommentsFlow:
+        "The flow that resolves $COMMENT#* placeholders intro actual comments.", // $COMMENT#JSDOC#DEFINITIONS#RESOLVECOMMENTSFLOW
+      compressCommentsFlow:
+        "The flow that compresses actual comments into $COMMENT#* placeholders.", // $COMMENT#JSDOC#DEFINITIONS#COMPRESSCOMMENTSFLOW
+      findAllImports:
+        "Finds all import paths recursively related to a given file path.", // $COMMENT#JSDOC#DEFINITIONS#FINDALLIMPORTS
+      processImport: "Processes recursively and resolves a single import path.", // $COMMENT#JSDOC#DEFINITIONS#PROCESSIMPORT
+      flattenConfigData:
+        "Flattens the config's data property into a one-dimensional object of $COMMENT-*-like keys and string values.", // $COMMENT#JSDOC#DEFINITIONS#FLATTENCONFIGDATA
+      resolveConfig:
+        "Verifies, validates and resolves the config path to retrieve the config's data and ignores.", // $COMMENT#JSDOC#DEFINITIONS#RESOLVECONFIG
+    }),
+    params: Object.freeze({
+      string: "The string.", // $COMMENT#JSDOC#PARAMS#STRING
+      flattenedConfigData:
+        "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
+      ruleName:
+        'The name of the rule currently used. (Either `"resolve"` or `"compress"`.)', // $COMMENT#JSDOC#PARAMS#RULENAME
+      ignores:
+        "The array of paths and globs for the flow's ESLint instance to ignore.", // $COMMENT#JSDOC#PARAMS#IGNORES
+      eitherFlattenedConfigData:
+        "Either the flattened config data or the reversed flattened config data, since they share the same structure.", // $COMMENT#JSDOC#PARAMS#EITHERFLATTENEDCONFIGDATA
+      filePath:
+        "The absolute path of the file whose imports are being recursively found, such as that of a project's `comments.config.js` file.", // $COMMENT#JSDOC#PARAMS#FILEPATH
+      cwd: "The current working directory, set as `process.cwd()` by default.", // $COMMENT#JSDOC#PARAMS#CWD
+      visitedSet:
+        "The set of strings tracking the import paths that have already been visited, instantiated as a `new Set()` by default.", // $COMMENT#JSDOC#PARAMS#VISITEDSET
+      depth:
+        "The current depth of the recursion, instantiated at `0` by default.", // $COMMENT#JSDOC#PARAMS#DEPTH
+      maxDepth:
+        "The maximum depth allowed for the recursion, instantiated at `100` by default.", // $COMMENT#JSDOC#PARAMS#MAXDEPTH
+      importPath: "The import path currently being addressed.", // $COMMENT#JSDOC#PARAMS#IMPORTPATH
+      currentDir:
+        "The directory containing the import path currently being addressed.", // $COMMENT#JSDOC#PARAMS#CURRENTDIR
+      configData:
+        "The config's data property. (Values are typed `any` given the limitations in typing recursive values in JSDoc.)", // $COMMENT#JSDOC#PARAMS#CONFIGDATA
+      configDataMap:
+        "The map housing the flattened keys with their values and sources through recursion, instantiated as a `new Map()`.", // $COMMENT#JSDOC#PARAMS#CONFIGDATAMAP
+      parentKeys:
+        "The list of keys that are parent to the key at hand given the recursive nature of the config's data's data structure, instantiated as an empty array of strings.", // $COMMENT#JSDOC#PARAMS#PARENTKEYS
+      configPath:
+        "The path of the config, either from `comments.config.js` or from a config passed via the `--config` flag.", // $COMMENT#JSDOC#PARAMS#CONFIGPATH
+    }),
+    returns: Object.freeze({
+      exitDueToFailure:
+        "Never. (Somehow typing needs to be explicit for unreachable code inference.)", // $COMMENT#JSDOC#RETURNS#EXITDUETOFAILURE
+      escapeRegex: `The string with regex characters escaped.`, // $COMMENT#JSDOC#RETURNS#ESCAPEREGEX
+      makeRuleResolve: "The resolve rule based on the flattened config data.", // $COMMENT#JSDOC#RETURNS#MAKERULERESOLVE
+      makeRuleCompress:
+        "The compress rule based on the reversed flattened config data.", // $COMMENT#JSDOC#RETURNS#MAKERULECOMPRESS
+      findAllImports:
+        "The complete set of strings of import paths recursively related to the given file path, or `null` if an issue has arisen.", // $COMMENT#JSDOC#RETURNS#FINDALLIMPORTS
+      processImport:
+        "`true` to skip unresolved paths, `false` if resolution fails at any level.", // $COMMENT#JSDOC#RETURNS#PROCESSIMPORT
+      flattenConfigData:
+        "Both the flattened config data and its reversed version to ensure the strict reversibility of the `resolve` and `compress` commands.", // $COMMENT#JSDOC#RETURNS#FLATTENCONFIGDATA
+      resolveConfig:
+        "The flattened config data, the reverse flattened config data, the verified config path, the raw passed ignores, and the original config.", // $COMMENT#JSDOC#RETURNS#RESOLVECONFIG
+    }),
+  }),
+};
+
+const ignores = ["README.md"];
+
+const config = {
+  data,
+  ignores,
+};
+
+export default config;
+```
+
+And yes, even comments within JavaScript and TypeScript blocks in Markdown files are addressed.
+
+_Leverage the full power of JavaScript to programmatically design your JavaScript comments._

package/comments.config.js

@@ -16,80 +16,80 @@ const data = {
   jsDoc: Object.freeze({
     definitions: Object.freeze({
       exitDueToFailure:
-        "Terminates the whole process with a 'failure' code (1).",
+        "Terminates the whole process with a 'failure' code (1).", // $COMMENT#JSDOC#DEFINITIONS#EXITDUETOFAILURE
       escapeRegex:
-        'Escapes all regex characters with a `"\\"` in a string to prepare it for use in a regex.',
+        'Escapes all regex characters with a `"\\"` in a string to prepare it for use in a regex.', // $COMMENT#JSDOC#DEFINITIONS#ESCAPEREGEX
       makeRuleResolve:
-        "The utility that creates the resolve rule based on the flattened config data, used to transform $COMMENT#* placeholders into actual comments.",
+        "The utility that creates the resolve rule based on the flattened config data, used to transform $COMMENT#* placeholders into actual comments.", // $COMMENT#JSDOC#DEFINITIONS#MAKERULERESOLVE
       makeRuleCompress:
-        "The utility that creates the compress rule based on the reversed flattened config data, used to transform actual comments into $COMMENT#* placeholders.",
+        "The utility that creates the compress rule based on the reversed flattened config data, used to transform actual comments into $COMMENT#* placeholders.", // $COMMENT#JSDOC#DEFINITIONS#MAKERULECOMPRESS
       coreCommentsFlow:
-        "The core flow at the heart of resolving and compressing comments.",
+        "The core flow at the heart of resolving and compressing comments.", // $COMMENT#JSDOC#DEFINITIONS#CORECOMMENTSFLOW
       resolveCommentsFlow:
-        "The flow that resolves $COMMENT#* placeholders intro actual comments.",
+        "The flow that resolves $COMMENT#* placeholders intro actual comments.", // $COMMENT#JSDOC#DEFINITIONS#RESOLVECOMMENTSFLOW
       compressCommentsFlow:
-        "The flow that compresses actual comments into $COMMENT#* placeholders.",
+        "The flow that compresses actual comments into $COMMENT#* placeholders.", // $COMMENT#JSDOC#DEFINITIONS#COMPRESSCOMMENTSFLOW
       findAllImports:
-        "Finds all import paths recursively related to a given file path.",
-      processImport: "Processes recursively and resolves a single import path.",
+        "Finds all import paths recursively related to a given file path.", // $COMMENT#JSDOC#DEFINITIONS#FINDALLIMPORTS
+      processImport: "Processes recursively and resolves a single import path.", // $COMMENT#JSDOC#DEFINITIONS#PROCESSIMPORT
       flattenConfigData:
-        "Flattens the config's data property into a one-dimensional object of $COMMENT-*-like keys and string values.",
+        "Flattens the config's data property into a one-dimensional object of $COMMENT-*-like keys and string values.", // $COMMENT#JSDOC#DEFINITIONS#FLATTENCONFIGDATA
       resolveConfig:
-        "Verifies, validates and resolves the config path to retrieve the config's data and ignores.",
+        "Verifies, validates and resolves the config path to retrieve the config's data and ignores.", // $COMMENT#JSDOC#DEFINITIONS#RESOLVECONFIG
     }),
     params: Object.freeze({
-      string: "The string.",
+      string: "The string.", // $COMMENT#JSDOC#PARAMS#STRING
       flattenedConfigData:
-        "The flattened config data, with $COMMENT#* placeholders as keys and actual comments as values.",
+        "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.",
+        "The reversed flattened config data, with actual comments as keys and $COMMENT#* placeholders as values.", // $COMMENT#JSDOC#PARAMS#REVERSEDFLATTENEDCONFIGDATA
       ruleName:
-        'The name of the rule currently used. (Either `"resolve"` or `"compress"`.)',
+        'The name of the rule currently used. (Either `"resolve"` or `"compress"`.)', // $COMMENT#JSDOC#PARAMS#RULENAME
       ignores:
-        "The array of paths and globs for the flow's ESLint instance to ignore.",
+        "The array of paths and globs for the flow's ESLint instance to ignore.", // $COMMENT#JSDOC#PARAMS#IGNORES
       eitherFlattenedConfigData:
-        "Either the flattened config data or the reversed flattened config data, since they share the same structure.",
+        "Either the flattened config data or the reversed flattened config data, since they share the same structure.", // $COMMENT#JSDOC#PARAMS#EITHERFLATTENEDCONFIGDATA
       filePath:
-        "The absolute path of the file whose imports are being recursively found, such as that of a project's `comments.config.js` file.",
-      cwd: "The current working directory, set as `process.cwd()` by default.",
+        "The absolute path of the file whose imports are being recursively found, such as that of a project's `comments.config.js` file.", // $COMMENT#JSDOC#PARAMS#FILEPATH
+      cwd: "The current working directory, set as `process.cwd()` by default.", // $COMMENT#JSDOC#PARAMS#CWD
       visitedSet:
-        "The set of strings tracking the import paths that have already been visited, instantiated as a `new Set()` by default.",
+        "The set of strings tracking the import paths that have already been visited, instantiated as a `new Set()` by default.", // $COMMENT#JSDOC#PARAMS#VISITEDSET
       depth:
-        "The current depth of the recursion, instantiated at `0` by default.",
+        "The current depth of the recursion, instantiated at `0` by default.", // $COMMENT#JSDOC#PARAMS#DEPTH
       maxDepth:
-        "The maximum depth allowed for the recursion, instantiated at `100` by default.",
-      importPath: "The import path currently being addressed.",
+        "The maximum depth allowed for the recursion, instantiated at `100` by default.", // $COMMENT#JSDOC#PARAMS#MAXDEPTH
+      importPath: "The import path currently being addressed.", // $COMMENT#JSDOC#PARAMS#IMPORTPATH
       currentDir:
-        "The directory containing the import path currently being addressed.",
+        "The directory containing the import path currently being addressed.", // $COMMENT#JSDOC#PARAMS#CURRENTDIR
       configData:
-        "The config's data property. (Values are typed `any` given the limitations in typing recursive values in JSDoc.)",
+        "The config's data property. (Values are typed `any` given the limitations in typing recursive values in JSDoc.)", // $COMMENT#JSDOC#PARAMS#CONFIGDATA
       configDataMap:
-        "The map housing the flattened keys with their values and sources through recursion, instantiated as a `new Map()`.",
+        "The map housing the flattened keys with their values and sources through recursion, instantiated as a `new Map()`.", // $COMMENT#JSDOC#PARAMS#CONFIGDATAMAP
       parentKeys:
-        "The list of keys that are parent to the key at hand given the recursive nature of the config's data's data structure, instantiated as an empty array of strings.",
+        "The list of keys that are parent to the key at hand given the recursive nature of the config's data's data structure, instantiated as an empty array of strings.", // $COMMENT#JSDOC#PARAMS#PARENTKEYS
       configPath:
-        "The path of the config, either from `comments.config.js` or from a config passed via the `--config` flag.",
+        "The path of the config, either from `comments.config.js` or from a config passed via the `--config` flag.", // $COMMENT#JSDOC#PARAMS#CONFIGPATH
     }),
     returns: Object.freeze({
       exitDueToFailure:
-        "Never. (Somehow typing needs to be explicit for unreachable code inference.)",
-      escapeRegex: `The string with regex characters escaped.`,
-      makeRuleResolve: "The resolve rule based on the flattened config data.",
+        "Never. (Somehow typing needs to be explicit for unreachable code inference.)", // $COMMENT#JSDOC#RETURNS#EXITDUETOFAILURE
+      escapeRegex: `The string with regex characters escaped.`, // $COMMENT#JSDOC#RETURNS#ESCAPEREGEX
+      makeRuleResolve: "The resolve rule based on the flattened config data.", // $COMMENT#JSDOC#RETURNS#MAKERULERESOLVE
       makeRuleCompress:
-        "The compress rule based on the reversed flattened config data.",
+        "The compress rule based on the reversed flattened config data.", // $COMMENT#JSDOC#RETURNS#MAKERULECOMPRESS
       findAllImports:
-        "The complete set of strings of import paths recursively related to the given file path, or `null` if an issue has arisen.",
+        "The complete set of strings of import paths recursively related to the given file path, or `null` if an issue has arisen.", // $COMMENT#JSDOC#RETURNS#FINDALLIMPORTS
       processImport:
-        "`true` to skip unresolved paths, `false` if resolution fails at any level.",
+        "`true` to skip unresolved paths, `false` if resolution fails at any level.", // $COMMENT#JSDOC#RETURNS#PROCESSIMPORT
       flattenConfigData:
-        "Both the flattened config data and its reversed version to ensure the strict reversibility of the `resolve` and `compress` commands.",
+        "Both the flattened config data and its reversed version to ensure the strict reversibility of the `resolve` and `compress` commands.", // $COMMENT#JSDOC#RETURNS#FLATTENCONFIGDATA
       resolveConfig:
-        "The flattened config data, the reverse flattened config data, the verified config path and the raw passed ignores.",
+        "The flattened config data, the reverse flattened config data, the verified config path, the raw passed ignores, and the original config.", // $COMMENT#JSDOC#RETURNS#RESOLVECONFIG
     }),
   }),
 };
 
-const ignores = ["chocolat.js"];
+const ignores = ["README.md"];
 
 const config = {
   data,

package/library/_commons/constants/bases.js

@@ -28,9 +28,9 @@ export const myIgnoresOnlyFlag = "--my-ignores-only";
 
 // ESLint ignores
 export const knownIgnores = [
+  "node_modules",
   ".next",
   ".react-router",
-  "node_modules",
   ".parcel-cache",
   ".react-router-parcel",
   "dist",

package/library/_commons/utilities/resolve-config.js

@@ -8,7 +8,7 @@ import { ConfigDataSchema, ConfigIgnoresSchema } from "../schemas/config.js";
 /**
  * Verifies, validates and resolves the config path to retrieve the config's data and ignores.
  * @param {string} configPath The path of the config, either from `comments.config.js` or from a config passed via the `--config` flag.
- * @returns The flattened config data, the reverse flattened config data, the verified config path and the raw passed ignores.
+ * @returns The flattened config data, the reverse flattened config data, the verified config path, the raw passed ignores, and the original config.
  */
 export async function resolveConfig(configPath) {
   // Step 1: Checks if config file exists
@@ -58,10 +58,10 @@ export async function resolveConfig(configPath) {
   // - the reverse flattened config data,
   // - the verified config path
   // - and the raw passed ignores
-  console.log("Running with config:", config);
   return {
     ...flattenConfigData(configDataResult.data), // finalized
     configPath, // finalized
     passedIgnores: configIgnoresSchemaResult.data, // addressed with --lint-config-imports and --my-ignores-only to be finalized
+    config, // and the config itself too
   };
 }

package/library/index.js

@@ -12,6 +12,8 @@ import {
   lintConfigImportsFlag,
   myIgnoresOnlyFlag,
   knownIgnores,
+  resolveRuleName,
+  compressRuleName,
 } from "./_commons/constants/bases.js";
 
 import { exitDueToFailure } from "./_commons/utilities/helpers.js";
@@ -40,6 +42,10 @@ if (!hasGitFolder) {
 // GATHERS COMMANDS.
 
 const commands = process.argv;
+const coreCommand = commands[2];
+
+const skipDetails =
+  coreCommand === resolveRuleName || coreCommand === compressRuleName;
 
 // OBTAINS THE VALIDATED FLATTENED CONFIG, REVERSE FLATTENED CONFIG, CONFIG PATH, AND PASSED IGNORES.
 
@@ -61,16 +67,19 @@ if (!results) {
 }
 
 const {
+  config,
   flattenedConfigData,
   reversedFlattenedConfigData,
   configPath,
   passedIgnores,
 } = results;
 
-console.log("Flattened config is:", flattenedConfigData);
-console.log("Reversed flattened config is:", reversedFlattenedConfigData);
-console.log("Config path is:", configPath);
-console.log("Passed ignores are:", passedIgnores);
+skipDetails || console.log("Running with config:", config);
+skipDetails || console.log("Flattened config is:", flattenedConfigData);
+skipDetails ||
+  console.log("Reversed flattened config is:", reversedFlattenedConfigData);
+skipDetails || console.log("Config path is:", configPath);
+skipDetails || console.log("Passed ignores are:", passedIgnores);
 
 // ADDRESSES THE --lint-config-imports FLAG, GIVEN THAT THE FILES IMPORTED BY THE CONFIG ARE IGNORED BY DEFAULT.
 
@@ -84,10 +93,11 @@ const configPathIgnores = rawConfigPathIgnores.map((e) =>
   path.relative(cwd, e)
 );
 
-console.log(
-  lintConfigImports ? "Config path ignore is:" : "Config path ignores are:",
-  configPathIgnores
-);
+skipDetails ||
+  console.log(
+    lintConfigImports ? "Config path ignore is:" : "Config path ignores are:",
+    configPathIgnores
+  );
 
 // ADDRESSES THE --my-ignores-only FLAG, GIVEN THAT KNOWN IGNORES ARE IGNORED BY DEFAULT
 
@@ -95,17 +105,17 @@ const myIgnoresOnly = commands.indexOf(myIgnoresOnlyFlag) >= 2;
 const rawIgnores = [...configPathIgnores, ...passedIgnores];
 const ignores = myIgnoresOnly ? rawIgnores : [...rawIgnores, ...knownIgnores];
 
-console.log("Ignores are:", ignores);
+skipDetails || console.log("Ignores are:", ignores);
 
 // ADDRESSES THE CORE COMMANDS "resolve" AND "compress".
 
-const coreCommand = commands[2];
-
 switch (coreCommand) {
-  case "resolve":
+  case resolveRuleName:
+    console.log(`Running ${resolveRuleName}...`);
     await resolveCommentsFlow(ignores, flattenedConfigData);
     break;
-  case "compress":
+  case compressRuleName:
+    console.log(`Running ${compressRuleName}...`);
     await compressCommentsFlow(ignores, reversedFlattenedConfigData);
     break;
   default:

package/package.json

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