https://github.com/jlegrone/lerna-monorepo-example

Develop node modules inside a monorepo with lerna and conventional commits
https://github.com/jlegrone/lerna-monorepo-example

Last synced: 2 months ago
JSON representation

Develop node modules inside a monorepo with lerna and conventional commits

• Host: GitHub
• URL: https://github.com/jlegrone/lerna-monorepo-example
• Owner: jlegrone
• License: mit
• Created: 2017-06-01T01:57:29.000Z (over 7 years ago)
• Default Branch: develop
• Last Pushed: 2022-04-15T16:05:23.000Z (over 2 years ago)
• Last Synced: 2024-10-14T18:37:19.290Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 523 KB
• Stars: 25
• Watchers: 4
• Forks: 9
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# lerna-monorepo-example

[![Build Status](https://travis-ci.org/jlegrone/lerna-monorepo-example.svg?branch=master)](https://travis-ci.org/jlegrone/lerna-monorepo-example) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

## Getting Started

```

$ yarn bootstrap

```

See README from `packages/` to run individual projects.

To explore commands available through [lerna](https://github.com/lerna/lerna/):

```

$ yarn learna

```

To run [lerna](https://github.com/lerna/lerna/) commands directly:

```

$ yarn lerna 

```

## Committing Changes

This repo follows the [conventional commits specification](https://conventionalcommits.org).

Run `yarn commit` to start an interactive commit.  Valid scopes are `macos`, `mobile`, `redux-lib`, `web`, and `repo`.

## Publishing Packages

To increment package versions, add git tags, push changes, and publish to npm registry:

```

$ yarn release

```

## Testing

To run tests on file changes across all packages (at project root):

```

$ yarn test:watch

```

To run tests for specific package:

```

$ cd packages/

$ yarn test

```

## Available Package Scripts

| Name | Description |

|------|-------------|

|`bootstrap`|Pre-transpile module(s) and execute `lerna bootstrap`|

|`cleanup`|Remove `node_modules` within each package directory|

|`commit`|Open an interactive dialogue to generate a conventional commit message|

|`learna`|Start the lerna wizard|

|`release`|Generate changelogs and publish new package versions|

|`start`|Run `yarn start` in each package in parallel|

|`watch`|Transpile module(s) on file system changes|