Merge pull request #1 from JaredCE/javascript-testing-frameworks

Snippets for other testing frameworks

Author: JaredCE

.github/workflows/main.yml

@@ -0,0 +1,21 @@
+name: Deploy Extension
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Publish VS Code Extension
+        # You may pin to the exact commit or the version.
+        # uses: HaaLeo/publish-vscode-extension@c1a0486c5a3eed24e8c21d4e37889a7c4c60c443
+        uses: HaaLeo/publish-vscode-extension@v1
+        with:
+          # Personal access token
+          pat: ${{secrets.VSCODE_PUBLISHER_ACCESS_TOKEN}}
+          # Use the registry API at this base URL
+          registryUrl: https://marketplace.visualstudio.com
+          # Set this option to "true" to package your extension but do not publish it.
+          dryRun: true

.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+	"version": "0.2.0",
+	"configurations": [{
+			"name": "Run Extension",
+			"type": "extensionHost",
+			"request": "launch",
+			"runtimeExecutable": "${execPath}",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}"
+			],
+			"outFiles": [
+				"${workspaceFolder}/out/**/*.js"
+			],
+			// "preLaunchTask": "npm: watch"
+		}
+	]
+}

.vscodeignore

@@ -1,3 +1,5 @@
 .gitignore
+.github/**
+.vscode/**
 LICENSE
-CHANGELOG.md
+CHANGELOG.md

README.md

@@ -2,101 +2,164 @@
 ## VS Code JavaScript testing framework snippets
 -------------------
 
-<!-- [![Version](https://vsmarketplacebadge.apphb.com/version/xabikos.JasmineSnippets.svg)](https://marketplace.visualstudio.com/items?itemName=xabikos.JasmineSnippets)
-[![Installs](https://vsmarketplacebadge.apphb.com/installs/xabikos.JasmineSnippets.svg)](https://marketplace.visualstudio.com/items?itemName=xabikos.JasmineSnippets)
-[![Ratings](https://vsmarketplacebadge.apphb.com/rating/xabikos.JasmineSnippets.svg)](https://marketplace.visualstudio.com/items?itemName=xabikos.JasmineSnippets) -->
+<!-- [![Version](https://vsmarketplacebadge.apphb.com/version/JaredE.javascript-test-snippets.svg)](https://marketplace.visualstudio.com/items?itemName=JaredE.javascript-test-snippets)
+[![Installs](https://vsmarketplacebadge.apphb.com/installs/JaredE.javascript-test-snippets.svg)](https://marketplace.visualstudio.com/items?itemName=JaredE.javascript-test-snippets)
+[![Ratings](https://vsmarketplacebadge.apphb.com/rating/JaredE.javascript-test-snippets.svg)](https://marketplace.visualstudio.com/items?itemName=JaredE.javascript-test-snippets) -->
 
-This extension contains code snippets for various JavaScript testing frameworks, based off of the [Jasmine][jasmine] test framework and is based on the awesome [sublime-jasmine][sublime-jusmine] package by [@NicoSantangelo][NicoSantangelo].
+This extension contains code snippets for the three main JavaScript testing frameworks: Jasmine, Jest and Mocha.  You can switch between the code snippets available by setting your preferred framework at a User or Workspace level in the settings page.  You can also choose the quote style (*"*, *'* or *\`*) you prefer at a User or Workspace level for your `desc` methods.
 
-[Original][original] credit should goto [xabikos][xabikos] for writing this extension.
-
-## Installation
-
-In order to install an extension you need to launch the Command Palette (Ctrl + Shift + P or Cmd + Shift + P) and type Extensions.
-There you have either the option to show the already installed snippets or install new ones.
+[Original][original] credit should goto [xabikos][xabikos] for writing this extension which was based off of the [Jasmine][jasmine] test framework and is based on the awesome [sublime-jasmine][sublime-jusmine] package by [@NicoSantangelo][NicoSantangelo].
 
 ## Supported languages (file extensions)
 * JavaScript (.js)
 * TypeScript (.ts)
-* TypeScript React (.tsx)
-* JavaScript React (.jsx)
 
 ## Snippets
 
 Below is a list of all available snippets and the triggers of each one. The **→** means the `TAB` key.
 
-### Specs
+### Jest Commands
+| Trigger      | Content |
+| -------:     | ------- |
+| `aa→` | afterAll method |
+| `aaa→` | afterAllAsync method |
+| `ae→` | afterEach method |
+| `aea→` | afterEachAsync method |
+| `ba→` | beforeAll method |
+| `baa→` | beforeAllAsync method |
+| `be→` | beforeEach method |
+| `bea→` | beforeEachAsync method |
+| `desc→` | describe method |
+| `it→` | it method |
+| `ait→` | itAsync method |
+| `aat→` | afterAllTimeout method |
+| `aet→` | afterEachTimeout method |
+| `bat→` | beforeAllTimeout method |
+| `bet→` | beforeEachTimeout method |
+| `desce→` | describeEach method |
+| `desco→` | describeOnly method |
+| `desceo→` | describeOnlyEach method |
+| `descsk→` | describeSkip method |
+| `descse→` | describeSkipEach method |
+| `exp→` | expect method |
+| `expe→` | expect.extend method |
+| `expa→` | expect.anything method |
+| `exy→` | expect.any method |
+| `ac→` | expect.arrayContaining method |
+| `ass→` | expect.assertions method |
+| `ha→` | expect.hasAssertions method |
+| `nac→` | expect.not.arrayContaining method |
+| `noc→` | expect.not.objectContaining(object) method |
+| `nsc→` | expect.not.stringContaining method |
+| `nsm→` | expect.not.stringMatching method |
+| `oc→` | expect.objectContaining method |
+| `sc→` | expect.stringContaining method |
+| `sm→` | expect.stringMatching method |
+| `ass→` | expect.addSnapshotSerializer method |
+| `ito→` | itOnly method |
+| `itsk→` | itSkip method |
+| `not→` | not method |
+| `res→` | resolves method |
+| `rej→` | rejects method |
+| `te→` | test method |
+| `tea→` | testAsync method |
+| `tee→` | testEach method |
+| `teo→` | testOnly method |
+| `teoe→` | testOnlyEach method |
+| `tsk→` | testSkip method |
+| `tske→` | testSkipEach method |
+| `ttodo→` | testToDo method |
+| `tb→` | toBe method |
+| `tbc→` | toHaveBeenCalled method |
+| `bct→` | toHaveBeenCalledTimes method |
+| `bcw→` | toHaveBeenCalledWith method |
+| `bclw→` | toHaveBeenLastCalledWith method |
+| `bncw→` | toHaveBeenNthCalledWith method |
+| `hr→` | toHaveReturned method |
+| `hrt→` | toHaveReturnedTimes method |
+| `hrw→` | toHaveReturnedWith method |
+| `hlrw→` | toHaveLastReturnedWith method |
+| `tnrw→` | toHaveNthReturnedWith method |
+| `hl→` | toHaveLength method |
+| `hp→` | toHaveProperty method |
+| `bclt→` | toBeCloseTo method |
+| `tbd→` | toBeDefined method |
+| `tbf→` | toBeFalsy method |
+| `gt→` | toBeGreaterThan method |
+| `gte→` | toBeGreaterThanOrEqual method |
+| `lt→` | toBeLessThan method |
+| `lte→` | toBeLessThanOrEqual method |
+| `bio→` | toBeInstanceOf method |
+| `bnu→` | toBeNull method |
+| `btr→` | toBeTruthy method |
+| `bund→` | toBeUndefined method |
+| `bnan→` | toBeNaN method |
+| `tcon→` | toContain method |
+| `tce→` | toContainEqual method |
+| `te→` | toEqual method |
+| `tm→` | toMatch method |
+| `tmo→` | toMatchObject method |
+| `tms→` | toMatchSnapshot method |
+| `tmis→` | toMatchInlineSnapshot method |
+| `tse→` | toStrictEqual method |
+| `ttr→` | toThrow method |
+| `ttrer→` | toThrowErrorMatchingSnapshot method |
+| `tterrin→` | toThrowErrorMatchingInlineSnapshot method |
+
+### Jasmine Commands
+
 | Trigger      | Content |
 | -------:     | ------- |
-| `desc→`      | describe method |
-| `xdesc→`     | xdescribe method |
-| `fdesc→`     | fdescribe method |
-| `it→`        | it method |
-| `ait→`       | async it method |
-| `xit→`       | xit method |
-| `fit→`       | fit method |
-| `ae→`        | after each method |
-| `aa→`        | after all methods |
-| `be→`        | before each method |
-| `ba→`        | before all methods |
+| `aa→` | afterAll method |
+| `aaa→` | afterAllAsync method |
+| `ae→` | afterEach method |
+| `aea→` | afterEachAsync method |
+| `ba→` | beforeAll method |
+| `baa→` | beforeAllAsync method |
+| `be→` | beforeEach method |
+| `bea→` | beforeEachAsync method |
+| `desc→` | describe method |
+| `it→` | it method |
+| `ait→` | itAsync method |
+| `aat→` | afterAllTimeout method |
+| `aet→` | afterEachTimeout method |
+| `bat→` | beforeAllTimeout method |
+| `bet→` | beforeEachTimeout method |
+| `exp→` | expect method |
+| `expa→` | expectAsync method |
+| `fa→` | fail method |
+| `fdesc→` | focusDescribe method |
+| `fit→` | focusedIt method |
+| `pen→` | pending method |
+| `ssp→` | setSpecProperty method |
+| `ssup→` | setSuiteProperty method |
+| `so→` | spyOn method |
+| `soaf→` | spyOnAllFunctions method |
+| `spg→` | spyOnProperty get method |
+| `sps→` | spyOnProperty set method |
+| `xdesc→` | xDescribe method |
+| `xit→` | xIt method |
+| `xait→` | xItAsync method |
 
-### Expectations
-| Trigger  | Content |
-| -------: | ------- |
-| `exp→` 	 | expect |
-| `tb→`    | expect().toBe |
-| `tbct→`  | expect().toBeCloseTo |
-| `tbd→`   | expect().toBeDefined |
-| `tbf→`   | expect().toBeFalsy |
-| `tbgt→`  | expect().toBeGreaterThan |
-| `tblt→`  | expect().toBeLessThan |
-| `tbn→`   | expect().toBeNull |
-| `tbt→`   | expect().toBeTruthy |
-| `tbu→`   | expect().toBeUndefined |
-| `tc→`    | expect().toContain |
-| `te→`    | expect().toEqual |
-| `thbc→`  | expect().toHaveBeenCalled |
-| `thbcw→` | expect().toHaveBeenCalledWith |
-| `tm→`    | expect().toMatch |
-| `tt→`    | expect().toThrow |
-| `tte→`   | expect().toThrowError |
-| `nb→`    | expect().not.toBe |
-| `nct→`   | expect().not.toBeCloseTo |
-| `nd→`    | expect().not.toBeDefined |
-| `nf→`    | expect().not.toBeFalsy |
-| `ngt→`   | expect().not.toBeGreaterThan |
-| `nlt→`   | expect().not.toBeLessThan |
-| `nn→`    | expect().not.toBeNull |
-| `nt→`    | expect().not.toBeTruthy |
-| `nu→`    | expect().not.toBeUndefined |
-| `nc→`    | expect().not.toContain |
-| `ne→`    | expect().not.toEqual |
-| `nm→`    | expect().not.toMatch |
-| `nt→`    | expect().not.toThrow |
-| `any→`   | jasmine.any |
-| `oc→`    | jasmine.objectContaining |
+### mocha commands
 
-### Spies
-| Trigger  | Content |
-| -------: | ------- |
-|`so→`     | spyOn |
-|`sct→`    | spyOn.and.callThrough |
-|`scf→`    | spyOn.and.callFake |
-|`spg→`     | spyOnProperty($obj,'$property', 'get') |
-|`sps→`     | spyOnProperty($obj,'$property', 'set') |
-|`srv→`    | spyOn.and.returnValue |
-|`ss→`     | spyOn.and.stub |
-|`ste→`    | spyOn.and.throwError |
-|`ca→`     | spy.calls.all |
-|`caa→`    | spy.calls.allArgs |
-|`ca→`     | spy.calls.any |
-|`caf→`    | spy.calls.argsFor |
-|`cc→`     | spy.calls.count |
-|`cf→`     | spy.calls.first |
-|`cmr→`    | spy.calls.mostRecent |
-|`cr→`     | spy.calls.reset |
-|`cs→`     | createSpy |
-|`cso→`    | createSpyObj |
+| Trigger      | Content |
+| -------:     | ------- |
+| `aa→` | afterAll method |
+| `aaa→` | afterAllAsync method |
+| `ae→` | afterEach method |
+| `aea→` | afterEachAsync method |
+| `ba→` | beforeAll method |
+| `baa→` | beforeAllAsync method |
+| `be→` | beforeEach method |
+| `bea→` | beforeEachAsync method |
+| `desc→` | describe method |
+| `it→` | it method |
+| `ait→` | itAsync method |
+| `desco→` | describeOnly method |
+| `descsk→` | describeSkip method |
+| `ito→` | itOnly method |
+| `itsk→` | itSkip method |
 
 [jasmine]: http://jasmine.github.io
 [sublime-jusmine]: https://github.com/NicoSantangelo/sublime-jasmine

extension.js

@@ -0,0 +1,58 @@
+'use strict';
+
+const vscode = require('vscode');
+const merge = require('lodash.merge')
+
+const generic = require('./snippets/frameworks/generic.json')
+const jasmine = require('./snippets/frameworks/jasmine.json')
+const mocha = require('./snippets/frameworks/mocha.json')
+const jest = require('./snippets/frameworks/jest.json')
+
+function activate(context) {
+    vscode.languages.registerCompletionItemProvider(
+        {language: 'javascript', scheme: 'file'},
+        {
+            provideCompletionItems(document, position, token, context) {
+                const quote = vscode.workspace.getConfiguration('javascript-test-snippets').get('quoteStyle', '"')
+                const framework = vscode.workspace.getConfiguration('javascript-test-snippets').get('framework', 'mocha')
+
+                let definedCompletions = generic
+
+                if (framework === 'mocha') {
+                    definedCompletions = merge(definedCompletions, mocha)
+                } else if (framework === 'jest') {
+                    definedCompletions = merge(definedCompletions, jest)
+                } else {
+                    definedCompletions = merge(definedCompletions, jasmine)
+                }
+
+                const completions = []
+                for (const testCompletion in definedCompletions) {
+                    let item = new vscode.CompletionItem(
+                        {
+                            label: definedCompletions[testCompletion].prefix,
+                            description: definedCompletions[testCompletion].description,
+                        },
+                        vscode.CompletionItemKind.Snippet
+                    )
+                    let insertTextOriginal = definedCompletions[testCompletion].body
+                    const newQuoteInsertText = insertTextOriginal.replaceAll("'", quote)
+                    item.insertText = new vscode.SnippetString(newQuoteInsertText)
+                    completions.push(item)
+                }
+
+                return new vscode.CompletionList(completions)
+
+            }
+        }
+    )
+}
+
+// this method is called when your extension is deactivated
+function deactivate() {}
+
+// eslint-disable-next-line no-undef
+module.exports = {
+	activate,
+	deactivate
+}