-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs(README): new feature instructions
- Loading branch information
Showing
2 changed files
with
9 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,7 +11,6 @@ success! | |
|
||
# Convenient | ||
❯ my-script | ||
zsh: command not found: my-script | ||
pjshell: falling back to npm-script: my-script | ||
|
||
> @pjshell/[email protected] my-script | ||
|
@@ -21,13 +20,13 @@ success! | |
❯ lint:style | ||
pjshell: falling back to npm-script: lint:style | ||
|
||
# Supports passing args | ||
❯ lint -- --format json | ||
# Supports passing args naturally | ||
❯ lint --format json | ||
pjshell: falling back to npm-script: lint | ||
|
||
``` | ||
|
||
This zsh plugin is for users who want to use pjshell globally on projects they do not own or without having to [use the pjshell package to persistently link a project's scripts](#to-do). | ||
This zsh plugin is for users who want to use pjshell globally on projects they do not own or without having to [use the pjshell package to persistently link a project's scripts](#to-do).[^0] | ||
|
||
## Requirements | ||
|
||
|
@@ -36,6 +35,8 @@ and must be installed. I might remove this requirement later… | |
|
||
## Installation | ||
|
||
For either method, the relative path to the temporary `.pjs` directory should be included in your $PATH (as early as possible). E.g.: `export -U PATH=./.pjs${PATH:+:$PATH}` | ||
|
||
### [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh/wiki/Customization#adding-a-new-plugin) | ||
|
||
```sh | ||
|
@@ -58,7 +59,9 @@ popd; | |
|
||
## To-do | ||
|
||
- [x] Suppress command-not-found error message if script matches | ||
- [ ] use pjshell to link the scripts per-project | ||
- [ ] Options for handling namespace conflicts (e.g., `test`) | ||
- [ ] Facilitate installation through `npm i -g @pjshell/zsh` | ||
- [ ] use pjshell to link the scripts per-project | ||
- [x] Suppress command-not-found error message if script matches | ||
|
||
[^0]: This plugin will create an emphemeral `.pjs` directory containing your scripts as executable files whenever you run a (non-existent) command that matches one of the scripts in the working directory's package.json. As soon as the command runs, the directory is torn down and removed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters