comment-variables 0.13.0 → 0.14.1

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,16 +3,19 @@
 
 import path from "path";
 import fs from "fs";
+import url from "url";
 
 import resolveConfig, {
   defaultConfigFileName,
+  templateFileName,
+  exampleFileName,
   configFlag,
+  cwd,
   knownIgnores,
   makeResolvedConfigData,
 } from "comment-variables-resolve-config";
 
 import {
-  cwd,
   hasPackageJson,
   hasGitFolder,
   resolveRuleName,
@@ -67,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}...`);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comment-variables",
-  "version": "0.13.0",
+  "version": "0.14.1",
   "description": "A CLI tool for configuring, managing and maintaining JavaScript comments as JavaScript variables.",
   "bin": {
     "jscomments": "./library/index.js",
@@ -29,7 +29,7 @@
   "type": "module",
   "dependencies": {
     "@eslint/markdown": "^6.5.0",
-    "comment-variables-resolve-config": "^1.12.0",
+    "comment-variables-resolve-config": "^1.12.3",
     "eslint": "^9.29.0"
   },
   "devDependencies": {

package/comments.example.js

@@ -1 +0,0 @@
-// A JavaScript file that acts as an example file for the generated Comment Variables template config. Use the `comment-variables compress` and `comment-variables resolve` commands to see how the following comments go back and forth from Comment Variables placeholders to actual comments reversibly.

package/comments.template.js

@@ -1 +0,0 @@
-// A Comment Variables config template generated upon approval in case no config file has been found. Feel free to use it as a steping stone to learn how to use Comment Variables.