Skip to content

add build:dev and docs #186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion boilerplates/lerna-module/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,20 @@ npm install __MODULENAME__

When first cloning the repo:

```
```sh
yarn
# build the prod packages. When devs would like to navigate to the source code, this will only navigate from references to their definitions (.d.ts files) between packages.
yarn build
```

Or if you want to make your dev process smoother, you can run:

```sh
yarn
# build the dev packages with .map files, this enables navigation from references to their source code between packages.
yarn build:dev
```

## Related

Checkout these related projects:
Expand Down
1 change: 1 addition & 0 deletions boilerplates/lerna-module/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
"clean": "rimraf dist/**",
"prepare": "npm run build",
"build": "npm run clean; tsc; tsc -p tsconfig.esm.json; npm run copy",
"build:dev": "npm run clean; tsc --declarationMap; tsc -p tsconfig.esm.json; npm run copy",
"lint": "eslint . --fix",
"test": "jest",
"test:watch": "jest --watch"
Expand Down
13 changes: 11 additions & 2 deletions boilerplates/lerna-workspace/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,22 @@ npm install __MODULENAME__

## Developing


When first cloning the repo:
```

```sh
yarn
# build the prod packages. When devs would like to navigate to the source code, this will only navigate from references to their definitions (.d.ts files) between packages.
yarn build
```

Or if you want to make your dev process smoother, you can run:

```sh
yarn
# build the dev packages with .map files, this enables navigation from references to their source code between packages.
yarn build:dev
```

## Related

Checkout these related projects:
Expand Down
1 change: 1 addition & 0 deletions boilerplates/lerna-workspace/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
"scripts": {
"clean": "lerna run clean",
"build": "lerna run build --stream",
"build:dev": "lerna run build:dev --stream; yarn symlink",
"lint": "lerna run lint --parallel",
"symlink": "symlink-workspace --logLevel error",
"postinstall": "yarn symlink"
Expand Down