fix(schematics): fix typo in option name #2522
Conversation
|
Preview docs changes for 54c0af3 at https://previews.ngrx.io/pr2522-54c0af3/ |
|
@aszechlicki I misread this. We want |
|
@brandonroberts so I should rename all skipTest to skipTests? |
|
Yes |
|
Sorry. We should probably keep both for now, deprecate |
|
ok, then can you tell me how to mark this property as deprecated? |
|
In the schema.json, just add Deprecated to the description, and just replace the deprecated version in the markdown. |
aszechlicki
force-pushed
the
schematics-skip-test
branch
from
6b0ec3c to
7766a7f
Compare
| @@ -27,6 +27,11 @@ | |||
| "description": "Flag to indicate if a dir is created." | |||
| }, | |||
| "skipTest": { | |||
| "type": "boolean", | |||
| "description": "(Deprecated) Use skipTests instead", | |||
There was a problem hiding this comment.
Fyi, instead of adding deprecated to the description we could use the x-deprecated property.
This way the cli will log a warning when skipTest is being used.
As an example, see the entryComponent option
There was a problem hiding this comment.
Still needs x-deprecated
rename skipTests option in action schematics to skipTest, consistent with naming in other schematics pass option value instead of hardcoded true in feature schematics update tests fixes ngrx#2521
make sure old option still works
aszechlicki
force-pushed
the
schematics-skip-test
branch
from
7766a7f to
9d1853a
Compare
aszechlicki
force-pushed
the
schematics-skip-test
branch
from
9d1853a to
8e799ae
Compare
| @@ -27,6 +27,11 @@ | |||
| "description": "Flag to indicate if a dir is created." | |||
| }, | |||
| "skipTest": { | |||
| "type": "boolean", | |||
| "description": "(Deprecated) Use skipTests instead", | |||
There was a problem hiding this comment.
Still needs x-deprecated
| @@ -25,6 +25,11 @@ | |||
| "aliases": ["p"] | |||
| }, | |||
| "skipTest": { | |||
| "type": "boolean", | |||
| "description": "(Deprecated) Use skipTests instead", | |||
| "default": false | |||
There was a problem hiding this comment.
Still needs x-deprecated
|
Thanks @aszechlicki! |
rename skipTests option in action schematics to skipTest, consistent with naming in other schematics
pass option value instead of hardcoded true in feature schematics
update tests
fixes #2521
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Closes #2521
What is the new behavior?
Action schematics skipTests option now has consistent name with other schematics - skipTest
feature schematics now passes actual option value instead of hardcoded true to skipTest option of action schematics
Does this PR introduce a breaking change?
Other information