comment-variables 0.16.0 → 1.0.0
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
|
@@ -12,19 +12,19 @@ npm install -g comment-variables
|
|
|
12
12
|
|
|
13
13
|
## Commands
|
|
14
14
|
|
|
15
|
-
**`comment-variables` (aliases `jscomments
|
|
15
|
+
**`comment-variables` (aliases `jscomments`/`comvar`) comes with three commands in this initial release:**
|
|
16
16
|
|
|
17
17
|
```
|
|
18
18
|
comment-variables
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Interacts with your root `comments.config.js` file's 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.)
|
|
21
|
+
Interacts with your root `comments.config.js` file's 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. If no configuration file is found, a tutorial mode is triggered, generating a template config file for you.)
|
|
22
22
|
|
|
23
23
|
```
|
|
24
24
|
comment-variables compress
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
Scans your line and block comments for string values defined in your root `comments.config.js` file (like `"This is a comment"`) to turn them into their corresponding `$COMMENT#*` placeholders defined
|
|
27
|
+
Scans your line and block comments for string values defined in your root `comments.config.js` file (like `"This is a comment"`) to turn them into their corresponding `$COMMENT#*` placeholders defined via your root `comments.config.js` file. (`This is a comment.` => `$COMMENT#COMMENT`)
|
|
28
28
|
|
|
29
29
|
```
|
|
30
30
|
comment-variables resolve
|
|
@@ -50,7 +50,7 @@ Creates Comment Variables placeholders right next to the single sources of truth
|
|
|
50
50
|
comment-variables --config <your-config.js>
|
|
51
51
|
```
|
|
52
52
|
|
|
53
|
-
Passes a different file as your config instead of the default root `comments.config.js` file (like `comment-variables --config your-config.js`), through a path relative to the root of your project.
|
|
53
|
+
Passes a different file as your config file instead of the default root `comments.config.js` file (like `comment-variables --config your-config.js`), through a path relative to the root of your project.
|
|
54
54
|
|
|
55
55
|
```
|
|
56
56
|
--lint-config-imports is now part of the config at the `lintConfigImports` key
|
package/package.json
CHANGED