You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-22Lines changed: 6 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,27 +1,5 @@
1
1
# command-signatures
2
2
3
-
## Cargo Dependency Tips
4
-
5
-
This repo is for the `warp-command-signatures` crate that is used as a dependency in `warp-internal`. In `warp-internal/Cargo.toml` you should see a line like this under `[workspace.dependencies]`:
When testing changes in `command-signatures` you can update that dependency to point to a local path. That will look something like this, depending on your directory structure:
Note that this `command-signatures` repo contains a Cargo workspace with two crates inside it and above we're telling `warp-internal` to get it's `warp-command-signatures` dependency from the `command-signatures` crate inside the `command-signatures` directory.
20
-
21
-
### Ready for Release
22
-
23
-
When your changes to `command-signatures` are complete, you can go back to the original `git` dependency definition in `warp-internal` and update the `rev` (revision) to point to the latest `command-signatures` commit hash after the change has been merged. That's how you tell `warp-internal` to start using your latest changes.
24
-
25
3
## JSON Command Signatures
26
4
27
5
The command signatures, a.k.a. "specs", are stored in the `./command-signatures/json`.
@@ -80,3 +58,9 @@ Options are therefore matched by the `OptionOverrides::name` field and positiona
80
58
**Note:** Overrides for all fields on `fig_types::{Arg, Option}` may not be implemented yet.
81
59
At the time of writing, _only_`template` is supported.
82
60
Others will need to be added as needed.
61
+
62
+
## License
63
+
64
+
This project is licensed under the MIT License. See the LICENSE file for details. Many of the signatures were adapted from Fig (https://github.com/withfig/autocomplete), which is also licensed under the MIT License.
65
+
66
+
Warp requires contributors to sign a contributor license agreement (CLA) before their contributions can be merged. You can read and sign our CLA at https://cla.warp.dev.
0 commit comments