3 kind dev environment

.eslintrc.json

@@ -1,20 +1,43 @@
 {
     "root": true,
+	"extends": "eslint:recommended",
     "parser": "@typescript-eslint/parser",
     "parserOptions": {
-        "ecmaVersion": 6,
-        "sourceType": "module"
+		"project": "./tsconfig.json"
     },
     "plugins": [
         "@typescript-eslint"
     ],
     "rules": {
-        "@typescript-eslint/naming-convention": "warn",
+		"@typescript-eslint/adjacent-overload-signatures": "error",
+		"@typescript-eslint/await-thenable": "error",
+		//"@typescript-eslint/ban-ts-comment": "warn",
+		"@typescript-eslint/no-empty-interface": "error",
+		"@typescript-eslint/no-extra-non-null-assertion": "error",
+		"@typescript-eslint/no-for-in-array": "error",
+		"@typescript-eslint/no-misused-new": "error",
+		"@typescript-eslint/no-non-null-asserted-optional-chain": "error",
+		"@typescript-eslint/no-non-null-assertion": "warn",
+		"@typescript-eslint/no-this-alias": "error",
+		"@typescript-eslint/no-unnecessary-type-assertion": "error",
+		"@typescript-eslint/no-unnecessary-type-constraint": "error",
+		"@typescript-eslint/no-var-requires": "error",
+		"@typescript-eslint/prefer-as-const": "error",
+		"@typescript-eslint/prefer-namespace-keyword": "error",
+		"@typescript-eslint/restrict-plus-operands": "error",
+		"@typescript-eslint/restrict-template-expressions": "error",
+		"@typescript-eslint/triple-slash-reference": "error",
+		"@typescript-eslint/unbound-method": "error",
+		"@typescript-eslint/explicit-function-return-type": "warn",
+		"@typescript-eslint/naming-convention": "warn",
         "@typescript-eslint/semi": "warn",
         "curly": "warn",
         "eqeqeq": "warn",
-        "no-throw-literal": "warn",
-        "semi": "off"
+        "no-async-promise-executor": "off",
+		"no-throw-literal": "warn",
+		"no-undef":"off",
+		"no-unused-vars": "off",
+		"sort-imports":"warn"
     },
     "ignorePatterns": [
         "out",

.github/CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing to oc-vscode-extension
 
-All contributions are welcomed, thank you!
+All contributions are welcome, thank you!
 
 ## Useful Links
 
@@ -20,16 +20,21 @@ All you need is [VSCode][2] and [NodeJS][0].
 ### Project Layout
 
 - [src][10] contains the source code for the extension.
-- [integration-tests][11] contains the sources for integration testing.
-- [snippets][12] contains the snippets offered by the extension.
-- [templates][13] contains template files for orchestrating new projects.
-- [test-workspace][14] used for integration testing, git is keeping it and ignoring its content.
+- [tests][11] contains the sources for the unit tests.
+- [integration-tests][12] contains the sources for integration tests.
+- [snippets][13] contains the snippets offered by the extension.
+- [templates][14] contains template files for orchestrating new projects.
+- [images][15] contains various images used throughout the project.
+- [test-workspace][16] used for integration testing, git is keeping it and ignoring its content.
 
 ### NPM Scripts
 
 - `npm install` will install all the required modules for the project.
 - `npm run lint` will lint all _typescript_ sources.
-- `npm run build` will lint and compile the project.
+- `npm run tests` will run the unit tests.
+- `npm run tests:cov` will run the unit tests and verify and summarize the code coverage.
+- `npm run tests:cov-rep` will run the unit tests and verify the coverage creating an HTML coverage report.
+- `npm run build` will lint, compile, test, and verify the code coverage for the project.
 - `npm run clean:build` will remove any pre-compiled sources before building.
 - `npm run integration-tests` will run the integration tests.
 - `npm run clean` will remove the compiled sources
@@ -38,6 +43,27 @@ All you need is [VSCode][2] and [NodeJS][0].
 - `npm run clean:all` will execute the above three clean scripts.
 - `npm run vsce:package` will build the VSIX package.
 
+### Coding Guidelines
+
+For maintainability, readability, and testing purposes, as well as for the overall robustness of this project,
+we separate the various _vscode_ integrations from their underlying implementations.</br>
+
+For example, at the time of writing this, _vscode_ integrations reside in the [commands package][17] and the
+underlying implementations reside in the [utils package][18].</br>
+Take the layout of the package with a pinch of salt, but also take the following couple of rules of thumb under
+consideration while contributing code:
+
+- The _vscode_ integration part should be as small as possible, and functions should be perceived as wrappers for
+  the underlying implementations.
+- The underlying implementations should be completely decoupled from _vscode_'s API.
+
+In regards to testing,</br>
+_vscode_'s integration should be tested within the context of [integration tests][12],</br>
+the underlying implementations can, and probably should be tested within the context of [unit tests][11].
+
+As for commits and pull requests, we prefer [conventional commit messages][4], but we do not enforce it yet.
+Please be as informative as possible when opening pull requests.
+
 ### Launch Configurations
 
 - _Run Extension_ will run the extension in a separate _vscode instance_.
@@ -48,9 +74,14 @@ All you need is [VSCode][2] and [NodeJS][0].
 [1]: https://code.visualstudio.com/api
 [2]: https://code.visualstudio.com/
 [3]: https://github.com/ilan-pinto/ocm-vscode-extension/releases/tag/early-access
+[4]: https://www.conventionalcommits.org/
 <!-- CODE LINKS -->
 [10]: https://github.com/ilan-pinto/ocm-vscode-extension/tree/main/src
-[11]: https://github.com/ilan-pinto/ocm-vscode-extension/tree/main/integration-tests
-[12]: https://github.com/ilan-pinto/ocm-vscode-extension/tree/main/snippets
-[13]: https://github.com/ilan-pinto/ocm-vscode-extension/tree/main/templates
-[14]: https://github.com/ilan-pinto/ocm-vscode-extension/tree/main/test-workspace
+[11]: https://github.com/ilan-pinto/ocm-vscode-extension/tree/main/tests
+[12]: https://github.com/ilan-pinto/ocm-vscode-extension/tree/main/integration-tests
+[13]: https://github.com/ilan-pinto/ocm-vscode-extension/tree/main/snippets
+[14]: https://github.com/ilan-pinto/ocm-vscode-extension/tree/main/templates
+[15]: https://github.com/ilan-pinto/ocm-vscode-extension/tree/main/images
+[16]: https://github.com/ilan-pinto/ocm-vscode-extension/tree/main/test-workspace
+[17]: https://github.com/ilan-pinto/ocm-vscode-extension/tree/main/src/commands
+[18]: https://github.com/ilan-pinto/ocm-vscode-extension/tree/main/src/utils

.github/workflows/pr.yml

@@ -42,6 +42,9 @@ jobs:
           path: .vscode-test
           key: ${{ runner.os }}-vscode-test-${{ hashFiles('package.json') }}
 
+      - name: Run unit tests
+        run: npm test
+
       - name: Run integration tests linux
         if: runner.os == 'Linux'
         run: xvfb-run -a npm run integration-tests
@@ -51,5 +54,7 @@ jobs:
         run: npm run integration-tests
 
       - name: Create a VSIX package for target ${{ matrix.target }}
-        run: |
-          npm run vsce:package -- --target ${{ matrix.target }}
+        run: >
+          npm run vsce:package --
+          --target ${{ matrix.target }}
+          --out ocm-vscode-extension-${{ matrix.target }}-dev.vsix

.github/workflows/stage.yml

@@ -35,9 +35,14 @@ jobs:
       - name: Install project modules
         run: npm i
 
+      - name: Run unit tests
+        run: npm test
+
       - name: Create VSIX package
-        run: |
-          npm run vsce:package -- --target ${{ matrix.target }}
+        run: >
+          npm run vsce:package --
+          --target ${{ matrix.target }}
+          --out ocm-vscode-extension-${{ matrix.target }}-early-access.vsix
 
       - name: Upload VSIX package as artifact
         uses: actions/upload-artifact@v3

.gitignore

@@ -1,4 +1,6 @@
+.nyc_output
 .vscode-test
+coverage
 node_modules
 out
 # note the order of the next test-workspace records

.vscode/launch.json

@@ -26,7 +26,7 @@
 			"args": [
 				"--disable-extensions",
 				"--extensionDevelopmentPath=${workspaceFolder}",
-				"--extensionTestsPath=${workspaceFolder}/out/integration-tests/suite/index",
+				"--extensionTestsPath=${workspaceFolder}/out/integration-tests/suite",
 				"${workspaceFolder}/test-workspace"
 			],
 			"outFiles": [

.vscodeignore

@@ -1,12 +1,16 @@
 .git/**
 .github/**
+.nyc_output/**
 .vscode/**
 .vscode-test/**
+coverage/**
 images/**
 integration-tests/**
 out/integration-tests/**
 src/**
 test-workspace/**
+tests/**
+out/tests/**
 .editorconfig
 .eslintrc.json
 .gitignore
@@ -15,3 +19,4 @@ tsconfig.json
 **/*.ts
 **/*.vsix
 !images/icon.png
+!images/icon-black.svg

README.md

@@ -14,6 +14,13 @@ The `ocm-vscode-extension` helps quickly create Open Cluster Management (OCM) ap
 
 ![new-project][11]
 
+- Create a local environment using [kind][5], [clusteradm][6], and [kubectl][7]:
+  - Verify the existence of the required tools.
+  - Create as many [kind][5] clusters as you need.
+  - Initialize the _hub cluster_ using [clusteradm][6], and [kubectl][7].
+  - Send join requests from the _managed clusters_ to the _hub cluster_ using [clusteradm][6], and [kubectl][7].
+  - Accept the join requests from the _hub cluster_ using [clusteradm][6], and [kubectl][7].
+
 ## Installation
 
 This extension is still in development and is available as pre-release development snapshots only.</br>
@@ -40,6 +47,9 @@ See our [Contributing Guidelines][3] for more information.
 [2]: https://github.com/open-cluster-management-io/clusteradm
 [3]: https://github.com/ilan-pinto/ocm-vscode-extension/contribute
 [4]: https://github.com/ilan-pinto/ocm-vscode-extension/releases/tag/early-access
+[5]: https://kind.sigs.k8s.io/
+[6]: https://github.com/open-cluster-management-io/clusteradm
+[7]: https://kubernetes.io/docs/tasks/tools/
 <!-- GIFS -->
 [10]: https://raw.githubusercontent.com/ilan-pinto/ocm-vscode-extension/main/images/snippets-from-palette.gif
 [11]: https://raw.githubusercontent.com/ilan-pinto/ocm-vscode-extension/main/images/new-project.gif

integration-tests/runSuite.ts

@@ -1,8 +1,8 @@
-import * as path from 'path';
 import * as fse from 'fs-extra';
+import * as path from 'path';
 import { runTests } from '@vscode/test-electron';
 
-async function main() {
+async function main(): Promise<void> {
 	try {
 		// the folder containing the extension manifest package.json, passed to `--extensionDevelopmentPath`
 		const extensionDevelopmentPath: string = path.resolve(__dirname, '../../');

integration-tests/suite.ts

@@ -1,12 +1,13 @@
-import * as path from 'path';
 import * as Mocha from 'mocha';
 import * as glob from 'glob';
+import * as path from 'path';
 
 export function run(): Promise<void> {
 	// Create the mocha test
 	const mocha = new Mocha({
 		ui: 'tdd',
-		color: true
+		color: true,
+		slow: 600
 	});
 
 	const testsRoot: string = path.join(__dirname, 'test-files');