comment-variables 0.12.4 → 0.14.1

package/README.md

@@ -44,26 +44,27 @@ Creates Comment Variables placeholders right next to the single sources of truth
 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`).
+Passes a different file as your config instead of the default `comments.config.js` (like `comment-variables --config your-config.js`), through a path relative to the root of your project.
 
 ```
-comment-variables --lint-config-imports
+--lint-config-imports now part of the config at the `lintConfigImports` key
 ```
 
 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
+--my-ignores-only now part of the config at the `myIgnoresOnly` key
 ```
 
 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:_
+_The --config flag can be composed with any of the 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
+comment-variables compress --config your-config.js
+comment-variables resolve --config your-config.js
+comment-variables placeholders --config your-config.js
 ```
 
 ## **`comments.config.js`**
@@ -128,9 +129,14 @@ const data = {
 
 const ignores = ["README.md"];
 
+const lintConfigImports = false; // can be ommitted
+const myIgnoresOnly = false; // can be ommitted
+
 const config = {
   data,
   ignores,
+  lintConfigImports,
+  myIgnoresOnly,
 };
 
 export default config;

package/comments.config.js

@@ -106,9 +106,16 @@ const data = {
 
 const ignores = ["README.md"];
 
+// FORMER CLI FLAGS NOW TO BE INCLUDED INSIDE THE CONFIG ITSELF
+
+const lintConfigImports = false; // can be ommitted
+const myIgnoresOnly = false; // can be ommitted
+
 const config = {
   data,
   ignores,
+  lintConfigImports,
+  myIgnoresOnly,
 };
 
 export default config;

package/library/_commons/constants/bases.js

@@ -1,14 +1,13 @@
 import fs from "fs";
 import path from "path";
 
+import { cwd } from "comment-variables-resolve-config";
+
 // rule names
 export const resolveRuleName = "resolve";
 export const compressRuleName = "compress";
 export const placeholdersRuleName = "placeholders"; // rule?
 
-// current working directory
-export const cwd = process.cwd();
-
 // to prevent accidental changes
 export const hasPackageJson = fs.existsSync(path.join(cwd, "package.json"));
 // to prevent irreversible changes

package/library/index.js

@@ -3,18 +3,19 @@
 
 import path from "path";
 import fs from "fs";
+import url from "url";
 
 import resolveConfig, {
   defaultConfigFileName,
+  templateFileName,
+  exampleFileName,
   configFlag,
-  lintConfigImportsFlag,
-  myIgnoresOnlyFlag,
+  cwd,
   knownIgnores,
   makeResolvedConfigData,
 } from "comment-variables-resolve-config";
 
 import {
-  cwd,
   hasPackageJson,
   hasGitFolder,
   resolveRuleName,
@@ -29,6 +30,16 @@ import {
   placeholdersCommentsFlow,
 } from "./_commons/utilities/flows.js";
 
+// GATHERS COMMANDS.
+
+const commands = process.argv;
+const coreCommand = commands[2];
+
+const skipDetails =
+  coreCommand === resolveRuleName ||
+  coreCommand === compressRuleName ||
+  coreCommand === placeholdersRuleName;
+
 // ENSURES THE CLI TOOL ONLY RUNS IN FOLDERS THAT POSSESS A package.json FILE AND A .git FOLDER.
 
 if (!hasPackageJson) {
@@ -37,22 +48,15 @@ if (!hasPackageJson) {
   );
   exitDueToFailure();
 }
+skipDetails || console.log("package.json file noticed. Allowed to proceed.");
+
 if (!hasGitFolder) {
   console.error(
     "ERROR. No git folder found in this directory. Aborting to prevent irreversible changes."
   );
   exitDueToFailure();
 }
-
-// GATHERS COMMANDS.
-
-const commands = process.argv;
-const coreCommand = commands[2];
-
-const skipDetails =
-  coreCommand === resolveRuleName ||
-  coreCommand === compressRuleName ||
-  coreCommand === placeholdersRuleName;
+skipDetails || console.log("git folder noticed. Allowed to proceed.");
 
 // OBTAINS THE VALIDATED FLATTENED CONFIG, REVERSE FLATTENED CONFIG, CONFIG PATH, AND PASSED IGNORES.
 
@@ -66,7 +70,38 @@ const passedConfig = commands[configFlagIndex + 1];
 const passedConfigPath =
   hasConfigFlag && passedConfig ? path.join(cwd, passedConfig) : null;
 // defaults to comments.config.js if no --config flag is set
-const rawConfigPath = passedConfigPath ?? path.join(cwd, defaultConfigFileName);
+let rawConfigPath = passedConfigPath ?? path.join(cwd, defaultConfigFileName);
+
+if (!fs.existsSync(rawConfigPath)) {
+  console.log(
+    `No Comment Variables config file found at ${rawConfigPath}. Switching to tutorial mode.`
+  );
+
+  const templateFilePath = path.join(cwd, templateFileName);
+  const exampleFilePath = path.join(cwd, exampleFileName);
+  const dirname = path.dirname(url.fileURLToPath(import.meta.url));
+
+  if (fs.existsSync(templateFilePath)) {
+    console.log(`Proceeding with template file found at ${templateFilePath}.`);
+  } else {
+    const sourceTemplateFilePath = path.join(
+      dirname,
+      "../generate.template.js"
+    );
+    console.log(`Generating template file at ${templateFilePath}.`);
+    fs.copyFileSync(sourceTemplateFilePath, templateFilePath);
+  }
+
+  if (fs.existsSync(exampleFilePath)) {
+    console.log(`Proceeding with example file found at ${exampleFilePath}.`);
+  } else {
+    const sourceExampleFilePath = path.join(dirname, "../generate.example.js");
+    console.log(`Generating example file at ${exampleFilePath}.`);
+    fs.copyFileSync(sourceExampleFilePath, exampleFilePath);
+  }
+
+  rawConfigPath = templateFilePath;
+}
 
 console.log(`Resolving config at ${rawConfigPath}...`);
 
@@ -87,6 +122,9 @@ const {
   configPath,
   passedIgnores,
   rawConfigAndImportPaths,
+  // NEW
+  lintConfigImports,
+  myIgnoresOnly,
 } = resolveConfigResults;
 
 skipDetails || console.log("Running with config:", config);
@@ -99,10 +137,19 @@ skipDetails ||
 skipDetails || console.log("Aliases are:", aliases_flattenedKeys);
 skipDetails || console.log("Config path is:", configPath);
 skipDetails || console.log("Passed ignores are:", passedIgnores);
+// NEW
+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, GIVEN THAT THE FILES IMPORTED BY THE CONFIG ARE IGNORED BY DEFAULT.
+// 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;
+// const lintConfigImports = commands.indexOf(lintConfigImportsFlag) >= 2; // NOW FROM CONFIG
 const rawConfigPathIgnores = lintConfigImports
   ? [configPath]
   : rawConfigAndImportPaths;
@@ -118,9 +165,9 @@ skipDetails ||
     configPathIgnores
   );
 
-// ADDRESSES THE --my-ignores-only FLAG, GIVEN THAT KNOWN IGNORES ARE IGNORED BY DEFAULT
+// ADDRESSES THE --my-ignores-only FLAG (myIgnoresOnly, no longer a flag, GIVEN THAT KNOWN IGNORES ARE IGNORED BY DEFAULT
 
-const myIgnoresOnly = commands.indexOf(myIgnoresOnlyFlag) >= 2;
+// const myIgnoresOnly = commands.indexOf(myIgnoresOnlyFlag) >= 2; // NOW FROM CONFIG
 const rawIgnores = [...configPathIgnores, ...passedIgnores];
 const ignores = myIgnoresOnly ? rawIgnores : [...rawIgnores, ...knownIgnores];
 
@@ -176,9 +223,7 @@ switch (coreCommand) {
     else
       console.log(
         `If these settings are correct with you, feel free to initiate the command "${resolveRuleName}" to resolve comments, or "${compressRuleName}" to compress them back to their $COMMENT forms. You can also generate the placeholders at their definitions locations with the command "${placeholdersRuleName}".${
-          passedConfigPath || lintConfigImports || myIgnoresOnly
-            ? " (And DON'T FORGET YOUR FLAGS!)"
-            : ""
+          passedConfigPath ? " (And DON'T FORGET YOUR --config FLAG!)" : ""
         }`
       );
     break;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comment-variables",
-  "version": "0.12.4",
+  "version": "0.14.1",
   "description": "A CLI tool for configuring, managing and maintaining JavaScript comments as JavaScript variables.",
   "bin": {
     "jscomments": "./library/index.js",
@@ -10,7 +10,9 @@
   "files": [
     "library",
     "comments.config.js",
-    "comments.config.json"
+    "comments.config.json",
+    "comments.template.js",
+    "comments.example.js"
   ],
   "repository": {
     "type": "git",
@@ -27,7 +29,7 @@
   "type": "module",
   "dependencies": {
     "@eslint/markdown": "^6.5.0",
-    "comment-variables-resolve-config": "^1.11.0",
+    "comment-variables-resolve-config": "^1.12.3",
     "eslint": "^9.29.0"
   },
   "devDependencies": {