Create or implement a Syntax Checker for Chocolatey commands #1286
Description
Checklist
- I have verified this is the correct repository for opening this issue.
- I have verified no other issues exist related to my request.
Is Your Feature Request Related To A Problem? Please describe.
The inclusion of a Chocolatey command syntax checker in the docs would be beneficial for users to try Chocolatey commands before running them live to ensure they have formed them correctly. Ideally, this would include the ability to check the syntax for options & switches and package parameters to provide users with concrete data on how to formulate a Chocolatey command.
Describe The Solution. Why is it needed?
The options and switches output on each product page can be difficult to comb through as well as the package parameters can be hard to understand. A separate issue or issues to address these will be created, and providing users with the functionality of building Chocolatey commands promotes user education. This is also why implementing a syntax checker within the Chocolatey courses would be invaluable.
User Story
As a novice Chocolatey user,
I want a way to check the syntax of Chocolatey commands,
so that I know they are correct before actually running them.
Additional Context
While in school for networking, the learning material we used included a syntax checker to highlight mistakes in the configurations we were writing, as well as provided useful feedback for future scripts.
This is a massive undertaking, requiring a lot of work on both the backend to get it built and in place and the frontend to make it fun and worthwhile for users.
Acceptance Criteria
- When typing a Chocolatey command into the Syntax Checker and clicking a button that says "Check", then the Syntax Checker display whether or not the command is correct, or if there are errors.
- If there are errors reported, then the suggested fixes are presented in a box below the input and is syntax highlighted.
Related Issues
n/a