|
| 1 | +<p> |
| 2 | + <img width="100%" src="https://assets.solidjs.com/banner?type=your-repository-name&background=tiles&project=Monorepo" alt="your-repository-name Monorepo"> |
| 3 | +</p> |
| 4 | + |
| 5 | +# your-repository-name |
| 6 | + |
| 7 | +[](https://pnpm.io/) |
| 8 | +[](https://turborepo.org/) |
| 9 | + |
| 10 | +your-repository-desc |
| 11 | + |
| 12 | +> **Note** After using this template, you have to search and replace all `your-repository-name` and similar strings |
| 13 | +> with appropriate texts. |
| 14 | +> |
| 15 | +> `your-repository-name` should be a **kebab-case** string representing the name of you monorepo. |
| 16 | +> |
| 17 | +> `your-repository-desc` should be a **Normal case** string with the description of the repository. |
| 18 | +> |
| 19 | +> `your-nickname` should be a **kebab-case** string from your profile URL. |
| 20 | +> |
| 21 | +> `your-author-name` should be a **Normal case** string with your first and last name. |
| 22 | +
|
| 23 | +## Project Commands |
| 24 | + |
| 25 | +List of cli commands available from a project root. |
| 26 | + |
| 27 | +To use the commands, first install [pnpm](https://pnpm.io) and install dependencies with `pnpm i`. |
| 28 | + |
| 29 | +```bash |
| 30 | +pnpm run dev |
| 31 | +# Builds all packages in watch mode, and starts all playgrounds |
| 32 | +# turbo run dev --parallel |
| 33 | + |
| 34 | +pnpm run build |
| 35 | +# Builds all the packages in the monorepo |
| 36 | +# turbo run build --filter=!./playgrounds/* |
| 37 | + |
| 38 | +pnpm run test |
| 39 | +# Runs tests for all the packages in the monorepo |
| 40 | +# turbo run test --filter=!./playgrounds/* |
| 41 | + |
| 42 | +pnpm run typecheck |
| 43 | +# Runs TS typecheck for all the packages in the monorepo |
| 44 | +# turbo run typecheck --filter=!./playgrounds/* |
| 45 | + |
| 46 | +pnpm run build-test |
| 47 | +# Runs build, typecheck and test commands for all the packages in the monorepo |
| 48 | +# "turbo run build test typecheck --filter=!./playgrounds/* |
| 49 | + |
| 50 | +pnpm run format |
| 51 | +# Formats the reposotory with prettier |
| 52 | +# prettier -w \"packages/**/*.{js,ts,json,css,tsx,jsx,md}\" \"playgrounds/**/*.{js,ts,json,css,tsx,jsx,md}\" |
| 53 | + |
| 54 | +pnpm run changeset |
| 55 | +# Creates a changeset |
| 56 | +# changeset |
| 57 | + |
| 58 | +pnpm run version-packages |
| 59 | +# Applies changesets to bump package versions and update CHANGELOGs |
| 60 | +# "changeset version && pnpm i |
| 61 | + |
| 62 | +pnpm run release |
| 63 | +# Builds and publishes changed packages to npm |
| 64 | +# pnpm run build-test && changeset publish |
| 65 | + |
| 66 | +pnpm run update-deps |
| 67 | +# Updates all dependencies in the repository |
| 68 | +# taze -w -r && pnpm i |
| 69 | +``` |
0 commit comments