comment-variables 0.4.1 → 0.4.2
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 +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -18,15 +18,15 @@ Interacts with your `comments.config.js` default exported object to print all th
|
|
|
18
18
|
comment-variables compress
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Scans your line and block comments for values defined in your `comments.config.js` (like `"This is a comment"`) to turn them into their corresponding `$COMMENT#*` tokens defined in your `comments.config.js`. (`
|
|
21
|
+
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#*` tokens defined in your `comments.config.js`. (`This is a comment.` => `$COMMENT#COMMENT`)
|
|
22
22
|
|
|
23
23
|
```
|
|
24
24
|
comment-variables resolve
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
Scans your line and block comments for `$COMMENT#*` tokens (like
|
|
27
|
+
Scans your line and block comments for `$COMMENT#*` tokens (like `$COMMENT#COMMENT`) to turn them into their corresponding string values defined in your `comments.config.js`. (`$COMMENT#COMMENT` => `This is a comment.`)
|
|
28
28
|
|
|
29
|
-
_The `compress` and `resolve` commands
|
|
29
|
+
_The `compress` and `resolve` commands make each other entirely reversible._
|
|
30
30
|
|
|
31
31
|
## Flags
|
|
32
32
|
|
|
@@ -48,7 +48,7 @@ By default, `comment-variables` excludes your config file and all the (JavaScrip
|
|
|
48
48
|
comment-variables --my-ignores-only
|
|
49
49
|
```
|
|
50
50
|
|
|
51
|
-
By default, `comment-variables` includes a preset list of ignored folders ("node_modules"
|
|
51
|
+
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.
|
|
52
52
|
|
|
53
53
|
_All three flags can be composed together, and with any of the three commands:_
|
|
54
54
|
|
package/package.json
CHANGED