@optique/git 0.9.0-dev.250 → 0.9.0-dev.252
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 +0 -29
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -91,7 +91,6 @@ const result = await parse(parser, ["main"]);
|
|
|
91
91
|
~~~~
|
|
92
92
|
|
|
93
93
|
Options:
|
|
94
|
-
- `fs`: Custom filesystem implementation (defaults to Deno or Node.js fs)
|
|
95
94
|
- `dir`: Git repository directory (defaults to current working directory)
|
|
96
95
|
- `metavar`: Metavar name for help text (default: `"BRANCH"`)
|
|
97
96
|
|
|
@@ -220,34 +219,6 @@ The factory returns a `GitParsers` object with the following methods:
|
|
|
220
219
|
- `ref(options?)` - Same as `gitRef()`
|
|
221
220
|
|
|
222
221
|
|
|
223
|
-
### `FileSystem` interface
|
|
224
|
-
|
|
225
|
-
Custom filesystem implementations must implement this interface for use with
|
|
226
|
-
Git parsers:
|
|
227
|
-
|
|
228
|
-
~~~~ typescript
|
|
229
|
-
import type { FileSystem } from "@optique/git";
|
|
230
|
-
|
|
231
|
-
const customFs: FileSystem = {
|
|
232
|
-
async readFile(path) { /* ... */ },
|
|
233
|
-
async writeFile(path, data) { /* ... */ },
|
|
234
|
-
async mkdir(path, options) { /* ... */ },
|
|
235
|
-
async rmdir(path, options) { /* ... */ },
|
|
236
|
-
async unlink(path) { /* ... */ },
|
|
237
|
-
async readdir(path) { /* ... */ },
|
|
238
|
-
async lstat(path) { /* ... */ },
|
|
239
|
-
async stat(path) { /* ... */ },
|
|
240
|
-
async readlink(path) { /* ... */ },
|
|
241
|
-
async symlink(target, path) { /* ... */ },
|
|
242
|
-
async chmod(path, mode) { /* ... */ },
|
|
243
|
-
async chown(path, uid, gid) { /* ... */ },
|
|
244
|
-
async rename(oldPath, newPath) { /* ... */ },
|
|
245
|
-
async copyFile(srcPath, destPath) { /* ... */ },
|
|
246
|
-
async exists(path) { /* ... */ },
|
|
247
|
-
};
|
|
248
|
-
~~~~
|
|
249
|
-
|
|
250
|
-
|
|
251
222
|
Shell completion
|
|
252
223
|
----------------
|
|
253
224
|
|