https://github.com/iulianraduat/taskfile-launcher
A Visual Studio Code extension for displaying and running all tasks defined in a Taskfile.yml file
https://github.com/iulianraduat/taskfile-launcher
visual-studio-code-extension
Last synced: 10 months ago
JSON representation
A Visual Studio Code extension for displaying and running all tasks defined in a Taskfile.yml file
- Host: GitHub
- URL: https://github.com/iulianraduat/taskfile-launcher
- Owner: iulianraduat
- License: gpl-3.0
- Created: 2022-02-18T20:59:16.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-01T17:45:26.000Z (almost 2 years ago)
- Last Synced: 2025-04-03T00:32:35.675Z (about 1 year ago)
- Topics: visual-studio-code-extension
- Language: TypeScript
- Homepage:
- Size: 347 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Taskfile launcher
[](https://marketplace.visualstudio.com/items?itemName=iulian-radu-at.taskfile-launcher)
[](https://marketplace.visualstudio.com/items?itemName=iulian-radu-at.taskfile-launcher)
[](https://marketplace.visualstudio.com/items?itemName=iulian-radu-at.taskfile-launcher)
Automatically find all tasks defined in Taskfile.yml like files.
For more information about Taskfile.yml files visit [taskfile.dev](https://taskfile.dev/).
## Sponsorship
By purchasing [Coding Guidelines for React with TypeScript](https://www.amazon.com/dp/B0DD3DNDY1) from any Amazon website, you will get a set of guidelines for writing a clean, maintainable, and efficient code. Also you will sponsor me, showing your appreciation for my effort in creating and mentaining this extension.
## Features
- Automatically find all defined tasks in Taskfile.yml like files
- The tasks can be started in a terminal directly from Visual Studio Code interface
- The prerequisite is to have the command `task` already installed and available in PATH
## Usage
This extension has its own panel. The symbol of this panel is a similar with the official symbol of [task](https://taskfile.dev/).
Open the panel and the extension will start the scan for the tasks.
If you made changes to the taskfiles, the extension will not detect these to avoid unnecessary scans.
You can force a rescan using the reload button found at top right of the panel.
If there are no taskfiles or tasks in the taskfiles, the panel will display this information.
### Included files
By default, only Taskfile.yml files found in the folders of a workspace are found and scanned.
If you want to include other files you can define them in the settings of this extension.
Or you can add a section called taskfileLauncher in package.json
```json
# package.json
{
"taskfileLauncher": [ "**/Taskfile.yml" ]
}
```
Or create a file called .taskfileLauncher.json in the same folder with package.json
```json
# .taskfileLauncher.json
[ "**/Taskfile.yml" ]
```
If both are used then all globs will be used.
## Used terminal
The task will be started with the default terminal. This is defined in the Visual Studio Code setting "Terminal > Integrated > Default Profile: ". Take care that this setting will be ignored if there is defined any shell via the setting "terminal.integrated.shell." or any shell arguments via "terminal.integrated.shellArgs.".
### Screenshot
Bellow you can see an example of found tasks as are they displayed by this extension:
## Requirements
There are no special requirements.
## Extension Settings
- taskfileLauncher.debug:
- Taskfile launcher: log all actions in an output window
- default false
- taskfileLauncher.defaultResultExpanded:
- Taskfile launcher: show all found results initially expanded (otherwise collapsed)
- default false
- taskfileLauncher.taskfileNames:
- Taskfile launcher: list the name of all files containing tasks (as a glob)
- default Taskfile.yml
- taskfileLauncher.shellPath:
- Taskfile launcher: path to a shell executable to be used in the terminal
- default terminal configured in Visual Studio Code
- taskfileLauncher.shellArgs:
- Taskfile launcher: args for the shell executable defined in taskfileLauncher.shellPath (each argument is separated by a space)
- default none
## Known Issues
None.
## Change Log
See Change Log [here](CHANGELOG.md)
## Issues
Submit an [issue](https://github.com/iulian-radu-at/taskfile-launcher/issues) if you find any bug or have any request.
## Contribution
Fork the [repo](https://github.com/iulian-radu-at/taskfile-launcher) and submit pull requests.