Добавлена ДБ
This commit is contained in:
134
node_modules/citty/README.md
generated
vendored
Normal file
134
node_modules/citty/README.md
generated
vendored
Normal file
@@ -0,0 +1,134 @@
|
||||
# 🌆 citty
|
||||
|
||||
[![npm version][npm-version-src]][npm-version-href]
|
||||
[![npm downloads][npm-downloads-src]][npm-downloads-href]
|
||||
[![bundle][bundle-src]][bundle-href]
|
||||
[![Codecov][codecov-src]][codecov-href]
|
||||
[![License][license-src]][license-href]
|
||||
|
||||
> Elegant CLI Builder
|
||||
|
||||
- Fast and lightweight argument parser based on [mri](https://github.com/lukeed/mri)
|
||||
- Smart value parsing with typecast, boolean shortcuts and unknown flag handling
|
||||
- Nested sub-commands
|
||||
- Lazy and Async commands
|
||||
- Plugable and composable API
|
||||
- Auto generated usage and help
|
||||
|
||||
🚧 This project is under heavy development. More features are coming soon!
|
||||
|
||||
## Usage
|
||||
|
||||
Install package:
|
||||
|
||||
```sh
|
||||
# npm
|
||||
npm install citty
|
||||
|
||||
# yarn
|
||||
yarn add citty
|
||||
|
||||
# pnpm
|
||||
pnpm install citty
|
||||
```
|
||||
|
||||
Import:
|
||||
|
||||
```js
|
||||
// ESM
|
||||
import { defineCommand, runMain } from "citty";
|
||||
|
||||
// CommonJS
|
||||
const { defineCommand, runMain } = require("citty");
|
||||
```
|
||||
|
||||
Define main command to run:
|
||||
|
||||
```ts
|
||||
import { defineCommand, runMain } from "citty";
|
||||
|
||||
const main = defineCommand({
|
||||
meta: {
|
||||
name: "hello",
|
||||
version: "1.0.0",
|
||||
description: "My Awesome CLI App",
|
||||
},
|
||||
args: {
|
||||
name: {
|
||||
type: "positional",
|
||||
description: "Your name",
|
||||
required: true,
|
||||
},
|
||||
friendly: {
|
||||
type: "boolean",
|
||||
description: "Use friendly greeting",
|
||||
},
|
||||
},
|
||||
run({ args }) {
|
||||
console.log(`${args.friendly ? "Hi" : "Greetings"} ${args.name}!`);
|
||||
},
|
||||
});
|
||||
|
||||
runMain(main);
|
||||
```
|
||||
|
||||
## Utils
|
||||
|
||||
### `defineCommand`
|
||||
|
||||
`defineCommand` is a type helper for defining commands.
|
||||
|
||||
### `runMain`
|
||||
|
||||
Runs a command with usage support and graceful error handling.
|
||||
|
||||
### `createMain`
|
||||
|
||||
Create a wrapper around command that calls `runMain` when called.
|
||||
|
||||
### `runCommand`
|
||||
|
||||
Parses input args and runs command and sub-commands (unsupervised). You can access `result` key from returnd/awaited value to access command's result.
|
||||
|
||||
### `parseArgs`
|
||||
|
||||
Parses input arguments and applies defaults.
|
||||
|
||||
### `renderUsage`
|
||||
|
||||
Renders command usage to a string value.
|
||||
|
||||
### `showUsage`
|
||||
|
||||
Renders usage and prints to the console
|
||||
|
||||
## Development
|
||||
|
||||
- Clone this repository
|
||||
- Install latest LTS version of [Node.js](https://nodejs.org/en/)
|
||||
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
|
||||
- Install dependencies using `pnpm install`
|
||||
- Run interactive tests using `pnpm dev`
|
||||
|
||||
## License
|
||||
|
||||
Made with 💛 Published under [MIT License](./LICENSE).
|
||||
|
||||
Argument parser is based on [lukeed/mri](https://github.com/lukeed/mri) by Luke Edwards ([@lukeed](https://github.com/lukeed)).
|
||||
|
||||
<!-- Badges -->
|
||||
|
||||
<!-- Badges -->
|
||||
|
||||
[npm-version-src]: https://img.shields.io/npm/v/citty?style=flat&colorA=18181B&colorB=F0DB4F
|
||||
[npm-version-href]: https://npmjs.com/package/citty
|
||||
[npm-downloads-src]: https://img.shields.io/npm/dm/citty?style=flat&colorA=18181B&colorB=F0DB4F
|
||||
[npm-downloads-href]: https://npmjs.com/package/citty
|
||||
[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/citty/main?style=flat&colorA=18181B&colorB=F0DB4F
|
||||
[codecov-href]: https://codecov.io/gh/unjs/citty
|
||||
[bundle-src]: https://img.shields.io/bundlephobia/minzip/citty?style=flat&colorA=18181B&colorB=F0DB4F
|
||||
[bundle-href]: https://bundlephobia.com/result?p=citty
|
||||
[license-src]: https://img.shields.io/github/license/unjs/citty.svg?style=flat&colorA=18181B&colorB=F0DB4F
|
||||
[license-href]: https://github.com/unjs/citty/blob/main/LICENSE
|
||||
[jsdocs-src]: https://img.shields.io/badge/jsDocs.io-reference-18181B?style=flat&colorA=18181B&colorB=F0DB4F
|
||||
[jsdocs-href]: https://www.jsdocs.io/package/citty
|
||||
Reference in New Issue
Block a user