Engineering (#135)

* Fixup Development.md

* Sort package.json

Using https://www.npmjs.com/package/sort-package-json 1.57.0

* Add prettierrc

From mark-wiemer/vscode-helloworld

* Teardown format tests correctly

Previously tests were modifying the `in` sample files, which needed to be manually reverted.

Now tests do not change any of the files they touch.

* Convert grammar to YAML, run tests via CLI

* Add ESLint and fix problems

* Add validate script

* Add formatter

Remove `Getting started` as it's covered by `Contributing`

* Add pre-commit hooks

Excessive output: lint-staged/lint-staged#1145
nbd

.eslintrc

@@ -0,0 +1,17 @@
+{
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": 6,
+        "sourceType": "module"
+    },
+    "plugins": ["@typescript-eslint"],
+    "rules": {
+        "@typescript-eslint/naming-convention": "warn",
+        "@typescript-eslint/semi": "warn",
+        "curly": "warn",
+        "eqeqeq": "warn",
+        "no-throw-literal": "warn"
+    },
+    "ignorePatterns": ["out", "dist", "**/*.d.ts"]
+}

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/ISSUE_TEMPLATE/bug-report--non-formatter-.md

@@ -1,11 +1,11 @@
 ---
 name: Bug report (non-formatter)
-about: Report a bug with the extension. For issues with the formatter, please use
-  the "Formatting bug" template
+about:
+    Report a bug with the extension. For issues with the formatter, please use
+    the "Formatting bug" template
 title: ''
 labels: bug
 assignees: mark-wiemer
-
 ---
 
 ## Description
@@ -15,6 +15,7 @@ A clear and concise description of what the bug is.
 ## Reproduction steps
 
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '...'
 3. Scroll down to '...'

.github/ISSUE_TEMPLATE/feature_request.md

@@ -4,7 +4,6 @@ about: Suggest an idea for this project
 title: ''
 labels: enhancement
 assignees: mark-wiemer
-
 ---
 
 **Is your feature request related to a problem? Please describe.**

.github/ISSUE_TEMPLATE/formatting-bug.md

@@ -4,7 +4,6 @@ about: Report issues with code formatting
 title: ''
 labels: bug, formatter
 assignees: mark-wiemer
-
 ---
 
 ### Description

.github/ISSUE_TEMPLATE/other-issue.md

@@ -4,7 +4,4 @@ about: Not sure if it's a bug or a feature? Open a blank issue
 title: ''
 labels: ''
 assignees: mark-wiemer
-
 ---
-
-

.github/pull_request_template.md

@@ -1,7 +1,8 @@
 Closes #ISSUE.
 
 Changes proposed in this pull request:
-- CHANGE
+
+-   CHANGE
 
 ---
 

.gitignore

@@ -1,9 +1,13 @@
+# Contents of this file are also in `.prettierignore`
+
 # Folders
 .idea/
 .@vscode/test-electron/
+.vscode-test/
 node_modules
 out
 
 # Files
 .vscode/settings.json
-*.vsix
+*.vsix
+syntaxes/*.json

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

.prettierignore

@@ -0,0 +1,13 @@
+# From `.gitignore`
+
+# Folders
+.idea/
+.@vscode/test-electron/
+.vscode-test/
+node_modules
+out
+
+# Files
+.vscode/settings.json
+*.vsix
+syntaxes/*.json

.prettierrc

@@ -0,0 +1,7 @@
+singleQuote: true
+tabWidth: 4
+trailingComma: all
+overrides:
+  - files: ['*.yml', '*.yaml', '.prettierrc']
+    options:
+      tabWidth: 2

.vscode/launch.json

@@ -17,6 +17,7 @@
             "request": "launch",
             "runtimeExecutable": "${execPath}",
             "args": [
+                "--disable-extensions",
                 "--extensionDevelopmentPath=${workspaceFolder}",
                 "--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
             ],

Contributing.md

@@ -0,0 +1,24 @@
+# Contributing
+
+I welcome any issues or PRs :)
+
+## Running locally
+
+1. Clone the repo
+1. Install the relevant dependencies
+    - VS Code Insiders (needed to run the tests from CLI, see [using Insiders version for extension development](https://code.visualstudio.com/api/working-with-extensions/testing-extension#using-insiders-version-for-extension-development))
+    - Node 16 with npm 8
+1. `npm i`
+
+## Validate the build
+
+1. `npm run test`
+1. Go to `Run and Debug` viewlet (`Ctrl+Shift+D`) and click "Run Extension"
+
+## Automated checks
+
+All checks are found in `package.json`.
+
+    -   Test
+        -   Pretest (compile): tsc, js-yaml
+        -   Automated tests: Mocha

README.md

@@ -1,13 +1,14 @@
 # AutoHotkey Plus Plus (AHK++)
 
 AutoHotkey Plus Plus (AHK++) provides AutoHotkey language support for VS Code. This includes:
-- IntelliSense
-- code highlighting
-- basic debug support
-- code formatting
-- ...and more!
 
- AHK++ is a fork of [AutoHotkey Plus by cweijan](https://github.com/AutoHotkey-Plus/vscode-autohotkey), with the primary goal of fixing bugs and adding user-requested features.
+-   IntelliSense
+-   code highlighting
+-   basic debug support
+-   code formatting
+-   ...and more!
+
+AHK++ is a fork of [AutoHotkey Plus by cweijan](https://github.com/AutoHotkey-Plus/vscode-autohotkey), with the primary goal of fixing bugs and adding user-requested features.
 
 > View this README on the [project site](https://github.com/mark-wiemer/vscode-autohotkey-plus-plus#readme)
 

docs/Development.md

@@ -32,7 +32,7 @@ The tests should run automatically, and you should see passing output in the Deb
 1.  Bump the version in `package.json`. The message of the commit should be e.g. `v2.8.2`.
 1.  Push the changes.
 1.  Merge the PR. The body of the commit message should be the changelog entry.
-1.  Checkout `main`
+1.  `git checkout main`
 1.  Package the new version using `vsce package`.
 1.  Install the new version:
     1. Select the newly-created `.vsix` file.
@@ -48,10 +48,9 @@ The tests should run automatically, and you should see passing output in the Deb
 ### Publishing
 
 1. Tag the release
-    1. Delete the release branch in local
     1. `git checkout main`
-    1. `git tag v<major>.<minor>.<patch>`
-    1. `git push origin v<major>.<minor>.<patch>`
+    1. e.g. `git tag v2.8.2`
+    1. `git push origin v2.8.2`
     1. [Create a new release for this tag](https://github.com/mark-wiemer/vscode-autohotkey-plus-plus/tags)
         1. Release title: Same as in [Changelog.md](../Changelog.md)
         1. Description: Same as in changelog