microsoft / rush-example

Illustrates a sample monorepo configuration for use with the Rush tool

Example Rush Monorepo

This template is part of the documentation of the Rush tool. It contains documented templates for all the standard Rush configuration files. It also includes three barebones projects that illustrate some dependency relationships in a Rush repo:

• apps/my-app: The web application
• libraries/my-controls: A control library used by the application
• tools/my-toolchain: A NodeJS build tool used to compile the other projects

(These projects are NOT meant to provide a realistic toolchain.)

Building this repo

To build the projects in this repo, try these shell commands:

npm install -g @microsoft/rush
rush install
rush build

For more information, see the documentation at: https://rushjs.io/

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

rush-example's Issues

Rush Change

I can't seem to get rush change working, but I'm also not sure if I'm doing it properly. I always get "No changes were detected to relevant packages on this branch. Nothing to do." If there is an example for how change operates. I'd appreciate taking a look.

rushx fails in project folder

Running rushx build in a project directory (libraries\my-controls or apps\my-app) fails:

Found configuration in S:\Repos\rush-example\rush.json

Executing: "node_modules/.bin/my-build"

'node_modules' is not recognized as an internal or external command,
operable program or batch file.
The script failed with exit code 1

rush build and npm run build both succeed.

How can I integrated rush with 'lint-staged' package?

Since there is no package.json file in the root folder. I have to install the 'lint-staged' package into all the projects.

ERROR: running in node 18.12 environment

ERROR: Your dev environment is running Node.js version v18.12.1 which does not meet the requirements for building this repository. (The rush.json configuration requires nodeSupportedVersionRange=">=12.13.0 <13.0.0 || >=14.15.0
<15.0.0 || >=16.13.0 <17.0.0")

This repo is missing important files

There are important files that Microsoft projects should all have that are not present in this repository. A pull request has been opened to add the missing file(s). When the pr is merged this issue will be closed automatically.

Microsoft teams can learn more about this effort and share feedback within the open source guidance available internally.

Merge this pull request

README grammer changes

Tool chain should be toolchain.
Documentated should be documented