mkvscode is a command-line tool for quickly setting up a Visual Studio Code project with predefined configurations for Python or Lua projects, as well as creating a git repo with the relevant .gitignore file.
- Creates a project folder with the specified name.
- Sets up a
README.mdfile. - Generates a source file with an appropriate extension based on the chosen language.
- Includes a
launch.jsonfor debugging configurations. - Prepares a Visual Studio Code workspace file.
- Adds a
.gitignorefile tailored for the project. - Commits the initial project setup to git.
- Optionally, opens the project in Visual Studio Code upon creation.
mkvscode [-o] <project_name> <language>
-o: Open the project in Visual Studio Code after creation.
project_name: Name of your project.language: Programming language for the project. Can be eitherpyfor Python orluafor Lua.
Create a Python project named "my_project":
mkvscode my_project py
Create a Lua project named "game_project" and open it in Visual Studio Code:
mkvscode -o game_project lua
To install mkvscode, clone the repository and add the path to your shell configuration file.
git clone https://github.com/<your-username>/mkvscode.git
echo 'export PATH="$PATH:/path/to/mkvscode"' >> ~/.bashrc
For zsh users, add to ~/.zshrc instead.
To contribute to mkvscode, please follow these steps:
- Fork the repository on GitHub.
- Clone your fork locally.
- Create a new feature branch (
git checkout -b my-new-feature). - Make your changes and commit them (
git commit -am 'Add some feature'). - Push the branch to GitHub (
git push origin my-new-feature). - Create a new Pull Request on GitHub from your feature branch.
mkvscode is open-sourced software licensed under the MIT license.