Skip to content

Commit

Permalink
chore: merge main conflicts
Browse files Browse the repository at this point in the history
  • Loading branch information
@iowillhoit
iowillhoit committed Mar 22, 2024
2 parents b799b38 + 5336f76 commit 2c722b4
Show file tree
Hide file tree
Showing 5 changed files with 135 additions and 43 deletions.
18 changes: 18 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
## [4.3.8](https://github.com/oclif/plugin-plugins/compare/4.3.7...4.3.8) (2024-03-19)

### Bug Fixes

- update npm version ([1f35a94](https://github.com/oclif/plugin-plugins/commit/1f35a9448d37970a270e45b028cd55f42ea17ecb))

## [4.3.7](https://github.com/oclif/plugin-plugins/compare/4.3.6...4.3.7) (2024-03-18)

### Bug Fixes

- **deps:** bump @oclif/core from 3.23.0 to 3.25.2 ([#823](https://github.com/oclif/plugin-plugins/issues/823)) ([80c8e6d](https://github.com/oclif/plugin-plugins/commit/80c8e6da04573ffc66eaf91046de4396c553c7ba))

## [4.3.6](https://github.com/oclif/plugin-plugins/compare/4.3.5...4.3.6) (2024-03-14)

### Bug Fixes

- bump version of npm ([151453f](https://github.com/oclif/plugin-plugins/commit/151453f0351c22ace3d5a8449b9774005f53283c))

## [4.3.5](https://github.com/oclif/plugin-plugins/compare/4.3.4...4.3.5) (2024-03-12)

### Bug Fixes
Expand Down
65 changes: 65 additions & 0 deletions CONRTIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Contributing

## Development

**1. Clone this repository...**

```bash
$ git clone [email protected]:oclif/plugin-plugins.git
```

**2. Navigate into project & install development-specific dependencies...**

```bash
$ cd ./plugin-plugins && yarn
```

**3. Write some code &/or add some tests...**

```bash
...
```

**4. Test changes locally**

To test using local dev script:

```
./bin/dev.js <command>
```

To test inside an existing oclif CLI (must have [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins) installed):

```
<CLI> plugins link --no-install
<CLI> <command>
```

See `plugins link` [documentation](https://github.com/oclif/plugin-plugins?tab=readme-ov-file#mycli-pluginslink-plugin)

**5. Run tests & ensure they pass...**

```
$ yarn test
```

**6. Open a [Pull Request](https://github.com/oclif/plugin-plugins/pulls) for your work & become the newest contributor to `@oclif/plugin-plugins`! 🎉**

## Pull Request Conventions

We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). When opening a pull request, please be sure that either the pull request title, or each commit in the pull request, has one of the following prefixes:

- `feat`: For when introducing a new feature. The result will be a new semver minor version of the package when it is next published.
- `fix`: For bug fixes. The result will be a new semver patch version of the package when it is next published.
- `docs`: For documentation updates. The result will be a new semver patch version of the package when it is next published.
- `chore`: For changes that do not affect the published module. Often these are changes to tests. The result will be _no_ change to the version of the package when it is next published (as the commit does not affect the published version).

## What _not_ to contribute?

### Dependencies

It should be noted that our team does not accept third-party dependency updates/PRs. We use dependabot to ensure dependencies are staying up-to-date & will ship security patches for CVEs as they occur. If you submit a PR trying to update our dependencies we will close it with or without a reference to these contribution guidelines.

### Tools/Automation

Our core team is responsible for the maintenance of the tooling/automation in this project & we ask collaborators to kindly not make changes to these when contributing (ex. `.github/*`, `.eslintrc.json`, package.json `scripts`, etc.)
59 changes: 34 additions & 25 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
plugins plugin for oclif

[![Version](https://img.shields.io/npm/v/@oclif/plugin-plugins.svg)](https://npmjs.org/package/@oclif/plugin-plugins)
[![Known Vulnerabilities](https://snyk.io/test/github/oclif/plugin-plugins/badge.svg)](https://snyk.io/test/github/oclif/plugin-plugins)
[![Downloads/week](https://img.shields.io/npm/dw/@oclif/plugin-plugins.svg)](https://npmjs.org/package/@oclif/plugin-plugins)
[![License](https://img.shields.io/npm/l/@oclif/plugin-plugins.svg)](https://github.com/oclif/plugin-plugins/blob/main/package.json)

Expand All @@ -16,6 +15,7 @@ plugins plugin for oclif
- [Aliases](#aliases)
- [Environment Variables](#environment-variables)
- [Commands](#commands)
- [Contributing](#contributing)
<!-- tocstop -->

# What is this?
Expand Down Expand Up @@ -90,7 +90,7 @@ For removing plugins that are no longer needed (either because they're sunset or

- [`mycli plugins`](#mycli-plugins)
- [`mycli plugins:inspect PLUGIN...`](#mycli-pluginsinspect-plugin)
- [`mycli plugins:install PLUGIN...`](#mycli-pluginsinstall-plugin)
- [`mycli plugins install PLUGIN`](#mycli-plugins-install-plugin)
- [`mycli plugins link PATH`](#mycli-plugins-link-path)
- [`mycli plugins reset`](#mycli-plugins-reset)
- [`mycli plugins uninstall [PLUGIN]`](#mycli-plugins-uninstall-plugin)
Expand All @@ -117,7 +117,7 @@ EXAMPLES
$ mycli plugins
```

_See code: [src/commands/plugins/index.ts](https://github.com/oclif/plugin-plugins/blob/4.3.6-beta.0/src/commands/plugins/index.ts)_
_See code: [src/commands/plugins/index.ts](https://github.com/oclif/plugin-plugins/blob/5.0.0-beta.4/src/commands/plugins/index.ts)_

## `mycli plugins:inspect PLUGIN...`

Expand All @@ -128,7 +128,7 @@ USAGE
$ mycli plugins inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
PLUGIN... [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
Expand All @@ -144,18 +144,18 @@ EXAMPLES
$ mycli plugins inspect myplugin
```

_See code: [src/commands/plugins/inspect.ts](https://github.com/oclif/plugin-plugins/blob/4.3.6-beta.0/src/commands/plugins/inspect.ts)_
_See code: [src/commands/plugins/inspect.ts](https://github.com/oclif/plugin-plugins/blob/5.0.0-beta.4/src/commands/plugins/inspect.ts)_

## `mycli plugins:install PLUGIN...`
## `mycli plugins install PLUGIN`

Installs a plugin into the CLI.
Installs a plugin into mycli.

```
USAGE
$ mycli plugins install PLUGIN...
$ mycli plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN Plugin to install.
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
Expand All @@ -167,28 +167,33 @@ GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installs a plugin into mycli.
Installation of a user-installed plugin will override a core plugin.
Uses bundled npm executable to install plugins into /Users/ewillhoit/.local/share/@oclif/plugin-plugins
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
Installation of a user-installed plugin will override a core plugin.
Use the MYCLI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the MYCLI_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ mycli plugins add
EXAMPLES
$ mycli plugins install myplugin
Install a plugin from npm registry.
$ mycli plugins install myplugin
Install a plugin from a github url.
$ mycli plugins install https://github.com/someuser/someplugin
$ mycli plugins install https://github.com/someuser/someplugin
$ mycli plugins install someuser/someplugin
Install a plugin from a github slug.
$ mycli plugins install someuser/someplugin
```

_See code: [src/commands/plugins/install.ts](https://github.com/oclif/plugin-plugins/blob/4.3.6-beta.0/src/commands/plugins/install.ts)_
_See code: [src/commands/plugins/install.ts](https://github.com/oclif/plugin-plugins/blob/5.0.0-beta.4/src/commands/plugins/install.ts)_

## `mycli plugins link PATH`

Expand Down Expand Up @@ -218,7 +223,7 @@ EXAMPLES
$ mycli plugins link myplugin
```

_See code: [src/commands/plugins/link.ts](https://github.com/oclif/plugin-plugins/blob/4.3.6-beta.0/src/commands/plugins/link.ts)_
_See code: [src/commands/plugins/link.ts](https://github.com/oclif/plugin-plugins/blob/5.0.0-beta.4/src/commands/plugins/link.ts)_

## `mycli plugins reset`

Expand All @@ -233,18 +238,18 @@ FLAGS
--reinstall Reinstall all plugins after uninstalling.
```

_See code: [src/commands/plugins/reset.ts](https://github.com/oclif/plugin-plugins/blob/4.3.6-beta.0/src/commands/plugins/reset.ts)_
_See code: [src/commands/plugins/reset.ts](https://github.com/oclif/plugin-plugins/blob/5.0.0-beta.4/src/commands/plugins/reset.ts)_

## `mycli plugins uninstall [PLUGIN]`

Removes a plugin from the CLI.

```
USAGE
$ mycli plugins uninstall [PLUGIN] [-h] [-v]
$ mycli plugins uninstall [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN plugin to uninstall
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
Expand All @@ -261,7 +266,7 @@ EXAMPLES
$ mycli plugins uninstall myplugin
```

_See code: [src/commands/plugins/uninstall.ts](https://github.com/oclif/plugin-plugins/blob/4.3.6-beta.0/src/commands/plugins/uninstall.ts)_
_See code: [src/commands/plugins/uninstall.ts](https://github.com/oclif/plugin-plugins/blob/5.0.0-beta.4/src/commands/plugins/uninstall.ts)_

## `mycli plugins update`

Expand All @@ -279,6 +284,10 @@ DESCRIPTION
Update installed plugins.
```

_See code: [src/commands/plugins/update.ts](https://github.com/oclif/plugin-plugins/blob/4.3.6-beta.0/src/commands/plugins/update.ts)_
_See code: [src/commands/plugins/update.ts](https://github.com/oclif/plugin-plugins/blob/5.0.0-beta.4/src/commands/plugins/update.ts)_

<!-- commandsstop -->

# Contributing

See [contributing guide](./CONRTIBUTING.md)
4 changes: 2 additions & 2 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"author": "Salesforce",
"bugs": "https://github.com/oclif/plugin-plugins/issues",
"dependencies": {
"@oclif/core": "^3.23.0",
"@oclif/core": "^3.25.2",
"chalk": "^5.3.0",
"debug": "^4.3.4",
"npm": "10.2.4",
Expand Down Expand Up @@ -36,7 +36,7 @@
"husky": "^9",
"lint-staged": "^15.2.2",
"mocha": "^10.3.0",
"oclif": "^4.4.17",
"oclif": "^4.5.4",
"prettier": "^3.2.5",
"shx": "^0.3.4",
"sinon": "^17",
Expand Down
32 changes: 16 additions & 16 deletions yarn.lock
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1313,10 +1313,10 @@
node-gyp "^10.0.0"
which "^4.0.0"

"@oclif/core@^3.21.0", "@oclif/core@^3.23.0":
version "3.23.0"
resolved "https://registry.yarnpkg.com/@oclif/core/-/core-3.23.0.tgz#d0ccc5f99c376e4bcfce04e8e94efae8417a53f8"
integrity sha512-giQ/8Ft8yXWg4IyPVtynPb7ihoQsa3A/1Q53UIJIhh+8k+EedE3lJ01yn6sq6Ha35IGqsG1WhkeHzlJIuldEaw==
"@oclif/core@^3.21.0", "@oclif/core@^3.23.0", "@oclif/core@^3.25.2":
version "3.25.2"
resolved "https://registry.yarnpkg.com/@oclif/core/-/core-3.25.2.tgz#a26d56abe5686c57c1e973957777bd2ae324e973"
integrity sha512-OkW/cNa/3DhoCz2YlSpymVe8DXqkoRaLY4SPTVqNVzR4R1dFBE5KoCtuwKwnhxYLCRCqaViPgRnB5K26f0MnjA==
dependencies:
"@types/cli-progress" "^3.11.5"
ansi-escapes "^4.3.2"
Expand Down Expand Up @@ -1354,7 +1354,7 @@
dependencies:
"@oclif/core" "^3.23.0"

"@oclif/plugin-not-found@^3.0.10":
"@oclif/plugin-not-found@^3.0.14":
version "3.0.14"
resolved "https://registry.yarnpkg.com/@oclif/plugin-not-found/-/plugin-not-found-3.0.14.tgz#a5eb6d38cd185e9d30178f5fbd0dc674dbae9b01"
integrity sha512-HLz04cmS+5F6Tsx1zQEoYV6wamDC/0cM2NqklPIEg8pq/JHPhktmhpzsGaRyBrtx4Pv+uNCo3s+mrTz2v5v03w==
Expand Down Expand Up @@ -2216,9 +2216,9 @@
integrity sha512-nG96G3Wp6acyAgJqGasjODb+acrI7KltPiRxzHPXnP3NgI28bpQDRv53olbqGXbfcgF5aiiHmO3xpwEpS5Ld9g==

"@types/node@*":
version "20.11.25"
resolved "https://registry.yarnpkg.com/@types/node/-/node-20.11.25.tgz#0f50d62f274e54dd7a49f7704cc16bfbcccaf49f"
integrity sha512-TBHyJxk2b7HceLVGFcpAUjsa5zIdsPWlR6XHfyGzd0SFu+/NFgQgMAl96MSDZgQDvJAvV6BKsFOrt6zIL09JDw==
version "20.11.28"
resolved "https://registry.yarnpkg.com/@types/node/-/node-20.11.28.tgz#4fd5b2daff2e580c12316e457473d68f15ee6f66"
integrity sha512-M/GPWVS2wLkSkNHVeLkrF2fD5Lx5UC4PxA0uZcKc6QqbIQUJyW1jVjueJYi1z8n0I5PxYrtpnPnWglE+y9A0KA==
dependencies:
undici-types "~5.26.4"

Expand All @@ -2228,9 +2228,9 @@
integrity sha512-qjd88DrCxupx/kJD5yQgZdcYKZKSIGBVDIBE1/LTGcNm3d2Np/jxojkdePDdfnBHJc5W7vSMpbJ1aB7p/Py69A==

"@types/node@^18":
version "18.19.22"
resolved "https://registry.yarnpkg.com/@types/node/-/node-18.19.22.tgz#f622f92514b897e6b09903e97c16a0db8e94689f"
integrity sha512-p3pDIfuMg/aXBmhkyanPshdfJuX5c5+bQjYLIikPLXAUycEogij/c50n/C+8XOA5L93cU4ZRXtn+dNQGi0IZqQ==
version "18.19.24"
resolved "https://registry.yarnpkg.com/@types/node/-/node-18.19.24.tgz#707d8a4907e55901466e60e8f7a62bc6197ace95"
integrity sha512-eghAz3gnbQbvnHqB+mgB2ZR3aH6RhdEmHGS48BnV75KceQPHqabkxKI0BbUSsqhqy2Ddhc2xD/VAR9ySZd57Lw==
dependencies:
undici-types "~5.26.4"

Expand Down Expand Up @@ -6637,16 +6637,16 @@ object.values@^1.1.7:
define-properties "^1.2.0"
es-abstract "^1.22.1"

oclif@^4.4.17:
version "4.5.2"
resolved "https://registry.yarnpkg.com/oclif/-/oclif-4.5.2.tgz#b90f9bb624fccb73e57dd733e3a5146f3eeb7599"
integrity sha512-9xUwaaNvdrN1tSx/jxKD1tsu/sR3ZHFv1f72S8GAZ01xmp5EGyRw97xUT64TFLPQLp/6h3zXm3VUwhZyCv9bkw==
oclif@^4.5.4:
version "4.5.4"
resolved "https://registry.yarnpkg.com/oclif/-/oclif-4.5.4.tgz#8b874dd3bbab1a16a4a72a1e7e3babd34c3614c4"
integrity sha512-3WVlr9FtTXiS5+kBmMdENvWwSHzhrfEpML6HgXDvyEYub3YeapbE60/sCvvNmgBDZ8vYnbOTf3RgqBt1oFo05Q==
dependencies:
"@aws-sdk/client-cloudfront" "^3.525.0"
"@aws-sdk/client-s3" "^3.515.0"
"@oclif/core" "^3.21.0"
"@oclif/plugin-help" "^6.0.14"
"@oclif/plugin-not-found" "^3.0.10"
"@oclif/plugin-not-found" "^3.0.14"
"@oclif/plugin-warn-if-update-available" "^3.0.12"
async-retry "^1.3.3"
change-case "^4"
Expand Down

0 comments on commit 2c722b4

Please sign in to comment.