kblincoe / VisualGit_SE701_2019_1

1 stars 0 forks source link

Fixes #114 - Add, Configure & Enforce Linter to VisualGit #181

Closed SamuelZheng11 closed 5 years ago

SamuelZheng11 commented 5 years ago

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

  1. In the root directory for the repository open a terminal
  2. 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)

For Future and Advanced Developers

  1. In the root directory for the repository open a terminal
  2. 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)

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.

bcox280 commented 5 years ago

Had a click through the application, all works as intended, no loss in functionality that I could see.

encryptededdy commented 5 years ago

Sorry, will take a look now.