Skip to content

Commit

Permalink
Fixed for release.
Browse files Browse the repository at this point in the history
  • Loading branch information
Angelmaneuver committed Aug 15, 2024
1 parent 077700c commit 76c30d1
Show file tree
Hide file tree
Showing 23 changed files with 61 additions and 38 deletions.
97 changes: 60 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
<img alt="EyeCatch" src="docs/eyecatch.gif" />

<div align="center" style="text-align:center;">
<h1>Command Launcher</h1>
<p>A launcher extension that manages commands for the command palette and terminal command.</p>
<p>Toolbox to manage your extensions and terminal commands.</p>
<div>
<img alt="Version" src="https://img.shields.io/github/package-json/version/angelmaneuver/command-launcher?color=blue" />
<img alt="Version" src="https://img.shields.io/visual-studio-marketplace/v/angelmaneuver.command-launcher?color=blue" />
<img alt="Language" src="https://img.shields.io/badge/Language-en%2Cja-brightgreen?logo=Language">
<img alt="Installs" src="https://img.shields.io/visual-studio-marketplace/i/Angelmaneuver.command-launcher" />
<a href="https://codeclimate.com/github/Angelmaneuver/command-launcher/maintainability"><img src="https://api.codeclimate.com/v1/badges/423732b5edf0ced05786/maintainability" /></a>
<a href="https://codeclimate.com/github/Angelmaneuver/command-launcher/test_coverage"><img src="https://api.codeclimate.com/v1/badges/423732b5edf0ced05786/test_coverage" /></a>
Expand All @@ -13,79 +16,95 @@
</div>

## Usage
### Step1.

### Step1. Customize menu

Press `⇧⌘P` to bring up the command pallete and enter '`Command Launcher - Edit`'.

![Usage Step1. image](resource/readme/usage1.png)
![Usage Step1. Customize menu1 image](docs/usage/usage1.png)

### Step2.
Customize the menu as you like.
and Customize the menu as you like.

![Usage Step2. image](resource/readme/usage2.png)
![Usage Step1. Customize menu2 image](docs/usage/usage2.png)

### Step2. Run commands

### Step3.
Press `⇧⌘P` to bring up the command pallete and enter '`Command Launcher`'.

![Usage Step3-1. image](resource/readme/usage3-1.png)
![Usage Step2. Run commands](docs/usage/usage3.png)

Your own toolbox is ready!
Your toolbox is ready!

![Usage Step3-2. image](resource/readme/usage3-2.png)
![Usage Step2. Run commands](docs/usage/usage4.png)

## Feature
### Easy Setup
Just follow the guide to easily set the menu.

![Easy Setup image](resource/readme/demo1.gif)

### Command - Calling other extension
Check the `Feature Contributions` -> `Commands` -> `Name` of the extension you wish to call.

You can call the extensions you have installed.

<details><summary>Click here to see more detail on how to set up.</summary>

#### How to check the value

Check the Extension's page `FEATURES` -> `Commands` -> `ID` of the extension you wish to call.

Set its value as a command.

![Checkout1 image](resource/readme/demo2.png)
![Command1 image](docs/feature/command1-1.png)

\* In the image example, `wallpaper-setting.guidance`.

</details>

### Command - Calling VSCode's command
First, `Command Pallete` -> `Gear` in that order.

![Checkout2-1 image](resource/readme/demo3.png)
You can call the VSCode's commands.

<details><summary>Click here to see more detail on how to set up.</summary>

#### How to check the value

First, `Command Pallete` -> `You want to set the VSCode's command` -> `Gear (Configure Keybinding)`.

![Command2-1 image](docs/feature/command2-1.png)

The value entered in the filter is the value of the command you wish to call.

![Checkout2-2 image](resource/readme/demo4.png)
![Command2-2 image](docs/feature/command2-2.png)

\* In the image example, `workbench.action.editor.changeLanguageMode`.

</details>

### Terminal Command - Execute Terminal's command

You can execute terminal commands from the menu.

![Execute terminal command image](resource/readme/demo7.gif)
#### Question

Ability to assemble terminal command by typing or selecting from a pre-created set of choices.

#### Confirm

Ability to run terminal command without automatically run them, but only after confirm to see if they should be run.

#### Singleton

Are there any terminal commands that keep working? (e.g, a command that detects file change and recompiles them etc...)

The singleton feature allows you to have only one process execute that commands.

No more need to switch terminals!

![Singleton image](resource/readme/demo9.gif)

#### History

Having trouble entering the same terminal commands?

The history function eliminates that difficulty.

##### Usage
Press '⇧⌘P' to bring up the command pallete and enter 'Command Launcher - History'.

\* The history function is disabled by default.

![History image](resource/readme/demo8.png)

### Folder
You can create folders to manage commands.

![Folder image](resource/readme/demo5.gif)

### Uninstall

Didn't like this extension?

Sorry for not being able to help you.
Expand All @@ -94,10 +113,14 @@ Let's uninstall it and erase all settings related to this extension.

It won't pollute your environment.

![Uninstall image](resource/readme/demo6.gif)

## Cautions

### How will this extension affect your environment?

This extension will make changes to the following file.

1. settings.json

## External libraries used by this extension

1. [lodash](https://github.com/lodash/lodash)
Binary file added docs/eyecatch.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/feature/command1-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/feature/command2-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/feature/command2-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/usage/usage1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/usage/usage2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/usage/usage3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/usage/usage4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "command-launcher",
"displayName": "Command Launcher",
"description": "A launcher extension that manages commands for the command palette and terminal command.",
"description": "Toolbox to manage your extensions and terminal commands.",
"publisher": "Angelmaneuver",
"version": "1.0.0",
"homepage": "https://github.com/Angelmaneuver/command-launcher/blob/main/README.md#command-launcher",
Expand Down
Binary file removed resource/readme/demo1.gif
Binary file not shown.
Binary file removed resource/readme/demo2.png
Binary file not shown.
Binary file removed resource/readme/demo3.png
Binary file not shown.
Binary file removed resource/readme/demo4.png
Binary file not shown.
Binary file removed resource/readme/demo5.gif
Binary file not shown.
Binary file removed resource/readme/demo6.gif
Binary file not shown.
Binary file removed resource/readme/demo7.gif
Binary file not shown.
Binary file removed resource/readme/demo8.png
Binary file not shown.
Binary file removed resource/readme/demo9.gif
Binary file not shown.
Binary file removed resource/readme/usage1.png
Binary file not shown.
Binary file removed resource/readme/usage2.png
Binary file not shown.
Binary file removed resource/readme/usage3-1.png
Binary file not shown.
Binary file removed resource/readme/usage3-2.png
Binary file not shown.

0 comments on commit 76c30d1

Please sign in to comment.