Merge pull request #57 from paulober/develop

Major update v3

Author: paulober

.editorconfig

@@ -0,0 +1,6 @@
+tab_width = 2
+indent_style = space
+indent_size = 2
+charset = utf-8
+insert_final_newline = true
+trim_trailing_whitespace = true

.eslintrc.json

@@ -2,14 +2,20 @@
     "root": true,
     "parser": "@typescript-eslint/parser",
     "parserOptions": {
-        "ecmaVersion": 11,
+        "ecmaVersion": 12,
         "sourceType": "module"
     },
     "plugins": [
         "@typescript-eslint"
     ],
     "rules": {
         "@typescript-eslint/naming-convention": "warn",
+        "@typescript-eslint/no-unused-vars": "warn",
+        "@typescript-eslint/no-explicit-any": "warn",
+        "@typescript-eslint/array-type": ["error", { "default": "array-simple" }],
+        "@typescript-eslint/consistent-type-imports": ["error", { "prefer": "type-imports" }],
+        "@typescript-eslint/explicit-function-return-type": ["error", { "allowExpressions": true }],
+        "@typescript-eslint/consistent-type-exports": "error",
         "@typescript-eslint/semi": "warn",
         "curly": "warn",
         "eqeqeq": "warn",
@@ -18,7 +24,13 @@
         "no-mixed-requires":"error",
         "no-this-before-super": "warn",
         "no-unreachable": "warn",
-        "no-unused-vars": "warn"
+        "no-unused-vars": "off",
+        "max-len": ["warn", { "code": 80, "comments": 100, "ignoreComments": false }],
+        "no-fallthrough": "warn",
+        "newline-before-return": "warn",
+        "no-return-await": "warn",
+        "arrow-body-style": ["error", "as-needed"],
+        "no-unexpected-multiline": "error"
     },
     "ignorePatterns": [
         "out",
@@ -30,5 +42,11 @@
         "es6": true,
         "commonjs": true,
         "browser": false
-    }
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:@typescript-eslint/recommended-requiring-type-checking",
+        "prettier"
+    ]
 }

.github/CONTRIBUTING.md

@@ -1,13 +1,30 @@
 # Contributing
 
-When contributing to this repository, please first discuss the change you wish to make via an issue, email, or any other method with the owners of this repository before making a change.
+When contributing to this repository, please first discuss the change you wish to make via an issue with the owners of this repository before making a change.
 
 ::Please note we have a Code of Conduct, please follow it in all your interactions with the project.::
 
 ## Pull Request Process
 
-1. Update the `README.md` with details of changes to the interface, this includes new environment variables, useful file locations and container parameters.
-2. Increase the version numbers in any examples files and the `README.md` to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](https://semver.org).
+### - NPM setup
+In order to install `paulober/pyboard-serial-com` sub-package you first have configure npm. See ["Configuring npm for use with GitHub Package Registry."](https://help.github.com/en/articles/configuring-npm-for-use-with-github-package-registry#authenticating-to-github-package-registry)
+
+### Repository setup
+1. Fork the repository into your private account
+2. Create a branch with following naming scheeme `fix-<issue-id>-<short-title-of-the-issue>`
+3. Download your fork of the repository (Github.cli recommended)
+4. `cd Pico-W-Go`
+5. Switch to your newly created branch (`git checkout <branch-name>` for example)
+6. `npm install`
+
+Do changes and commits...
+
+After the fix is complete DO some extensive testing if all what could be affected works without problems.
+
+7. Now squash all your commits and name the final commit something like `Fix #<issue-id>, <Short title of the issue>`
+    - The description of the squash commit should contain a list (description) of all the changes you've made
+
+8. Push and create a pull request to the develop branch of paulober/Pico-W-Go
 
 ## Code of Conduct
 

.github/workflows/codeql-analysis.yml

@@ -27,18 +27,21 @@ jobs:
     permissions:
       actions: read
       contents: read
+      packages: read
       security-events: write
 
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript']
+        language: [ 'typescript', 'javascript']
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
         # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
 
     steps:
     - name: Checkout repository
       uses: actions/checkout@v3
+    
+    - run: sed -i '1i//npm.pkg.github.com/:_authToken=${NODE_AUTH_TOKEN}' .npmrc
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

.github/workflows/main.yml

@@ -6,35 +6,41 @@ on:
     branches-ignore:
       - "dependabot/**"
     paths-ignore:
-      - "doc/**"
+      - ".idea/**"
+      - ".vscode/**"
+      - "**/*.md"
+      - ".prettierrc.json"
+      - "LICENSE"
+      - ".editorconfig"
+      - ".eslintrc.json"
+
+permissions:
+  contents: read
+  packages: read
 
 jobs:
   build:
-    name: "Build ${{ matrix.os }}"
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
+    name: "Build ubuntu-latest"
+    runs-on: ubuntu-latest
+    
     steps:
       - uses: actions/checkout@v3
 
       - name: Setup node
         uses: actions/setup-node@v3
         with:
           node-version: "16.14.x"
+          registry-url: "https://npm.pkg.github.com"
+          scope: "@paulober"
+          token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Install Dependencies
         shell: bash
         run: |
-          npm install --no-audit
+          sed -i '1i//npm.pkg.github.com/:_authToken=${NODE_AUTH_TOKEN}' .npmrc
+          npm ci --no-audit
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Package Extension
-        run: npx vsce package --no-yarn --dependencies -o picowgo-${{ github.sha }}.vsix
-
-# Stop uploading artifacts for the basic build process
-#      - name: Upload VSIX
-#        #if: github.event_name == 'schedule'
-#        uses: actions/upload-artifact@v3
-#        with:
-#          name: picowgo-nightly.vsix
-#          path: ./picowgo-${{ github.sha }}.vsix
+        run: npx @vscode/vsce package --no-yarn -o picowgo-${{ github.sha }}.vsix

.github/workflows/publish.yml

@@ -4,6 +4,11 @@ on:
   release:
     types: [published]
 
+permissions:
+  contents: read
+  deployments: write
+  packages: read
+
 jobs:
   release:
     runs-on: ubuntu-22.04
@@ -13,14 +18,22 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: '16.14.x'
+          registry-url: "https://npm.pkg.github.com"
+          scope: "@paulober"
+          token: ${{ secrets.GITHUB_TOKEN }}
 
-      - run: npm install
-        name: NPM install
+      - name: NPM install
+        shell: bash
+        run: |
+          sed -i '1i//npm.pkg.github.com/:_authToken=${NODE_AUTH_TOKEN}' .npmrc
+          npm ci --no-audit
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Package
-        run: npx vsce package --no-yarn --dependencies
+        run: npx @vscode/vsce package --no-yarn
 
-      - run: npx vsce publish --no-yarn --dependencies --target win32-x64 linux-x64 linux-arm64 linux-armhf darwin-x64 darwin-arm64
+      - run: npx @vscode/vsce publish --no-yarn --target win32-x64 win32-arm64 linux-x64 linux-arm64 linux-armhf darwin-x64 darwin-arm64
         name: Publish
         env:
           VSCE_PAT: ${{ secrets.VSCE_PAT }}

.gitignore

@@ -1,6 +1,6 @@
 # no compiled
-out
-dist
+out/
+dist/
 # no dependencies
 node_modules
 .vscode-test/

.npmrc

@@ -0,0 +1 @@
+@paulober:registry=https://npm.pkg.github.com

.prettierrc.json

@@ -0,0 +1,10 @@
+{
+    "semi": true,
+    "tabWidth": 2,
+    "useTabs": false,
+    "printWidth": 80,
+    "parser": "typescript",
+    "singleQuote": false,
+    "arrowParens": "avoid",
+    "bracketSameLine": true
+}

.vscode/launch.json

@@ -13,7 +13,7 @@
 				"--extensionDevelopmentPath=${workspaceFolder}"
 			],
 			"outFiles": [
-				"${workspaceFolder}/dist/**/*.js"
+				"${workspaceFolder}/dist/**/*.cjs"
 			],
 			"preLaunchTask": "${defaultBuildTask}"
 		},