comment-variables 0.15.1 → 0.15.3
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 +7 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
# comment-variables
|
|
2
|
+
|
|
1
3
|
A CLI tool for configuring, managing and maintaining JavaScript comments as JavaScript variables, via a `comments.config.js` file at the root of your project.
|
|
2
4
|
|
|
3
5
|
|
|
@@ -16,19 +18,19 @@ npm install -g comment-variables
|
|
|
16
18
|
comment-variables
|
|
17
19
|
```
|
|
18
20
|
|
|
19
|
-
Interacts with your `comments.config.js` default exported object to print all the parameters you need to be aware of before running `compress` or `resolve`. Also acts as a dry run validation check. If no error is printed, it means you can run `compress` or `resolve` safely, as long the printed parameters correspond to what you've expected from your defined config. (Additionally creates a resolved version of your config data as a JSON file.)
|
|
21
|
+
Interacts with your `comments.config.js` default exported object to print all the parameters you need to be aware of before running `compress` or `resolve`. Also acts as a dry run validation check. If no error is printed, it means you can run `compress` or `resolve` safely, as long as the printed parameters correspond to what you've expected from your defined config. (Additionally creates a resolved version of your config data as a JSON file.)
|
|
20
22
|
|
|
21
23
|
```
|
|
22
24
|
comment-variables compress
|
|
23
25
|
```
|
|
24
26
|
|
|
25
|
-
Scans your line and block comments for string values defined in your `comments.config.js` (like `"This is a comment"`) to turn them into their corresponding `$COMMENT#*`
|
|
27
|
+
Scans your line and block comments for string values defined in your `comments.config.js` (like `"This is a comment"`) to turn them into their corresponding `$COMMENT#*` placeholders defined in your `comments.config.js`. (`This is a comment.` => `$COMMENT#COMMENT`)
|
|
26
28
|
|
|
27
29
|
```
|
|
28
30
|
comment-variables resolve
|
|
29
31
|
```
|
|
30
32
|
|
|
31
|
-
Scans your line and block comments for `$COMMENT#*`
|
|
33
|
+
Scans your line and block comments for `$COMMENT#*` placeholders (like `$COMMENT#COMMENT`) to turn them into their corresponding string values defined in your `comments.config.js`. (`$COMMENT#COMMENT` => `This is a comment.`)
|
|
32
34
|
|
|
33
35
|
_The `compress` and `resolve` commands make each other entirely reversible._
|
|
34
36
|
|
|
@@ -149,3 +151,5 @@ export default config;
|
|
|
149
151
|
And yes, even comments within JavaScript and TypeScript blocks in Markdown files are addressed.
|
|
150
152
|
|
|
151
153
|
_Leverage the power of JavaScript to programmatically design your JavaScript comments._
|
|
154
|
+
|
|
155
|
+
**The Comment Variables VS Code extension is available [here](https://comvar.lemonsqueezy.com/buy/723b0220-ea5d-4b0a-835a-f0843e431639?logo=0&discount=0).**
|
package/package.json
CHANGED