comment-variables 0.15.0 → 0.15.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 +7 -5
- 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
|
|
|
@@ -51,13 +53,13 @@ comment-variables --config <your-config.js>
|
|
|
51
53
|
Passes a different file as your config instead of the default `comments.config.js` (like `comment-variables --config your-config.js`), through a path relative to the root of your project.
|
|
52
54
|
|
|
53
55
|
```
|
|
54
|
-
--lint-config-imports now part of the config at the `lintConfigImports` key
|
|
56
|
+
--lint-config-imports is now part of the config at the `lintConfigImports` key
|
|
55
57
|
```
|
|
56
58
|
|
|
57
59
|
By default, `comment-variables` excludes your config file and all the (JavaScript/TypeScript) files it recursively imports. This flag cancels this mechanism, linting config imports. (The config file however still remains excluded from linting.)
|
|
58
60
|
|
|
59
61
|
```
|
|
60
|
-
--my-ignores-only now part of the config at the `myIgnoresOnly` key
|
|
62
|
+
--my-ignores-only is now part of the config at the `myIgnoresOnly` key
|
|
61
63
|
```
|
|
62
64
|
|
|
63
65
|
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.
|
package/package.json
CHANGED