SlimIO - Project Structure Policy. A policy aims to accurately describe the constituent elements of a project. This CLI has been created to apply the following Specification.

⚠️ This project has been created for SlimIO (it will not work outside). Feel free to replicate the idea / core concept.

Requirements

• Node.js v12 or higher
• a SlimIO Manifest file at the root of the scanned project.

Getting Started

This package is available in the Node Package Repository and can be easily installed with npm or yarn.

$ npm i @slimio/psp
# or
$ yarn add @slimio/psp

Usage example

When installed globally the psp executable will be exposed in your terminal.

If you want to continue the execution even for critical warnings, just run with force mode:

Arguments

API

PSP is available in API mode too.

const psp = require("@slimio/psp");

async function main() {
    const { warn, crit } = await psp({
        forceMode: true, // <-- stay to true (else it will exit the process on CRIT).
        CWD: "./dir",
        isCLI: false, // <-- stay to false (else it will work as it was executed as a CLI).
        verbose: false
    });
    console.log(`warn => ${warn}, crit => ${crit}`);
}
main().catch(console.error);

Get a global overview of many projects

The SlimIO Sync project allow to run a command to get a global overview of warnings of all projects in the current working dir.

Dependencies

License

MIT