Install it once globally:
yarn global add @rispa/cli
npm install -g @rispa/cli
You will need to have Node >= 7.10 on your machine.
ris new project-name
It will create a directory called
project-name inside the current folder.
Inside that directory, it will generate the initial project structure and install the selected plugins:
rispa.json is an entry point of RISPA project, it contains information about current project.
To create project in development mode, run:
Project will be generated without Subtree usage.
To add plugins, run inside project directory:
ris add rispa-eslint-config
It will add plugin with name
rispa-eslint-config to current project.
If you want to browse and select plugins to install, run:
It will display available plugins. Press
space to select plugins for installation, then press
enter to install selected plugins.
If you want to add plugin via git url, run:
ris add git:https://github.com/rispa-io/rispa-core.git
It will add
rispa-core plugin via git url to current project.
To update installed plugins, run inside project directory:
It will pull changes to all installed plugins in current project.
Pulling changes works through the git interface.
To remove a plugin, run inside project directory:
It will remove
plugins-name plugin from current project.
Plugin removal is an unsafe operation, because, it doesn't make changes to the client code and requires corrections by user.
To assemble plugins, run inside project directory:
It will install not installed plugins from
Launch plugin script
To launch plugin script, run inside project directory:
It will launch script
To launch script for all plugins, run inside project directory:
It will launch script
lint for all installed plugins.
To force or disable usage of Yarn, use
ris run all lint --yarn=true
To skip plugins, use
ris run all lint --skip=@rispa/ui-kit,feature-plugin
To launch plugin generator, run inside project directory:
ris g core generator-name
It will launch
generator-name generator of
core package in current project.
To commit project or plugins changes, run inside project directory:
It will collect project changes and ask you to enter commit message. The commit will be pushed to the current branch.
To numerate project changes, run inside project directory:
It will scan project tags and display available versions.
If you launched the globally installed CLI and there will be local version found, the call will be redirected to the local version.
We use Subtree
merge strategy for plugins.
Generated project based on Lerna monorepo
Plugins are a part of monorepo
modules, they extend the project functionality.
- is an entry point for all plugins, providing enhancements and correct initialization of connected plugins.
List of available plugins can be seen here
To see the full details of an error, run CLI with ENV: