mirror of
https://github.com/tauri-apps/plugins-workspace.git
synced 2026-01-31 00:45:24 +01:00
cf4d7d4e6c
* chore: adjust prettier config, .gitignore and use taplo to format toml files This brings the plugins-workspace repository to the same code style of the main tauri repo * format toml * ignore examples gen dir * add .vscode/extensions.json * remove packageManager field * fmt * fix audit * taplo ignore permissions autogenerated files * remove create dummy dist * fix prettier workflow * install fmt in prettier workflow --------- Co-authored-by: Lucas Nogueira <lucas@tauri.app>
73 lines
1.5 KiB
TypeScript
73 lines
1.5 KiB
TypeScript
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
/**
|
|
* Parse arguments from your Command Line Interface.
|
|
*
|
|
* @module
|
|
*/
|
|
|
|
import { invoke } from '@tauri-apps/api/core'
|
|
|
|
/**
|
|
* @since 2.0.0
|
|
*/
|
|
interface ArgMatch {
|
|
/**
|
|
* string if takes value
|
|
* boolean if flag
|
|
* string[] or null if takes multiple values
|
|
*/
|
|
value: string | boolean | string[] | null
|
|
/**
|
|
* Number of occurrences
|
|
*/
|
|
occurrences: number
|
|
}
|
|
|
|
/**
|
|
* @since 2.0.0
|
|
*/
|
|
interface SubcommandMatch {
|
|
name: string
|
|
matches: CliMatches
|
|
}
|
|
|
|
/**
|
|
* @since 2.0.0
|
|
*/
|
|
interface CliMatches {
|
|
args: Record<string, ArgMatch>
|
|
subcommand: SubcommandMatch | null
|
|
}
|
|
|
|
/**
|
|
* Parse the arguments provided to the current process and get the matches using the configuration defined [`tauri.cli`](https://tauri.app/v1/api/config/#tauriconfig.cli) in `tauri.conf.json`
|
|
*
|
|
* @example
|
|
* ```typescript
|
|
* import { getMatches } from '@tauri-apps/plugin-cli';
|
|
* const matches = await getMatches();
|
|
* if (matches.subcommand?.name === 'run') {
|
|
* // `./your-app run $ARGS` was executed
|
|
* const args = matches.subcommand?.matches.args
|
|
* if ('debug' in args) {
|
|
* // `./your-app run --debug` was executed
|
|
* }
|
|
* } else {
|
|
* const args = matches.args
|
|
* // `./your-app $ARGS` was executed
|
|
* }
|
|
* ```
|
|
*
|
|
* @since 2.0.0
|
|
*/
|
|
async function getMatches(): Promise<CliMatches> {
|
|
return await invoke('plugin:cli|cli_matches')
|
|
}
|
|
|
|
export type { ArgMatch, SubcommandMatch, CliMatches }
|
|
|
|
export { getMatches }
|