@slimio/psp

Project structure policy

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 v10 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.

$ psp

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

$ psp --force

Arguments

name	description
-h --help	Show help
--force	Enable force mode
--gitignore	Show .gitignore file
--npmignore	Show .npmignore file
--editorconfig	Show .editorconfig file

API

TBC

Dependencies

Name	Refactoring	Security Risk	Usage
@slimio/arg-parser	Minor	Low	Cli argument parser
@slimio/manifest	Minor	Low	Manifest config file
cherow	⚠️Major	Low	Javascript parser
estree-walker	⚠️Major	Low	Retrieves require package
file-ignore-parser	Minor	Low	Parse .ignore file
file-normalize	⚠️Major	Low	File normalizer
js-yaml	⚠️Major	Low	YAML parser/writer
kleur	Minor	Low	CLI color
make-promises-safe	⚠️Major	Low	Promise don't exit process when fail
node-emoji	⚠️Major	Low	Emojify string

License

MIT