A suite of tools for working on Ghost and in the surrounding ecosystem.
It (will soon) provide a CLI tool for quickly starting new projects.
Slimer is capable of creating 4 different types of project:
- Pkg: create a package inside a mono repo
- Mono: start a new mono repo with lerna, just like the
slimer
repo - Module: a simple standalone node module
- App: a standalone app, based on express
Add me to your globals:
npm i -g @tryghost/slimer-cli
I aim to be easy to use, if you ever get stuck, try adding --help
to a command.
slimer new <name>
- Run
slimer
orslimer --help
for full usage details
This is a mono repository, managed with lerna.
git clone
this repo &cd
into it as usualyarn setup
is mapped tolerna bootstrap
- installs all external dependencies
- links all internal dependencies
yarn dev
(oryarn slimer
) are aliases forslimer
yarn link:cli
will make your local dev version available globally as justslimer <command>
yarn unlink:cli
will remove it again
Note: normally yarn link
would work for this, but it's not working with the lerna repo for me.
yarn lint
run just eslintyarn test
run tests & then eslint
yarn ship
is mapped tolerna publish
and will publish any package that has changed.
Copyright (c) 2018 Ghost Foundation - Released under the MIT license.