A collection of projects for managing a vanilla Minecraft multiplayer server.
See "Getting started as a developer" for an introduction to working in a Rush monorepo.
Install rush
globally
npm i -g @microsoft/rush
Install dependencies for all projects
rush update
See "Everyday commands" for a guide to the most common commands. Run
rush -h
or consult the "Command reference" for more information.
Rush cheat sheet:
rush add -p <package> [--dev]
- add a dependency to the current project according to the working directory and runrush update
rush build
- build only the projects that have changedrush install
- install dependencies for all projects according to the shrinkwrap file; unlikerush update
, won't modify the shrinkwrap filerush list
- list all projectsrush purge
- clear caches and remove temporary filesrush rebuild
- perform a full, clean build of every project in the repositoryrush update
- install dependencies for all projects; run whenever apackage.json
file has changed, commit any changes it creates undercommon/config
; usually incremental, run with--purge
to force a full reinstall of all projectsrushx <command>
- run a command in the current project according to the working directory
Custom commands:
Custom commands are configured in command-line.json. See "Custom commands" for more information.
rush lint
- lint JavaScriptrush lint:md
- lint Markdown
Issue: Unable to resolve a new or updated project module,
especially after rush purge
.
Related issues:
- microsoft/rushstack#708, [rush] NPM 5.x or newer ignores changes for Rush's "file:" version specifiers
- microsoft/rushstack#886, [rush] Let's get NPM 6 working with Rush
- microsoft/rushstack#1706, [rush] "rush update" fails if npm-shrinkwrap.json is present (sometimes)
- microsoft/rushstack#2542, [rush] Cannot find installed dependency on rush update