command-alias

Generate alias for different command system, support zsh/bash and Windows Command/PowerShell.

Usage

Installation

1# npm
2npm install @x-toolkit/command-alias --save-dev
3
4# yarn
5yarn add @x-toolkit/command-alias --dev
6
7# pnpm 
8pnpm add @x-toolkit/command-alias --save-dev

Api

Using the following api will generate a few alias file under output directory throught alias.yaml:

1import { generateCommandAliasByPlugin } from '@x-toolkit/command-alias'
2
3generateCommandAliasByPlugin('alias.yaml', 'output')

Params

1type generateCommandAliasByPlugin =  (
2  source: string,
3  outDir: string,
4  options?: Options
5) => Promise<void>
6
7type Options = {
8  filename?: string;
9  plugins?: string[];
10}

source

Alias config filepath, support json/yaml format.

Source file yaml example:

1part1:
2  sa: short alias
3part2:
4  saa: short alias with optionA
5  sab: short alias with optionB

outDir

Alias output directory, all alias files will be placed under outDir.

options

Optional configs.

options.filename

Define the output filename, default is alias.

options.plugins

Define the using plugins to generate, without specifying will use all plugins by default.

Support options:

• sh: for bash-like command, like zsh/bash
• bat: for Windows Command
• ps1: for Windows PowerShell

Development

Install dependencies:

1pnpm install

Make changes and run tests:

1pnpm run test

License

MIT