Snippets support

Author: chenglou

CONTRIBUTING.md

@@ -46,6 +46,10 @@ For more grammar inspirations, check:
 - [TypeScript's grammar](https://github.com/microsoft/TypeScript-TmLanguage/blob/a771bc4e79deeae81a01d988a273e300290d0072/TypeScript.YAML-tmLanguage)
 - [Writing a TextMate Grammar: Some Lessons Learned](https://www.apeth.com/nonblog/stories/textmatebundle.html)
 
+### Snippets
+
+Snippets are also synced from https://github.com/rescript-lang/rescript-sublime. VSCode snippets docs [here](https://code.visualstudio.com/api/references/contribution-points#contributes.snippets).
+
 ## Editor Diagnostics
 
 They should be synced in from `lib/bs/.compiler.log` build. Don't take them from other places.

HISTORY.md

@@ -1,3 +1,9 @@
+## 1.0.x (Unreleased)
+
+- All the usual features now work on `bsconfig.json` too!
+- Snippets, for ease a few syntaxes.
+- Improved highlighting for polymorphic variants
+
 ## 1.0.1
 
 - Fix temp file creation logic.

README.md

@@ -2,6 +2,8 @@
 
 The official VSCode plugin for ReScript.
 
+![ezgif com-video-to-gif-2](https://user-images.githubusercontent.com/1909539/101266821-790b1400-3707-11eb-8e9f-fb7e36e660e6.gif)
+
 ## Prerequisite
 
 You **must** have `bs-platform 8.3.3` installed locally in your project, through the usual [npm installation](https://rescript-lang.org/docs/manual/latest/installation#integrate-into-existing-js-project). Older versions are not guaranteed to work.
@@ -20,9 +22,12 @@ The plugin activates on `.res` and `.resi` files. If you've already got Reason-L
   - Cannot be a temporary file.
 - Syntax errors diagnosis (only after formatting).
 - Built-in bsb watcher (optional, and exposed explicitly as a pop-up; no worries of dangling build).
-- Type diagnosis.
+- Type hint.
 - Jump to location.
 - Autocomplete.
+- Snippets to ease a few syntaxes:
+  - `external` features such as `@bs.module` and `@bs.val`
+  - `try`, `for`, etc.
 
 ### Upcoming Features
 

package.json

@@ -29,6 +29,12 @@
 				"url": "https://raw.githubusercontent.com/rescript-lang/rescript-compiler/master/docs/docson/build-schema.json"
 			}
 		],
+		"snippets": [
+			{
+				"language": "rescript",
+				"path": "./snippets.json"
+			}
+		],
 		"taskDefinitions_unused": [
 			{
 				"type": "bsb",

snippets.json

@@ -0,0 +1,91 @@
+{
+	"Module": {
+		"prefix": [
+			"module"
+		],
+		"body": [
+			"module ${1:Name} = {",
+			"\t${2:// Module contents}",
+			"}"
+		]
+	},
+	"Switch": {
+		"prefix": [
+			"switch"
+		],
+		"body": [
+			"switch ${1:value} {",
+			"| ${2:pattern1} => ${3:expression}",
+			"${4:| ${5:pattern2} => ${6:expression}}",
+			"}"
+		]
+	},
+	"Try": {
+		"prefix": [
+			"try"
+		],
+		"body": [
+			"try {",
+			"\t${1:expression}",
+			"} catch {",
+			"| ${2:MyException} => ${3:expression}",
+			"}"
+		]
+	},
+	"For Loop": {
+		"prefix": [
+			"for"
+		],
+		"body": [
+			"for ${1:i} in ${2:startValueInclusive} to ${3:endValueInclusive} {",
+			"\t${4:Js.log(${1:i})}",
+			"}"
+		]
+	},
+	"Reverse For Loop": {
+		"prefix": [
+			"for"
+		],
+		"body": [
+			"for ${1:i} in ${2:startValueInclusive} downto ${3:endValueInclusive} {",
+			"\t${4:Js.log(${1:i})}",
+			"}"
+		]
+	},
+	"Global External Object": {
+		"prefix": [
+			"@bs",
+			"external"
+		],
+		"body": [
+			"@val external ${1:setTimeout}: ${2:(unit => unit, int) => float} = \"${3:setTimeout}\""
+		]
+	},
+	"Global External Module": {
+		"prefix": [
+			"@bs",
+			"external"
+		],
+		"body": [
+			"@scope(\"${1:Math}\") @val external ${2:random}: ${3:unit => float} = \"${4:random}\""
+		]
+	},
+	"JS Module External": {
+		"prefix": [
+			"@bs",
+			"external"
+		],
+		"body": [
+			"@module(\"${1:path}\") external ${2:dirname}: ${3:string => string} = \"${4:dirname}\""
+		]
+	},
+	"JS Module Default External": {
+		"prefix": [
+			"@bs",
+			"external"
+		],
+		"body": [
+			"@module external ${1:leftPad}: ${2:(string, int) => string} = \"${3:leftPad}\""
+		]
+	}
+}