Related Issue/Keyword:
Closes #114
Adds, configures and set up a linter for the repository.
Changes files to compile with the linter
Description:
This pull request adds a linter and changes all TS files to compile with recommended standards along with a few custom ones (specified in the tslint.json config file)
Running the linterFor Normal Developers
In the root directory for the repository open a terminal
Run the command npm run lint
This will run the linter on the repositories TS files checking for any major violation of our tslint.json config (errors only)
If there is a critical failure (return code 1) it means that the linter is not running properly, please contact @SamuelZheng11 for help
If there is a linting issue (return code 2) then it means there are linting errors present, fix accordingly by scrolling to a lint error and pressing ctrl + click on the file that is specified
If there are no lint errors there a message will read Linter completed with no linting errors
For Future and Advanced Developers
In the root directory for the repository open a terminal
Run the command npm run lintAllSeverities
This will run the linter on the repositories TS files checking for any major or minor violation of our tslint.json config (includes errors, warnings, notes, etc)
The exit code is the same as running the linter normally
Minor config violations will be logged in the console. However, The linter will terminal gracefully (without saying it ran into any issues)
Testing
Testing on my local machine, there appear to be no issues with the changes I have made. However, I urge reviewers to test on their machine in case I have missed something.
Because a test suite is not currently up, the best way to test if VisualGit still works as intended is to click through the program and ensure that all functionality persists with my changes.
[x] Latest master merged/rebased into your feature branch
[ ] Tests covering all changes - N/A we currently don't have UI tests of any kind set up.
[x] Meets the projects coding conventions
[x] No out of scope changes
[x] @Mentioned any relevant team members
[x] Included a relevant gif (search here for inspiration)
Related Issue/Keyword: Closes #114 Adds, configures and set up a linter for the repository. Changes files to compile with the linter
Description: This pull request adds a linter and changes all TS files to compile with recommended standards along with a few custom ones (specified in the tslint.json config file)
Running the linter For Normal Developers
npm run lint
This will run the linter on the repositories TS files checking for any major violation of our tslint.json config (errors only)
If there is a critical failure (return code 1) it means that the linter is not running properly, please contact @SamuelZheng11 for help
If there is a linting issue (return code 2) then it means there are linting errors present, fix accordingly by scrolling to a lint error and pressing
ctrl + click
on the file that is specifiedIf there are no lint errors there a message will read
Linter completed with no linting errors
For Future and Advanced Developers
npm run lintAllSeverities
This will run the linter on the repositories TS files checking for any major or minor violation of our tslint.json config (includes errors, warnings, notes, etc)
Testing Testing on my local machine, there appear to be no issues with the changes I have made. However, I urge reviewers to test on their machine in case I have missed something.
Because a test suite is not currently up, the best way to test if VisualGit still works as intended is to click through the program and ensure that all functionality persists with my changes.
Tests covering all changes- N/A we currently don't have UI tests of any kind set up.