Skip to content

ArthurSudbrackIbarra/cloney-vscode-extension

Repository files navigation

Cloney

This extension provides enhanced support for the Cloney tool, making it easier to work with Cloney template repositories directly from within the Visual Studio Code environment.



What is Cloney?

Cloney is a versatile tool designed for cloning and creating dynamic template git repositories. With Cloney, you can define reusable templates with Go template syntax, making it a powerful solution for creating dynamic and adaptable projects.

Features

  • Custom Icons:

    • Provides custom icons for .cloney.yaml and .cloney-vars files.

      Custom Icons

  • Snippets and Autocompletion:

    • Supports .cloney.yaml metadata file.

      Metadata File Snippets

    • Supports .cloney-vars variables file.

      Local Variables: Variables File Snippets

      Remote Variables: Remote Variables File Snippets

    • Provides partial autocompletion for Go template syntax.

      Go Template Autocompletion

  • Run Cloney Commands through VSCode UI:

    • Execute Cloney commands (Clone, Dry-run, and Validate) via F1 or Ctrl + Shift + P.

      Run Cloney Commands

Requirements

  1. To use this extension, you should have Cloney installed on your machine. If you haven't installed Cloney yet, the extension guides you to the installation page. In case you don't want to install Cloney, the extension offers the option to run Cloney commands from within Docker containers.

  2. For the remote variables feature, you also need to have Git installed on your machine.

Extension Settings

This extension contributes the following settings:

  • cloney.cloneyExecutablePath: (Optional) The absolute path to the Cloney executable.
  • cloney.dockerExecutablePath: (Optional) The absolute path to the Docker executable. Only applicable if you want to run Cloney commands from within Docker containers.
  • cloney.enableGoTemplatesSuggestions: Whether or not to enable Go Templates suggestions when a Cloney metadata file (.cloney.yaml) is present.

Contributing

If you find any issues or have suggestions, feel free to contribute or open an issue on GitHub.

License

This extension is licensed under the MIT License - see the LICENSE file for details.