comment-variables 0.15.4 → 0.15.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/comments.config.js +3 -3
- package/generate.template.js +5 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -133,10 +133,10 @@ const data = {
|
|
|
133
133
|
}),
|
|
134
134
|
};
|
|
135
135
|
|
|
136
|
-
const ignores = ["README.md"];
|
|
136
|
+
const ignores = ["README.md", "generate.template.js", "generate.example.js"];
|
|
137
137
|
|
|
138
|
-
const lintConfigImports = false; // can be
|
|
139
|
-
const myIgnoresOnly = false; // can be
|
|
138
|
+
const lintConfigImports = false; // can be omitted
|
|
139
|
+
const myIgnoresOnly = false; // can be omitted
|
|
140
140
|
|
|
141
141
|
const config = {
|
|
142
142
|
data,
|
package/comments.config.js
CHANGED
|
@@ -104,12 +104,12 @@ const data = {
|
|
|
104
104
|
}),
|
|
105
105
|
};
|
|
106
106
|
|
|
107
|
-
const ignores = ["README.md"];
|
|
107
|
+
const ignores = ["README.md", "generate.template.js", "generate.example.js"];
|
|
108
108
|
|
|
109
109
|
// FORMER CLI FLAGS NOW TO BE INCLUDED INSIDE THE CONFIG ITSELF
|
|
110
110
|
|
|
111
|
-
const lintConfigImports = false; // can be
|
|
112
|
-
const myIgnoresOnly = false; // can be
|
|
111
|
+
const lintConfigImports = false; // can be omitted
|
|
112
|
+
const myIgnoresOnly = false; // can be omitted
|
|
113
113
|
|
|
114
114
|
const config = {
|
|
115
115
|
data,
|
package/generate.template.js
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
// 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.
|
|
2
2
|
|
|
3
|
-
// As a first step, go ahead and run the command `comment-variables placeholders`.
|
|
4
|
-
// Then rename the `$COMMENT#COMMENT` placeholder next to `alias` to `$COMMENT#ALIAS
|
|
3
|
+
// As a first step, go ahead and run the command `comment-variables placeholders`. (This generates the Comment Variables placeholders right next to where their values are defined.)
|
|
4
|
+
// Then rename the `$COMMENT#COMMENT` placeholder next to the `alias` key's value in the `data` object to `$COMMENT#ALIAS`, and run again `comment-variables placeholders` to see what happens. (...Which is nothing, and I let you figure out why.)
|
|
5
|
+
|
|
5
6
|
// You can now use and explore Comment Variables on the accompanying `comments.example.js` file that has also been generated.
|
|
6
7
|
|
|
7
8
|
const data = Object.freeze({
|
|
@@ -16,8 +17,8 @@ const data = Object.freeze({
|
|
|
16
17
|
|
|
17
18
|
const ignores = [];
|
|
18
19
|
|
|
19
|
-
const lintConfigImports = false; // can be
|
|
20
|
-
const myIgnoresOnly = false; // can be
|
|
20
|
+
const lintConfigImports = false; // can be omitted
|
|
21
|
+
const myIgnoresOnly = false; // can be omitted
|
|
21
22
|
|
|
22
23
|
const config = {
|
|
23
24
|
data,
|
package/package.json
CHANGED