Skip to content

Commit

Permalink
task: Renames package to @release-it-plugins/workspaces
Browse files Browse the repository at this point in the history
  • Loading branch information
scalvert committed Jul 20, 2022
1 parent 93d0400 commit 3ec6c11
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 8 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ folder and calling `npm publish`).
Installation using your projects normal package manager, for example:

```sh
npm install --save-dev @release-it/workspaces

# or

yarn add --dev --ignore-workspace-root-check @release-it-plugins/workspaces
```

Expand Down Expand Up @@ -62,7 +66,7 @@ A quick summary (in TypeScript syntax) of the supported options (more details
on each just below):

```ts
interface ReleaseItYarnWorkSpacesConfiguration {
interface ReleaseItWorkSpacesConfiguration {
/**
Disables checks for `npm` registry and login info.
Expand Down Expand Up @@ -178,9 +182,9 @@ used.
### workspaces

The list of workspaces is gathered from the `package.json` in the current
working directory. This is the same location that `yarn install` uses, and it
working directory. This is the same location that `npm install`/`yarn install` uses, and it
is a great default for `@release-it-plugins/workspaces`. In some circumstances, the
workspace settings that `yarn` should use differ from the actual locations that
workspace settings that `npm`/`yarn` should use differ from the actual locations that
are published. Most commonly this is due to a custom build script that emits
the compiled and ready to publish packages into a different location (e.g.
`dist/packages/*`).
Expand Down
2 changes: 1 addition & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ npm install --global release-it
* Second, ensure that you have installed your projects dependencies:

```
yarn install
npm install
```

* And last (but not least 😁) do your release. It requires a
Expand Down
4 changes: 2 additions & 2 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ function resolveWorkspaces(workspaces) {
}

throw new Error(
"This package doesn't use yarn workspaces. (package.json doesn't contain a `workspaces` property)"
"This package doesn't use workspaces. (package.json doesn't contain a `workspaces` property)"
);
}

Expand Down Expand Up @@ -118,7 +118,7 @@ class JSONFile {
}
}

export default class YarnWorkspacesPlugin extends Plugin {
export default class WorkspacesPlugin extends Plugin {
static isEnabled(options) {
return fs.existsSync(ROOT_MANIFEST_PATH) && options !== false;
}
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"name": "@release-it-plugins/workspaces",
"version": "2.0.1",
"description": "release-it plugin for bumping and publishing yarn workspaces",
"description": "release-it plugin for bumping and publishing workspaces",
"keywords": [
"release",
"release-it",
"release-it-plugin",
"plugin"
],
"repository": "https://github.com/rwjblue/@release-it-plugins/workspaces",
"repository": "https://github.com/@release-it-plugins/workspaces",
"license": "MIT",
"author": "Robert Jackson <me@rwjblue.com>",
"type": "module",
Expand Down

0 comments on commit 3ec6c11

Please sign in to comment.