Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kcmr/vshelper
CLI tool to configure VSCode projects and tasks from customizable settings.json and task.json files
https://github.com/kcmr/vshelper
cli polymer utility vscode
Last synced: about 2 months ago
JSON representation
CLI tool to configure VSCode projects and tasks from customizable settings.json and task.json files
- Host: GitHub
- URL: https://github.com/kcmr/vshelper
- Owner: kcmr
- License: mit
- Created: 2017-07-16T10:52:54.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-08-06T21:14:38.000Z (over 7 years ago)
- Last Synced: 2024-11-09T05:37:02.304Z (3 months ago)
- Topics: cli, polymer, utility, vscode
- Language: JavaScript
- Size: 6.84 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# VS project helper
> A CLI tool to configure a directory as a Visual Studio Code project with typical settings for a Web Component using Polymer, a Polymer app or your own project types.
## Motivation
Unfortunately, Visual Studio Code does not have at the moment global tasks, task templates or something similar, so I usually find myself copying and pasting settings and tasks from project to project.
This script simply copies a basic predefined settings.json and tasks.json files into the current directory by executing the `vsproject` command.
The default settings and tasks are meant for Web Components and apps using Polymer, but you can customize your tasks and project types to suit your own needs.
## Install
npm install -g vsproject
## Usage
In a component (default type)
vsproject
In an app
vsproject --type app
## Customize settings, tasks and project types
You can use your own predefined set of tasks or settings by placing a settings.json and/or tasks.json file inside a folder named as the type of project you want to set (eg.: component (default), app, your-own-project-type) in `~/.vscode/vsproject//`.
__Example:__
The following tasks.json template will be used for "dummy" projects:
In `~/.vscode/vsproject/dummy/tasks.json`:
{
// my own tasks for dummy projects
}
In your project directory:
$ vsproject --type dummy
## Running tasks in VSCode
Show the command palette (`Cmd+P`) and type `task` followed by a space to show the available tasks.
Additionally you can set your own custom key shortcut to show the project tasks by adding the following to your keybindings.json:
{
"key": "ctrl+t", // your own keybinding
"command": "workbench.action.tasks.runTask"
}
## Demo
