Skip to content

Commit

Permalink
docs(dev): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tomgao365 committed Jun 22, 2024
1 parent e57e799 commit 67f4a58
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 32 deletions.
29 changes: 13 additions & 16 deletions packages/vscode-dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ npm add @tomjs/vscode-dev -D
```bash
$ vscode-dev --help

vscode-dev/2.0.0
vscode-dev/3.0.0

Usage:
$ vscode-dev [cwd]
Expand All @@ -43,21 +43,22 @@ For more info, run any command with the `--help` flag:
$ vscode-dev --help

Options:
--locales [locales] Specify i18n directory (default: locales)
--lang [lang] Specify i18n source language (default: en)
--dts-dir [dtsDir] Specify the output directory of d.ts. If not specified, generated in the order "types", "extension", "src", "."
--dts-name [dtsName] Specify the output file name of d.ts (default: vscode.d.ts)
-w, --watch Watch mode
--verbose Display verbose output (default: true)
-h, --help Display this message
-v, --version Display version number
--config [config] The config file path
--locales [locales] Specify i18n directory (default: locales)
--lang [lang] Specify i18n source language (default: en)
--dts-dir [dtsDir] Specify the output directory of d.ts. If not specified, generated in the order "types", "extension", "src", "."
--dts-name [dtsName] Specify the output file name of d.ts (default: vscode.d.ts)
--builtin [...builtin] Builtin commands
-w, --watch Watch mode
--verbose Display verbose output
-h, --help Display this message
-v, --version Display version number
```

- vscode.d.ts
### vscode.d.ts

```ts
// generated by @tomjs/vscode-dev

import '@tomjs/vscode';

declare module '@tomjs/vscode' {
Expand All @@ -75,11 +76,7 @@ declare module '@tomjs/vscode' {
}

declare module 'vscode' {
export type BuiltinCommand =
| 'workbench.action.reloadWindow'
| 'workbench.extensions.installExtension'
| 'workbench.extensions.uninstallExtension';

export type BuiltinCommand = undefined;
export type UserCommand = 'tomjs.xxx.showHello';

export namespace commands {
Expand Down
30 changes: 14 additions & 16 deletions packages/vscode-dev/README.zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ npm add @tomjs/vscode-dev -D
```bash
$ vscode-dev --help

vscode-dev/2.0.0
vscode-dev/3.0.0

Usage:
$ vscode-dev [cwd]
Expand All @@ -43,21 +43,22 @@ For more info, run any command with the `--help` flag:
$ vscode-dev --help

Options:
--locales [locales] Specify i18n directory (default: locales)
--lang [lang] Specify i18n source language (default: en)
--dts-dir [dtsDir] Specify the output directory of d.ts. If not specified, generated in the order "types", "extension", "src", "."
--dts-name [dtsName] Specify the output file name of d.ts (default: vscode.d.ts)
-w, --watch Watch mode
--verbose Display verbose output (default: true)
-h, --help Display this message
-v, --version Display version number
--config [config] The config file path
--locales [locales] Specify i18n directory (default: locales)
--lang [lang] Specify i18n source language (default: en)
--dts-dir [dtsDir] Specify the output directory of d.ts. If not specified, generated in the order "types", "extension", "src", "."
--dts-name [dtsName] Specify the output file name of d.ts (default: vscode.d.ts)
--builtin [...builtin] Builtin commands
-w, --watch Watch mode
--verbose Display verbose output
-h, --help Display this message
-v, --version Display version number
```

- vscode.d.ts
### vscode.d.ts

```ts
// generated by @tomjs/vscode-dev

import '@tomjs/vscode';

declare module '@tomjs/vscode' {
Expand All @@ -75,11 +76,7 @@ declare module '@tomjs/vscode' {
}

declare module 'vscode' {
export type BuiltinCommand =
| 'workbench.action.reloadWindow'
| 'workbench.extensions.installExtension'
| 'workbench.extensions.uninstallExtension';

export type BuiltinCommand = undefined;
export type UserCommand = 'tomjs.xxx.showHello';

export namespace commands {
Expand Down Expand Up @@ -108,6 +105,7 @@ declare module 'vscode' {
export interface StatusBarItem {
command?: BuiltinCommand | UserCommand;
}
}
```

### config
Expand Down

0 comments on commit 67f4a58

Please sign in to comment.