Merge pull request #2 from scanapi/initial_version

Initial Version

Author: camilamaia

CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

README.md

@@ -0,0 +1,31 @@
+![](https://github.com/scanapi/design/raw/master/images/github-hero-dark.png)
+
+# Scanapi - IntelliSense
+
+An extension that provides code completion for the [ScanApi](https://github.com/scanapi/scanapi) specification.<bR>
+Check Scanapi's [documentation](https://github.com/scanapi/scanapi) for futher information about the specification.
+
+## Installing
+
+Preferably, install it from the VSCode Marketplace, but if for some reason you can't, you can download the latest stable version [here](https://github.com/scanapi/vscode-extension/releases).<br>
+Install it using:<br>
+`code --install-extension file_name_here.vsix`
+
+## Snippets
+
+|     Name | Result                                           |
+| -------: | ------------------------------------------------ |
+|   `cvar` | `Produces a custom var / ENV var interpolation.` |
+| `pycode` | `Produces a python code interpolation.`          |
+
+### `cvar`
+
+```
+${custom_var} or ${ENV_VAR}
+```
+
+### `pycode`
+
+```python
+${{assert 1 + 1 = 2}}
+```

images/scanapi.png

@@ -0,0 +1,43 @@
+{
+  "name": "scanapi-intellisense",
+  "displayName": "Scanapi - IntelliSense",
+  "description": "Provides code completion for the Scanapi YAML specification.",
+  "icon": "images/scanapi.png",
+  "version": "0.0.1",
+  "publisher": "scanapi",
+  "author": {
+    "name": "abreumatheus"
+  },
+  "license": "SEE LICENSE IN LICENSE",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/scanapi/vscode-extension"
+  },
+  "bugs": {
+    "url": "https://github.com/scanapi/vscode-extension/issues"
+  },
+  "engines": {
+    "vscode": "^1.47.0"
+  },
+  "categories": [
+    "Other"
+  ],
+  "activationEvents": [
+    "onLanguage:yaml"
+  ],
+  "main": "./out/extension.js",
+  "scripts": {
+    "vscode:prepublish": "npm run compile",
+    "compile": "tsc -p ./",
+    "lint": "eslint . --ext .ts,.tsx",
+    "watch": "tsc -watch -p ./"
+  },
+  "devDependencies": {
+    "@types/node": "^12.12.0",
+    "@types/vscode": "^1.32.0",
+    "@typescript-eslint/eslint-plugin": "^3.0.2",
+    "@typescript-eslint/parser": "^3.0.2",
+    "eslint": "^7.1.0",
+    "typescript": "^3.9.4"
+  }
+}

package.json

@@ -0,0 +1,59 @@
+import * as vscode from 'vscode';
+
+export function activate(context: vscode.ExtensionContext) {
+  const provider = vscode.languages.registerCompletionItemProvider('yaml', {
+    provideCompletionItems(
+      document: vscode.TextDocument,
+      position: vscode.Position,
+      token: vscode.CancellationToken,
+      context: vscode.CompletionContext,
+    ) {
+      const customVarSnippet = new vscode.CompletionItem('cvar');
+      customVarSnippet.insertText = new vscode.SnippetString('${${1}}');
+      customVarSnippet.documentation = new vscode.MarkdownString(
+        'Snippet for custom vars or ENV vars:\n`${custom_var}`\n`${ENV_VAR}`',
+      );
+
+      const pythonCodeSnippet = new vscode.CompletionItem('pycode');
+      pythonCodeSnippet.insertText = new vscode.SnippetString('${{${1}}}');
+      customVarSnippet.documentation = new vscode.MarkdownString(
+        'Snippet for python code, used for the tests section:\n`${{assert 1 + 1 == 2}}`',
+      );
+
+      const mainFileSnippets: Array<vscode.CompletionItem> = [
+        customVarSnippet,
+        pythonCodeSnippet,
+      ];
+
+      const mainFileCompletion: Array<vscode.CompletionItem> = [
+        new vscode.CompletionItem('endpoints:\n\t- name:'),
+        new vscode.CompletionItem('requests:\n\t- name:'),
+        new vscode.CompletionItem('tests:\n\t- name:'),
+        new vscode.CompletionItem('headers:\n\t- '),
+        new vscode.CompletionItem('vars:\n\t'),
+        new vscode.CompletionItem('name: '),
+        new vscode.CompletionItem('path: '),
+        new vscode.CompletionItem('method: '),
+        new vscode.CompletionItem('assert: '),
+        new vscode.CompletionItem('params: '),
+      ];
+
+      const configFileCompletion: Array<vscode.CompletionItem> = [
+        new vscode.CompletionItem('report:\n\t'),
+        new vscode.CompletionItem('hide-request\n\t'),
+        new vscode.CompletionItem('project_name: '),
+        new vscode.CompletionItem('spec_path: '),
+        new vscode.CompletionItem('output_path: '),
+        new vscode.CompletionItem('template: '),
+      ];
+
+      return [
+        ...mainFileCompletion,
+        ...mainFileSnippets,
+        ...configFileCompletion,
+      ];
+    },
+  });
+
+  context.subscriptions.push(provider);
+}

src/extension.ts

@@ -0,0 +1,15 @@
+{
+	"compilerOptions": {
+		"module": "commonjs",
+		"target": "es2019",
+		"lib": ["ES2019"],
+		"outDir": "out",
+		"sourceMap": true,
+		"strict": true,
+		"rootDir": "src"
+	},
+	"exclude": [
+		"node_modules",
+		".vscode-test"
+	]
+}