Skip to content

Commit

Permalink
chore(docs): replace yarn references for pnpm
Browse files Browse the repository at this point in the history
  • Loading branch information
joshvanallen authored and DominikPieper committed Sep 6, 2023
1 parent 6856d96 commit 5264386
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 63 deletions.
40 changes: 8 additions & 32 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

PR's, ideas and discussions are welcome.

Always run `yarn format` before doing a push!
Always run `pnpm format` before doing a push!

## Project Structure

This project uses the Nx CLI with Yarn 1.x.
This project uses the Nx CLI with pnpm.

This project is built with Nx and follows the OSS project structure. The [Getting Started](https://nx.dev/getting-started) guide shows how to work with Nx workspaces.

Expand All @@ -15,37 +15,37 @@ This project is built with Nx and follows the OSS project structure. The [Gettin
After cloning the project, to install the dependencies, run:

```
yarn
pnpm install
```

To build a plugin, run:

```
yarn build [plugin]
pnpm build [plugin]
```

## Run the Unit Tests

Run unit tests for a specific plugin with:

```
yarn test [plugin]
pnpm test [plugin]
```

## Run the e2e Tests

Run e2e tests for a specific plugin with:

```
yarn e2e [plugin]
pnpm e2e [plugin]
```

## Test Locally

Create a playground Nx repository:

```
yarn create-playground
pnpm create-playground
```

This will create a playground repository inside the Nxext repository directory. You'll find it here:
Expand All @@ -57,31 +57,7 @@ It is a regular Nx repository and you're able to do everything like create proje
To update the playground with changes on the plugins without rebuilding a new playground, run:

```
yarn update-playground
pnpm update-playground
```

## Publishing to a local registry

To test if your changes will actually work once the changes are published,
it can be useful to publish to a local registry.

```bash
# Starts the local registry. Keep this running in a separate terminal.
yarn local-registry start

# Set npm and yarn to use the local registry.
# Note: This reroutes your installs to your local registry
yarn local-registry enable

# Revert npm and yarn to use their default registries
yarn local-registry disable
```

To publish packages to a local registry, do the following:

- Run `yarn local-registry start` in Terminal 1 (keep it running)
- Run `npm adduser --registry http://localhost:4873` in Terminal 2 (real credentials are not required, you just need to be logged in. You can use test/test/[email protected].)
- Run `yarn local-registry enable` in Terminal 2
- Run `yarn local-release 999.9.9` in Terminal 2

**Happy coding :-)**
38 changes: 7 additions & 31 deletions docs/docs/nxext/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ PR's, ideas and discussions are welcome.

## Project Structure

This project uses the Nx CLI with Yarn 1.x.
This project uses the Nx CLI with pnpm.

This project is built with Nx and follows the OSS project structure. The [Getting Started](https://nx.dev/angular/getting-started/what-is-nx) guide shows how to work with Nx workspaces.

Expand All @@ -13,37 +13,37 @@ This project is built with Nx and follows the OSS project structure. The [Gettin
After cloning the project, to install the dependencies, run:

```
yarn
pnpm install
```

To build a plugin, run:

```
yarn build [plugin]
pnpm build [plugin]
```

## Run the Unit Tests

Run unit tests for a specific plugin with:

```
yarn test [plugin]
pnpm test [plugin]
```

## Run the e2e Tests

Run e2e tests for a specific plugin with:

```
yarn e2e [plugin]
pnpm e2e [plugin]
```

## Test Locally

Create a playground Nx repository:

```
yarn create-playground
pnpm create-playground
```

This will create a playground repository inside the Nxext repository directory. You'll find it here:
Expand All @@ -55,31 +55,7 @@ It is a regular Nx repository and you're able to do everything like create proje
To update the playground with changes on the plugins without rebuilding a new playground, run:

```
yarn update-playground
pnpm update-playground
```

## Publishing to a local registry

To test if your changes will actually work once the changes are published,
it can be useful to publish to a local registry.

```bash
# Starts the local registry. Keep this running in a separate terminal.
yarn local-registry start

# Set npm and yarn to use the local registry.
# Note: This reroutes your installs to your local registry
yarn local-registry enable

# Revert npm and yarn to use their default registries
yarn local-registry disable
```

To publish packages to a local registry, do the following:

- Run `yarn local-registry start` in Terminal 1 (keep it running)
- Run `npm adduser --registry http://localhost:4873` in Terminal 2 (real credentials are not required, you just need to be logged in. You can use test/test/[email protected].)
- Run `yarn local-registry enable` in Terminal 2
- Run `yarn local-release 999.9.9` in Terminal 2

**Happy coding :-)**

0 comments on commit 5264386

Please sign in to comment.