comment-variables 0.14.5 → 0.14.7

package/generate.template.js

@@ -1,7 +1,7 @@
 // A Comment Variables config template generated in case no config file has been found. Feel free to use it as a stepping stone to learn how to use Comment Variables.
 
 // As a first step, go ahead and run the command `comment-variables placeholders`.
-// Then rename the `$COMMENT#COMMENT` placeholder next to `alias` to `$COMMENT#ALIAS` and run `comment-variables placeholders` to see what happens.
+// Then rename the `$COMMENT#COMMENT` placeholder next to `alias` to `$COMMENT#ALIAS` and run again `comment-variables placeholders` to see what happens.
 // You can now use and explore Comment Variables on the accompanying `comments.example.js` file that has also been generated.
 
 const data = Object.freeze({
@@ -28,4 +28,4 @@ const config = {
 
 export default config;
 
-// Once you've grasped these concepts, simply copy or rename this file to `comments.config.js` and you're good to go.
+// Once you've grasped these concepts, simply rename this file and its JSON counterpart to `comments.config.js` and `comments.config.json` respectively and you're good to go. (If you're using the extension, make sure to run VS Code's "Developer: Reload Window" command for the extension to operate based on your new `comments.config.js` file.)

package/library/_commons/utilities/flows.js

@@ -38,10 +38,10 @@ const coreCommentsFlow = async (
     fix: true,
     errorOnUnmatchedPattern: false,
     overrideConfigFile: true,
+    ignorePatterns: ignores,
     overrideConfig: [
       {
         files: allJSTSFileGlobs,
-        ignores,
         languageOptions: typeScriptAndJSXCompatible,
         plugins: {
           [commentVariablesPluginName]: {
@@ -59,13 +59,11 @@ const coreCommentsFlow = async (
       },
       {
         files: allMDFileGlobs,
-        ignores,
         plugins: { markdown },
         processor: "markdown/markdown",
       },
       {
         files: allMDVirtualJSTSFileGlobs,
-        ignores,
         languageOptions: typeScriptAndJSXCompatible,
         rules: {
           [`${commentVariablesPluginName}/${ruleName}`]: "warn",

package/library/index.js

@@ -72,6 +72,8 @@ const passedConfigPath =
 // defaults to comments.config.js if no --config flag is set
 let rawConfigPath = passedConfigPath ?? path.join(cwd, defaultConfigFileName);
 
+// HANDLES TUTORIAL MODE
+
 if (!fs.existsSync(rawConfigPath)) {
   console.log(
     `No Comment Variables config file found at ${rawConfigPath}. Switching to tutorial mode.`
@@ -103,6 +105,8 @@ if (!fs.existsSync(rawConfigPath)) {
   rawConfigPath = templateFilePath;
 }
 
+// RESOLVES THE CONFIG
+
 console.log(`Resolving config at ${rawConfigPath}...`);
 
 const resolveConfigResults = await resolveConfig(rawConfigPath);
@@ -141,12 +145,6 @@ skipDetails || console.log("Passed ignores are:", passedIgnores);
 skipDetails || console.log("lintConfigImports is:", lintConfigImports);
 skipDetails || console.log("myIgnoresOnly are:", myIgnoresOnly);
 
-/* IMPORTANT 
-Aside from the config flag, all other flags (`--lint-config-imports`, `--my-ignores-only`) should be included in the config so that they can be shared across the CLI and the extension within a single source of truth, invalidating the need to scream " (And DON'T FORGET YOUR FLAGS!)".
-This didn't come to mind originally because the idea of these flags came into play before I reliably made the VS Code extension.
-The goal therefore becomes that ONLY the config path remains the SOLE available flag for the CLI and config option for the extension that users will have to manage manually across both solutions.
-And then I can start working on the template for Comment Variables to unleash upon asking if no config file is found. comments.template.js */
-
 // ADDRESSES THE --lint-config-imports FLAG (lintConfigImports, no longer a flag), GIVEN THAT THE FILES IMPORTED BY THE CONFIG ARE IGNORED BY DEFAULT.
 
 // const lintConfigImports = commands.indexOf(lintConfigImportsFlag) >= 2; // NOW FROM CONFIG

package/package.json

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