The npm packagepromyze-cli allows to compute best practices suggestions on a code base to detect locations where best practices are not followed. It also provides facilities to produce a report file for tools like SonarQube, or in the SARIF format (Static Analysis Results Interchange Format).
Installation
We recommend installing the promyze-cli tool globally.
npmi-gpromyze-cli
Configuration
There is one mandatory parameter to set:
PROMYZE_API_KEY: A valid user API Key to connect to your Packmind instance.
We recommend setting these values as environment variables, but you can also pass them as command-line arguments.
You can also use the dotenv package:
npm install dotenv dotenv-cli
Then, create a .env.promyze file and set these two values (add it to your .gitignore to not share sensitive data):