Merge branch 'master' into feature/update-package.json

Author: gnikit

.vscode/launch.json

@@ -19,9 +19,7 @@
       "runtimeExecutable": "${execPath}",
       "args": [
         "${workspaceFolder}/test/resources",
-        "--install-extension",
-        "ms-vscode.cpptools",
-        "--disable-extensions",
+        "--disable-extension=fortran-lang.linter-gfortran",
         "--extensionDevelopmentPath=${workspaceFolder}",
         "--extensionTestsPath=${workspaceFolder}/out/test"
       ],

CONTRIBUTING.md

@@ -1,15 +1,67 @@
-# #CONTRIBUTING
+# Contributing
 
-You _always_ want to look at this file **before** contributing. In here you
-should find steps that you need to take to set up your development environment
-as well as instructions for coding standards and contribution guidelines.
+👍🎉 Thank you for taking the time to contribute! 🎉👍
+
+In this file you will find all the steps necessary to guide you through your first contribution to the project.
+
+Please note our [Code of Conduct](https://github.com/fortran-lang/.github/blob/main/CODE_OF_CONDUCT.md) and adhere to it in all your interactions with this project.
+
+## 📚 Getting Started
+
+### Downloading ⬇️
+
+Firstly, fork the repository from <https://github.com/fortran-lang/vscode-fortran-support>.
+
+Then clone the repository into your local machine.
+
+```sh
+[email protected]:<YOUR-USERNAME>/vscode-fortran-support.git
+```
+
+Where `<YOUR-USERNAME>` should be your GitHub username.
+
+### Dependencies
+
+To build this project you will need [NodeJS](https://nodejs.org/) `>= 16.13.1`.
+Open a terminal and run for a quick dependency installation:
+
+```sh
+npm ci
+```
+
+or for a full dependency installation:
+
+```sh
+npm install
+```
+
+### Compiling 🏗️
+
+During development, you can run a watcher to continuously check for changes and compile the extension:
+
+```sh
+npm run watch-dev
+```
+
+or do a standalone compilation via:
+
+```sh
+npm run compile-dev
+```
+
+👉 **Tip!** You can press <kbd>CTRL+SHIFT+B</kbd> (<kbd>CMD+SHIFT+B</kbd> on Mac) to start the watch task.
+
+### Developing & Debugging 🐞️
+
+You can now start writing code the `watcher` task will check for compilation errors.
+You can actively debug the extension by pressing <kbd>F5</kbd> with `Launch Extension` selected.
+
+👉 **Tip!** You don't need to stop and restart the development version of VS Code after each change. You can just execute `Reload Window` from the command palette in the
+VS Code window prefixed with `[Extension Development Host]`.
+
+
+
+https://user-images.githubusercontent.com/16143716/167411072-58a25378-13ad-41c5-bb20-2dacc8ad004a.mp4
 
-## Setup instructions
 
-First of all, this is a Visual Studio Code extension that uses TypeScript and tools based on [Node.js](https://nodejs.org/en/) with dependencies from npm. So you will need to have Node installed on your `$PATH`.
 
-1. Fork the repo
-2. Clone your fork
-3. Create a branch
-4. Run `npm install`
-5. To test the extension run `npm run test:grammar && npm test`

package-lock.json

@@ -375,6 +375,7 @@
   },
   "scripts": {
     "vscode:prepublish": "npm run compile",
+    "clean": "npx rimraf dist out .vscode-test",
     "compile": "webpack --mode production",
     "compile-dev": "webpack --mode development",
     "watch": "webpack --mode production --watch --progress",
@@ -396,12 +397,12 @@
     "@types/glob": "^7.2.0",
     "@types/mocha": "^9.1.0",
     "@types/node": "^16.11.33",
-    "@types/vscode": "^1.63.0",
+    "@types/vscode": "^1.67.0",
     "@types/which": "^2.0.1",
     "@typescript-eslint/eslint-plugin": "^5.22.0",
     "@typescript-eslint/parser": "^5.22.0",
     "@vscode/test-electron": "^2.1.2",
-    "eslint": "^8.14.0",
+    "eslint": "^8.15.0",
     "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-jsdoc": "^39.2.9",
     "eslint-plugin-prettier": "^4.0.0",

package.json

@@ -13,12 +13,7 @@ async function main() {
     // Passed to --extensionTestsPath
     const extensionTestsPath = path.resolve(__dirname, './index');
 
-    const launchArgs = [
-      workspacePath,
-      '--disable-extensions',
-      '--install-extension',
-      'ms-vscode.cpptools',
-    ];
+    const launchArgs = [workspacePath, '--disable-extensions'];
     // Download VS Code, unzip it and run the integration test
     await runTests({
       launchArgs,