This repository has been archived by the owner on Jul 15, 2023. It is now read-only.
Used inquirer to prompt for properties when creating a new rule. #679
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
IllusionMH
suggested changes
Dec 17, 2018
JoshuaKGoldberg
previously requested changes
Dec 18, 2018
There was a problem hiding this comment.
Looks great, thanks @reduckted! I tried it out locally and it works wonderfully.
No comments from me other than what IllusionMH posted, just waiting on responses/resolutions to those.
|
Thanks for the suggestions. I've made those extra changes. Detecting VS Code Insiders ended up being easier than I thought it would be. I've tested the generator in VS Code and Insiders, and the new files opened up in the correct instance, but it would be great if someone else could confirm it works for them just in case there's something special about my configuration that made it work. |
IllusionMH
approved these changes
Dec 18, 2018
|
Thanks @reduckted! This is very snazzy. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR checklist
Includes testsOverview of change:
As per #258, I've used Inquirer.js to prompt for the rule's metadata.
All metadata except for the
options(and related properties) andcommonWeaknessEnumerationcan be specified. I figured it wasn't worth doing anything with CWE because of #611.Is there anything you'd like reviewers to focus on?
The existing generator didn't actually work, because it tried to add the new rule to the root
tslint.jsonfile, but that file contains comments and cannot be parsed as JSON. For now, I've removed that step, but I kinda think it's something that should still be done. I'm just not sure how to go about doing it. 😕 Any suggestions are welcome.I've also tried to be nice and open the new rule's files after they've been created. I can detect that the generator is running in the VS Code terminal by looking at the environment variables and just launch
code new_file_name.tsto open the file in the current VS Code instance. It works for me on Windows. In theory it should work on other operating systems, but I haven't confirmed that. I'm happy to remove this feature if you don't think it's worth the trouble.