@slimio/psp

Project structure policy

SlimIO - Project structure policy. This project is in progress production to help SlimIO contributors to describe all elements and structures of a project

Requirements

• Node.js v10 or higher

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

TBC

Checked

• Files

name	description	Severity - checked if
package.json	Project manifest	:no_entry:exist
slimio.toml	Project Slimio manifest	:no_entry:exist
.eslintrc	Linting configuration for JavaScript	:no_entry:exist :warning:correct extends :warning:rules or not
.editorconfig	Editor configuration, slimIO standard	:no_entry:exist :warning:identique of the slimIO projects
index.d.ts	Type(s) definition	:no_entry:exist
jsdoc.json	JSDoc configuration	:no_entry:exist :no_entry:all source files
commitlint.config.json	GIT Commit convention configuration	:no_entry:exist, :no_entry:correct extends
LICENSE	Project LICENSE (default MIT)	:no_entry:exist
.npmignore	Keep stuff out of your package	:no_entry:exist

• Structures

Folders--

name	description	Severity - checked if
/src	This folder contains project sources	:no_entry:exist
/test	This folder contains test files and / or folder	:warning:exist
/benchmark	This folder contains scripts that aim to measure project performance	:bulb:exist
/docs	This folder containing documentation and / or project specification	:bulb:exist

CLI--

name	Type	description	Severity - checked if
/bin	folder

License

MIT