microsoft / rushstack-samples

Code samples for the Rush Stack family of tools.

Rush Stack Samples

This monorepo hosts code samples for the Rush Stack family of tools.

Documentation Links

• What is Rush Stack? - learn about the mission behind these projects
• Zulip chat room - chat with the Rush Stack developers

Related Repos

• rushstack - the main monorepo where the Rush Stack tools are developed
• rush-example - a minimal Rush repo that demonstrates the fundamentals of Rush without relying on any other Rush Stack tooling
• rushstack-legacy - older projects that are still maintained but no longer actively developed

Sample Projects

Folder	Description
/heft/heft-fastify-tutorial	This project illustrates usage of Fastify with Heft
/heft/heft-node-basic-tutorial	This project illustrates a minimal tutorial Heft project targeting the Node.js runtime
/heft/heft-node-jest-tutorial	Illustrates how various Jest features work with Heft
/heft/heft-node-rig-tutorial	This project illustrates a minimal tutorial Heft project targeting the Node.js runtime and using a rig package
/heft/heft-storybook-react-tutorial	This project illustrates usage of Storybook with Heft
/heft/heft-storybook-react-tutorial-storykit	Storybook build dependencies for heft-storybook-react-tutorial
/heft/heft-webpack-basic-tutorial	This project illustrates a minimal tutorial Heft project targeting the web browser runtime
/other/packlets-tutorial	This project illustrates how to use @rushstack/eslint-plugin-packlets

Contributor Notice

This repo 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 repo 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.

rushstack-samples's Issues

Should we add publishFolder samples

I saw we help publishFolder but we cannot find any example about that.

So I think we should be add it into examples

Unable to make it work without the @types/jest

Your project should get its typings from @types/heft-jest instead of @types/jest:

I removed the @types/jest but my project broke and I then ran yours...

Example: react component library

Looking for a react component library example with all the bells and whistles of storybook and maybe webpack?

Example: JS-only project

Looking for an example of how to setup a JS-only package with heft and all the relevant plugins.