Code Assess

Installation

npm i -D code-assess Optional: Add a .code-assessrc.json file to your root folder. This is where you can set up which linters and tests you would like to run. Although all of the tests come with preconfigured rc files, you can choose to add your own in your root directory and those will take precendence over the default configs. Note: due to sudo access being droped in npm for dependencies, you need to install Sonarwhal yourself: npm i sonarwhal

Usage

The easiest way to get up and running is adding: "assess": "babel-node node_modules/.bin/code-assess src" to your pacakge.json file. You can then run npm run assess

Code-assess Configuration

The config should be stored in the root directory of your project. If there is no config, code-assess will only run tests for things it find rc files for. For example, if you were to have an eslintrc file, only eslint tests would be run. Adding a code-assessrc.json file to project allows you to run any of the available tests you would like without needing configs for everything else. The format of the config is as follows: { "eslint": { "run": true } }
Unless otherwise noted, these are the only parameters required with the json file.

Current Tests

ESLint

Website: https://eslint.org/
Writing a config: https://eslint.org/docs/user-guide/configuring#using-configuration-files

SCSSLint

Website: https://github.com/brigade/scss-lint
Writing a config: https://github.com/brigade/scss-lint#configuration

HTMLHint

Website: http://htmlhint.com/
Writing a config: https://github.com/yaniswang/HTMLHint/wiki/Usage#about-htmlhintrc

Sonarwhal

Website: https://sonarwhal.com/
Writing a config: https://sonarwhal.com/docs/user-guide/concepts/rules/
*Note: Within the config file, a uri array is required. Each element of the uri is a different 'site' that will be checked by sonarwhal. Example:
{ "sonarwhal": { "run": true, "uri":["localhost:5000", "localhost:8000"] } }