Run with NPM
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.
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:
Then, create a .env.promyze
file and set these two values (add it to your .gitignore to not share sensitive data):
Then add a script in your package.json
:
And you can finally run it as:
Run a scan in standalone mode
Outside a npm script, run the following command to ensure everything works fine:
If yes, you can check the section below to configure the code analysis.
Generate coding practices with AI
TODO
Configuration
For any suggestion to improve this package, feel free to submit us your suggestion, and we'd be happy to consider it:
Last updated