NutritionMate / Nutrition.Information.Api

This is an API to retrieve the nutritional information of a given food item.
MIT License
1 stars 1 forks source link

As a contributor to the Nutrition Information API, I want continuous integration to automatically lint the code for readability, maintainability, and functionality errors, so I can automatically confirm the code changes meet coding styles specified in the lint rules. #24

Closed PaddingtonBrown closed 7 years ago

PaddingtonBrown commented 7 years ago

As a contributor to the Nutrition Information API, I want continuous integration to automatically lint the code for readability, maintainability, and functionality errors, so I can automatically confirm the code changes meet coding styles specified in the lint rules.

Acceptance Criteria

Test Plan Testing for this issue will be done manually covering the acceptance criteria by running builds to match each of the criteria.

Dev Work

  1. Install tslint and save as a dev depenedency $ npm install tslint --save-dev
  2. Use tslint --init to generate an initial tslint.json config file. We will update this further in future tasks with rules from https://palantir.github.io/tslint/rules/ that we desire
  3. Add the following npm script to package.json "lint": "tslint --project ./ --typecheck"
  4. Update the npm test script to start with npm run-script lint
  5. Test locally and apply fixes to pass the current set of rules

Definition of Ready

PaddingtonBrown commented 7 years ago

This has been done and merged into master via #33