内容简介:Opaline— a CLI tools framework and compiler. It draws inspiration from
Opaline – CLI Tools Framework
Opaline— a CLI tools framework and compiler. It draws inspiration from NextJS (and similar projects) and provides a quick, convention based, way of creating CLI tools.
-
It looks for files in
./commands
folder and treats them as commands for a CLI:-
commands └── build.ts # Means it can be run as following: λ cli build
-
-
Command file must export a function (can be async function too):
-
export default function myCommand() {} // or module.exports = async function myCommand() {};
-
-
Uses JSDoc to describe parameters and documentation for a CLI. Read more on supported JSDoc syntax and how to use it.
Table of Contents
Usage
Use a generator to bootstrap an Opaline based CLI:
λ npx @opaline/core create app λ cd app λ npm install
Compile the CLI:
λ npm run build λ npm run dev # for dev mode with watch and auto linking
Creating Commands
By default generator creates commands/index.js
file, which is a default command, and can be run without specifying a command name:
λ cli --param1 20
But if required there might be multiple commands in one CLI. In order to do that, we just need to create another file in ./commands
folder (or rename index.js
, it's not required to have a default command):
// ./commands/build.js export default function build() { console.log("hello build!"); }
Adding Command Parameters and Documentation
Opaline uses JSDoc to define parameters and documentation for a command:
// ./commands/build.js /** * Description of a command is just a comment above the command's function. * Params are described as JSDoc params: * * @param {string} name Name of an app to build * @param {string} [lang="TypeScript"] A parameter with default value */ export default function build(name, lang) { console.log(`hello ${name}, language ${lang}`); }
Help will be generated for both default and this new command:
λ examples-for-docs --help # help for the whole cli, with list of commands VERSION examples-for-docs/0.0.0 USAGE examples-for-docs inputs --param1 10 --param2 20 **** COMMANDS build Description of a command is just a comment above the command's function. Params are described as JSDoc params: > NOTE: To view the usage information for a specific command, run 'examples-for-docs [COMMAND] --help' OPTIONS --param1 Some parameter for a CLI with a default value [number] [default: 20] --param2 Some parameter for a CLI [string] --help Output usage information --version Output the version number λ examples-for-docs build --help # help for a subcommand Description of a command is just a comment above the command's function. Params are described as JSDoc params: OPTIONS --name Name of an app to build [string] --lang A parameter with default value [string] [default: "TypeScript"]
JSDoc
Opalineuses JSDoc to describe command's parameters and documentation.
Supported JSDoc Tags
Tag | Description |
---|---|
@param – https://jsdoc.app/tags-param.html |
Supports primitive types: string , number , boolean . And arrays of strings string[] |
@example |
Note: only one line examples : @example {cliName} --params 10 |
Extra JSDoc Tags
Tag | Description |
---|---|
@usage |
Similar to example, but outlines the main example on how to use a CLI command. @usage {cliName} build |
{cliName} |
A variable that will be replaced by the name of a CLI tool described in package.json . Supported by @usage and @example |
package.json
Opaline gets multiple things from a package.json
file, to even more reduce configuration:
package.json#bin
https://docs.npmjs.com/files/package.json#bin
There are 2 way of using the bin
field in package.json
:
// 1 { "name": "cli-name", "bin": "./cli/cli.js" } // 2 { "name": "cli-name", "bin": { "cli-name": "./cli/cli.js" } }
Opalinesupports both of them. And uses those fields in a following way:
- Path to a CLI file – For both cases the file path is used as an output target for a CLI entry point, and will be automatically created by Opaline, no need to manually create it.
- Name of a CLI – For [1] the name will be
package.json#name
, if you need to have a different name than the name of a package, use an option 2. Name is used as{cliName}
in JSDoc and also when linking packages in dev mode. Which makes them accessible globally, by this name:-
cli-name [COMMAND]
-
package.json#description
Used as main description for a CLI tool.
Examples
Tools built with Opaline :
Screenshots
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持 码农网
猜你喜欢:本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们。
Artificial Intelligence
Stuart Russell、Peter Norvig / Pearson / 2009-12-11 / USD 195.00
The long-anticipated revision of this #1 selling book offers the most comprehensive, state of the art introduction to the theory and practice of artificial intelligence for modern applications. Intell......一起来看看 《Artificial Intelligence》 这本书的介绍吧!