Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Hy-Vee/lerna-yarn-workspaces-monorepo
🐉 A Monorepo with multiple packages and a shared build, test, and release process.
https://github.com/Hy-Vee/lerna-yarn-workspaces-monorepo
babel jest lerna monorepo react storybook styled-components yarn-workspaces
Last synced: 16 days ago
JSON representation
🐉 A Monorepo with multiple packages and a shared build, test, and release process.
- Host: GitHub
- URL: https://github.com/Hy-Vee/lerna-yarn-workspaces-monorepo
- Owner: Hy-Vee
- Created: 2019-03-25T14:09:52.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-01-06T20:57:24.000Z (over 1 year ago)
- Last Synced: 2024-02-27T05:35:12.313Z (4 months ago)
- Topics: babel, jest, lerna, monorepo, react, storybook, styled-components, yarn-workspaces
- Language: JavaScript
- Homepage: https://medium.com/hy-vee-engineering/creating-a-monorepo-with-lerna-yarn-workspaces-cf163908965d
- Size: 1020 KB
- Stars: 265
- Watchers: 11
- Forks: 44
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Lists
- my-awesome-stars - Hy-Vee/lerna-yarn-workspaces-monorepo - 🐉 A Monorepo with multiple packages and a shared build, test, and release process. (JavaScript)
README
# Monorepo with Lerna & Yarn Workspaces
> A Monorepo with multiple packages and a shared build, test, and release process.
View example ➡️ https://storybook-monorepo.now.sh/
- 🐉 [Lerna](https://lernajs.io/) - The Monorepo manager
- 📦 [Yarn Workspaces](https://yarnpkg.com/lang/en/docs/workspaces/) - Sane multi-package management
- 🚀 [React](https://reactjs.org/) - JavaScript library for user interfaces
- 💅 [styled-components](https://www.styled-components.com/) - CSS in JS elegance
- 🛠 [Babel](https://babeljs.io/) - Compiles next-gen JavaScript
- 📖 [Storybook](https://storybook.js.org/) - UI Component Environment
- 🃏 [Jest](https://jestjs.io/) - Unit/Snapshot Testing
## Usage
- `yarn dev` - This starts Storybook for viewing all the components locally.
- `yarn bootstrap` - This installs all of the packages and links dependent packages together.
- `yarn build` - This babelfies all of the packages and creates `/lib` folders for each one.
- `yarn test` - Run all linting and unit tests before committing.
- `yarn test -o` - Run only the tests that have changed.
- `yarn test -u` - Update all of the snapshot tests.
## Lerna
- `lerna changed` - Show which packages have changed.
- `lerna diff` - Show specifically what files have cause the packages to change.
## Linking
When linking inside of the Monorepo, everything works as expected. If you are trying to consume packages from this Monorepo _in a different application_ locally, using `npm link` or `yarn link` [does not work as expected](https://github.com/yarnpkg/yarn/issues/5538). However, we have a workaround for the time being.
1. Run `yarn build`
1. Run `yarn dev`
1. Change the `package.json` of the consumer from `$YOUR_PACKAGE_NAME` (which lives inside the monorepo) to `file:./../monorepo/packages/$YOUR_PACKAGE_NAME`
1. Run `rm -rf node_modules && yarn` in the consumer
1. 🎉
## Contributing
All formatting and linting should be taken care of for you using [stylelint](https://github.com/stylelint/stylelint), [ESLint](https://eslint.org/), and [Prettier](https://prettier.io/). You should also consider installing an extension for CSS syntax highlighting.
- [vscode-styled-components](https://marketplace.visualstudio.com/items?itemName=jpoissonnier.vscode-styled-components)
- [webstorm-styled-components](https://github.com/styled-components/webstorm-styled-components)
- [Other IDEs](https://www.styled-components.com/docs/tooling#syntax-highlighting)
## FAQ
### Why the limitation on yarn versions?
[It's a known issue](https://github.com/yarnpkg/yarn/issues/7807) that yarn workspaces using yarn versions > `1.18.0` can produce the following false positive error message when adding or updating dependencies in packages.
```
error An unexpected error occurred: "expected workspace package to exist for "XXX".
```
To guard against this, we've:
- Changed `package.json` to enforce a yarn version range.
- Added a `.yvmrc` file, so if you're using [yvm](https://yvm.js.org/docs/overview) to manage your yarn versions (like [nvm](https://github.com/nvm-sh/nvm) for node version), it'll pick up the yarn version automatically.