fix: derive CompileSummary from BuilderResult (#20)

Signed-off-by: dankeboy36 <dankeboy36@gmail.com>

Author: dankeboy36

.eslintrc.json

@@ -1,4 +1,8 @@
-name: Build
+name: CI
+permissions:
+  contents: read
+  pull-requests: write
+
 on:
   push:
     branches:
@@ -9,64 +13,79 @@ on:
       - main
 
 jobs:
-  build:
-    name: test (${{ matrix.os }}, node-${{ matrix.node }}
+  test:
+    name: Test (${{ matrix.os }}, node-${{ matrix.node }})
     strategy:
       fail-fast: false
       matrix:
         os: [windows-latest, ubuntu-latest, macos-latest]
-        node: [18.x]
+        node: [22.14.0]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Use Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.config.node }}
+          node-version: ${{ matrix.node }}
+
       - name: Install Dependencies
         run: npm ci
-      - name: Check API Docs
-        run: npm run doc && git diff --exit-code
+
       - name: Check Format
         run: npm run format && git diff --exit-code
+
+      - name: Check API Docs
+        run: npm run doc && git diff --exit-code
+
       - name: Lint
         run: npm run lint
+
       - name: Test
-        uses: coactions/setup-xvfb@v1
-        with:
-          run: npm test
+        run: ${{ matrix.os == 'ubuntu-latest' && 'xvfb-run' || '' }} npm test
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   release:
     if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
     runs-on: ubuntu-latest
-    needs: [build]
+    needs: [test]
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           persist-credentials: false
+
       - name: Use Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
-          node-version: 18.x
+          node-version: 22.14.0
+
       - name: Install Dependencies
         run: npm ci
+
       - name: Build
         run: npm run build
+
       - name: Generate Typings
         run: npm run typings
+
+      - name: Load secrets from 1Password
+        id: load_secrets
+        uses: 1password/load-secrets-action@v3
+        env:
+          OP_SERVICE_ACCOUNT_TOKEN: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+          GITHUB_TOKEN: op://cicd_dankeboy36/GITHUB_TOKEN/credential
+          NPM_TOKEN: op://cicd_dankeboy36/NPM_TOKEN/credential
+
       - name: Release
         id: release
         run: npm run release
         env:
-          GITHUB_TOKEN: ${{ secrets.ADMIN_TOKEN }}
-          VSCE_PAT: ${{ secrets.VSCE_PAT }}
-          OVSX_PAT: ${{ secrets.OVSX_PAT }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          GITHUB_TOKEN: ${{ steps.load_secrets.outputs.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ steps.load_secrets.outputs.NPM_TOKEN }}
     outputs:
       release_version: ${{ steps.release.outputs.release_version }}

.github/workflows/build.yml .github/workflows/ci.yml.github/workflows/build.yml renamed to .github/workflows/ci.yml

@@ -1,4 +1,7 @@
 name: PR Title
+permissions:
+  contents: read
+  pull-requests: write
 
 on:
   pull_request_target:
@@ -12,6 +15,6 @@ jobs:
   validate:
     runs-on: ubuntu-latest
     steps:
-      - uses: amannn/action-semantic-pull-request@v3.1.0
+      - uses: amannn/action-semantic-pull-request@d2ab30dcffc66150340abb5b947d518a3c3ce9cb # v3.1.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pr-title.yml

@@ -11,5 +11,13 @@
   "typescript.tsdk": "./node_modules/typescript/lib",
   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": "explicit"
-  }
+  },
+  "[javascript][javascriptreact][json][typescript][typescriptreact][css]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnPaste": true,
+    "editor.formatOnSave": true
+  },
+  "eslint.format.enable": true,
+  "js/ts.implicitProjectConfig.checkJs": true,
+  "js/ts.implicitProjectConfig.module": "NodeNext"
 }

.prettierrc.json

@@ -7,11 +7,10 @@ src/**
 .gitignore
 .prettierignore
 CHANGELOG.md
-webpack.config.js
 **/tsconfig.json
 **/.eslintrc.json
 **/*.map
 **/*.ts
-release.config.js
+*.config.*
 .nyc_output/**
 docs/**

.vscode/settings.json

@@ -27,16 +27,16 @@ If you want to use the Arduino APIs, you have to do the followings:
 1.  Consume the `ArduinoContext` extension API in your VS Code extension:
 
     ```ts
-    import * as vscode from 'vscode';
-    import type { ArduinoContext } from 'vscode-arduino-api';
+    import * as vscode from 'vscode'
+    import type { ArduinoContext } from 'vscode-arduino-api'
 
     export function activate(context: vscode.ExtensionContext) {
       const context: ArduinoContext = vscode.extensions.getExtension(
         'dankeboy36.vscode-arduino-api'
-      )?.exports;
+      )?.exports
       if (!context) {
         // Failed to load the Arduino API.
-        return;
+        return
       }
 
       // Use the Arduino API in your VS Code extension.
@@ -47,19 +47,19 @@ If you want to use the Arduino APIs, you have to do the followings:
         vscode.commands.registerCommand('myExtension.showSketchPath', () => {
           vscode.window.showInformationMessage(
             `Sketch path: ${context.sketchPath}`
-          );
+          )
         })
-      );
+      )
 
       // Listen on state change.
       // Register a listener to show the FQBN of the currently selected board as an information message.
       context.onDidChangeSketch((event) => {
         if (event.changedProperties.includes('board')) {
           vscode.window.showInformationMessage(
             `FQBN: ${event.object.board?.fqbn}`
-          );
+          )
         }
-      });
+      })
     }
     ```
 

.vscodeignore

@@ -1,12 +1,10 @@
-# vscode-arduino-api
-
-## Table of contents
+**vscode-arduino-api**
 
-### Classes
+---
 
-- [Disposable](classes/Disposable.md)
+# vscode-arduino-api
 
-### Interfaces
+## Interfaces
 
 - [ArduinoContext](interfaces/ArduinoContext.md)
 - [ArduinoState](interfaces/ArduinoState.md)
@@ -16,125 +14,16 @@
 - [CompileSummary](interfaces/CompileSummary.md)
 - [ConfigOption](interfaces/ConfigOption.md)
 - [ConfigValue](interfaces/ConfigValue.md)
+- [Disposable](interfaces/Disposable.md)
 - [Event](interfaces/Event.md)
 - [Port](interfaces/Port.md)
 - [Programmer](interfaces/Programmer.md)
 - [SketchFolder](interfaces/SketchFolder.md)
 - [SketchFoldersChangeEvent](interfaces/SketchFoldersChangeEvent.md)
 
-### Type Aliases
-
-- [BoardIdentifier](README.md#boardidentifier)
-- [BuildProperties](README.md#buildproperties)
-- [Tool](README.md#tool)
-- [Version](README.md#version)
-
-### Variables
-
-- [ConfigOption](README.md#configoption)
-- [ConfigValue](README.md#configvalue)
-- [Port](README.md#port)
-- [Programmer](README.md#programmer)
-
 ## Type Aliases
 
-### BoardIdentifier
-
-Ƭ **BoardIdentifier**: `Nullable`\<`ApiBoard`, `"fqbn"`\>
-
-Lightweight information to identify a board:
-
-- The board's `name` is to provide a fallback for the UI. Preferably do not use this property for any sophisticated logic and board comparison. It must never participate in the board's identification.
-- The FQBN might contain boards config options if selected from the discovered ports (see [arduino/arduino-ide#1588](https://github.com/arduino/arduino-ide/issues/1588)).
-
----
-
-### BuildProperties
-
-Ƭ **BuildProperties**: `Readonly`\<`Record`\<`string`, `string`\>\>
-
-Build properties used for compiling. The board-specific properties are retrieved from `board.txt` and `platform.txt`. For example, if the `board.txt` contains the `build.tarch=xtensa` entry for the `esp32:esp32:esp32` board, the record includes the `"build.tarch": "xtensa"` property.
-
----
-
-### Tool
-
-Ƭ **Tool**: `Readonly`\<`Pick`\<`ToolsDependencies`, `"name"` \| `"version"` \| `"packager"`\>\>
-
-Required Tool dependencies of a board. See [`ToolsDependencies`](https://arduino.github.io/arduino-cli/latest/rpc/commands/#cc.arduino.cli.commands.v1.ToolsDependencies) for the CLI API.
-
----
-
-### Version
-
-Ƭ **Version**: `string`
-
-Supposed to be a [SemVer](https://semver.org/) as a `string` but it's not enforced by Arduino. You might need to coerce the SemVer string.
-
-## Variables
-
-### ConfigOption
-
-• **ConfigOption**: `Object`
-
-#### Type declaration
-
-| Name          | Type                                                                                                                                                                                                      |
-| :------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `create`      | (`base?`: \{ `option?`: `string` ; `optionLabel?`: `string` ; `values?`: \{ `selected?`: `boolean` ; `value?`: `string` ; `valueLabel?`: `string` }[] }) => [`ConfigOption`](interfaces/ConfigOption.md)  |
-| `decode`      | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`ConfigOption`](interfaces/ConfigOption.md)                                                                                                  |
-| `encode`      | (`message`: [`ConfigOption`](interfaces/ConfigOption.md), `writer?`: `Writer`) => `Writer`                                                                                                                |
-| `fromJSON`    | (`object`: `any`) => [`ConfigOption`](interfaces/ConfigOption.md)                                                                                                                                         |
-| `fromPartial` | (`object`: \{ `option?`: `string` ; `optionLabel?`: `string` ; `values?`: \{ `selected?`: `boolean` ; `value?`: `string` ; `valueLabel?`: `string` }[] }) => [`ConfigOption`](interfaces/ConfigOption.md) |
-| `toJSON`      | (`message`: [`ConfigOption`](interfaces/ConfigOption.md)) => `unknown`                                                                                                                                    |
-
----
-
-### ConfigValue
-
-• **ConfigValue**: `Object`
-
-#### Type declaration
-
-| Name          | Type                                                                                                                                 |
-| :------------ | :----------------------------------------------------------------------------------------------------------------------------------- |
-| `create`      | (`base?`: \{ `selected?`: `boolean` ; `value?`: `string` ; `valueLabel?`: `string` }) => [`ConfigValue`](interfaces/ConfigValue.md)  |
-| `decode`      | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`ConfigValue`](interfaces/ConfigValue.md)                               |
-| `encode`      | (`message`: [`ConfigValue`](interfaces/ConfigValue.md), `writer?`: `Writer`) => `Writer`                                             |
-| `fromJSON`    | (`object`: `any`) => [`ConfigValue`](interfaces/ConfigValue.md)                                                                      |
-| `fromPartial` | (`object`: \{ `selected?`: `boolean` ; `value?`: `string` ; `valueLabel?`: `string` }) => [`ConfigValue`](interfaces/ConfigValue.md) |
-| `toJSON`      | (`message`: [`ConfigValue`](interfaces/ConfigValue.md)) => `unknown`                                                                 |
-
----
-
-### Port
-
-• **Port**: `Object`
-
-#### Type declaration
-
-| Name          | Type                                                                                                                                                                                          |
-| :------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `create`      | (`base?`: \{ `address?`: `string` ; `hardwareId?`: `string` ; `label?`: `string` ; `properties?`: {} ; `protocol?`: `string` ; `protocolLabel?`: `string` }) => [`Port`](interfaces/Port.md)  |
-| `decode`      | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`Port`](interfaces/Port.md)                                                                                                      |
-| `encode`      | (`message`: [`Port`](interfaces/Port.md), `writer?`: `Writer`) => `Writer`                                                                                                                    |
-| `fromJSON`    | (`object`: `any`) => [`Port`](interfaces/Port.md)                                                                                                                                             |
-| `fromPartial` | (`object`: \{ `address?`: `string` ; `hardwareId?`: `string` ; `label?`: `string` ; `properties?`: {} ; `protocol?`: `string` ; `protocolLabel?`: `string` }) => [`Port`](interfaces/Port.md) |
-| `toJSON`      | (`message`: [`Port`](interfaces/Port.md)) => `unknown`                                                                                                                                        |
-
----
-
-### Programmer
-
-• **Programmer**: `Object`
-
-#### Type declaration
-
-| Name          | Type                                                                                                                     |
-| :------------ | :----------------------------------------------------------------------------------------------------------------------- |
-| `create`      | (`base?`: \{ `id?`: `string` ; `name?`: `string` ; `platform?`: `string` }) => [`Programmer`](interfaces/Programmer.md)  |
-| `decode`      | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`Programmer`](interfaces/Programmer.md)                     |
-| `encode`      | (`message`: [`Programmer`](interfaces/Programmer.md), `writer?`: `Writer`) => `Writer`                                   |
-| `fromJSON`    | (`object`: `any`) => [`Programmer`](interfaces/Programmer.md)                                                            |
-| `fromPartial` | (`object`: \{ `id?`: `string` ; `name?`: `string` ; `platform?`: `string` }) => [`Programmer`](interfaces/Programmer.md) |
-| `toJSON`      | (`message`: [`Programmer`](interfaces/Programmer.md)) => `unknown`                                                       |
+- [BoardIdentifier](type-aliases/BoardIdentifier.md)
+- [BuildProperties](type-aliases/BuildProperties.md)
+- [Tool](type-aliases/Tool.md)
+- [Version](type-aliases/Version.md)