comment-variables 0.14.1 → 0.14.3

package/generate.example.js

@@ -0,0 +1,7 @@
+// A JavaScript file that acts as an example file for the generated Comment Variables template config. Assuming you've yet to produce your own `comments.config.js` file, use the `comment-variables compress` and `comment-variables resolve` commands to see how the following comments go back and forth from Comment Variables placeholders (`$COMMENT`) to actual comments, reversibly.
+
+// This is a comment.
+// $COMMENT#ALIAS
+// Yes.
+// This is a comment. Yes. This is a comment.
+// $COMMENT#COMMENTS#NO

package/generate.template.js

@@ -0,0 +1,31 @@
+// 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.
+// You can now use and explore Comment Variables on the accompanying `comments.example.js` file that has also been generated.
+
+const data = Object.freeze({
+  comment: "This is a comment.",
+  alias: "COMMENT",
+  composed: "$COMMENT#COMMENT $COMMENT#COMMENTS#YES $COMMENT#ALIAS",
+  comments: Object.freeze({
+    yes: "Yes.",
+    no: "No.",
+  }),
+});
+
+const ignores = [];
+
+const lintConfigImports = false; // can be ommitted
+const myIgnoresOnly = false; // can be ommitted
+
+const config = {
+  data,
+  ignores,
+  lintConfigImports,
+  myIgnoresOnly,
+};
+
+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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comment-variables",
-  "version": "0.14.1",
+  "version": "0.14.3",
   "description": "A CLI tool for configuring, managing and maintaining JavaScript comments as JavaScript variables.",
   "bin": {
     "jscomments": "./library/index.js",
@@ -11,8 +11,8 @@
     "library",
     "comments.config.js",
     "comments.config.json",
-    "comments.template.js",
-    "comments.example.js"
+    "generate.template.js",
+    "generate.example.js"
   ],
   "repository": {
     "type": "git",