Visual Studio Code Snippets Builder

Enhance arcgis-js-vscode-snippets extension

Custom Snippet

> Official Visual Studio Code documentation: Snippets syntax

Prefix*

Prefix

Defines one or more trigger words that display the snippet in IntelliSense. Approximate string matching (fuzzy search) is performed on prefixes, so in this case, "fl" could match "FeatureLayer".

Recommendations
Good prefixes are short and easy to remember, so you can include the name of the method, class or property. Avoid using just acronyms. E.g. MapView, basemapsWithAPIKeys, findLayerByTitle, popupTemplateProps.

Name*

Name

Short description that follows the prefix.

Recommendations
Use plain English, using spaces as needed (length <35 characters). E.g. "Find layer in a MapView by title"

Language Snippet Scope*

Language Snippet Scope
Determines which programming languages or file types a snippet will appear in.

Recommendations
You can select multiple scopes for your snippet e.g "javascript, html"


Description

Description

It is an optional description of the snippet displayed by IntelliSense.

Recommendations
Explain of what the snippet does. Reuse text from the API reference whenever possible. Add AMD and ESM paths if it is a class initialization (new ...)

Body* (Prettier playground)

Description

Code snippet that will be place in the file. Newlines and embedded tabs will be formatted according to the context in which the snippet is inserted.

Recommendations
Use "Placeholders" (${1:foo}) and "Choices" (${1|value1,value2}) when possible.

Import Snippet

Import Snippet
Upload JSON snippet files directly from the computer.

Recommendations
Ensure that the JSON snippet file adheres to the correct format, including required fields such as name, prefix, body, and description.

For a sample snippet file, download sample.json.

Custom snippet code:

          
          
        

Do you think more users would benefit from this snippet?
If so, please consider contributing to the official extension:

Important
Before submitting your custom snippet proposal, please make sure it follows the conventions.
Read the arcgis-js-vscode-snippets conventions.

Submit proposal

Fork me on GitHub