@optique/git 1.0.0-dev.692 → 1.0.0-dev.701
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -10
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -30,7 +30,8 @@ Quick start
|
|
|
30
30
|
|
|
31
31
|
~~~~ typescript
|
|
32
32
|
import { gitBranch, gitTag, gitCommit } from "@optique/git";
|
|
33
|
-
import {
|
|
33
|
+
import { object } from "@optique/core/constructs";
|
|
34
|
+
import { argument, option } from "@optique/core/primitives";
|
|
34
35
|
import { parseAsync } from "@optique/core/parser";
|
|
35
36
|
|
|
36
37
|
const parser = object({
|
|
@@ -53,7 +54,8 @@ Use `createGitParsers()` to create parsers for a different repository:
|
|
|
53
54
|
|
|
54
55
|
~~~~ typescript
|
|
55
56
|
import { createGitParsers } from "@optique/git";
|
|
56
|
-
import {
|
|
57
|
+
import { object } from "@optique/core/constructs";
|
|
58
|
+
import { argument, option } from "@optique/core/primitives";
|
|
57
59
|
import { parseAsync } from "@optique/core/parser";
|
|
58
60
|
|
|
59
61
|
const git = createGitParsers({ dir: "/path/to/repo" });
|
|
@@ -79,7 +81,8 @@ existing branch in the repository.
|
|
|
79
81
|
|
|
80
82
|
~~~~ typescript
|
|
81
83
|
import { gitBranch } from "@optique/git";
|
|
82
|
-
import {
|
|
84
|
+
import { object } from "@optique/core/constructs";
|
|
85
|
+
import { argument } from "@optique/core/primitives";
|
|
83
86
|
import { parseAsync } from "@optique/core/parser";
|
|
84
87
|
|
|
85
88
|
const parser = object({
|
|
@@ -102,7 +105,8 @@ existing branch on the specified remote.
|
|
|
102
105
|
|
|
103
106
|
~~~~ typescript
|
|
104
107
|
import { gitRemoteBranch } from "@optique/git";
|
|
105
|
-
import {
|
|
108
|
+
import { object } from "@optique/core/constructs";
|
|
109
|
+
import { option } from "@optique/core/primitives";
|
|
106
110
|
import { parseAsync } from "@optique/core/parser";
|
|
107
111
|
|
|
108
112
|
const parser = object({
|
|
@@ -120,7 +124,8 @@ in the repository.
|
|
|
120
124
|
|
|
121
125
|
~~~~ typescript
|
|
122
126
|
import { gitTag } from "@optique/git";
|
|
123
|
-
import {
|
|
127
|
+
import { object } from "@optique/core/constructs";
|
|
128
|
+
import { option } from "@optique/core/primitives";
|
|
124
129
|
import { parseAsync } from "@optique/core/parser";
|
|
125
130
|
|
|
126
131
|
const parser = object({
|
|
@@ -138,7 +143,8 @@ remote in the repository.
|
|
|
138
143
|
|
|
139
144
|
~~~~ typescript
|
|
140
145
|
import { gitRemote } from "@optique/git";
|
|
141
|
-
import {
|
|
146
|
+
import { object } from "@optique/core/constructs";
|
|
147
|
+
import { option } from "@optique/core/primitives";
|
|
142
148
|
import { parseAsync } from "@optique/core/parser";
|
|
143
149
|
|
|
144
150
|
const parser = object({
|
|
@@ -156,7 +162,8 @@ A value parser for commit SHAs. Validates that the input is a valid commit SHA
|
|
|
156
162
|
|
|
157
163
|
~~~~ typescript
|
|
158
164
|
import { gitCommit } from "@optique/git";
|
|
159
|
-
import {
|
|
165
|
+
import { object } from "@optique/core/constructs";
|
|
166
|
+
import { option } from "@optique/core/primitives";
|
|
160
167
|
import { parseAsync } from "@optique/core/parser";
|
|
161
168
|
|
|
162
169
|
const parser = object({
|
|
@@ -174,7 +181,8 @@ that the input resolves to a valid Git reference.
|
|
|
174
181
|
|
|
175
182
|
~~~~ typescript
|
|
176
183
|
import { gitRef } from "@optique/git";
|
|
177
|
-
import {
|
|
184
|
+
import { object } from "@optique/core/constructs";
|
|
185
|
+
import { option } from "@optique/core/primitives";
|
|
178
186
|
import { parseAsync } from "@optique/core/parser";
|
|
179
187
|
|
|
180
188
|
const parser = object({
|
|
@@ -192,7 +200,8 @@ created by the factory share the same filesystem and directory options.
|
|
|
192
200
|
|
|
193
201
|
~~~~ typescript
|
|
194
202
|
import { createGitParsers } from "@optique/git";
|
|
195
|
-
import {
|
|
203
|
+
import { object } from "@optique/core/constructs";
|
|
204
|
+
import { argument, option } from "@optique/core/primitives";
|
|
196
205
|
import { parseAsync } from "@optique/core/parser";
|
|
197
206
|
|
|
198
207
|
const git = createGitParsers({ dir: "/path/to/repo" });
|
|
@@ -224,7 +233,8 @@ the user's input prefix.
|
|
|
224
233
|
|
|
225
234
|
~~~~ typescript
|
|
226
235
|
import { gitBranch } from "@optique/git";
|
|
227
|
-
import {
|
|
236
|
+
import { object } from "@optique/core/constructs";
|
|
237
|
+
import { argument } from "@optique/core/primitives";
|
|
228
238
|
|
|
229
239
|
const parser = object({
|
|
230
240
|
branch: argument(gitBranch()),
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@optique/git",
|
|
3
|
-
"version": "1.0.0-dev.
|
|
3
|
+
"version": "1.0.0-dev.701+138e5e73",
|
|
4
4
|
"description": "Git value parsers for Optique",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"CLI",
|
|
@@ -59,7 +59,7 @@
|
|
|
59
59
|
"dependencies": {
|
|
60
60
|
"@logtape/logtape": "^1.2.2",
|
|
61
61
|
"isomorphic-git": "^1.36.1",
|
|
62
|
-
"@optique/core": "1.0.0-dev.
|
|
62
|
+
"@optique/core": "1.0.0-dev.701+138e5e73"
|
|
63
63
|
},
|
|
64
64
|
"devDependencies": {
|
|
65
65
|
"@types/node": "^20.19.9",
|