comment-variables 1.1.0 → 1.1.1

package/README.md

@@ -12,7 +12,7 @@ npm install -g comment-variables
 
 ## Commands
 
-**`comment-variables` (aliases `jscomments`/`comvar`) comes with three commands in this initial release:**
+**`comment-variables` (aliases `jscomments`/`comvar`) comes with four commands in this initial release:**
 
 ```
 comment-variables
@@ -20,6 +20,12 @@ 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.)
 
+```
+comment-variables placeholders
+```
+
+Creates Comment Variables placeholders right next to the single sources of truth where Comment Variables are defined. (See in config example below.)
+
 ```
 comment-variables compress
 ```
@@ -34,45 +40,63 @@ Scans your line and block comments for `$COMMENT#*` placeholders (like `$COMMENT
 
 _The `compress` and `resolve` commands make each other entirely reversible._
 
-**New command: `comment-variables placeholders`**
+## Flags
+
+**The CLI tool comes with a single flag:**
 
 ```
-comment-variables placeholders
+comment-variables --config <your-config.js>
 ```
 
-Creates Comment Variables placeholders right next to the single sources of truth where Comment Variables are defined. (See in config example below.)
+Passes a different file as your config file instead of the default root `comments.config.js` file (like `comment-variables --config your-config.js`), through a path relative to the root of your project.
 
-## Flags
+_The --config flag can be composed with any of the commands:_
+
+```
+comment-variables --config your-config.js
+comment-variables compress --config your-config.js
+comment-variables resolve --config your-config.js
+comment-variables placeholders --config your-config.js
+```
 
-**The CLI tool also comes with three flags initially:**
+## Settings
+
+**The config object requires the following settings:**
 
 ```
-comment-variables --config <your-config.js>
+data:
 ```
 
-Passes a different file as your config file instead of the default root `comments.config.js` file (like `comment-variables --config your-config.js`), through a path relative to the root of your project.
+Your dedicated object defining your Comment Variables through nested key-value pairs of string literals.
 
 ```
---lint-config-imports is now part of the config at the `lintConfigImports` key
+ignores:
 ```
 
-By default, `comment-variables` excludes your config file and all the (JavaScript/TypeScript) files it recursively imports. This config option cancels this mechanism, linting config imports. (The config file however still remains excluded from linting.)
+Your dedicated array defining your files and folders to be ignored by the `compress` and `resolve` commands through strings of paths relative to the root of your project.
+
+## Options
+
+**The config object supports the following options:**
 
 ```
---my-ignores-only is now part of the config at the `myIgnoresOnly` key
+lintConfigImports:
 ```
 
-By default, `comment-variables` includes a preset list of ignored folders (`"node_modules"`, `".next"`, `".react-router"`...). This config option cancels this mechanism so that you can have full control over your ignored files and folders.
+By default, `comment-variables` excludes your config file and all the (JavaScript/TypeScript) files it recursively imports. Passing `true` to this config option cancels this mechanism, linting config imports. (The config file however still remains excluded from linting.)
 
-_The --config flag can be composed with any of the commands:_
+```
+myIgnoresOnly:
+```
+
+By default, `comment-variables` includes a preset list of ignored folders (`"node_modules"`, `".next"`, `".react-router"`...). Passing `true` to this config option cancels this mechanism so that you can have full control over your ignored files and folders.
 
 ```
-comment-variables --config your-config.js
-comment-variables compress --config your-config.js
-comment-variables resolve --config your-config.js
-comment-variables placeholders --config your-config.js
+composedVariablesExclusives:
 ```
 
+In due time, you may end up creating Comment Variables that are exclusively meant to be used to create other Comment Variables – the latter classified as composed variables. Passing an array to this config option, comprised of the keys of these original comment variables (for example, if a Comment Variable placeholder is `$COMMENT#COMMENT` its related key is `COMMENT`), prevents these original comment variables from being affected by the `compress` and `resolve` commands.
+
 ## **`comments.config.js`**
 
 A root `comments.config.js` file looks like this. (This is the config file I'm using to manage my JavaScript comments in this library.)
@@ -142,11 +166,14 @@ const ignores = ["README.md", "generate.template.js", "generate.example.js"];
 const lintConfigImports = false; // can be omitted
 const myIgnoresOnly = false; // can be omitted
 
+const composedVariablesExclusives = []; // can be omitted
+
 const config = {
   data,
   ignores,
   lintConfigImports,
   myIgnoresOnly,
+  composedVariablesExclusives,
 };
 
 export default config;

package/comments.config.js

@@ -115,7 +115,6 @@ const ignores = ["README.md", "generate.template.js", "generate.example.js"];
 const lintConfigImports = false; // can be omitted
 const myIgnoresOnly = false; // can be omitted
 
-// NEW
 const composedVariablesExclusives = []; // can be omitted
 
 const config = {

package/generate.template.js

@@ -20,7 +20,6 @@ const ignores = [];
 const lintConfigImports = false; // can be omitted
 const myIgnoresOnly = false; // can be omitted
 
-// NEW
 const composedVariablesExclusives = []; // can be omitted
 
 const config = {

package/library/index.js

@@ -142,7 +142,10 @@ skipDetails || console.log("lintConfigImports is:", lintConfigImports);
 skipDetails || console.log("myIgnoresOnly are:", myIgnoresOnly);
 // NEW
 skipDetails ||
-  console.log("composedVariablesExclusives are:", composedVariablesExclusives);
+  console.log(
+    "Composed variables exclusives are:",
+    composedVariablesExclusives
+  );
 
 // ADDRESSES THE --lint-config-imports FLAG (lintConfigImports, no longer a flag), GIVEN THAT THE FILES IMPORTED BY THE CONFIG ARE IGNORED BY DEFAULT.
 

package/package.json

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