Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update README.md with small fixess #4

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md with small fixess #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
- Type `ext install`
- Search `pnpm-vscode-helper`

Also, you can use `Ctrl(Command) + Shift + X` to open VS Code Extension Tab, and search for `pnpm-vscode-helper`.
Also, you can use the `Ctrl(Command) + Shift + X` to open VS Code Extension Tab, and search for the `pnpm-vscode-helper`.

## Features

Expand All @@ -30,7 +30,7 @@ Also, you can use `Ctrl(Command) + Shift + X` to open VS Code Extension Tab, and

## Commands

### Confiure
### Configure

Configure extension features.

Expand All @@ -41,13 +41,13 @@ See [Configure](##Configurations) for more details.
- `pnpm-vscode-helper.create-npm-rc-config`
- `pnpm-vscode-helper.create-pnpm-workspace-config`

Create `.npmrc` / `pnpm-workspace.yaml` file in current project root, with pnpm specified configuration and default value.
Create `.npmrc` / `pnpm-workspace.yaml` file in current project root, with pnpm specified configuration and default values.

### Install

- `pnpm-vscode-helper.install-workspace-root-deps`

Install workspace root dependencies only(as pnpm doesnot support this, we collect dependencies from workspace root and install them).
Install workspace root dependencies only(as pnpm does not support this, we collect the dependencies from the workspace root and install them).

![install-workspace-root-deps](assets/gif/install-workspace-root-deps.gif)

Expand All @@ -61,9 +61,9 @@ Create `.npmrc` / `pnpm-workspace.yaml` file in current project root, with pnpm

- `pnpm-vscode-helper.select-workspace-package`

Select a workspace package, and then select script to execute and filtering type.
Select a workspace package, and then select a script to execute and a filtering type.

- script selection items come from selected package's `package.json` file and workspace-only extra scripts(see `Workspace.ExtraWorkspaceScripts`).
- script selection items come from the selected package's `package.json` file and workspace-only extra scripts(see `Workspace.ExtraWorkspaceScripts`).
- filtering types come from the filtering syntax supported by pnpm now:
- self
- withDependencies
Expand All @@ -77,7 +77,7 @@ Create `.npmrc` / `pnpm-workspace.yaml` file in current project root, with pnpm

- `pnpm-vscode-helper.publish-node-package`

This command will ask you for the release type(`major`, `minor`, ...), and some publish related opitions( `git-checks` , `tag`, ...) , and update the bumped version in `package.json` 's `version` field, then run `pnpm publish` with arguments composed from prompt result.
This command will ask you for the release type(`major`, `minor`, ...), and some publish related options( `git-checks` , `tag`, ...) , and update the bumped version in `package.json` 's `version` field, then run `pnpm publish` with arguments composed from prompt result.

- you can choose release type which follows `semver` type, or input new version manually.
- we ask `tag`, `access`, `git-checks`, for final command arguments.
Expand All @@ -96,7 +96,7 @@ Create `.npmrc` / `pnpm-workspace.yaml` file in current project root, with pnpm

Selected dependencies will be removed by `pnpm remove` command.

This command is also avaliable in non-workspace project.
This command is also available in non-workspace project.

- `pnpm-vscode-helper.remove-workspace-package-deps`

Expand Down Expand Up @@ -124,9 +124,9 @@ Create `.npmrc` / `pnpm-workspace.yaml` file in current project root, with pnpm

- `pnpm-vscode-helper.remove-extra-workspace-scripts`

This extra scripts command helps you to create pre-configured npm scripts, which will used by `select-workspace-package` command.
This extra scripts command helps you to create pre-configured npm scripts, which will be used by the `select-workspace-package` command.

This can be useful when you want to run some scripts which only exist in dependencies or dependents of selected package.
This can be useful when you want to run some scripts which only exist in the dependencies or dependents of the selected package.

## Providers

Expand Down