https://github.com/Gruntfuggly/auto-snippet

A vscode extension to automatically insert a predefined snippet when a file is created, or an empty file is opened.
https://github.com/Gruntfuggly/auto-snippet

Last synced: 2 months ago
JSON representation

A vscode extension to automatically insert a predefined snippet when a file is created, or an empty file is opened.

• Host: GitHub
• URL: https://github.com/Gruntfuggly/auto-snippet
• Owner: Gruntfuggly
• License: other
• Created: 2018-11-09T16:03:54.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-06-14T11:23:14.000Z (over 3 years ago)
• Last Synced: 2024-08-03T09:07:51.628Z (6 months ago)
• Language: JavaScript
• Size: 21.5 KB
• Stars: 14
• Watchers: 2
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: License.txt

Awesome Lists containing this project

• awesome-github-star - auto-snippet

README

        
# Auto Snippet

This extension automatically inserts a predefined snippet when a file is created, or an empty file is opened.

This allows templates for classes etc. to be inserted with all the benefits of placeholders and regular expressions, etc.

## Configuration

There is one configuration setting which maps filename globs (or language IDs) to snippet names. For example, to match a typescript filename in any folder, use one of the following:

- set `"pattern"` to `"**/*.ts"`

- set `"regex"` to `".*\.ts"`

- set `"language"` to `"typescript"`.

You can also specify an array of commands to execute after inserting the snippet. *Note: The commands are not executed synchronously. If no snippet is configured, the commands are still run*.

Example:

```javascript

autoSnippet.snippets: [

    { "pattern": "**/ut-*.cpp", "snippet": "ut-template" },

    { "pattern": "**/*.h", "snippet": "header-template" },

    { "pattern": "**/*.cpp", "snippet": "body-template" },

    { "language": "javascript", "snippet": "template", "commands":[ "editor.action.commentLine" ] }

]

```

*Note: The patterns are matched in order of definition. The first one that matches will be used.*

Use F1, **Preferences: Configure User Snippets** to configure your snippets. For more information on configuration snippets, see [here](https://code.visualstudio.com/docs/editor/userdefinedsnippets).

### Output Channel

There is also an output channel which can be enabled via the settings. This can be used to check pattern matches, etc.

## Installing

You can install the latest version of the extension via the Visual Studio Marketplace [here](https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.auto-snippet).

### Source Code

The source code is available on GitHub [here](https://github.com/Gruntfuggly/auto-snippet).

## Credits

Icon made by [Freepik](https://www.freepik.com) from [www.flaticon.com](https://www.flaticon.com/) is licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/).