Compare commits

..

3 Commits

Author SHA1 Message Date
Akos Kitta
5c31c93636 fix: relaxed hover service request when scrolling
- do not render footer when scrolling
 - fix anchor word wrapping for long long links in the markdown
 - underline the link and change the cursor to pointer on hover
 - consider status-bar height when calculating hover top

Signed-off-by: Akos Kitta <a.kitta@arduino.cc>
2023-03-17 09:17:33 +01:00
Akos Kitta
03355903b9 fix: no group for the description if it's missing
Signed-off-by: Akos Kitta <a.kitta@arduino.cc>
2023-03-16 10:12:02 +01:00
Akos Kitta
fa4626bf14 feat: support updates in lib/boards widget
- can show badge with updates count,
 - better hover for libraries and platforms,
 - save/restore widget state (Closes #1398),
 - fixed `sentence` and `paragraph` order (Ref #1611)

Signed-off-by: Akos Kitta <a.kitta@arduino.cc>
2023-03-16 10:03:30 +01:00
488 changed files with 35829 additions and 53861 deletions

View File

@@ -10,17 +10,14 @@ module.exports = {
ignorePatterns: [ ignorePatterns: [
'node_modules/*', 'node_modules/*',
'**/node_modules/*', '**/node_modules/*',
'.node_modules/*',
'.github/*', '.github/*',
'.browser_modules/*', '.browser_modules/*',
'docs/*', 'docs/*',
'scripts/*', 'scripts/*',
'electron-app/lib/*', 'electron-app/*',
'electron-app/src-gen/*', 'plugins/*',
'electron-app/gen-webpack*.js',
'!electron-app/webpack.config.js',
'electron-app/plugins/*',
'arduino-ide-extension/src/node/cli-protocol', 'arduino-ide-extension/src/node/cli-protocol',
'**/lib/*',
], ],
settings: { settings: {
react: { react: {

View File

@@ -1,7 +1,7 @@
name: Bug report name: Bug report
description: Report a problem with the code or documentation in this repository. description: Report a problem with the code or documentation in this repository.
labels: labels:
- 'type: imperfection' - "type: imperfection"
body: body:
- type: textarea - type: textarea
id: description id: description

View File

@@ -1,7 +1,7 @@
name: Feature request name: Feature request
description: Suggest an enhancement to this project. description: Suggest an enhancement to this project.
labels: labels:
- 'type: enhancement' - "type: enhancement"
body: body:
- type: textarea - type: textarea
id: description id: description

View File

@@ -1,18 +1,15 @@
### Motivation ### Motivation
<!-- Why this pull request? --> <!-- Why this pull request? -->
### Change description ### Change description
<!-- What does your code do? --> <!-- What does your code do? -->
### Other information ### Other information
<!-- Any additional information that could help the review process --> <!-- Any additional information that could help the review process -->
### Reviewer checklist ### Reviewer checklist
- [ ] PR addresses a single concern. * [ ] PR addresses a single concern.
- [ ] The PR has no duplicates (please search among the [Pull Requests](https://github.com/arduino/arduino-ide/pulls) before creating one) * [ ] The PR has no duplicates (please search among the [Pull Requests](https://github.com/arduino/arduino-ide/pulls) before creating one)
- [ ] PR title and description are properly filled. * [ ] PR title and description are properly filled.
- [ ] Docs have been added / updated (for bug fixes / features) * [ ] Docs have been added / updated (for bug fixes / features)

View File

@@ -12,4 +12,4 @@ updates:
schedule: schedule:
interval: daily interval: daily
labels: labels:
- 'topic: infrastructure' - "topic: infrastructure"

View File

@@ -1,27 +1,24 @@
# Used by the "Sync Labels" workflow # Used by the "Sync Labels" workflow
# See: https://github.com/Financial-Times/github-label-sync#label-config-file # See: https://github.com/Financial-Times/github-label-sync#label-config-file
- name: 'topic: accessibility' - name: "topic: accessibility"
color: '00ffff' color: "00ffff"
description: Enabling the use of the software by everyone description: Enabling the use of the software by everyone
- name: 'topic: CLI' - name: "topic: CLI"
color: '00ffff' color: "00ffff"
description: Related to Arduino CLI description: Related to Arduino CLI
- name: 'topic: cloud' - name: "topic: debugger"
color: '00ffff' color: "00ffff"
description: Related to Arduino Cloud and cloud sketches
- name: 'topic: debugger'
color: '00ffff'
description: Related to the integrated debugger description: Related to the integrated debugger
- name: 'topic: language server' - name: "topic: language server"
color: '00ffff' color: "00ffff"
description: Related to the Arduino Language Server description: Related to the Arduino Language Server
- name: 'topic: serial monitor' - name: "topic: serial monitor"
color: '00ffff' color: "00ffff"
description: Related to the Serial Monitor description: Related to the Serial Monitor
- name: 'topic: theia' - name: "topic: theia"
color: '00ffff' color: "00ffff"
description: Related to the Theia IDE framework description: Related to the Theia IDE framework
- name: 'topic: theme' - name: "topic: theme"
color: '00ffff' color: "00ffff"
description: Related to GUI theming description: Related to GUI theming

View File

@@ -1,112 +0,0 @@
# The Arduino IDE Linux build workflow job runs in this container.
# syntax=docker/dockerfile:1
FROM ubuntu:18.04
# See: https://unofficial-builds.nodejs.org/download/release/
ARG node_version="18.17.1"
RUN \
apt-get \
--yes \
update
# This is required to get add-apt-repository
RUN \
apt-get \
--yes \
install \
"software-properties-common=0.96.24.32.22"
# Install Git
# The PPA is required to get a modern version of Git. The version in the Ubuntu 18.04 package repository is 2.17.1,
# while action/checkout@v3 requires 2.18 or higher.
RUN \
add-apt-repository \
--yes \
"ppa:git-core/ppa" && \
apt-get \
--yes \
update && \
\
apt-get \
--yes \
install \
"git" && \
\
apt-get \
--yes \
purge \
"software-properties-common"
# The repository path must be added to safe.directory, otherwise any Git operations on it would fail with a
# "dubious ownership" error. actions/checkout configures this, but it is not applied to containers.
RUN \
git config \
--add \
--global \
"safe.directory" "/__w/arduino-ide/arduino-ide"
ENV \
GIT_CONFIG_GLOBAL="/root/.gitconfig"
# Install Python
# The Python installed by actions/setup-python has dependency on a higher version of glibc than available in the
# ubuntu:18.04 container.
RUN \
apt-get \
--yes \
install \
"python3.8-minimal=3.8.0-3ubuntu1~18.04.2" && \
\
ln \
--symbolic \
--force \
"$(which python3.8)" \
"/usr/bin/python3"
# Install Theia's package dependencies
# These are pre-installed in the GitHub Actions hosted runner machines.
RUN \
apt-get \
--yes \
install \
"libsecret-1-dev=0.18.6-1" \
"libx11-dev=2:1.6.4-3ubuntu0.4" \
"libxkbfile-dev=1:1.0.9-2"
# Install Node.js
# It is necessary to use the "unofficial" linux-x64-glibc-217 build because the official Node.js 18.x is dynamically
# linked against glibc 2.28, while Ubuntu 18.04 has glibc 2.27.
ARG node_installation_path="/tmp/node-installation"
ARG artifact_name="node-v${node_version}-linux-x64-glibc-217"
RUN \
mkdir "$node_installation_path" && \
cd "$node_installation_path" && \
\
apt-get \
--yes \
install \
"wget=1.19.4-1ubuntu2.2" && \
\
archive_name="${artifact_name}.tar.xz" && \
wget \
"https://unofficial-builds.nodejs.org/download/release/v${node_version}/${archive_name}" && \
\
apt-get \
--yes \
purge \
"wget" && \
\
tar \
--file="$archive_name" \
--extract && \
rm "$archive_name"
ENV PATH="${PATH}:${node_installation_path}/${artifact_name}/bin"
# Install Yarn
# Yarn is pre-installed in the GitHub Actions hosted runner machines.
RUN \
npm \
install \
--global \
"yarn@1.22.19"

View File

@@ -1,28 +1,20 @@
name: Arduino IDE name: Arduino IDE
on: on:
create:
push: push:
branches: branches:
- main - main
- '[0-9]+.[0-9]+.x'
paths-ignore: paths-ignore:
- '.github/**' - '.github/**'
- '!.github/workflows/build.yml' - '!.github/workflows/build.yml'
- '.vscode/**' - '.vscode/**'
- 'docs/**' - 'docs/**'
- 'scripts/**' - 'scripts/**'
- '!scripts/merge-channel-files.js'
- 'static/**' - 'static/**'
- '*.md' - '*.md'
tags: tags:
- '[0-9]+.[0-9]+.[0-9]+*' - '[0-9]+.[0-9]+.[0-9]+*'
workflow_dispatch: workflow_dispatch:
inputs:
paid-runners:
description: Include builds on non-free runners
type: boolean
default: false
pull_request: pull_request:
paths-ignore: paths-ignore:
- '.github/**' - '.github/**'
@@ -30,338 +22,65 @@ on:
- '.vscode/**' - '.vscode/**'
- 'docs/**' - 'docs/**'
- 'scripts/**' - 'scripts/**'
- '!scripts/merge-channel-files.js'
- 'static/**' - 'static/**'
- '*.md' - '*.md'
schedule: schedule:
- cron: '0 3 * * *' # run every day at 3AM (https://docs.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events-schedule) - cron: '0 3 * * *' # run every day at 3AM (https://docs.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events-schedule)
workflow_run:
workflows:
- Push Container Images
branches:
- main
types:
- completed
env: env:
# See vars.GO_VERSION field of https://github.com/arduino/arduino-cli/blob/master/DistTasks.yml # See vars.GO_VERSION field of https://github.com/arduino/arduino-cli/blob/master/DistTasks.yml
GO_VERSION: '1.21' GO_VERSION: "1.19"
# See: https://github.com/actions/setup-node/#readme
NODE_VERSION: '18.17'
JOB_TRANSFER_ARTIFACT: build-artifacts JOB_TRANSFER_ARTIFACT: build-artifacts
CHANGELOG_ARTIFACTS: changelog CHANGELOG_ARTIFACTS: changelog
STAGED_CHANNEL_FILES_ARTIFACT: staged-channel-files
BASE_BUILD_DATA: | jobs:
- config: build:
# Human identifier for the job. name: build (${{ matrix.config.os }})
name: Windows strategy:
runs-on: [self-hosted, windows-sign-pc] matrix:
# The value is a string representing a JSON document. config:
# Setting this to null causes the job to run directly in the runner machine instead of in a container. - os: windows-2019
container: | certificate-secret: WINDOWS_SIGNING_CERTIFICATE_PFX # Name of the secret that contains the certificate.
null certificate-password-secret: WINDOWS_SIGNING_CERTIFICATE_PASSWORD # Name of the secret that contains the certificate password.
# Name of the secret that contains the certificate. certificate-extension: pfx # File extension for the certificate.
certificate-secret: INSTALLER_CERT_WINDOWS_CER - os: ubuntu-18.04 # https://github.com/arduino/arduino-ide/issues/259
# Name of the secret that contains the certificate password. - os: macos-latest
certificate-password-secret: INSTALLER_CERT_WINDOWS_PASSWORD
# File extension for the certificate.
certificate-extension: pfx
# Container for windows cert signing
certificate-container: INSTALLER_CERT_WINDOWS_CONTAINER
# Quoting on the value is required here to allow the same comparison expression syntax to be used for this
# and the companion needs.select-targets.outputs.merge-channel-files property (output values always have string
# type).
mergeable-channel-file: 'false'
# as this runs on a self hosted runner, we need to avoid building with the default working directory path,
# otherwise paths in the build job will be too long for `light.exe`
# we use the below as a Symbolic link (just changing the wd will break the checkout action)
# this is a work around (see: https://github.com/actions/checkout/issues/197).
working-directory: 'C:\a'
artifacts:
- path: '*Windows_64bit.exe'
name: Windows_X86-64_interactive_installer
- path: '*Windows_64bit.msi'
name: Windows_X86-64_MSI
- path: '*Windows_64bit.zip'
name: Windows_X86-64_zip
- config:
name: Linux
runs-on: ubuntu-latest
container: |
{
\"image\": \"ghcr.io/arduino/arduino-ide/linux:main\"
}
mergeable-channel-file: 'false'
artifacts:
- path: '*Linux_64bit.zip'
name: Linux_X86-64_zip
- path: '*Linux_64bit.AppImage'
name: Linux_X86-64_app_image
- config:
name: macOS x86
runs-on: macos-13
container: |
null
# APPLE_SIGNING_CERTIFICATE_P12 secret was produced by following the procedure from: # APPLE_SIGNING_CERTIFICATE_P12 secret was produced by following the procedure from:
# https://www.kencochrane.com/2020/08/01/build-and-sign-golang-binaries-for-macos-with-github-actions/#exporting-the-developer-certificate # https://www.kencochrane.com/2020/08/01/build-and-sign-golang-binaries-for-macos-with-github-actions/#exporting-the-developer-certificate
certificate-secret: APPLE_SIGNING_CERTIFICATE_P12 certificate-secret: APPLE_SIGNING_CERTIFICATE_P12
certificate-password-secret: KEYCHAIN_PASSWORD certificate-password-secret: KEYCHAIN_PASSWORD
certificate-extension: p12 certificate-extension: p12
mergeable-channel-file: 'true' runs-on: ${{ matrix.config.os }}
artifacts:
- path: '*macOS_64bit.dmg'
name: macOS_X86-64_dmg
- path: '*macOS_64bit.zip'
name: macOS_X86-64_zip
- config:
name: macOS ARM
runs-on: macos-latest
container: |
null
certificate-secret: APPLE_SIGNING_CERTIFICATE_P12
certificate-password-secret: KEYCHAIN_PASSWORD
certificate-extension: p12
mergeable-channel-file: 'true'
artifacts:
- path: '*macOS_arm64.dmg'
name: macOS_arm64_dmg
- path: '*macOS_arm64.zip'
name: macOS_arm64_zip
PAID_RUNNER_BUILD_DATA: |
# This system was implemented to allow selective use of paid GitHub-hosted runners, due to the Apple Silicon runner
# incurring a charge at that time. Free Apple Silicon runners are now available so the configuration was moved to
# `BASE_BUILD_DATA`, but the system was left in place for future use.
jobs:
run-determination:
runs-on: ubuntu-latest
outputs:
result: ${{ steps.determination.outputs.result }}
permissions: {}
steps:
- name: Determine if the rest of the workflow should run
id: determination
run: |
RELEASE_BRANCH_REGEX="refs/heads/[0-9]+.[0-9]+.x"
# The `create` event trigger doesn't support `branches` filters, so it's necessary to use Bash instead.
if [[
"${{ github.event_name }}" != "create" ||
"${{ github.ref }}" =~ $RELEASE_BRANCH_REGEX
]]; then
# Run the other jobs.
RESULT="true"
else
# There is no need to run the other jobs.
RESULT="false"
fi
echo "result=$RESULT" >> $GITHUB_OUTPUT
build-type-determination:
needs: run-determination
if: needs.run-determination.outputs.result == 'true'
runs-on: ubuntu-latest
outputs:
is-release: ${{ steps.determination.outputs.is-release }}
is-nightly: ${{ steps.determination.outputs.is-nightly }}
channel-name: ${{ steps.determination.outputs.channel-name }}
publish-to-s3: ${{ steps.determination.outputs.publish-to-s3 }}
permissions: {}
steps:
- name: Determine the type of build
id: determination
run: |
if [[
"${{ startsWith(github.ref, 'refs/tags/') }}" == "true"
]]; then
is_release="true"
is_nightly="false"
channel_name="stable"
elif [[
"${{ github.event_name }}" == "schedule" ||
(
"${{ github.event_name }}" == "workflow_dispatch" &&
"${{ github.ref }}" == "refs/heads/main"
)
]]; then
is_release="false"
is_nightly="true"
channel_name="nightly"
else
is_release="false"
is_nightly="false"
channel_name="nightly"
fi
echo "is-release=$is_release" >> $GITHUB_OUTPUT
echo "is-nightly=$is_nightly" >> $GITHUB_OUTPUT
echo "channel-name=$channel_name" >> $GITHUB_OUTPUT
# Only attempt upload to Amazon S3 if the credentials are available.
echo "publish-to-s3=${{ secrets.AWS_SECRET_ACCESS_KEY != '' }}" >> $GITHUB_OUTPUT
select-targets:
needs: build-type-determination
runs-on: ubuntu-latest
outputs:
artifact-matrix: ${{ steps.assemble.outputs.artifact-matrix }}
build-matrix: ${{ steps.assemble.outputs.build-matrix }}
merge-channel-files: ${{ steps.assemble.outputs.merge-channel-files }}
permissions: {}
steps:
- name: Assemble target data
id: assemble
run: |
# Only run the builds that incur runner charges on release or select manually triggered runs.
if [[
"${{ needs.build-type-determination.outputs.is-release }}" == "true" ||
"${{ github.event.inputs.paid-runners }}" == "true"
]]; then
build_matrix="$(
(
echo "${{ env.BASE_BUILD_DATA }}";
echo "${{ env.PAID_RUNNER_BUILD_DATA }}"
) | \
yq \
--output-format json \
'[.[].config]'
)"
artifact_matrix="$(
(
echo "${{ env.BASE_BUILD_DATA }}";
echo "${{ env.PAID_RUNNER_BUILD_DATA }}"
) | \
yq \
--output-format json \
'[.[].artifacts.[]]'
)"
# The build matrix produces two macOS jobs (x86 and ARM) so the "channel update info files"
# generated by each must be merged.
merge_channel_files="true"
else
build_matrix="$(
echo "${{ env.BASE_BUILD_DATA }}" | \
yq \
--output-format json \
'[.[].config]'
)"
artifact_matrix="$(
echo "${{ env.BASE_BUILD_DATA }}" | \
yq \
--output-format json \
'[.[].artifacts.[]]'
)"
merge_channel_files="false"
fi
# Set workflow step outputs.
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#multiline-strings
delimiter="$RANDOM"
echo "build-matrix<<$delimiter" >> $GITHUB_OUTPUT
echo "$build_matrix" >> $GITHUB_OUTPUT
echo "$delimiter" >> $GITHUB_OUTPUT
delimiter="$RANDOM"
echo "artifact-matrix<<$delimiter" >> $GITHUB_OUTPUT
echo "$artifact_matrix" >> $GITHUB_OUTPUT
echo "$delimiter" >> $GITHUB_OUTPUT
echo "merge-channel-files=$merge_channel_files" >> $GITHUB_OUTPUT
build:
name: build (${{ matrix.config.name }})
needs:
- build-type-determination
- select-targets
env:
# https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/
ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION: true
# Location of artifacts generated by build.
BUILD_ARTIFACTS_PATH: electron-app/dist/build-artifacts
# to skip passing signing credentials to electron-builder
IS_WINDOWS_CONFIG: ${{ matrix.config.name == 'Windows' }}
INSTALLER_CERT_WINDOWS_CER: "/tmp/cert.cer"
# We are hardcoding the path for signtool because is not present on the windows PATH env var by default.
# Keep in mind that this path could change when upgrading to a new runner version
SIGNTOOL_PATH: "C:/Program Files (x86)/Windows Kits/10/bin/10.0.19041.0/x86/signtool.exe"
WIN_CERT_PASSWORD: ${{ secrets[matrix.config.certificate-password-secret] }}
WIN_CERT_CONTAINER_NAME: ${{ secrets[matrix.config.certificate-container] }}
strategy:
matrix:
config: ${{ fromJson(needs.select-targets.outputs.build-matrix) }}
runs-on: ${{ matrix.config.runs-on }}
container: ${{ fromJSON(matrix.config.container) }}
defaults:
run:
# Avoid problems caused by different default shell for container jobs (sh) vs non-container jobs (bash).
shell: bash
timeout-minutes: 90 timeout-minutes: 90
steps: steps:
- name: Symlink custom working directory
shell: cmd
if: runner.os == 'Windows' && matrix.config.working-directory
run: |
if not exist "${{ matrix.config.working-directory }}" mklink /d "${{ matrix.config.working-directory }}" "C:\actions-runner\_work\arduino-ide\arduino-ide"
- name: Checkout - name: Checkout
if: fromJSON(matrix.config.container) == null
uses: actions/checkout@v4
- name: Checkout
# actions/checkout@v4 has dependency on a higher version of glibc than available in the Linux container.
if: fromJSON(matrix.config.container) != null
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: Install Node.js - name: Install Node.js 16.x
if: fromJSON(matrix.config.container) == null && runner.name != 'WINDOWS-SIGN-PC' uses: actions/setup-node@v3
uses: actions/setup-node@v4
with: with:
node-version: ${{ env.NODE_VERSION }} node-version: '16.x'
registry-url: 'https://registry.npmjs.org' registry-url: 'https://registry.npmjs.org'
cache: 'yarn'
- name: Install Python 3.x - name: Install Python 3.x
if: fromJSON(matrix.config.container) == null && runner.name != 'WINDOWS-SIGN-PC' uses: actions/setup-python@v4
uses: actions/setup-python@v5
with: with:
python-version: '3.11.x' python-version: '3.x'
- name: Install Go - name: Install Go
if: fromJSON(matrix.config.container) == null && runner.name != 'WINDOWS-SIGN-PC'
uses: actions/setup-go@v5
with:
go-version: ${{ env.GO_VERSION }}
- name: Install Go
# actions/setup-go@v5 has dependency on a higher version of glibc than available in the Linux container.
if: fromJSON(matrix.config.container) != null && runner.name != 'WINDOWS-SIGN-PC'
uses: actions/setup-go@v4 uses: actions/setup-go@v4
with: with:
go-version: ${{ env.GO_VERSION }} go-version: ${{ env.GO_VERSION }}
- name: Install Taskfile - name: Install Taskfile
if: fromJSON(matrix.config.container) == null && runner.name != 'WINDOWS-SIGN-PC'
uses: arduino/setup-task@v2
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
version: 3.x
- name: Install Taskfile
# actions/setup-task@v2 has dependency on a higher version of glibc than available in the Linux container.
if: fromJSON(matrix.config.container) != null && runner.name != 'WINDOWS-SIGN-PC'
uses: arduino/setup-task@v1 uses: arduino/setup-task@v1
with: with:
repo-token: ${{ secrets.GITHUB_TOKEN }} repo-token: ${{ secrets.GITHUB_TOKEN }}
version: 3.x version: 3.x
- name: Package - name: Package
shell: bash
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
AC_USERNAME: ${{ secrets.AC_USERNAME }} AC_USERNAME: ${{ secrets.AC_USERNAME }}
@@ -369,143 +88,55 @@ jobs:
AC_TEAM_ID: ${{ secrets.AC_TEAM_ID }} AC_TEAM_ID: ${{ secrets.AC_TEAM_ID }}
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
IS_NIGHTLY: ${{ needs.build-type-determination.outputs.is-nightly }} IS_NIGHTLY: ${{ github.event_name == 'schedule' || (github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main') }}
IS_RELEASE: ${{ needs.build-type-determination.outputs.is-release }} IS_RELEASE: ${{ startsWith(github.ref, 'refs/tags/') }}
CAN_SIGN: ${{ secrets[matrix.config.certificate-secret] != '' }} CAN_SIGN: ${{ secrets[matrix.config.certificate-secret] != '' }}
working-directory: ${{ matrix.config.working-directory || './' }}
run: | run: |
# See: https://www.electron.build/code-signing # See: https://www.electron.build/code-signing
if [ $CAN_SIGN = false ] || [ $IS_WINDOWS_CONFIG = true ]; then if [ $CAN_SIGN = false ]; then
echo "Skipping the app signing: certificate not provided." echo "Skipping the app signing: certificate not provided."
else else
export CSC_LINK="${{ runner.temp }}/signing_certificate.${{ matrix.config.certificate-extension }}" export CSC_LINK="${{ runner.temp }}/signing_certificate.${{ matrix.config.certificate-extension }}"
echo "${{ secrets[matrix.config.certificate-secret] }}" | base64 --decode > "$CSC_LINK" echo "${{ secrets[matrix.config.certificate-secret] }}" | base64 --decode > "$CSC_LINK"
export CSC_KEY_PASSWORD="${{ secrets[matrix.config.certificate-password-secret] }}" export CSC_KEY_PASSWORD="${{ secrets[matrix.config.certificate-password-secret] }}"
export CSC_FOR_PULL_REQUEST=true
fi fi
if [ "${{ runner.OS }}" = "Windows" ]; then
npm config set msvs_version 2017 --global
fi
npx node-gyp install npx node-gyp install
yarn install yarn --cwd ./electron/packager/
yarn --cwd ./electron/packager/ package
yarn --cwd arduino-ide-extension build
yarn --cwd electron-app rebuild
yarn --cwd electron-app build
yarn --cwd electron-app package
# Both macOS jobs generate a "channel update info file" with same path and name. The second job to complete would
# overwrite the file generated by the first in the workflow artifact.
- name: Stage channel file for merge
if: >
needs.select-targets.outputs.merge-channel-files == 'true' &&
matrix.config.mergeable-channel-file == 'true'
working-directory: ${{ matrix.config.working-directory || './' }}
run: |
staged_channel_files_path="${{ runner.temp }}/staged-channel-files"
mkdir "$staged_channel_files_path"
mv \
"${{ env.BUILD_ARTIFACTS_PATH }}/${{ needs.build-type-determination.outputs.channel-name }}-mac.yml" \
"${staged_channel_files_path}/${{ needs.build-type-determination.outputs.channel-name }}-mac-${{ runner.arch }}.yml"
# Set workflow environment variable for use in other steps.
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable
echo "STAGED_CHANNEL_FILES_PATH=$staged_channel_files_path" >> "$GITHUB_ENV"
- name: Upload staged-for-merge channel file artifact
uses: actions/upload-artifact@v3
if: >
needs.select-targets.outputs.merge-channel-files == 'true' &&
matrix.config.mergeable-channel-file == 'true'
with:
if-no-files-found: error
name: ${{ env.STAGED_CHANNEL_FILES_ARTIFACT }}
path: ${{ matrix.config.working-directory && format('{0}/{1}', matrix.config.working-directory, env.STAGED_CHANNEL_FILES_PATH) || env.STAGED_CHANNEL_FILES_PATH }}
- name: Upload [GitHub Actions] - name: Upload [GitHub Actions]
uses: actions/upload-artifact@v3 uses: actions/upload-artifact@v3
with: with:
name: ${{ env.JOB_TRANSFER_ARTIFACT }} name: ${{ env.JOB_TRANSFER_ARTIFACT }}
path: ${{ matrix.config.working-directory && format('{0}/{1}', matrix.config.working-directory, env.BUILD_ARTIFACTS_PATH) || env.BUILD_ARTIFACTS_PATH }} path: electron/build/dist/build-artifacts/
- name: Manual Clean up for self-hosted runners
if: runner.os == 'Windows' && matrix.config.working-directory
shell: cmd
run: |
rmdir /s /q "${{ matrix.config.working-directory }}\${{ env.BUILD_ARTIFACTS_PATH }}"
merge-channel-files:
needs:
- build-type-determination
- select-targets
- build
if: needs.select-targets.outputs.merge-channel-files == 'true'
runs-on: ubuntu-latest
permissions: {}
steps:
- name: Set environment variables
run: |
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable
echo "CHANNEL_FILES_PATH=${{ runner.temp }}/channel-files" >> "$GITHUB_ENV"
- name: Checkout
uses: actions/checkout@v4
- name: Download staged-for-merge channel files artifact
uses: actions/download-artifact@v3
with:
name: ${{ env.STAGED_CHANNEL_FILES_ARTIFACT }}
path: ${{ env.CHANNEL_FILES_PATH }}
- name: Remove no longer needed artifact
uses: geekyeggo/delete-artifact@v2
with:
name: ${{ env.STAGED_CHANNEL_FILES_ARTIFACT }}
- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: ${{ env.NODE_VERSION }}
registry-url: 'https://registry.npmjs.org'
cache: 'yarn'
- name: Install Go
uses: actions/setup-go@v5
with:
go-version: ${{ env.GO_VERSION }}
- name: Install Task
uses: arduino/setup-task@v2
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
version: 3.x
- name: Install dependencies
run: yarn
- name: Merge "channel update info files"
run: |
node \
./scripts/merge-channel-files.js \
--channel "${{ needs.build-type-determination.outputs.channel-name }}" \
--input "${{ env.CHANNEL_FILES_PATH }}"
- name: Upload merged channel files to job transfer artifact
uses: actions/upload-artifact@v3
with:
if-no-files-found: error
name: ${{ env.JOB_TRANSFER_ARTIFACT }}
path: ${{ env.CHANNEL_FILES_PATH }}
artifacts: artifacts:
name: ${{ matrix.artifact.name }} artifact name: ${{ matrix.artifact.name }} artifact
needs: needs: build
- select-targets
- build
if: always() && needs.build.result != 'skipped' if: always() && needs.build.result != 'skipped'
runs-on: ubuntu-latest runs-on: ubuntu-latest
strategy: strategy:
matrix: matrix:
artifact: ${{ fromJson(needs.select-targets.outputs.artifact-matrix) }} artifact:
- path: '*Linux_64bit.zip'
name: Linux_X86-64_zip
- path: '*Linux_64bit.AppImage'
name: Linux_X86-64_app_image
- path: '*macOS_64bit.dmg'
name: macOS_dmg
- path: '*macOS_64bit.zip'
name: macOS_zip
- path: '*Windows_64bit.exe'
name: Windows_X86-64_interactive_installer
- path: '*Windows_64bit.msi'
name: Windows_X86-64_MSI
- path: '*Windows_64bit.zip'
name: Windows_X86-64_zip
steps: steps:
- name: Download job transfer artifact - name: Download job transfer artifact
@@ -521,22 +152,20 @@ jobs:
path: ${{ env.JOB_TRANSFER_ARTIFACT }}/${{ matrix.artifact.path }} path: ${{ env.JOB_TRANSFER_ARTIFACT }}/${{ matrix.artifact.path }}
changelog: changelog:
needs: needs: build
- build-type-determination
- build
runs-on: ubuntu-latest runs-on: ubuntu-latest
outputs: outputs:
BODY: ${{ steps.changelog.outputs.BODY }} BODY: ${{ steps.changelog.outputs.BODY }}
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v4 uses: actions/checkout@v3
with: with:
fetch-depth: 0 # To fetch all history for all branches and tags. fetch-depth: 0 # To fetch all history for all branches and tags.
- name: Generate Changelog - name: Generate Changelog
id: changelog id: changelog
env: env:
IS_RELEASE: ${{ needs.build-type-determination.outputs.is-release }} IS_RELEASE: ${{ startsWith(github.ref, 'refs/tags/') }}
run: | run: |
export LATEST_TAG=$(git describe --abbrev=0) export LATEST_TAG=$(git describe --abbrev=0)
export GIT_LOG=$(git log --pretty=" - %s [%h]" $LATEST_TAG..HEAD | sed 's/ *$//g') export GIT_LOG=$(git log --pretty=" - %s [%h]" $LATEST_TAG..HEAD | sed 's/ *$//g')
@@ -562,27 +191,15 @@ jobs:
echo "$BODY" > CHANGELOG.txt echo "$BODY" > CHANGELOG.txt
- name: Upload Changelog [GitHub Actions] - name: Upload Changelog [GitHub Actions]
if: needs.build-type-determination.outputs.is-nightly == 'true' if: github.event_name == 'schedule' || (github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main')
uses: actions/upload-artifact@v3 uses: actions/upload-artifact@v3
with: with:
name: ${{ env.JOB_TRANSFER_ARTIFACT }} name: ${{ env.JOB_TRANSFER_ARTIFACT }}
path: CHANGELOG.txt path: CHANGELOG.txt
publish: publish:
needs: needs: changelog
- build-type-determination if: github.repository == 'arduino/arduino-ide' && (github.event_name == 'schedule' || (github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main'))
- merge-channel-files
- changelog
if: >
always() &&
needs.build-type-determination.result == 'success' &&
(
needs.merge-channel-files.result == 'skipped' ||
needs.merge-channel-files.result == 'success'
) &&
needs.changelog.result == 'success' &&
needs.build-type-determination.outputs.publish-to-s3 == 'true' &&
needs.build-type-determination.outputs.is-nightly == 'true'
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Download [GitHub Actions] - name: Download [GitHub Actions]
@@ -602,19 +219,8 @@ jobs:
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
release: release:
needs: needs: changelog
- build-type-determination if: startsWith(github.ref, 'refs/tags/')
- merge-channel-files
- changelog
if: >
always() &&
needs.build-type-determination.result == 'success' &&
(
needs.merge-channel-files.result == 'skipped' ||
needs.merge-channel-files.result == 'success'
) &&
needs.changelog.result == 'success' &&
needs.build-type-determination.outputs.is-release == 'true'
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Download [GitHub Actions] - name: Download [GitHub Actions]
@@ -629,7 +235,7 @@ jobs:
echo "TAG_NAME=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT echo "TAG_NAME=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
- name: Publish Release [GitHub] - name: Publish Release [GitHub]
uses: svenstaro/upload-release-action@2.9.0 uses: svenstaro/upload-release-action@2.5.0
with: with:
repo_token: ${{ secrets.GITHUB_TOKEN }} repo_token: ${{ secrets.GITHUB_TOKEN }}
release_name: ${{ steps.tag_name.outputs.TAG_NAME }} release_name: ${{ steps.tag_name.outputs.TAG_NAME }}
@@ -639,7 +245,7 @@ jobs:
body: ${{ needs.changelog.outputs.BODY }} body: ${{ needs.changelog.outputs.BODY }}
- name: Publish Release [S3] - name: Publish Release [S3]
if: needs.build-type-determination.outputs.publish-to-s3 == 'true' if: github.repository == 'arduino/arduino-ide'
uses: docker://plugins/s3 uses: docker://plugins/s3
env: env:
PLUGIN_SOURCE: '${{ env.JOB_TRANSFER_ARTIFACT }}/*' PLUGIN_SOURCE: '${{ env.JOB_TRANSFER_ARTIFACT }}/*'
@@ -653,7 +259,6 @@ jobs:
# This job must run after all jobs that use the transfer artifact. # This job must run after all jobs that use the transfer artifact.
needs: needs:
- build - build
- merge-channel-files
- publish - publish
- release - release
- artifacts - artifacts

View File

@@ -3,7 +3,6 @@ name: Check Certificates
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
on: on:
create:
push: push:
paths: paths:
- '.github/workflows/check-certificates.ya?ml' - '.github/workflows/check-certificates.ya?ml'
@@ -21,49 +20,12 @@ env:
EXPIRATION_WARNING_PERIOD: 30 EXPIRATION_WARNING_PERIOD: 30
jobs: jobs:
run-determination:
runs-on: ubuntu-latest
outputs:
result: ${{ steps.determination.outputs.result }}
steps:
- name: Determine if the rest of the workflow should run
id: determination
run: |
RELEASE_BRANCH_REGEX="refs/heads/[0-9]+.[0-9]+.x"
REPO_SLUG="arduino/arduino-ide"
if [[
(
# Only run on branch creation when it is a release branch.
# The `create` event trigger doesn't support `branches` filters, so it's necessary to use Bash instead.
"${{ github.event_name }}" != "create" ||
"${{ github.ref }}" =~ $RELEASE_BRANCH_REGEX
) &&
(
# Only run when the workflow will have access to the certificate secrets.
# This could be done via a GitHub Actions workflow conditional, but makes more sense to do it here as well.
(
"${{ github.event_name }}" != "pull_request" &&
"${{ github.repository }}" == "$REPO_SLUG"
) ||
(
"${{ github.event_name }}" == "pull_request" &&
"${{ github.event.pull_request.head.repo.full_name }}" == "$REPO_SLUG"
)
)
]]; then
# Run the other jobs.
RESULT="true"
else
# There is no need to run the other jobs.
RESULT="false"
fi
echo "result=$RESULT" >> $GITHUB_OUTPUT
check-certificates: check-certificates:
name: ${{ matrix.certificate.identifier }} name: ${{ matrix.certificate.identifier }}
needs: run-determination # Only run when the workflow will have access to the certificate secrets.
if: needs.run-determination.outputs.result == 'true' if: >
(github.event_name != 'pull_request' && github.repository == 'arduino/arduino-ide') ||
(github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == 'arduino/arduino-ide')
runs-on: ubuntu-latest runs-on: ubuntu-latest
strategy: strategy:
fail-fast: false fail-fast: false
@@ -74,11 +36,9 @@ jobs:
- identifier: macOS signing certificate # Text used to identify certificate in notifications. - identifier: macOS signing certificate # Text used to identify certificate in notifications.
certificate-secret: APPLE_SIGNING_CERTIFICATE_P12 # Name of the secret that contains the certificate. certificate-secret: APPLE_SIGNING_CERTIFICATE_P12 # Name of the secret that contains the certificate.
password-secret: KEYCHAIN_PASSWORD # Name of the secret that contains the certificate password. password-secret: KEYCHAIN_PASSWORD # Name of the secret that contains the certificate password.
type: pkcs12
- identifier: Windows signing certificate - identifier: Windows signing certificate
certificate-secret: INSTALLER_CERT_WINDOWS_CER certificate-secret: WINDOWS_SIGNING_CERTIFICATE_PFX
# The password for the Windows certificate is not needed, because its not a container, but a single certificate. password-secret: WINDOWS_SIGNING_CERTIFICATE_PASSWORD
type: x509
steps: steps:
- name: Set certificate path environment variable - name: Set certificate path environment variable
@@ -97,7 +57,7 @@ jobs:
CERTIFICATE_PASSWORD: ${{ secrets[matrix.certificate.password-secret] }} CERTIFICATE_PASSWORD: ${{ secrets[matrix.certificate.password-secret] }}
run: | run: |
( (
openssl ${{ matrix.certificate.type }} \ openssl pkcs12 \
-in "${{ env.CERTIFICATE_PATH }}" \ -in "${{ env.CERTIFICATE_PATH }}" \
-legacy \ -legacy \
-noout \ -noout \
@@ -124,7 +84,6 @@ jobs:
CERTIFICATE_PASSWORD: ${{ secrets[matrix.certificate.password-secret] }} CERTIFICATE_PASSWORD: ${{ secrets[matrix.certificate.password-secret] }}
id: get-days-before-expiration id: get-days-before-expiration
run: | run: |
if [[ ${{ matrix.certificate.type }} == "pkcs12" ]]; then
EXPIRATION_DATE="$( EXPIRATION_DATE="$(
( (
openssl pkcs12 \ openssl pkcs12 \
@@ -145,22 +104,6 @@ jobs:
'notAfter=(\K.*)' 'notAfter=(\K.*)'
) )
)" )"
elif [[ ${{ matrix.certificate.type }} == "x509" ]]; then
EXPIRATION_DATE="$(
(
openssl x509 \
-in ${{ env.CERTIFICATE_PATH }} \
-noout \
-enddate
) | (
grep \
--max-count=1 \
--only-matching \
--perl-regexp \
'notAfter=(\K.*)'
)
)"
fi
DAYS_BEFORE_EXPIRATION="$((($(date --utc --date="$EXPIRATION_DATE" +%s) - $(date --utc +%s)) / 60 / 60 / 24))" DAYS_BEFORE_EXPIRATION="$((($(date --utc --date="$EXPIRATION_DATE" +%s) - $(date --utc +%s)) / 60 / 60 / 24))"

View File

@@ -1,58 +0,0 @@
name: Check Containers
on:
pull_request:
paths:
- ".github/workflows/check-containers.ya?ml"
- "**.Dockerfile"
- "**/Dockerfile"
push:
paths:
- ".github/workflows/check-containers.ya?ml"
- "**.Dockerfile"
- "**/Dockerfile"
repository_dispatch:
schedule:
# Run periodically to catch breakage caused by external changes.
- cron: "0 7 * * MON"
workflow_dispatch:
jobs:
run:
name: Run (${{ matrix.image.path }})
runs-on: ubuntu-latest
permissions: {}
services:
registry:
image: registry:2
ports:
- 5000:5000
env:
IMAGE_NAME: name/app:latest
REGISTRY: localhost:5000
strategy:
fail-fast: false
matrix:
image:
- path: .github/workflows/assets/linux.Dockerfile
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Build and push to local registry
uses: docker/build-push-action@v5
with:
context: .
file: ${{ matrix.image.path }}
push: true
tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
- name: Run container
run: |
docker \
run \
--rm \
${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}

View File

@@ -2,11 +2,10 @@ name: Check Internationalization
env: env:
# See vars.GO_VERSION field of https://github.com/arduino/arduino-cli/blob/master/DistTasks.yml # See vars.GO_VERSION field of https://github.com/arduino/arduino-cli/blob/master/DistTasks.yml
GO_VERSION: '1.21' GO_VERSION: "1.19"
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
on: on:
create:
push: push:
paths: paths:
- '.github/workflows/check-i18n-task.ya?ml' - '.github/workflows/check-i18n-task.ya?ml'
@@ -23,61 +22,32 @@ on:
repository_dispatch: repository_dispatch:
jobs: jobs:
run-determination:
runs-on: ubuntu-latest
outputs:
result: ${{ steps.determination.outputs.result }}
permissions: {}
steps:
- name: Determine if the rest of the workflow should run
id: determination
run: |
RELEASE_BRANCH_REGEX="refs/heads/[0-9]+.[0-9]+.x"
TAG_REGEX="refs/tags/.*"
# The `create` event trigger doesn't support `branches` filters, so it's necessary to use Bash instead.
if [[
("${{ github.event_name }}" != "create" ||
"${{ github.ref }}" =~ $RELEASE_BRANCH_REGEX) &&
! "${{ github.ref }}" =~ $TAG_REGEX
]]; then
# Run the other jobs.
RESULT="true"
else
# There is no need to run the other jobs.
RESULT="false"
fi
echo "result=$RESULT" >> $GITHUB_OUTPUT
check: check:
needs: run-determination
if: needs.run-determination.outputs.result == 'true'
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout repository - name: Checkout repository
uses: actions/checkout@v4 uses: actions/checkout@v3
- name: Install Node.js 18.17 - name: Install Node.js 16.x
uses: actions/setup-node@v4 uses: actions/setup-node@v3
with: with:
node-version: '18.17' node-version: '16.x'
registry-url: 'https://registry.npmjs.org' registry-url: 'https://registry.npmjs.org'
cache: 'yarn'
- name: Install Go - name: Install Go
uses: actions/setup-go@v5 uses: actions/setup-go@v4
with: with:
go-version: ${{ env.GO_VERSION }} go-version: ${{ env.GO_VERSION }}
- name: Install Taskfile - name: Install Taskfile
uses: arduino/setup-task@v2 uses: arduino/setup-task@v1
with: with:
repo-token: ${{ secrets.GITHUB_TOKEN }} repo-token: ${{ secrets.GITHUB_TOKEN }}
version: 3.x version: 3.x
- name: Install dependencies - name: Install dependencies
run: yarn install --immutable run: yarn
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

View File

@@ -1,88 +0,0 @@
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-javascript-task.md
name: Check JavaScript
env:
# See: https://github.com/actions/setup-node/#readme
NODE_VERSION: 18.17
# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows
on:
create:
push:
paths:
- '.github/workflows/check-javascript.ya?ml'
- '**/.eslintignore'
- '**/.eslintrc*'
- '**/.npmrc'
- '**/package.json'
- '**/package-lock.json'
- '**/yarn.lock'
- '**.jsx?'
pull_request:
paths:
- '.github/workflows/check-javascript.ya?ml'
- '**/.eslintignore'
- '**/.eslintrc*'
- '**/.npmrc'
- '**/package.json'
- '**/package-lock.json'
- '**/yarn.lock'
- '**.jsx?'
workflow_dispatch:
repository_dispatch:
jobs:
run-determination:
runs-on: ubuntu-latest
permissions: {}
outputs:
result: ${{ steps.determination.outputs.result }}
steps:
- name: Determine if the rest of the workflow should run
id: determination
run: |
RELEASE_BRANCH_REGEX="refs/heads/[0-9]+.[0-9]+.x"
# The `create` event trigger doesn't support `branches` filters, so it's necessary to use Bash instead.
if [[
"${{ github.event_name }}" != "create" ||
"${{ github.ref }}" =~ $RELEASE_BRANCH_REGEX
]]; then
# Run the other jobs.
RESULT="true"
else
# There is no need to run the other jobs.
RESULT="false"
fi
echo "result=$RESULT" >> $GITHUB_OUTPUT
check:
needs: run-determination
if: needs.run-determination.outputs.result == 'true'
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
cache: yarn
node-version: ${{ env.NODE_VERSION }}
- name: Install npm package dependencies
env:
# Avoid failure of @vscode/ripgrep installation due to GitHub API rate limiting:
# https://github.com/microsoft/vscode-ripgrep#github-api-limit-note
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
yarn install
- name: Lint
run: |
yarn \
--cwd arduino-ide-extension \
lint

View File

@@ -1,91 +0,0 @@
name: Check Yarn
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
on:
create:
push:
paths:
- ".github/workflows/check-yarn.ya?ml"
- "**/.yarnrc"
- "**/package.json"
- "**/package-lock.json"
- "**/yarn.lock"
pull_request:
paths:
- ".github/workflows/check-yarn.ya?ml"
- "**/.yarnrc"
- "**/package.json"
- "**/package-lock.json"
- "**/yarn.lock"
schedule:
# Run every Tuesday at 8 AM UTC to catch breakage resulting from changes to the JSON schema.
- cron: "0 8 * * TUE"
workflow_dispatch:
repository_dispatch:
jobs:
run-determination:
runs-on: ubuntu-latest
permissions: {}
outputs:
result: ${{ steps.determination.outputs.result }}
steps:
- name: Determine if the rest of the workflow should run
id: determination
run: |
RELEASE_BRANCH_REGEX="refs/heads/[0-9]+.[0-9]+.x"
# The `create` event trigger doesn't support `branches` filters, so it's necessary to use Bash instead.
if [[
"${{ github.event_name }}" != "create" ||
"${{ github.ref }}" =~ $RELEASE_BRANCH_REGEX
]]; then
# Run the other jobs.
RESULT="true"
else
# There is no need to run the other jobs.
RESULT="false"
fi
echo "result=$RESULT" >> $GITHUB_OUTPUT
check-sync:
name: check-sync (${{ matrix.project.path }})
needs: run-determination
if: needs.run-determination.outputs.result == 'true'
runs-on: ubuntu-latest
permissions:
contents: read
strategy:
fail-fast: false
matrix:
project:
- path: .
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
cache: yarn
node-version: ${{ env.NODE_VERSION }}
- name: Install npm package dependencies
env:
# Avoid failure of @vscode/ripgrep installation due to GitHub API rate limiting:
# https://github.com/microsoft/vscode-ripgrep#github-api-limit-note
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
yarn \
install \
--ignore-scripts
- name: Check yarn.lock
run: |
git \
diff \
--color \
--exit-code \
"${{ matrix.project.path }}/yarn.lock"

View File

@@ -8,7 +8,7 @@ on:
env: env:
CHANGELOG_ARTIFACTS: changelog CHANGELOG_ARTIFACTS: changelog
# See: https://github.com/actions/setup-node/#readme # See: https://github.com/actions/setup-node/#readme
NODE_VERSION: '18.17' NODE_VERSION: 16.x
jobs: jobs:
create-changelog: create-changelog:
@@ -16,10 +16,10 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v4 uses: actions/checkout@v3
- name: Install Node.js - name: Install Node.js
uses: actions/setup-node@v4 uses: actions/setup-node@v3
with: with:
node-version: ${{ env.NODE_VERSION }} node-version: ${{ env.NODE_VERSION }}
registry-url: 'https://registry.npmjs.org' registry-url: 'https://registry.npmjs.org'
@@ -32,7 +32,7 @@ jobs:
- name: Create full changelog - name: Create full changelog
id: full-changelog id: full-changelog
run: | run: |
yarn add @octokit/rest@19.0.13 --ignore-workspace-root-check yarn add @octokit/rest --ignore-workspace-root-check
mkdir "${{ github.workspace }}/${{ env.CHANGELOG_ARTIFACTS }}" mkdir "${{ github.workspace }}/${{ env.CHANGELOG_ARTIFACTS }}"
# Get the changelog file name to build # Get the changelog file name to build

View File

@@ -2,7 +2,7 @@ name: i18n-nightly-push
env: env:
# See vars.GO_VERSION field of https://github.com/arduino/arduino-cli/blob/master/DistTasks.yml # See vars.GO_VERSION field of https://github.com/arduino/arduino-cli/blob/master/DistTasks.yml
GO_VERSION: '1.21' GO_VERSION: "1.19"
on: on:
schedule: schedule:
@@ -14,28 +14,27 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v4 uses: actions/checkout@v3
- name: Install Node.js 18.17 - name: Install Node.js 16.x
uses: actions/setup-node@v4 uses: actions/setup-node@v3
with: with:
node-version: '18.17' node-version: '16.x'
registry-url: 'https://registry.npmjs.org' registry-url: 'https://registry.npmjs.org'
cache: 'yarn'
- name: Install Go - name: Install Go
uses: actions/setup-go@v5 uses: actions/setup-go@v4
with: with:
go-version: ${{ env.GO_VERSION }} go-version: ${{ env.GO_VERSION }}
- name: Install Task - name: Install Task
uses: arduino/setup-task@v2 uses: arduino/setup-task@v1
with: with:
repo-token: ${{ secrets.GITHUB_TOKEN }} repo-token: ${{ secrets.GITHUB_TOKEN }}
version: 3.x version: 3.x
- name: Install dependencies - name: Install dependencies
run: yarn install --immutable run: yarn
- name: Run i18n:push script - name: Run i18n:push script
run: yarn run i18n:push run: yarn run i18n:push

View File

@@ -2,7 +2,7 @@ name: i18n-weekly-pull
env: env:
# See vars.GO_VERSION field of https://github.com/arduino/arduino-cli/blob/master/DistTasks.yml # See vars.GO_VERSION field of https://github.com/arduino/arduino-cli/blob/master/DistTasks.yml
GO_VERSION: '1.21' GO_VERSION: "1.19"
on: on:
schedule: schedule:
@@ -14,28 +14,27 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v4 uses: actions/checkout@v3
- name: Install Node.js 18.17 - name: Install Node.js 16.x
uses: actions/setup-node@v4 uses: actions/setup-node@v3
with: with:
node-version: '18.17' node-version: '16.x'
registry-url: 'https://registry.npmjs.org' registry-url: 'https://registry.npmjs.org'
cache: 'yarn'
- name: Install Go - name: Install Go
uses: actions/setup-go@v5 uses: actions/setup-go@v4
with: with:
go-version: ${{ env.GO_VERSION }} go-version: ${{ env.GO_VERSION }}
- name: Install Task - name: Install Task
uses: arduino/setup-task@v2 uses: arduino/setup-task@v1
with: with:
repo-token: ${{ secrets.GITHUB_TOKEN }} repo-token: ${{ secrets.GITHUB_TOKEN }}
version: 3.x version: 3.x
- name: Install dependencies - name: Install dependencies
run: yarn install --immutable run: yarn
- name: Run i18n:pull script - name: Run i18n:pull script
run: yarn run i18n:pull run: yarn run i18n:pull
@@ -46,7 +45,7 @@ jobs:
TRANSIFEX_API_KEY: ${{ secrets.TRANSIFEX_API_KEY }} TRANSIFEX_API_KEY: ${{ secrets.TRANSIFEX_API_KEY }}
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v5 uses: peter-evans/create-pull-request@v4
with: with:
commit-message: Updated translation files commit-message: Updated translation files
title: Update translation files title: Update translation files

View File

@@ -1,70 +0,0 @@
name: Push Container Images
on:
pull_request:
paths:
- ".github/workflows/push-container-images.ya?ml"
push:
paths:
- ".github/workflows/push-container-images.ya?ml"
- "**.Dockerfile"
- "**/Dockerfile"
repository_dispatch:
schedule:
# Run periodically to catch breakage caused by external changes.
- cron: "0 8 * * MON"
workflow_dispatch:
jobs:
push:
name: Push (${{ matrix.image.name }})
# Only run the job when GITHUB_TOKEN has the privileges required for Container registry login.
if: >
(
github.event_name != 'pull_request' &&
github.repository == 'arduino/arduino-ide'
) ||
(
github.event_name == 'pull_request' &&
github.event.pull_request.head.repo.full_name == 'arduino/arduino-ide'
)
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
strategy:
fail-fast: false
matrix:
image:
- path: .github/workflows/assets/linux.Dockerfile
name: ${{ github.repository }}/linux
registry: ghcr.io
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Log in to the Container registry
uses: docker/login-action@v3
with:
password: ${{ secrets.GITHUB_TOKEN }}
registry: ${{ matrix.image.registry }}
username: ${{ github.repository_owner }}
- name: Extract metadata for image
id: metadata
uses: docker/metadata-action@v5
with:
images: ${{ matrix.image.registry }}/${{ matrix.image.name }}
- name: Build and push image
uses: docker/build-push-action@v5
with:
context: .
file: ${{ matrix.image.path }}
labels: ${{ steps.metadata.outputs.labels }}
# Workflow is triggered on relevant events for the sake of a "dry run" validation but image is only pushed to
# registry on commit to the main branch.
push: ${{ github.ref == 'refs/heads/main' }}
tags: ${{ steps.metadata.outputs.tags }}

View File

@@ -5,15 +5,15 @@ name: Sync Labels
on: on:
push: push:
paths: paths:
- '.github/workflows/sync-labels.ya?ml' - ".github/workflows/sync-labels.ya?ml"
- '.github/label-configuration-files/*.ya?ml' - ".github/label-configuration-files/*.ya?ml"
pull_request: pull_request:
paths: paths:
- '.github/workflows/sync-labels.ya?ml' - ".github/workflows/sync-labels.ya?ml"
- '.github/label-configuration-files/*.ya?ml' - ".github/label-configuration-files/*.ya?ml"
schedule: schedule:
# Run daily at 8 AM UTC to sync with changes to shared label configurations. # Run daily at 8 AM UTC to sync with changes to shared label configurations.
- cron: '0 8 * * *' - cron: "0 8 * * *"
workflow_dispatch: workflow_dispatch:
repository_dispatch: repository_dispatch:
@@ -27,7 +27,7 @@ jobs:
steps: steps:
- name: Checkout repository - name: Checkout repository
uses: actions/checkout@v4 uses: actions/checkout@v3
- name: Download JSON schema for labels configuration file - name: Download JSON schema for labels configuration file
id: download-schema id: download-schema
@@ -106,7 +106,7 @@ jobs:
echo "flag=--dry-run" >> $GITHUB_OUTPUT echo "flag=--dry-run" >> $GITHUB_OUTPUT
- name: Checkout repository - name: Checkout repository
uses: actions/checkout@v4 uses: actions/checkout@v3
- name: Download configuration files artifact - name: Download configuration files artifact
uses: actions/download-artifact@v3 uses: actions/download-artifact@v3

View File

@@ -1,134 +0,0 @@
name: Test JavaScript
env:
# See vars.GO_VERSION field of https://github.com/arduino/arduino-cli/blob/master/DistTasks.yml
GO_VERSION: '1.21'
# See: https://github.com/actions/setup-node/#readme
NODE_VERSION: 18.17
on:
push:
paths:
- ".github/workflows/test-javascript.ya?ml"
- "**/.mocharc.js"
- "**/.mocharc.jsonc?"
- "**/.mocharc.ya?ml"
- "**/package.json"
- "**/package-lock.json"
- "**/yarn.lock"
- "tests/testdata/**"
- "**/tsconfig.json"
- "**.[jt]sx?"
pull_request:
paths:
- ".github/workflows/test-javascript.ya?ml"
- "**/.mocharc.js"
- "**/.mocharc.jsonc?"
- "**/.mocharc.ya?ml"
- "**/package.json"
- "**/package-lock.json"
- "**/yarn.lock"
- "tests/testdata/**"
- "**/tsconfig.json"
- "**.[jt]sx?"
workflow_dispatch:
repository_dispatch:
jobs:
run-determination:
runs-on: ubuntu-latest
permissions: {}
outputs:
result: ${{ steps.determination.outputs.result }}
steps:
- name: Determine if the rest of the workflow should run
id: determination
run: |
RELEASE_BRANCH_REGEX="refs/heads/[0-9]+.[0-9]+.x"
# The `create` event trigger doesn't support `branches` filters, so it's necessary to use Bash instead.
if [[
"${{ github.event_name }}" != "create" ||
"${{ github.ref }}" =~ $RELEASE_BRANCH_REGEX
]]; then
# Run the other jobs.
RESULT="true"
else
# There is no need to run the other jobs.
RESULT="false"
fi
echo "result=$RESULT" >> $GITHUB_OUTPUT
test:
name: test (${{ matrix.project.path }}, ${{ matrix.operating-system }})
needs: run-determination
if: needs.run-determination.outputs.result == 'true'
runs-on: ${{ matrix.operating-system }}
defaults:
run:
shell: bash
permissions:
contents: read
strategy:
fail-fast: false
matrix:
project:
- path: .
operating-system:
- macos-latest
- ubuntu-latest
- windows-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
cache: yarn
node-version: ${{ env.NODE_VERSION }}
# See: https://github.com/eclipse-theia/theia/blob/master/doc/Developing.md#prerequisites
- name: Install Python
uses: actions/setup-python@v5
with:
python-version: '3.11.x'
- name: Install Go
uses: actions/setup-go@v5
with:
go-version: ${{ env.GO_VERSION }}
- name: Install Taskfile
uses: arduino/setup-task@v2
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
version: 3.x
- name: Install npm package dependencies
env:
# Avoid failure of @vscode/ripgrep installation due to GitHub API rate limiting:
# https://github.com/microsoft/vscode-ripgrep#github-api-limit-note
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
yarn install
- name: Compile TypeScript
run: |
yarn \
--cwd arduino-ide-extension \
build
- name: Run tests
env:
# These secrets are optional. Dependent tests will be skipped if not available.
CREATE_USERNAME: ${{ secrets.CREATE_USERNAME }}
CREATE_PASSWORD: ${{ secrets.CREATE_PASSWORD }}
CREATE_CLIENT_SECRET: ${{ secrets.CREATE_CLIENT_SECRET }}
run: |
yarn test
yarn \
--cwd arduino-ide-extension \
test:slow

View File

@@ -8,36 +8,35 @@ on:
env: env:
# See vars.GO_VERSION field of https://github.com/arduino/arduino-cli/blob/master/DistTasks.yml # See vars.GO_VERSION field of https://github.com/arduino/arduino-cli/blob/master/DistTasks.yml
GO_VERSION: '1.21' GO_VERSION: "1.19"
NODE_VERSION: '18.17' NODE_VERSION: 16.x
jobs: jobs:
pull-from-jsonbin: pull-from-jsonbin:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v4 uses: actions/checkout@v3
- name: Install Node.js - name: Install Node.js
uses: actions/setup-node@v4 uses: actions/setup-node@v3
with: with:
node-version: ${{ env.NODE_VERSION }} node-version: ${{ env.NODE_VERSION }}
registry-url: 'https://registry.npmjs.org' registry-url: 'https://registry.npmjs.org'
cache: 'yarn'
- name: Install Go - name: Install Go
uses: actions/setup-go@v5 uses: actions/setup-go@v4
with: with:
go-version: ${{ env.GO_VERSION }} go-version: ${{ env.GO_VERSION }}
- name: Install Task - name: Install Task
uses: arduino/setup-task@v2 uses: arduino/setup-task@v1
with: with:
repo-token: ${{ secrets.GITHUB_TOKEN }} repo-token: ${{ secrets.GITHUB_TOKEN }}
version: 3.x version: 3.x
- name: Install dependencies - name: Install dependencies
run: yarn install --immutable run: yarn
- name: Run themes:pull script - name: Run themes:pull script
run: yarn run themes:pull run: yarn run themes:pull
@@ -55,7 +54,7 @@ jobs:
run: yarn run themes:generate run: yarn run themes:generate
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v5 uses: peter-evans/create-pull-request@v4
with: with:
commit-message: Updated themes commit-message: Updated themes
title: Update themes title: Update themes

13
.gitignore vendored
View File

@@ -1,22 +1,25 @@
node_modules/ node_modules/
# .node_modules is a hack for the electron builder.
.node_modules/
lib/ lib/
downloads/ downloads/
arduino-ide-extension/src/node/resources build/
arduino-ide-extension/Examples/ arduino-ide-extension/Examples/
!electron/build/
src-gen/ src-gen/
webpack.config.js
gen-webpack.config.js gen-webpack.config.js
gen-webpack.node.config.js
.DS_Store .DS_Store
# switching from `electron` to `browser` in dev mode. # switching from `electron` to `browser` in dev mode.
.browser_modules .browser_modules
yarn*.log yarn*.log
# For the VS Code extensions used by Theia. # For the VS Code extensions used by Theia.
electron-app/plugins plugins
# the tokens folder for the themes # the tokens folder for the themes
scripts/themes/tokens scripts/themes/tokens
# environment variables
.env
# content trace files for electron # content trace files for electron
electron-app/traces electron-app/traces
# any Arduino LS generated log files # any Arduino LS generated log files
inols*.log inols*.log
# The electron-builder output.
electron-app/dist

View File

@@ -1,11 +0,0 @@
lib
dist
plugins
src-gen
i18n
gen-webpack*
.browser_modules
arduino-ide-extension/src/node/resources
cli-protocol
*color-theme.json
arduino-icons.json

7
.prettierrc Normal file
View File

@@ -0,0 +1,7 @@
{
"singleQuote": true,
"tabWidth": 2,
"useTabs": false,
"printWidth": 80,
"endOfLine": "auto"
}

View File

@@ -1,28 +0,0 @@
{
"singleQuote": true,
"tabWidth": 2,
"useTabs": false,
"printWidth": 80,
"endOfLine": "auto",
"overrides": [
{
"files": "*.json",
"options": {
"tabWidth": 2
}
},
{
"files": "*.css",
"options": {
"tabWidth": 4,
"singleQuote": false
}
},
{
"files": "*.html",
"options": {
"tabWidth": 4
}
}
]
}

72
.vscode/launch.json vendored
View File

@@ -4,33 +4,35 @@
{ {
"type": "node", "type": "node",
"request": "launch", "request": "launch",
"name": "App", "name": "App (Electron) [Dev]",
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron", "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron",
"windows": { "windows": {
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron.cmd" "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron.cmd",
}, },
"cwd": "${workspaceFolder}/electron-app", "cwd": "${workspaceFolder}/electron-app",
"args": [ "args": [
".", ".",
"--log-level=debug", "--log-level=debug",
"--hostname=localhost", "--hostname=localhost",
"--app-project-path=${workspaceFolder}/electron-app", "--app-project-path=${workspaceRoot}/electron-app",
"--remote-debugging-port=9222", "--remote-debugging-port=9222",
"--no-app-auto-install", "--no-app-auto-install",
"--plugins=local-dir:./plugins", "--plugins=local-dir:../plugins",
"--hosted-plugin-inspect=9339", "--hosted-plugin-inspect=9339",
"--no-ping-timeout" "--content-trace",
"--open-devtools",
"--no-ping-timeout",
], ],
"env": { "env": {
"NODE_ENV": "development" "NODE_ENV": "development"
}, },
"sourceMaps": true, "sourceMaps": true,
"outFiles": [ "outFiles": [
"${workspaceFolder}/electron-app/lib/backend/electron-main.js", "${workspaceRoot}/electron-app/src-gen/backend/*.js",
"${workspaceFolder}/electron-app/lib/backend/main.js", "${workspaceRoot}/electron-app/src-gen/frontend/*.js",
"${workspaceFolder}/electron-app/lib/**/*.js", "${workspaceRoot}/electron-app/lib/**/*.js",
"${workspaceFolder}/arduino-ide-extension/lib/**/*.js", "${workspaceRoot}/arduino-ide-extension/lib/**/*.js",
"${workspaceFolder}/node_modules/@theia/**/*.js" "${workspaceRoot}/node_modules/@theia/**/*.js"
], ],
"smartStep": true, "smartStep": true,
"internalConsoleOptions": "openOnSessionStart", "internalConsoleOptions": "openOnSessionStart",
@@ -39,35 +41,33 @@
{ {
"type": "node", "type": "node",
"request": "launch", "request": "launch",
"name": "App [Dev]", "name": "App (Electron)",
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron", "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron",
"windows": { "windows": {
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron.cmd" "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron.cmd",
}, },
"cwd": "${workspaceFolder}/electron-app", "cwd": "${workspaceFolder}/electron-app",
"args": [ "args": [
".", ".",
"--log-level=debug", "--log-level=debug",
"--hostname=localhost", "--hostname=localhost",
"--app-project-path=${workspaceFolder}/electron-app", "--app-project-path=${workspaceRoot}/electron-app",
"--remote-debugging-port=9222", "--remote-debugging-port=9222",
"--no-app-auto-install", "--no-app-auto-install",
"--plugins=local-dir:./plugins", "--plugins=local-dir:../plugins",
"--hosted-plugin-inspect=9339", "--hosted-plugin-inspect=9339",
"--content-trace", "--no-ping-timeout",
"--open-devtools",
"--no-ping-timeout"
], ],
"env": { "env": {
"NODE_ENV": "development" "NODE_ENV": "development"
}, },
"sourceMaps": true, "sourceMaps": true,
"outFiles": [ "outFiles": [
"${workspaceFolder}/electron-app/lib/backend/electron-main.js", "${workspaceRoot}/electron-app/src-gen/backend/*.js",
"${workspaceFolder}/electron-app/lib/backend/main.js", "${workspaceRoot}/electron-app/src-gen/frontend/*.js",
"${workspaceFolder}/electron-app/lib/**/*.js", "${workspaceRoot}/electron-app/lib/**/*.js",
"${workspaceFolder}/arduino-ide-extension/lib/**/*.js", "${workspaceRoot}/arduino-ide-extension/lib/**/*.js",
"${workspaceFolder}/node_modules/@theia/**/*.js" "${workspaceRoot}/node_modules/@theia/**/*.js"
], ],
"smartStep": true, "smartStep": true,
"internalConsoleOptions": "openOnSessionStart", "internalConsoleOptions": "openOnSessionStart",
@@ -84,7 +84,7 @@
"type": "node", "type": "node",
"request": "launch", "request": "launch",
"name": "Run Test [current]", "name": "Run Test [current]",
"program": "${workspaceFolder}/node_modules/mocha/bin/_mocha", "program": "${workspaceRoot}/node_modules/mocha/bin/_mocha",
"args": [ "args": [
"--require", "--require",
"reflect-metadata/Reflect", "reflect-metadata/Reflect",
@@ -94,16 +94,8 @@
"--colors", "--colors",
"**/${fileBasenameNoExtension}.js" "**/${fileBasenameNoExtension}.js"
], ],
"outFiles": [
"${workspaceRoot}/electron-app/src-gen/backend/*.js",
"${workspaceRoot}/electron-app/src-gen/frontend/*.js",
"${workspaceRoot}/electron-app/lib/**/*.js",
"${workspaceRoot}/arduino-ide-extension/lib/**/*.js",
"${workspaceRoot}/node_modules/@theia/**/*.js"
],
"env": { "env": {
"TS_NODE_PROJECT": "${workspaceFolder}/tsconfig.json", "TS_NODE_PROJECT": "${workspaceRoot}/tsconfig.json"
"IDE2_TEST": "true"
}, },
"sourceMaps": true, "sourceMaps": true,
"smartStep": true, "smartStep": true,
@@ -115,12 +107,22 @@
"request": "attach", "request": "attach",
"name": "Attach by Process ID", "name": "Attach by Process ID",
"processId": "${command:PickProcess}" "processId": "${command:PickProcess}"
},
{
"type": "node",
"request": "launch",
"name": "Electron Packager",
"program": "${workspaceRoot}/electron/packager/index.js",
"cwd": "${workspaceFolder}/electron/packager"
} }
], ],
"compounds": [ "compounds": [
{ {
"name": "Launch Electron Backend & Frontend", "name": "Launch Electron Backend & Frontend",
"configurations": ["App", "Attach to Electron Frontend"] "configurations": [
"App (Electron)",
"Attach to Electron Frontend"
]
} }
] ]
} }

View File

@@ -7,6 +7,6 @@
}, },
"typescript.tsdk": "node_modules/typescript/lib", "typescript.tsdk": "node_modules/typescript/lib",
"editor.codeActionsOnSave": { "editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit" "source.fixAll.eslint": true
} },
} }

18
.vscode/tasks.json vendored
View File

@@ -2,13 +2,10 @@
"version": "2.0.0", "version": "2.0.0",
"tasks": [ "tasks": [
{ {
"label": "Rebuild App", "label": "Arduino IDE - Rebuild Electron App",
"type": "shell", "type": "shell",
"command": "yarn rebuild", "command": "yarn rebuild:browser && yarn rebuild:electron",
"group": "build", "group": "build",
"options": {
"cwd": "${workspaceFolder}/electron-app"
},
"presentation": { "presentation": {
"reveal": "always", "reveal": "always",
"panel": "new", "panel": "new",
@@ -16,7 +13,7 @@
} }
}, },
{ {
"label": "Watch Extension", "label": "Arduino IDE - Watch IDE Extension",
"type": "shell", "type": "shell",
"command": "yarn --cwd ./arduino-ide-extension watch", "command": "yarn --cwd ./arduino-ide-extension watch",
"group": "build", "group": "build",
@@ -27,7 +24,7 @@
} }
}, },
{ {
"label": "Watch App", "label": "Arduino IDE - Watch Electron App",
"type": "shell", "type": "shell",
"command": "yarn --cwd ./electron-app watch", "command": "yarn --cwd ./electron-app watch",
"group": "build", "group": "build",
@@ -38,9 +35,12 @@
} }
}, },
{ {
"label": "Watch All", "label": "Arduino IDE - Watch All [Electron]",
"type": "shell", "type": "shell",
"dependsOn": ["Watch Extension", "Watch App"] "dependsOn": [
"Arduino IDE - Watch IDE Extension",
"Arduino IDE - Watch Electron App"
]
} }
] ]
} }

View File

@@ -2,11 +2,9 @@
# Arduino IDE 2.x # Arduino IDE 2.x
[![Build status](https://github.com/arduino/arduino-ide/actions/workflows/build.yml/badge.svg)](https://github.com/arduino/arduino-ide/actions/workflows/build.yml) [![Arduino IDE](https://github.com/arduino/arduino-ide/workflows/Arduino%20IDE/badge.svg)](https://github.com/arduino/arduino-ide/actions?query=workflow%3A%22Arduino+IDE%22)
[![Check JavaScript status](https://github.com/arduino/arduino-ide/actions/workflows/check-javascript.yml/badge.svg)](https://github.com/arduino/arduino-ide/actions/workflows/check-javascript.yml)
[![Test JavaScript status](https://github.com/arduino/arduino-ide/actions/workflows/test-javascript.yml/badge.svg)](https://github.com/arduino/arduino-ide/actions/workflows/test-javascript.yml)
This repository contains the source code of the Arduino IDE 2.x. If you're looking for the old IDE, go to the [repository of the 1.x version](https://github.com/arduino/Arduino). This repository contains the source code of the Arduino IDE 2.x. If you're looking for the old IDE, go to the repository of the 1.x version at https://github.com/arduino/Arduino.
The Arduino IDE 2.x is a major rewrite, sharing no code with the IDE 1.x. It is based on the [Theia IDE](https://theia-ide.org/) framework and built with [Electron](https://www.electronjs.org/). The backend operations such as compilation and uploading are offloaded to an [arduino-cli](https://github.com/arduino/arduino-cli) instance running in daemon mode. This new IDE was developed with the goal of preserving the same interface and user experience of the previous major version in order to provide a frictionless upgrade. The Arduino IDE 2.x is a major rewrite, sharing no code with the IDE 1.x. It is based on the [Theia IDE](https://theia-ide.org/) framework and built with [Electron](https://www.electronjs.org/). The backend operations such as compilation and uploading are offloaded to an [arduino-cli](https://github.com/arduino/arduino-cli) instance running in daemon mode. This new IDE was developed with the goal of preserving the same interface and user experience of the previous major version in order to provide a frictionless upgrade.

View File

@@ -55,12 +55,10 @@ The Config Service knows about your system, like for example the default sketch
- checking whether a file is in a data or sketch directory - checking whether a file is in a data or sketch directory
### `"arduino"` configuration in the `package.json`: ### `"arduino"` configuration in the `package.json`:
- `"cli"`: - `"cli"`:
- `"version"` type `string` | `{ owner: string, repo: string, commitish?: string }`: if the type is a `string` and is a valid semver, it will get the corresponding [released](https://github.com/arduino/arduino-cli/releases) CLI. If the type is `string` and is a [date in `YYYYMMDD`](https://arduino.github.io/arduino-cli/latest/installation/#nightly-builds) format, it will get a nightly CLI. If the type is an object, a CLI, build from the sources in the `owner/repo` will be used. If `commitish` is not defined, the HEAD of the default branch will be used. In any other cases an error is thrown. - `"version"` type `string` | `{ owner: string, repo: string, commitish?: string }`: if the type is a `string` and is a valid semver, it will get the corresponding [released](https://github.com/arduino/arduino-cli/releases) CLI. If the type is `string` and is a [date in `YYYYMMDD`](https://arduino.github.io/arduino-cli/latest/installation/#nightly-builds) format, it will get a nightly CLI. If the type is an object, a CLI, build from the sources in the `owner/repo` will be used. If `commitish` is not defined, the HEAD of the default branch will be used. In any other cases an error is thrown.
#### Rebuild gRPC protocol interfaces #### Rebuild gRPC protocol interfaces
- Some CLI updates can bring changes to the gRPC interfaces, as the API might change. gRPC interfaces can be updated running the command - Some CLI updates can bring changes to the gRPC interfaces, as the API might change. gRPC interfaces can be updated running the command
`yarn --cwd arduino-ide-extension generate-protocol` `yarn --cwd arduino-ide-extension generate-protocol`
@@ -74,10 +72,8 @@ The [**clangd** C++ language server](https://clangd.llvm.org/) and the [**ClangF
1. Submit a pull request in [the `arduino/tooling-project-assets` repository](https://github.com/arduino/tooling-project-assets) to update the version in the `vars.DEFAULT_CLANG_FORMAT_VERSION` field of [`Taskfile.yml`](https://github.com/arduino/tooling-project-assets/blob/main/Taskfile.yml). 1. Submit a pull request in [the `arduino/tooling-project-assets` repository](https://github.com/arduino/tooling-project-assets) to update the version in the `vars.DEFAULT_CLANG_FORMAT_VERSION` field of [`Taskfile.yml`](https://github.com/arduino/tooling-project-assets/blob/main/Taskfile.yml).
### Customize Icons ### Customize Icons
ArduinoIde uses a customized version of FontAwesome. ArduinoIde uses a customized version of FontAwesome.
In order to update/replace icons follow the following steps: In order to update/replace icons follow the following steps:
- import the file `arduino-icons.json` in [Icomoon](https://icomoon.io/app/#/projects) - import the file `arduino-icons.json` in [Icomoon](https://icomoon.io/app/#/projects)
- load it - load it
- edit the icons as needed - edit the icons as needed

View File

@@ -1,85 +1,83 @@
{ {
"name": "arduino-ide-extension", "name": "arduino-ide-extension",
"version": "2.3.4", "version": "2.0.5",
"description": "An extension for Theia building the Arduino IDE", "description": "An extension for Theia building the Arduino IDE",
"license": "AGPL-3.0-or-later", "license": "AGPL-3.0-or-later",
"scripts": { "scripts": {
"prepare": "yarn download-cli && yarn download-fwuploader && yarn download-ls && yarn copy-i18n && yarn download-examples", "prepare": "yarn download-cli && yarn download-fwuploader && yarn download-ls && yarn copy-i18n && yarn clean && yarn download-examples && yarn build && yarn test",
"clean": "rimraf lib", "clean": "rimraf lib",
"compose-changelog": "node ./scripts/compose-changelog.js", "compose-changelog": "node ./scripts/compose-changelog.js",
"download-cli": "node ./scripts/download-cli.js", "download-cli": "node ./scripts/download-cli.js",
"download-fwuploader": "node ./scripts/download-fwuploader.js", "download-fwuploader": "node ./scripts/download-fwuploader.js",
"copy-i18n": "ncp ../i18n ./src/node/resources/i18n", "copy-i18n": "npx ncp ../i18n ./build/i18n",
"download-ls": "node ./scripts/download-ls.js", "download-ls": "node ./scripts/download-ls.js",
"download-examples": "node ./scripts/download-examples.js", "download-examples": "node ./scripts/download-examples.js",
"generate-protocol": "node ./scripts/generate-protocol.js", "generate-protocol": "node ./scripts/generate-protocol.js",
"lint": "eslint .", "lint": "eslint",
"prebuild": "rimraf lib", "build": "tsc && ncp ./src/node/cli-protocol/ ./lib/node/cli-protocol/ && yarn lint",
"build": "tsc",
"build:dev": "yarn build",
"postbuild": "ncp ./src/node/cli-protocol/ ./lib/node/cli-protocol/",
"watch": "tsc -w", "watch": "tsc -w",
"test": "cross-env IDE2_TEST=true mocha \"./lib/test/**/*.test.js\"", "test": "mocha \"./lib/test/**/*.test.js\"",
"test:slow": "cross-env IDE2_TEST=true mocha \"./lib/test/**/*.slow-test.js\" --slow 5000" "test:slow": "mocha \"./lib/test/**/*.slow-test.js\" --slow 5000",
"test:watch": "mocha --watch --watch-files lib \"./lib/test/**/*.test.js\""
}, },
"dependencies": { "dependencies": {
"@grpc/grpc-js": "^1.8.14", "@grpc/grpc-js": "^1.6.7",
"@theia/application-package": "1.41.0", "@theia/application-package": "1.31.1",
"@theia/core": "1.41.0", "@theia/core": "1.31.1",
"@theia/debug": "1.41.0", "@theia/debug": "1.31.1",
"@theia/editor": "1.41.0", "@theia/editor": "1.31.1",
"@theia/electron": "1.41.0", "@theia/electron": "1.31.1",
"@theia/filesystem": "1.41.0", "@theia/filesystem": "1.31.1",
"@theia/keymaps": "1.41.0", "@theia/keymaps": "1.31.1",
"@theia/markers": "1.41.0", "@theia/markers": "1.31.1",
"@theia/messages": "1.41.0", "@theia/messages": "1.31.1",
"@theia/monaco": "1.41.0", "@theia/monaco": "1.31.1",
"@theia/monaco-editor-core": "1.72.3", "@theia/monaco-editor-core": "1.67.2",
"@theia/navigator": "1.41.0", "@theia/navigator": "1.31.1",
"@theia/outline-view": "1.41.0", "@theia/outline-view": "1.31.1",
"@theia/output": "1.41.0", "@theia/output": "1.31.1",
"@theia/plugin-ext": "1.41.0", "@theia/plugin-ext": "1.31.1",
"@theia/plugin-ext-vscode": "1.41.0", "@theia/preferences": "1.31.1",
"@theia/preferences": "1.41.0", "@theia/scm": "1.31.1",
"@theia/scm": "1.41.0", "@theia/search-in-workspace": "1.31.1",
"@theia/search-in-workspace": "1.41.0", "@theia/terminal": "1.31.1",
"@theia/terminal": "1.41.0", "@theia/typehierarchy": "1.31.1",
"@theia/typehierarchy": "1.41.0", "@theia/workspace": "1.31.1",
"@theia/workspace": "1.41.0",
"@tippyjs/react": "^4.2.5", "@tippyjs/react": "^4.2.5",
"@types/auth0-js": "^9.21.3", "@types/auth0-js": "^9.14.0",
"@types/btoa": "^1.2.3", "@types/btoa": "^1.2.3",
"@types/dateformat": "^3.0.1", "@types/dateformat": "^3.0.1",
"@types/deepmerge": "^2.2.0",
"@types/glob": "^7.2.0",
"@types/google-protobuf": "^3.7.2", "@types/google-protobuf": "^3.7.2",
"@types/js-yaml": "^3.12.2", "@types/js-yaml": "^3.12.2",
"@types/jsdom": "^21.1.1", "@types/keytar": "^4.4.0",
"@types/lodash.debounce": "^4.0.6", "@types/lodash.debounce": "^4.0.6",
"@types/node-fetch": "^2.5.7", "@types/node-fetch": "^2.5.7",
"@types/p-queue": "^2.3.1", "@types/p-queue": "^2.3.1",
"@types/ps-tree": "^1.1.0", "@types/ps-tree": "^1.1.0",
"@types/react-tabs": "^2.3.2", "@types/react-tabs": "^2.3.2",
"@types/temp": "^0.8.34", "@types/temp": "^0.8.34",
"@types/which": "^1.3.1",
"@vscode/debugprotocol": "^1.51.0",
"arduino-serial-plotter-webapp": "0.2.0", "arduino-serial-plotter-webapp": "0.2.0",
"async-mutex": "^0.3.0", "async-mutex": "^0.3.0",
"auth0-js": "^9.23.2", "auth0-js": "^9.14.0",
"btoa": "^1.2.1", "btoa": "^1.2.1",
"classnames": "^2.3.1", "classnames": "^2.3.1",
"cpy": "^8.1.2",
"cross-fetch": "^3.1.5", "cross-fetch": "^3.1.5",
"dateformat": "^3.0.3", "dateformat": "^3.0.3",
"deepmerge": "^4.2.2", "deepmerge": "2.0.1",
"drivelist": "^9.2.4",
"electron-updater": "^4.6.5", "electron-updater": "^4.6.5",
"fast-deep-equal": "^3.1.3",
"fast-json-stable-stringify": "^2.1.0", "fast-json-stable-stringify": "^2.1.0",
"fast-safe-stringify": "^2.1.1", "fast-safe-stringify": "^2.1.1",
"filename-reserved-regex": "^2.0.0", "filename-reserved-regex": "^2.0.0",
"fqbn": "^1.0.5", "glob": "^7.1.6",
"glob": "10.4.4",
"google-protobuf": "^3.20.1", "google-protobuf": "^3.20.1",
"hash.js": "^1.1.7", "hash.js": "^1.1.7",
"is-online": "^10.0.0", "is-online": "^9.0.1",
"js-yaml": "^3.13.1", "js-yaml": "^3.13.1",
"jsdom": "^21.1.1",
"jsonc-parser": "^2.2.0", "jsonc-parser": "^2.2.0",
"just-diff": "^5.1.1", "just-diff": "^5.1.1",
"jwt-decode": "^3.1.2", "jwt-decode": "^3.1.2",
@@ -87,11 +85,9 @@
"lodash.debounce": "^4.0.8", "lodash.debounce": "^4.0.8",
"minimatch": "^3.1.2", "minimatch": "^3.1.2",
"node-fetch": "^2.6.1", "node-fetch": "^2.6.1",
"node-log-rotate": "^0.1.5",
"open": "^8.0.6", "open": "^8.0.6",
"p-debounce": "^2.1.0", "p-debounce": "^2.1.0",
"p-queue": "^2.4.2", "p-queue": "^2.4.2",
"process": "^0.11.10",
"ps-tree": "^1.2.0", "ps-tree": "^1.2.0",
"query-string": "^7.0.1", "query-string": "^7.0.1",
"react-disable": "^0.1.1", "react-disable": "^0.1.1",
@@ -105,31 +101,33 @@
"temp": "^0.9.1", "temp": "^0.9.1",
"temp-dir": "^2.0.0", "temp-dir": "^2.0.0",
"tree-kill": "^1.2.1", "tree-kill": "^1.2.1",
"util": "^0.12.5", "which": "^1.3.1"
"vscode-arduino-api": "^0.1.2"
}, },
"devDependencies": { "devDependencies": {
"@octokit/rest": "^18.12.0", "@octokit/rest": "^18.12.0",
"@types/chai": "^4.2.7", "@types/chai": "^4.2.7",
"@types/mocha": "^10.0.0", "@types/chai-string": "^1.4.2",
"@types/mocha": "^5.2.7",
"@types/react-window": "^1.8.5", "@types/react-window": "^1.8.5",
"@xhmikosr/downloader": "^13.0.1",
"chai": "^4.2.0", "chai": "^4.2.0",
"cross-env": "^7.0.3", "chai-string": "^1.5.0",
"decompress": "^4.2.0", "decompress": "^4.2.0",
"decompress-tarbz2": "^4.1.1", "decompress-tarbz2": "^4.1.1",
"decompress-targz": "^4.1.1", "decompress-targz": "^4.1.1",
"decompress-unzip": "^4.0.1", "decompress-unzip": "^4.0.1",
"grpc_tools_node_protoc_ts": "^5.3.3", "download": "^7.1.0",
"mocha": "^10.2.0", "grpc_tools_node_protoc_ts": "^4.1.0",
"mocha": "^7.0.0",
"mockdate": "^3.0.5", "mockdate": "^3.0.5",
"moment": "^2.24.0", "moment": "^2.24.0",
"ncp": "^2.0.0", "ncp": "^2.0.0",
"rimraf": "^2.6.1" "protoc": "^1.0.4",
"shelljs": "^0.8.3",
"uuid": "^3.2.1",
"yargs": "^11.1.0"
}, },
"optionalDependencies": { "optionalDependencies": {
"@pingghost/protoc": "^1.0.2", "grpc-tools": "^1.9.0"
"grpc-tools": "^1.12.4"
}, },
"mocha": { "mocha": {
"require": [ "require": [
@@ -149,9 +147,6 @@
"examples" "examples"
], ],
"theiaExtensions": [ "theiaExtensions": [
{
"preload": "lib/electron-browser/preload"
},
{ {
"backend": "lib/node/arduino-ide-backend-module", "backend": "lib/node/arduino-ide-backend-module",
"frontend": "lib/browser/arduino-ide-frontend-module" "frontend": "lib/browser/arduino-ide-frontend-module"
@@ -162,29 +157,26 @@
{ {
"frontendElectron": "lib/electron-browser/theia/core/electron-window-module" "frontendElectron": "lib/electron-browser/theia/core/electron-window-module"
}, },
{
"frontendElectron": "lib/electron-browser/electron-arduino-module"
},
{ {
"electronMain": "lib/electron-main/arduino-electron-main-module" "electronMain": "lib/electron-main/arduino-electron-main-module"
} }
], ],
"arduino": { "arduino": {
"arduino-cli": { "cli": {
"version": "1.1.0"
},
"arduino-fwuploader": {
"version": "2.4.1"
},
"arduino-language-server": {
"version": { "version": {
"owner": "arduino", "owner": "arduino",
"repo": "arduino-language-server", "repo": "arduino-cli",
"commitish": "05ec308" "commitish": "71a8576"
} }
}, },
"fwuploader": {
"version": "2.2.2"
},
"clangd": { "clangd": {
"version": "14.0.0" "version": "14.0.0"
},
"languageServer": {
"version": "0.7.4"
} }
} }
} }

View File

@@ -34,7 +34,7 @@
}, ''); }, '');
const args = process.argv.slice(2); const args = process.argv.slice(2);
if (args.length === 0) { if (args.length == 0) {
console.error('Missing argument to destination file'); console.error('Missing argument to destination file');
process.exit(1); process.exit(1);
} }

View File

@@ -2,6 +2,7 @@
(async () => { (async () => {
const path = require('path'); const path = require('path');
const shell = require('shelljs');
const semver = require('semver'); const semver = require('semver');
const moment = require('moment'); const moment = require('moment');
const downloader = require('./downloader'); const downloader = require('./downloader');
@@ -18,7 +19,7 @@
return undefined; return undefined;
} }
const cli = arduino['arduino-cli']; const { cli } = arduino;
if (!cli) { if (!cli) {
return undefined; return undefined;
} }
@@ -28,20 +29,14 @@
})(); })();
if (!version) { if (!version) {
console.log(`Could not retrieve CLI version info from the 'package.json'.`); shell.echo(`Could not retrieve CLI version info from the 'package.json'.`);
process.exit(1); shell.exit(1);
} }
const { platform, arch } = process; const { platform, arch } = process;
const resourcesFolder = path.join( const buildFolder = path.join(__dirname, '..', 'build');
__dirname,
'..',
'src',
'node',
'resources'
);
const cliName = `arduino-cli${platform === 'win32' ? '.exe' : ''}`; const cliName = `arduino-cli${platform === 'win32' ? '.exe' : ''}`;
const destinationPath = path.join(resourcesFolder, cliName); const destinationPath = path.join(buildFolder, cliName);
if (typeof version === 'string') { if (typeof version === 'string') {
const suffix = (() => { const suffix = (() => {
@@ -70,24 +65,24 @@
} }
})(); })();
if (!suffix) { if (!suffix) {
console.log(`The CLI is not available for ${platform} ${arch}.`); shell.echo(`The CLI is not available for ${platform} ${arch}.`);
process.exit(1); shell.exit(1);
} }
if (semver.valid(version)) { if (semver.valid(version)) {
const url = `https://downloads.arduino.cc/arduino-cli/arduino-cli_${version}_${suffix}`; const url = `https://downloads.arduino.cc/arduino-cli/arduino-cli_${version}_${suffix}`;
console.log( shell.echo(
`📦 Identified released version of the CLI. Downloading version ${version} from '${url}'` `📦 Identified released version of the CLI. Downloading version ${version} from '${url}'`
); );
await downloader.downloadUnzipFile(url, destinationPath, 'arduino-cli'); await downloader.downloadUnzipFile(url, destinationPath, 'arduino-cli');
} else if (moment(version, 'YYYYMMDD', true).isValid()) { } else if (moment(version, 'YYYYMMDD', true).isValid()) {
const url = `https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-${version}_${suffix}`; const url = `https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-${version}_${suffix}`;
console.log( shell.echo(
`🌙 Identified nightly version of the CLI. Downloading version ${version} from '${url}'` `🌙 Identified nightly version of the CLI. Downloading version ${version} from '${url}'`
); );
await downloader.downloadUnzipFile(url, destinationPath, 'arduino-cli'); await downloader.downloadUnzipFile(url, destinationPath, 'arduino-cli');
} else { } else {
console.log(`🔥 Could not interpret 'version': ${version}`); shell.echo(`🔥 Could not interpret 'version': ${version}`);
process.exit(1); shell.exit(1);
} }
} else { } else {
taskBuildFromGit(version, destinationPath, 'CLI'); taskBuildFromGit(version, destinationPath, 'CLI');

View File

@@ -1,62 +1,39 @@
// @ts-check // @ts-check
// The version to use. // The version to use.
const version = '1.10.1'; const version = '1.10.0';
(async () => { (async () => {
const os = require('node:os'); const os = require('os');
const { const { promises: fs } = require('fs');
existsSync, const path = require('path');
promises: fs, const shell = require('shelljs');
mkdirSync, const { v4 } = require('uuid');
readdirSync,
cpSync,
} = require('node:fs');
const path = require('node:path');
const { exec } = require('./utils');
const destination = path.join( const repository = path.join(os.tmpdir(), `${v4()}-arduino-examples`);
__dirname, if (shell.mkdir('-p', repository).code !== 0) {
'..', shell.exit(1);
'src',
'node',
'resources',
'Examples'
);
if (existsSync(destination)) {
console.log(
`Skipping Git checkout of the examples because the repository already exists: ${destination}`
);
return;
} }
const repository = await fs.mkdtemp( if (
path.join(os.tmpdir(), 'arduino-examples-') shell.exec(
); `git clone https://github.com/arduino/arduino-examples.git ${repository}`
).code !== 0
exec( ) {
'git', shell.exit(1);
['clone', 'https://github.com/arduino/arduino-examples.git', repository],
{ logStdout: true }
);
exec(
'git',
['-C', repository, 'checkout', `tags/${version}`, '-b', version],
{ logStdout: true }
);
mkdirSync(destination, { recursive: true });
const examplesPath = path.join(repository, 'examples');
const exampleResources = readdirSync(examplesPath);
for (const exampleResource of exampleResources) {
cpSync(
path.join(examplesPath, exampleResource),
path.join(destination, exampleResource),
{ recursive: true }
);
} }
if (
shell.exec(`git -C ${repository} checkout tags/${version} -b ${version}`)
.code !== 0
) {
shell.exit(1);
}
const destination = path.join(__dirname, '..', 'Examples');
shell.mkdir('-p', destination);
shell.cp('-fR', path.join(repository, 'examples', '*'), destination);
const isSketch = async (pathLike) => { const isSketch = async (pathLike) => {
try { try {
const names = await fs.readdir(pathLike); const names = await fs.readdir(pathLike);
@@ -115,5 +92,5 @@ const version = '1.10.1';
JSON.stringify(examples, null, 2), JSON.stringify(examples, null, 2),
{ encoding: 'utf8' } { encoding: 'utf8' }
); );
console.log(`Generated output to ${path.join(destination, 'examples.json')}`); shell.echo(`Generated output to ${path.join(destination, 'examples.json')}`);
})(); })();

View File

@@ -1,10 +1,12 @@
// @ts-check // @ts-check
(async () => { (async () => {
const path = require('node:path'); const fs = require('fs');
const path = require('path');
const temp = require('temp');
const shell = require('shelljs');
const semver = require('semver'); const semver = require('semver');
const downloader = require('./downloader'); const downloader = require('./downloader');
const { taskBuildFromGit } = require('./utils');
const version = (() => { const version = (() => {
const pkg = require(path.join(__dirname, '..', 'package.json')); const pkg = require(path.join(__dirname, '..', 'package.json'));
@@ -17,7 +19,7 @@
return undefined; return undefined;
} }
const fwuploader = arduino['arduino-fwuploader']; const { fwuploader } = arduino;
if (!fwuploader) { if (!fwuploader) {
return undefined; return undefined;
} }
@@ -27,37 +29,24 @@
})(); })();
if (!version) { if (!version) {
console.log( shell.echo(
`Could not retrieve Firmware Uploader version info from the 'package.json'.` `Could not retrieve Firmware Uploader version info from the 'package.json'.`
); );
process.exit(1); shell.exit(1);
} }
const { platform, arch } = process; const { platform, arch } = process;
const resourcesFolder = path.join( const buildFolder = path.join(__dirname, '..', 'build');
__dirname,
'..',
'src',
'node',
'resources'
);
const fwuploderName = `arduino-fwuploader${ const fwuploderName = `arduino-fwuploader${
platform === 'win32' ? '.exe' : '' platform === 'win32' ? '.exe' : ''
}`; }`;
const destinationPath = path.join(resourcesFolder, fwuploderName); const destinationPath = path.join(buildFolder, fwuploderName);
if (typeof version === 'string') { if (typeof version === 'string') {
const suffix = (() => { const suffix = (() => {
switch (platform) { switch (platform) {
case 'darwin': case 'darwin':
switch (arch) {
case 'arm64':
return 'macOS_ARM64.tar.gz';
case 'x64':
return 'macOS_64bit.tar.gz'; return 'macOS_64bit.tar.gz';
default:
return undefined;
}
case 'win32': case 'win32':
return 'Windows_64bit.zip'; return 'Windows_64bit.zip';
case 'linux': { case 'linux': {
@@ -77,14 +66,14 @@
} }
})(); })();
if (!suffix) { if (!suffix) {
console.log( shell.echo(
`The Firmware Uploader is not available for ${platform} ${arch}.` `The Firmware Uploader is not available for ${platform} ${arch}.`
); );
process.exit(1); shell.exit(1);
} }
if (semver.valid(version)) { if (semver.valid(version)) {
const url = `https://downloads.arduino.cc/arduino-fwuploader/arduino-fwuploader_${version}_${suffix}`; const url = `https://downloads.arduino.cc/arduino-fwuploader/arduino-fwuploader_${version}_${suffix}`;
console.log( shell.echo(
`📦 Identified released version of the Firmware Uploader. Downloading version ${version} from '${url}'` `📦 Identified released version of the Firmware Uploader. Downloading version ${version} from '${url}'`
); );
await downloader.downloadUnzipFile( await downloader.downloadUnzipFile(
@@ -93,10 +82,85 @@
'arduino-fwuploader' 'arduino-fwuploader'
); );
} else { } else {
console.log(`🔥 Could not interpret 'version': ${version}`); shell.echo(`🔥 Could not interpret 'version': ${version}`);
process.exit(1); shell.exit(1);
} }
} else { } else {
taskBuildFromGit(version, destinationPath, 'Firmware Uploader'); // We assume an object with `owner`, `repo`, commitish?` properties.
const { owner, repo, commitish } = version;
if (!owner) {
shell.echo(`Could not retrieve 'owner' from ${JSON.stringify(version)}`);
shell.exit(1);
}
if (!repo) {
shell.echo(`Could not retrieve 'repo' from ${JSON.stringify(version)}`);
shell.exit(1);
}
const url = `https://github.com/${owner}/${repo}.git`;
shell.echo(
`Building Firmware Uploader from ${url}. Commitish: ${
commitish ? commitish : 'HEAD'
}`
);
if (fs.existsSync(destinationPath)) {
shell.echo(
`Skipping the Firmware Uploader build because it already exists: ${destinationPath}`
);
return;
}
if (shell.mkdir('-p', buildFolder).code !== 0) {
shell.echo('Could not create build folder.');
shell.exit(1);
}
const tempRepoPath = temp.mkdirSync();
shell.echo(`>>> Cloning Firmware Uploader source to ${tempRepoPath}...`);
if (shell.exec(`git clone ${url} ${tempRepoPath}`).code !== 0) {
shell.exit(1);
}
shell.echo('<<< Cloned Firmware Uploader repo.');
if (commitish) {
shell.echo(`>>> Checking out ${commitish}...`);
if (
shell.exec(`git -C ${tempRepoPath} checkout ${commitish}`).code !== 0
) {
shell.exit(1);
}
shell.echo(`<<< Checked out ${commitish}.`);
}
shell.echo(`>>> Building the Firmware Uploader...`);
if (shell.exec('go build', { cwd: tempRepoPath }).code !== 0) {
shell.exit(1);
}
shell.echo('<<< Firmware Uploader build done.');
if (!fs.existsSync(path.join(tempRepoPath, fwuploderName))) {
shell.echo(
`Could not find the Firmware Uploader at ${path.join(
tempRepoPath,
fwuploderName
)}.`
);
shell.exit(1);
}
const builtFwUploaderPath = path.join(tempRepoPath, fwuploderName);
shell.echo(
`>>> Copying Firmware Uploader from ${builtFwUploaderPath} to ${destinationPath}...`
);
if (shell.cp(builtFwUploaderPath, destinationPath).code !== 0) {
shell.exit(1);
}
shell.echo(`<<< Copied the Firmware Uploader.`);
shell.echo('<<< Verifying Firmware Uploader...');
if (!fs.existsSync(destinationPath)) {
shell.exit(1);
}
shell.echo('>>> Verified Firmware Uploader.');
} }
})(); })();

View File

@@ -5,6 +5,7 @@
(() => { (() => {
const path = require('path'); const path = require('path');
const shell = require('shelljs');
const downloader = require('./downloader'); const downloader = require('./downloader');
const { goBuildFromGit } = require('./utils'); const { goBuildFromGit } = require('./utils');
@@ -15,8 +16,7 @@
const { arduino } = pkg; const { arduino } = pkg;
if (!arduino) return [undefined, undefined]; if (!arduino) return [undefined, undefined];
const { clangd } = arduino; const { languageServer, clangd } = arduino;
const languageServer = arduino['arduino-language-server'];
if (!languageServer) return [undefined, undefined]; if (!languageServer) return [undefined, undefined];
if (!clangd) return [undefined, undefined]; if (!clangd) return [undefined, undefined];
@@ -24,20 +24,20 @@
})(); })();
if (!DEFAULT_LS_VERSION) { if (!DEFAULT_LS_VERSION) {
console.log( shell.echo(
`Could not retrieve Arduino Language Server version info from the 'package.json'.` `Could not retrieve Arduino Language Server version info from the 'package.json'.`
); );
process.exit(1); shell.exit(1);
} }
if (!DEFAULT_CLANGD_VERSION) { if (!DEFAULT_CLANGD_VERSION) {
console.log( shell.echo(
`Could not retrieve clangd version info from the 'package.json'.` `Could not retrieve clangd version info from the 'package.json'.`
); );
process.exit(1); shell.exit(1);
} }
const yargs = require('@theia/core/shared/yargs') const yargs = require('yargs')
.option('ls-version', { .option('ls-version', {
alias: 'lv', alias: 'lv',
default: DEFAULT_LS_VERSION, default: DEFAULT_LS_VERSION,
@@ -62,50 +62,35 @@
const force = yargs['force-download']; const force = yargs['force-download'];
const { platform, arch } = process; const { platform, arch } = process;
const platformArch = platform + '-' + arch; const platformArch = platform + '-' + arch;
const resourcesFolder = path.join( const build = path.join(__dirname, '..', 'build');
__dirname,
'..',
'src',
'node',
'resources'
);
const lsExecutablePath = path.join( const lsExecutablePath = path.join(
resourcesFolder, build,
`arduino-language-server${platform === 'win32' ? '.exe' : ''}` `arduino-language-server${platform === 'win32' ? '.exe' : ''}`
); );
let clangdExecutablePath, clangFormatExecutablePath, lsSuffix, clangdSuffix; let clangdExecutablePath, clangFormatExecutablePath, lsSuffix, clangdSuffix;
switch (platformArch) { switch (platformArch) {
case 'darwin-x64': case 'darwin-x64':
clangdExecutablePath = path.join(resourcesFolder, 'clangd'); clangdExecutablePath = path.join(build, 'clangd');
clangFormatExecutablePath = path.join(resourcesFolder, 'clang-format'); clangFormatExecutablePath = path.join(build, 'clang-format');
lsSuffix = 'macOS_64bit.tar.gz'; lsSuffix = 'macOS_64bit.tar.gz';
clangdSuffix = 'macOS_64bit'; clangdSuffix = 'macOS_64bit';
break; break;
case 'darwin-arm64': case 'darwin-arm64':
clangdExecutablePath = path.join(resourcesFolder, 'clangd'); clangdExecutablePath = path.join(build, 'clangd');
clangFormatExecutablePath = path.join(resourcesFolder, 'clang-format'); clangFormatExecutablePath = path.join(build, 'clang-format');
lsSuffix = 'macOS_ARM64.tar.gz'; lsSuffix = 'macOS_ARM64.tar.gz';
clangdSuffix = 'macOS_ARM64'; clangdSuffix = 'macOS_ARM64';
break; break;
case 'linux-x64': case 'linux-x64':
clangdExecutablePath = path.join(resourcesFolder, 'clangd'); clangdExecutablePath = path.join(build, 'clangd');
clangFormatExecutablePath = path.join(resourcesFolder, 'clang-format'); clangFormatExecutablePath = path.join(build, 'clang-format');
lsSuffix = 'Linux_64bit.tar.gz'; lsSuffix = 'Linux_64bit.tar.gz';
clangdSuffix = 'Linux_64bit'; clangdSuffix = 'Linux_64bit';
break; break;
case 'linux-arm64':
clangdExecutablePath = path.join(resourcesFolder, 'clangd');
clangFormatExecutablePath = path.join(resourcesFolder, 'clang-format');
lsSuffix = 'Linux_ARM64.tar.gz';
clangdSuffix = 'Linux_ARM64';
break;
case 'win32-x64': case 'win32-x64':
clangdExecutablePath = path.join(resourcesFolder, 'clangd.exe'); clangdExecutablePath = path.join(build, 'clangd.exe');
clangFormatExecutablePath = path.join( clangFormatExecutablePath = path.join(build, 'clang-format.exe');
resourcesFolder,
'clang-format.exe'
);
lsSuffix = 'Windows_64bit.zip'; lsSuffix = 'Windows_64bit.zip';
clangdSuffix = 'Windows_64bit'; clangdSuffix = 'Windows_64bit';
break; break;
@@ -113,10 +98,10 @@
throw new Error(`Unsupported platform/arch: ${platformArch}.`); throw new Error(`Unsupported platform/arch: ${platformArch}.`);
} }
if (!lsSuffix || !clangdSuffix) { if (!lsSuffix || !clangdSuffix) {
console.log( shell.echo(
`The arduino-language-server is not available for ${platform} ${arch}.` `The arduino-language-server is not available for ${platform} ${arch}.`
); );
process.exit(1); shell.exit(1);
} }
if (typeof lsVersion === 'string') { if (typeof lsVersion === 'string') {
@@ -125,31 +110,20 @@
? 'nightly/arduino-language-server' ? 'nightly/arduino-language-server'
: 'arduino-language-server_' + lsVersion : 'arduino-language-server_' + lsVersion
}_${lsSuffix}`; }_${lsSuffix}`;
downloader.downloadUnzipAll( downloader.downloadUnzipAll(lsUrl, build, lsExecutablePath, force);
lsUrl,
resourcesFolder,
lsExecutablePath,
force
);
} else { } else {
goBuildFromGit(lsVersion, lsExecutablePath, 'language-server'); goBuildFromGit(lsVersion, lsExecutablePath, 'language-server');
} }
const clangdUrl = `https://downloads.arduino.cc/tools/clangd_${clangdVersion}_${clangdSuffix}.tar.bz2`; const clangdUrl = `https://downloads.arduino.cc/tools/clangd_${clangdVersion}_${clangdSuffix}.tar.bz2`;
downloader.downloadUnzipAll( downloader.downloadUnzipAll(clangdUrl, build, clangdExecutablePath, force, {
clangdUrl,
resourcesFolder,
clangdExecutablePath,
force,
{
strip: 1, strip: 1,
} }); // `strip`: the new clangd (12.x) is zipped into a folder, so we have to strip the outmost folder.
); // `strip`: the new clangd (12.x) is zipped into a folder, so we have to strip the outmost folder.
const clangdFormatUrl = `https://downloads.arduino.cc/tools/clang-format_${clangdVersion}_${clangdSuffix}.tar.bz2`; const clangdFormatUrl = `https://downloads.arduino.cc/tools/clang-format_${clangdVersion}_${clangdSuffix}.tar.bz2`;
downloader.downloadUnzipAll( downloader.downloadUnzipAll(
clangdFormatUrl, clangdFormatUrl,
resourcesFolder, build,
clangFormatExecutablePath, clangFormatExecutablePath,
force, force,
{ {

View File

@@ -1,19 +1,21 @@
// @ts-check
const fs = require('fs'); const fs = require('fs');
const path = require('path'); const path = require('path');
const shell = require('shelljs');
const download = require('download');
const decompress = require('decompress'); const decompress = require('decompress');
const unzip = require('decompress-unzip'); const unzip = require('decompress-unzip');
const untargz = require('decompress-targz'); const untargz = require('decompress-targz');
const untarbz2 = require('decompress-tarbz2'); const untarbz2 = require('decompress-tarbz2');
process.on('unhandledRejection', (reason) => { process.on('unhandledRejection', (reason, _) => {
console.log(String(reason)); shell.echo(String(reason));
process.exit(1); shell.exit(1);
throw reason;
}); });
process.on('uncaughtException', (error) => { process.on('uncaughtException', (error) => {
console.log(String(error)); shell.echo(String(error));
process.exit(1); shell.exit(1);
throw error;
}); });
/** /**
@@ -29,42 +31,54 @@ exports.downloadUnzipFile = async (
force = false force = false
) => { ) => {
if (fs.existsSync(targetFile) && !force) { if (fs.existsSync(targetFile) && !force) {
console.log(`Skipping download because file already exists: ${targetFile}`); shell.echo(`Skipping download because file already exists: ${targetFile}`);
return; return;
} }
fs.mkdirSync(path.dirname(targetFile), { recursive: true }); if (!fs.existsSync(path.dirname(targetFile))) {
if (shell.mkdir('-p', path.dirname(targetFile)).code !== 0) {
shell.echo('Could not create new directory.');
shell.exit(1);
}
}
const downloads = path.join(__dirname, '..', 'downloads'); const downloads = path.join(__dirname, '..', 'downloads');
fs.rmSync(targetFile, { recursive: true, force: true }); if (shell.rm('-rf', targetFile, downloads).code !== 0) {
fs.rmSync(downloads, { recursive: true, force: true }); shell.exit(1);
}
console.log(`>>> Downloading from '${url}'...`); shell.echo(`>>> Downloading from '${url}'...`);
const data = await download(url); const data = await download(url);
console.log(`<<< Download succeeded.`); shell.echo(`<<< Download succeeded.`);
console.log('>>> Decompressing...'); shell.echo('>>> Decompressing...');
const files = await decompress(data, downloads, { const files = await decompress(data, downloads, {
plugins: [unzip(), untargz(), untarbz2()], plugins: [unzip(), untargz(), untarbz2()],
}); });
if (files.length === 0) { if (files.length === 0) {
console.log('Error ocurred while decompressing the archive.'); shell.echo('Error ocurred while decompressing the archive.');
process.exit(1); shell.exit(1);
} }
const fileIndex = files.findIndex((f) => f.path.startsWith(filePrefix)); const fileIndex = files.findIndex((f) => f.path.startsWith(filePrefix));
if (fileIndex === -1) { if (fileIndex === -1) {
console.log( shell.echo(
`The downloaded artifact does not contain any file with prefix ${filePrefix}.` `The downloaded artifact does not contain any file with prefix ${filePrefix}.`
); );
process.exit(1); shell.exit(1);
} }
console.log('<<< Decompressing succeeded.'); shell.echo('<<< Decompressing succeeded.');
fs.renameSync(path.join(downloads, files[fileIndex].path), targetFile); if (
if (!fs.existsSync(targetFile)) { shell.mv('-f', path.join(downloads, files[fileIndex].path), targetFile)
console.log(`Could not find file: ${targetFile}`); .code !== 0
process.exit(1); ) {
shell.echo(`Could not move file to target path: ${targetFile}`);
shell.exit(1);
} }
console.log(`Done: ${targetFile}`); if (!fs.existsSync(targetFile)) {
shell.echo(`Could not find file: ${targetFile}`);
shell.exit(1);
}
shell.echo(`Done: ${targetFile}`);
}; };
/** /**
@@ -72,7 +86,7 @@ exports.downloadUnzipFile = async (
* @param targetDir {string} Directory into which to decompress the archive * @param targetDir {string} Directory into which to decompress the archive
* @param targetFile {string} Path to the main file expected after decompressing * @param targetFile {string} Path to the main file expected after decompressing
* @param force {boolean} Whether to download even if the target file exists * @param force {boolean} Whether to download even if the target file exists
* @param decompressOptions {import('decompress').DecompressOptions|undefined} [decompressOptions] * @param decompressOptions {import('decompress').DecompressOptions}
*/ */
exports.downloadUnzipAll = async ( exports.downloadUnzipAll = async (
url, url,
@@ -82,16 +96,21 @@ exports.downloadUnzipAll = async (
decompressOptions = undefined decompressOptions = undefined
) => { ) => {
if (fs.existsSync(targetFile) && !force) { if (fs.existsSync(targetFile) && !force) {
console.log(`Skipping download because file already exists: ${targetFile}`); shell.echo(`Skipping download because file already exists: ${targetFile}`);
return; return;
} }
fs.mkdirSync(targetDir, { recursive: true }); if (!fs.existsSync(targetDir)) {
if (shell.mkdir('-p', targetDir).code !== 0) {
shell.echo('Could not create new directory.');
shell.exit(1);
}
}
console.log(`>>> Downloading from '${url}'...`); shell.echo(`>>> Downloading from '${url}'...`);
const data = await download(url); const data = await download(url);
console.log(`<<< Download succeeded.`); shell.echo(`<<< Download succeeded.`);
console.log('>>> Decompressing...'); shell.echo('>>> Decompressing...');
let options = { let options = {
plugins: [unzip(), untargz(), untarbz2()], plugins: [unzip(), untargz(), untarbz2()],
}; };
@@ -100,27 +119,14 @@ exports.downloadUnzipAll = async (
} }
const files = await decompress(data, targetDir, options); const files = await decompress(data, targetDir, options);
if (files.length === 0) { if (files.length === 0) {
console.log('Error ocurred while decompressing the archive.'); shell.echo('Error ocurred while decompressing the archive.');
process.exit(1); shell.exit(1);
} }
console.log('<<< Decompressing succeeded.'); shell.echo('<<< Decompressing succeeded.');
if (!fs.existsSync(targetFile)) { if (!fs.existsSync(targetFile)) {
console.log(`Could not find file: ${targetFile}`); shell.echo(`Could not find file: ${targetFile}`);
process.exit(1); shell.exit(1);
} }
console.log(`Done: ${targetFile}`); shell.echo(`Done: ${targetFile}`);
}; };
/**
* @param {string} url
* @returns {Promise<import('node:buffer').Buffer>}
*/
async function download(url) {
const { default: download } = await import('@xhmikosr/downloader');
/** @type {import('node:buffer').Buffer} */
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
const data = await download(url);
return data;
}

View File

@@ -1,79 +1,75 @@
// @ts-check // @ts-check
(async () => { (async () => {
const os = require('node:os');
const path = require('node:path'); const os = require('os');
const { mkdirSync, promises: fs, rmSync } = require('node:fs'); const path = require('path');
const { exec } = require('./utils'); const glob = require('glob');
const { glob } = require('glob'); const { v4 } = require('uuid');
const { SemVer, gte, valid: validSemVer, gt } = require('semver'); const shell = require('shelljs');
// Use a node-protoc fork until apple arm32 is supported const protoc = path.dirname(require('protoc/protoc'));
// https://github.com/YePpHa/node-protoc/pull/10 shell.env.PATH = `${shell.env.PATH}${path.delimiter}${protoc}`;
const protoc = path.dirname(require('@pingghost/protoc/protoc')); shell.env.PATH = `${shell.env.PATH}${path.delimiter}${path.join(__dirname, '..', 'node_modules', '.bin')}`;
const repository = path.join(os.tmpdir(), `${v4()}-arduino-cli`);
if (shell.mkdir('-p', repository).code !== 0) {
shell.exit(1);
}
const { owner, repo, commitish } = (() => { const { owner, repo, commitish } = (() => {
const pkg = require(path.join(__dirname, '..', 'package.json')); const pkg = require(path.join(__dirname, '..', 'package.json'));
if (!pkg) { if (!pkg) {
console.log(`Could not parse the 'package.json'.`); shell.echo(`Could not parse the 'package.json'.`);
process.exit(1); shell.exit(1);
} }
const defaultVersion = {
owner: 'arduino',
repo: 'arduino-cli',
commitish: undefined,
};
const { arduino } = pkg; const { arduino } = pkg;
if (!arduino) { if (!arduino) {
return defaultVersion; return { owner: 'arduino', repo: 'arduino-cli' };
} }
const cli = arduino['arduino-cli']; const { cli } = arduino;
if (!cli) { if (!cli) {
return defaultVersion; return { owner: 'arduino', repo: 'arduino-cli' };
} }
const { version } = cli; const { version } = cli;
if (!version) { if (!version) {
return defaultVersion; return { owner: 'arduino', repo: 'arduino-cli' };
} }
if (typeof version === 'string') { if (typeof version === 'string') {
return defaultVersion; return { owner: 'arduino', repo: 'arduino-cli' };
} }
// We assume an object with `owner`, `repo`, commitish?` properties. // We assume an object with `owner`, `repo`, commitish?` properties.
const { owner, repo, commitish } = version; const { owner, repo, commitish } = version;
if (!owner) { if (!owner) {
console.log(`Could not retrieve 'owner' from ${JSON.stringify(version)}`); shell.echo(`Could not retrieve 'owner' from ${JSON.stringify(version)}`);
process.exit(1); shell.exit(1);
} }
if (!repo) { if (!repo) {
console.log(`Could not retrieve 'repo' from ${JSON.stringify(version)}`); shell.echo(`Could not retrieve 'repo' from ${JSON.stringify(version)}`);
process.exit(1); shell.exit(1);
} }
return { owner, repo, commitish }; return { owner, repo, commitish };
})(); })();
const url = `https://github.com/${owner}/${repo}.git`;
shell.echo(`>>> Cloning repository from '${url}'...`);
if (shell.exec(`git clone ${url} ${repository}`).code !== 0) {
shell.exit(1);
}
shell.echo(`<<< Repository cloned.`);
const { platform } = process; const { platform } = process;
const resourcesFolder = path.join( const build = path.join(__dirname, '..', 'build');
__dirname, const cli = path.join(build, `arduino-cli${platform === 'win32' ? '.exe' : ''}`);
'..', const versionJson = shell.exec(`${cli} version --format json`).trim();
'src',
'node',
'resources'
);
const cli = path.join(
resourcesFolder,
`arduino-cli${platform === 'win32' ? '.exe' : ''}`
);
const versionJson = exec(cli, ['version', '--format', 'json'], {
logStdout: true,
}).trim();
if (!versionJson) { if (!versionJson) {
console.log(`Could not retrieve the CLI version from ${cli}.`); shell.echo(`Could not retrieve the CLI version from ${cli}.`);
process.exit(1); shell.exit(1);
} }
// As of today (28.01.2021), the `VersionString` can be one of the followings: // As of today (28.01.2021), the `VersionString` can be one of the followings:
// - `nightly-YYYYMMDD` stands for the nightly build, we use the , the `commitish` from the `package.json` to check out the code. // - `nightly-YYYYMMDD` stands for the nightly build, we use the , the `commitish` from the `package.json` to check out the code.
@@ -91,151 +87,70 @@
*/ */
const versionObject = JSON.parse(versionJson); const versionObject = JSON.parse(versionJson);
const version = versionObject.VersionString; const version = versionObject.VersionString;
if (version && !version.startsWith('nightly-') && version !== '0.0.0-git' && version !== 'git-snapshot') {
// Clone the repository and check out the tagged version shell.echo(`>>> Checking out tagged version: '${version}'...`);
// Return folder with proto files shell.exec(`git -C ${repository} fetch --all --tags`);
async function getProtoPath(forceCliVersion) { if (shell.exec(`git -C ${repository} checkout tags/${version} -b ${version}`).code !== 0) {
const repository = await fs.mkdtemp(path.join(os.tmpdir(), 'arduino-cli-')); shell.exit(1);
const url = `https://github.com/${owner}/${repo}.git`;
console.log(`>>> Cloning repository from '${url}'...`);
exec('git', ['clone', url, repository], { logStdout: true });
console.log(`<<< Repository cloned.`);
let cliVersion = forceCliVersion || version;
if (validSemVer(cliVersion)) {
// https://github.com/arduino/arduino-cli/pull/2374
if (
gte(new SemVer(version, { loose: true }), new SemVer('0.35.0-rc.1'))
) {
cliVersion = `v${cliVersion}`;
} }
console.log(`>>> Checking out tagged version: '${cliVersion}'...`); shell.echo(`<<< Checked out tagged version: '${commitish}'.`);
exec('git', ['-C', repository, 'fetch', '--all', '--tags'], {
logStdout: true,
});
exec(
'git',
['-C', repository, 'checkout', `tags/${cliVersion}`, '-b', cliVersion],
{ logStdout: true }
);
console.log(`<<< Checked out tagged version: '${cliVersion}'.`);
} else if (forceCliVersion) {
console.log(`WARN: invalid semver: '${forceCliVersion}'.`);
// If the forced version is invalid, do not proceed with fallbacks.
return undefined;
} else if (commitish) { } else if (commitish) {
console.log( shell.echo(`>>> Checking out commitish from 'package.json': '${commitish}'...`);
`>>> Checking out commitish from 'package.json': '${commitish}'...` if (shell.exec(`git -C ${repository} checkout ${commitish}`).code !== 0) {
); shell.exit(1);
exec('git', ['-C', repository, 'checkout', commitish], { }
logStdout: true, shell.echo(`<<< Checked out commitish from 'package.json': '${commitish}'.`);
});
console.log(
`<<< Checked out commitish from 'package.json': '${commitish}'.`
);
} else if (versionObject.Commit) { } else if (versionObject.Commit) {
console.log( shell.echo(`>>> Checking out commitish from the CLI: '${versionObject.Commit}'...`);
`>>> Checking out commitish from the CLI: '${versionObject.Commit}'...` if (shell.exec(`git -C ${repository} checkout ${versionObject.Commit}`).code !== 0) {
); shell.exit(1);
exec('git', ['-C', repository, 'checkout', versionObject.Commit], { }
logStdout: true, shell.echo(`<<< Checked out commitish from the CLI: '${versionObject.Commit}'.`);
});
console.log(
`<<< Checked out commitish from the CLI: '${versionObject.Commit}'.`
);
} else { } else {
console.log( shell.echo(`WARN: no 'git checkout'. Generating from the HEAD revision.`);
`WARN: no 'git checkout'. Generating from the HEAD revision.`
);
} }
return path.join(repository, 'rpc'); shell.echo('>>> Generating TS/JS API from:');
if (shell.exec(`git -C ${repository} rev-parse --abbrev-ref HEAD`).code !== 0) {
shell.exit(1);
} }
const protoPath = await getProtoPath(); const rpc = path.join(repository, 'rpc');
if (!protoPath) {
console.log(`Could not find the proto files folder.`);
process.exit(1);
}
console.log('>>> Generating TS/JS API from:');
exec('git', ['-C', protoPath, 'rev-parse', '--abbrev-ref', 'HEAD'], {
logStdout: true,
});
const out = path.join(__dirname, '..', 'src', 'node', 'cli-protocol'); const out = path.join(__dirname, '..', 'src', 'node', 'cli-protocol');
// Must wipe the gen output folder. Otherwise, dangling service implementation remain in IDE2 code, shell.mkdir('-p', out);
// although it has been removed from the proto file.
// For example, https://github.com/arduino/arduino-cli/commit/50a8bf5c3e61d5b661ccfcd6a055e82eeb510859.
rmSync(out, { recursive: true, maxRetries: 5, force: true });
mkdirSync(out, { recursive: true });
if (gt(new SemVer(version, { loose: true }), new SemVer('1.0.4'))) { const protos = await new Promise(resolve =>
// Patch for https://github.com/arduino/arduino-cli/issues/2755 glob('**/*.proto', { cwd: rpc }, (error, matches) => {
// Credit https://github.com/dankeboy36/ardunno-cli-gen/pull/9/commits/64a5ac89aae605249261c8ceff7255655ecfafca if (error) {
// Download the 1.0.4 version and use the missing google/rpc/status.proto file. shell.echo(error.stack);
console.log('<<< Generating missing google proto files'); resolve([]);
const v104ProtoPath = await getProtoPath('1.0.4'); return;
if (!v104ProtoPath) {
console.log(`Could not find the proto files folder for version 1.0.4.`);
process.exit(1);
} }
await fs.cp( resolve(matches.map(filename => path.join(rpc, filename)));
path.join(v104ProtoPath, 'google'), }));
path.join(protoPath, 'google'),
{
recursive: true,
}
);
console.log(`>>> Generated missing google file`);
}
let protos = [];
try {
const matches = await glob('**/*.proto', { cwd: protoPath });
protos = matches.map((filename) => path.join(protoPath, filename));
} catch (error) {
console.log(error.stack ?? error.message);
}
if (!protos || protos.length === 0) { if (!protos || protos.length === 0) {
console.log(`Could not find any .proto files under ${protoPath}.`); shell.echo(`Could not find any .proto files under ${rpc}.`);
process.exit(1); shell.exit(1);
} }
// Generate JS code from the `.proto` files. // Generate JS code from the `.proto` files.
exec( if (shell.exec(`grpc_tools_node_protoc \
'grpc_tools_node_protoc', --js_out=import_style=commonjs,binary:${out} \
[ --grpc_out=generate_package_definition:${out} \
`--js_out=import_style=commonjs,binary:${out}`, -I ${rpc} \
`--grpc_out=generate_package_definition:${out}`, ${protos.join(' ')}`).code !== 0) {
'-I', shell.exit(1);
protoPath, }
...protos,
],
{ logStdout: true }
);
// Generate the `.d.ts` files for JS. // Generate the `.d.ts` files for JS.
exec( if (shell.exec(`protoc \
path.join(protoc, `protoc${platform === 'win32' ? '.exe' : ''}`), --plugin=protoc-gen-ts=${path.resolve(__dirname, '..', 'node_modules', '.bin', `protoc-gen-ts${platform === 'win32' ? '.cmd' : ''}`)} \
[ --ts_out=generate_package_definition:${out} \
`--plugin=protoc-gen-ts=${path.resolve( -I ${rpc} \
__dirname, ${protos.join(' ')}`).code !== 0) {
'..', shell.exit(1);
'node_modules', }
'.bin',
`protoc-gen-ts${platform === 'win32' ? '.cmd' : ''}` shell.echo('<<< Generation was successful.');
)}`,
`--ts_out=generate_package_definition:${out}`,
'-I',
protoPath,
...protos,
],
{ logStdout: true }
);
console.log('<<< Generation was successful.');
})(); })();

View File

@@ -1,28 +1,3 @@
// @ts-check
const exec = (
/** @type {string} */ command,
/** @type {readonly string[]} */ args,
/** @type {Partial<import('node:child_process').ExecFileSyncOptionsWithStringEncoding> & { logStdout?: boolean }|undefined} */ options = undefined
) => {
try {
const stdout = require('node:child_process').execFileSync(command, args, {
encoding: 'utf8',
...(options ?? {}),
});
if (options?.logStdout) {
console.log(stdout.trim());
}
return stdout;
} catch (err) {
console.log(
`Failed to execute ${command} with args: ${JSON.stringify(args)}`
);
throw err;
}
};
exports.exec = exec;
/** /**
* Clones something from GitHub and builds it with [`Task`](https://taskfile.dev/). * Clones something from GitHub and builds it with [`Task`](https://taskfile.dev/).
* *
@@ -46,98 +21,90 @@ exports.goBuildFromGit = (version, destinationPath, taskName) => {
}; };
/** /**
* The `command` must be either `'go'` or `'task'`. * The `command` is either `go` or `task`.
* @param {string} command
* @param {{ owner: any; repo: any; commitish: any; }} version
* @param {string} destinationPath
* @param {string} taskName
*/ */
function buildFromGit(command, version, destinationPath, taskName) { function buildFromGit(command, version, destinationPath, taskName) {
const fs = require('node:fs'); const fs = require('fs');
const path = require('node:path'); const path = require('path');
const temp = require('temp'); const temp = require('temp');
const shell = require('shelljs');
// We assume an object with `owner`, `repo`, commitish?` properties. // We assume an object with `owner`, `repo`, commitish?` properties.
if (typeof version !== 'object') { if (typeof version !== 'object') {
console.log( shell.echo(
`Expected a \`{ owner, repo, commitish }\` object. Got <${version}> instead.` `Expected a \`{ owner, repo, commitish }\` object. Got <${version}> instead.`
); );
} }
const { owner, repo, commitish } = version; const { owner, repo, commitish } = version;
if (!owner) { if (!owner) {
console.log(`Could not retrieve 'owner' from ${JSON.stringify(version)}`); shell.echo(`Could not retrieve 'owner' from ${JSON.stringify(version)}`);
process.exit(1); shell.exit(1);
} }
if (!repo) { if (!repo) {
console.log(`Could not retrieve 'repo' from ${JSON.stringify(version)}`); shell.echo(`Could not retrieve 'repo' from ${JSON.stringify(version)}`);
process.exit(1); shell.exit(1);
} }
const url = `https://github.com/${owner}/${repo}.git`; const url = `https://github.com/${owner}/${repo}.git`;
console.log( shell.echo(
`Building ${taskName} from ${url}. Commitish: ${ `Building ${taskName} from ${url}. Commitish: ${
commitish ? commitish : 'HEAD' commitish ? commitish : 'HEAD'
}` }`
); );
if (fs.existsSync(destinationPath)) { if (fs.existsSync(destinationPath)) {
console.log( shell.echo(
`Skipping the ${taskName} build because it already exists: ${destinationPath}` `Skipping the ${taskName} build because it already exists: ${destinationPath}`
); );
return; return;
} }
const resourcesFolder = path.join( const buildFolder = path.join(__dirname, '..', 'build');
__dirname, if (shell.mkdir('-p', buildFolder).code !== 0) {
'..', shell.echo('Could not create build folder.');
'src', shell.exit(1);
'node',
'resources'
);
fs.mkdirSync(resourcesFolder, { recursive: true });
const tempRepoPath = temp.mkdirSync();
console.log(`>>> Cloning ${taskName} source to ${tempRepoPath}...`);
exec('git', ['clone', url, tempRepoPath], { logStdout: true });
console.log(`<<< Cloned ${taskName} repo.`);
if (commitish) {
console.log(`>>> Checking out ${commitish}...`);
exec('git', ['-C', tempRepoPath, 'checkout', commitish], {
logStdout: true,
});
console.log(`<<< Checked out ${commitish}.`);
} }
exec('git', ['-C', tempRepoPath, 'rev-parse', '--short', 'HEAD'], { const tempRepoPath = temp.mkdirSync();
logStdout: true, shell.echo(`>>> Cloning ${taskName} source to ${tempRepoPath}...`);
}); if (shell.exec(`git clone ${url} ${tempRepoPath}`).code !== 0) {
shell.exit(1);
}
shell.echo(`<<< Cloned ${taskName} repo.`);
console.log(`>>> Building the ${taskName}...`); if (commitish) {
exec(command, ['build'], { shell.echo(`>>> Checking out ${commitish}...`);
cwd: tempRepoPath, if (shell.exec(`git -C ${tempRepoPath} checkout ${commitish}`).code !== 0) {
encoding: 'utf8', shell.exit(1);
logStdout: true, }
}); shell.echo(`<<< Checked out ${commitish}.`);
console.log(`<<< Done ${taskName} build.`); }
shell.echo(`>>> Building the ${taskName}...`);
if (shell.exec(`${command} build`, { cwd: tempRepoPath }).code !== 0) {
shell.exit(1);
}
shell.echo(`<<< Done ${taskName} build.`);
const binName = path.basename(destinationPath); const binName = path.basename(destinationPath);
if (!fs.existsSync(path.join(tempRepoPath, binName))) { if (!fs.existsSync(path.join(tempRepoPath, binName))) {
console.log( shell.echo(
`Could not find the ${taskName} at ${path.join(tempRepoPath, binName)}.` `Could not find the ${taskName} at ${path.join(tempRepoPath, binName)}.`
); );
process.exit(1); shell.exit(1);
} }
const binPath = path.join(tempRepoPath, binName); const binPath = path.join(tempRepoPath, binName);
console.log( shell.echo(
`>>> Copying ${taskName} from ${binPath} to ${destinationPath}...` `>>> Copying ${taskName} from ${binPath} to ${destinationPath}...`
); );
fs.copyFileSync(binPath, destinationPath); if (shell.cp(binPath, destinationPath).code !== 0) {
console.log(`<<< Copied the ${taskName}.`); shell.exit(1);
}
shell.echo(`<<< Copied the ${taskName}.`);
console.log(`<<< Verifying ${taskName}...`); shell.echo(`<<< Verifying ${taskName}...`);
if (!fs.existsSync(destinationPath)) { if (!fs.existsSync(destinationPath)) {
process.exit(1); shell.exit(1);
} }
console.log(`>>> Verified ${taskName}.`); shell.echo(`>>> Verified ${taskName}.`);
} }

View File

@@ -1,16 +0,0 @@
import type { Disposable } from '@theia/core/lib/common/disposable';
import type { AppInfo } from '../electron-common/electron-arduino';
import type { StartupTasks } from '../electron-common/startup-task';
import type { Sketch } from './contributions/contribution';
export type { AppInfo };
export const AppService = Symbol('AppService');
export interface AppService {
quit(): void;
info(): Promise<AppInfo>;
registerStartupTasksHandler(
handler: (tasks: StartupTasks) => void
): Disposable;
scheduleDeletion(sketch: Sketch): void; // TODO: find a better place
}

View File

@@ -1,47 +1,41 @@
import { ColorContribution } from '@theia/core/lib/browser/color-application-contribution'; import * as remote from '@theia/core/electron-shared/@electron/remote';
import { ColorRegistry } from '@theia/core/lib/browser/color-registry';
import { CommonMenus } from '@theia/core/lib/browser/common-frontend-contribution';
import { FrontendApplicationContribution } from '@theia/core/lib/browser/frontend-application';
import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';
import {
TabBarToolbarContribution,
TabBarToolbarRegistry,
} from '@theia/core/lib/browser/shell/tab-bar-toolbar';
import {
ColorTheme,
CssStyleCollector,
StylingParticipant,
} from '@theia/core/lib/browser/styling-service';
import {
CommandContribution,
CommandRegistry,
} from '@theia/core/lib/common/command';
import {
MAIN_MENU_BAR,
MenuContribution,
MenuModelRegistry,
} from '@theia/core/lib/common/menu';
import { MessageService } from '@theia/core/lib/common/message-service';
import { nls } from '@theia/core/lib/common/nls';
import { isHighContrast } from '@theia/core/lib/common/theme';
import { ElectronWindowPreferences } from '@theia/core/lib/electron-browser/window/electron-window-preferences';
import { import {
inject, inject,
injectable, injectable,
postConstruct, postConstruct,
} from '@theia/core/shared/inversify'; } from '@theia/core/shared/inversify';
import React from '@theia/core/shared/react'; import * as React from '@theia/core/shared/react';
import { EditorCommands } from '@theia/editor/lib/browser/editor-command'; import {
import { EditorMainMenu } from '@theia/editor/lib/browser/editor-menu'; MAIN_MENU_BAR,
MenuContribution,
MenuModelRegistry,
} from '@theia/core';
import { FrontendApplicationContribution } from '@theia/core/lib/browser';
import { ColorContribution } from '@theia/core/lib/browser/color-application-contribution';
import { ColorRegistry } from '@theia/core/lib/browser/color-registry';
import { CommonMenus } from '@theia/core/lib/browser/common-frontend-contribution';
import {
TabBarToolbarContribution,
TabBarToolbarRegistry,
} from '@theia/core/lib/browser/shell/tab-bar-toolbar';
import { nls } from '@theia/core/lib/common';
import {
CommandContribution,
CommandRegistry,
} from '@theia/core/lib/common/command';
import { MessageService } from '@theia/core/lib/common/message-service';
import { EditorCommands, EditorMainMenu } from '@theia/editor/lib/browser';
import { MonacoMenus } from '@theia/monaco/lib/browser/monaco-menu'; import { MonacoMenus } from '@theia/monaco/lib/browser/monaco-menu';
import { FileNavigatorCommands } from '@theia/navigator/lib/browser/navigator-contribution'; import { FileNavigatorCommands } from '@theia/navigator/lib/browser/navigator-contribution';
import { TerminalMenus } from '@theia/terminal/lib/browser/terminal-frontend-contribution'; import { TerminalMenus } from '@theia/terminal/lib/browser/terminal-frontend-contribution';
import { ElectronWindowPreferences } from '@theia/core/lib/electron-browser/window/electron-window-preferences';
import { BoardsServiceProvider } from './boards/boards-service-provider'; import { BoardsServiceProvider } from './boards/boards-service-provider';
import { BoardsToolBarItem } from './boards/boards-toolbar-item'; import { BoardsToolBarItem } from './boards/boards-toolbar-item';
import { ArduinoMenus } from './menu/arduino-menus'; import { ArduinoMenus } from './menu/arduino-menus';
import { MonitorViewContribution } from './serial/monitor/monitor-view-contribution'; import { MonitorViewContribution } from './serial/monitor/monitor-view-contribution';
import { SerialPlotterContribution } from './serial/plotter/plotter-frontend-contribution';
import { ArduinoToolbar } from './toolbar/arduino-toolbar'; import { ArduinoToolbar } from './toolbar/arduino-toolbar';
import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';
import { SerialPlotterContribution } from './serial/plotter/plotter-frontend-contribution';
@injectable() @injectable()
export class ArduinoFrontendContribution export class ArduinoFrontendContribution
@@ -50,8 +44,7 @@ export class ArduinoFrontendContribution
TabBarToolbarContribution, TabBarToolbarContribution,
CommandContribution, CommandContribution,
MenuContribution, MenuContribution,
ColorContribution, ColorContribution
StylingParticipant
{ {
@inject(MessageService) @inject(MessageService)
private readonly messageService: MessageService; private readonly messageService: MessageService;
@@ -69,7 +62,7 @@ export class ArduinoFrontendContribution
private readonly appStateService: FrontendApplicationStateService; private readonly appStateService: FrontendApplicationStateService;
@postConstruct() @postConstruct()
protected init(): void { protected async init(): Promise<void> {
if (!window.navigator.onLine) { if (!window.navigator.onLine) {
// tslint:disable-next-line:max-line-length // tslint:disable-next-line:max-line-length
this.messageService.warn( this.messageService.warn(
@@ -87,7 +80,8 @@ export class ArduinoFrontendContribution
switch (event.preferenceName) { switch (event.preferenceName) {
case 'window.zoomLevel': case 'window.zoomLevel':
if (typeof event.newValue === 'number') { if (typeof event.newValue === 'number') {
window.electronTheiaCore.setZoomLevel(event.newValue || 0); const webContents = remote.getCurrentWebContents();
webContents.setZoomLevel(event.newValue || 0);
} }
break; break;
} }
@@ -95,9 +89,10 @@ export class ArduinoFrontendContribution
}); });
this.appStateService.reachedState('ready').then(() => this.appStateService.reachedState('ready').then(() =>
this.electronWindowPreferences.ready.then(() => { this.electronWindowPreferences.ready.then(() => {
const webContents = remote.getCurrentWebContents();
const zoomLevel = const zoomLevel =
this.electronWindowPreferences.get('window.zoomLevel'); this.electronWindowPreferences.get('window.zoomLevel');
window.electronTheiaCore.setZoomLevel(zoomLevel); webContents.setZoomLevel(zoomLevel);
}) })
); );
} }
@@ -173,8 +168,7 @@ export class ArduinoFrontendContribution
defaults: { defaults: {
dark: 'button.background', dark: 'button.background',
light: 'button.background', light: 'button.background',
hcDark: 'activityBar.inactiveForeground', hc: 'activityBar.inactiveForeground',
hcLight: 'activityBar.inactiveForeground',
}, },
description: description:
'Background color of the toolbar items. Such as Upload, Verify, etc.', 'Background color of the toolbar items. Such as Upload, Verify, etc.',
@@ -184,8 +178,7 @@ export class ArduinoFrontendContribution
defaults: { defaults: {
dark: 'button.hoverBackground', dark: 'button.hoverBackground',
light: 'button.hoverBackground', light: 'button.hoverBackground',
hcDark: 'button.background', hc: 'button.background',
hcLight: 'button.background',
}, },
description: description:
'Background color of the toolbar items when hovering over them. Such as Upload, Verify, etc.', 'Background color of the toolbar items when hovering over them. Such as Upload, Verify, etc.',
@@ -195,8 +188,7 @@ export class ArduinoFrontendContribution
defaults: { defaults: {
dark: 'secondaryButton.foreground', dark: 'secondaryButton.foreground',
light: 'button.foreground', light: 'button.foreground',
hcDark: 'activityBar.inactiveForeground', hc: 'activityBar.inactiveForeground',
hcLight: 'activityBar.inactiveForeground',
}, },
description: description:
'Foreground color of the toolbar items. Such as Serial Monitor and Serial Plotter', 'Foreground color of the toolbar items. Such as Serial Monitor and Serial Plotter',
@@ -206,8 +198,7 @@ export class ArduinoFrontendContribution
defaults: { defaults: {
dark: 'secondaryButton.hoverBackground', dark: 'secondaryButton.hoverBackground',
light: 'button.hoverBackground', light: 'button.hoverBackground',
hcDark: 'textLink.foreground', hc: 'textLink.foreground',
hcLight: 'textLink.foreground',
}, },
description: description:
'Background color of the toolbar items when hovering over them, such as "Serial Monitor" and "Serial Plotter"', 'Background color of the toolbar items when hovering over them, such as "Serial Monitor" and "Serial Plotter"',
@@ -217,8 +208,7 @@ export class ArduinoFrontendContribution
defaults: { defaults: {
dark: 'editor.selectionBackground', dark: 'editor.selectionBackground',
light: 'editor.selectionBackground', light: 'editor.selectionBackground',
hcDark: 'textPreformat.foreground', hc: 'textPreformat.foreground',
hcLight: 'textPreformat.foreground',
}, },
description: description:
'Toggle color of the toolbar items when they are currently toggled (the command is in progress)', 'Toggle color of the toolbar items when they are currently toggled (the command is in progress)',
@@ -228,38 +218,37 @@ export class ArduinoFrontendContribution
defaults: { defaults: {
dark: 'dropdown.border', dark: 'dropdown.border',
light: 'dropdown.border', light: 'dropdown.border',
hcDark: 'dropdown.border', hc: 'dropdown.border',
hcLight: 'dropdown.border',
}, },
description: 'Border color of the Board Selector.', description: 'Border color of the Board Selector.',
}, },
{ {
id: 'arduino.toolbar.dropdown.borderActive', id: 'arduino.toolbar.dropdown.borderActive',
defaults: { defaults: {
dark: 'focusBorder', dark: 'focusBorder',
light: 'focusBorder', light: 'focusBorder',
hcDark: 'focusBorder', hc: 'focusBorder',
hcLight: 'focusBorder',
}, },
description: "Border color of the Board Selector when it's active", description: "Border color of the Board Selector when it's active",
}, },
{ {
id: 'arduino.toolbar.dropdown.background', id: 'arduino.toolbar.dropdown.background',
defaults: { defaults: {
dark: 'tab.unfocusedActiveBackground', dark: 'tab.unfocusedActiveBackground',
light: 'dropdown.background', light: 'dropdown.background',
hcDark: 'dropdown.background', hc: 'dropdown.background',
hcLight: 'dropdown.background',
}, },
description: 'Background color of the Board Selector.', description: 'Background color of the Board Selector.',
}, },
{ {
id: 'arduino.toolbar.dropdown.label', id: 'arduino.toolbar.dropdown.label',
defaults: { defaults: {
dark: 'dropdown.foreground', dark: 'dropdown.foreground',
light: 'dropdown.foreground', light: 'dropdown.foreground',
hcDark: 'dropdown.foreground', hc: 'dropdown.foreground',
hcLight: 'dropdown.foreground',
}, },
description: 'Font color of the Board Selector.', description: 'Font color of the Board Selector.',
}, },
@@ -268,8 +257,7 @@ export class ArduinoFrontendContribution
defaults: { defaults: {
dark: 'list.activeSelectionIconForeground', dark: 'list.activeSelectionIconForeground',
light: 'list.activeSelectionIconForeground', light: 'list.activeSelectionIconForeground',
hcDark: 'list.activeSelectionIconForeground', hc: 'list.activeSelectionIconForeground',
hcLight: 'list.activeSelectionIconForeground',
}, },
description: description:
'Color of the selected protocol icon in the Board Selector.', 'Color of the selected protocol icon in the Board Selector.',
@@ -279,8 +267,7 @@ export class ArduinoFrontendContribution
defaults: { defaults: {
dark: 'list.hoverBackground', dark: 'list.hoverBackground',
light: 'list.hoverBackground', light: 'list.hoverBackground',
hcDark: 'list.hoverBackground', hc: 'list.hoverBackground',
hcLight: 'list.hoverBackground',
}, },
description: 'Background color on hover of the Board Selector options.', description: 'Background color on hover of the Board Selector options.',
}, },
@@ -289,191 +276,11 @@ export class ArduinoFrontendContribution
defaults: { defaults: {
dark: 'list.activeSelectionBackground', dark: 'list.activeSelectionBackground',
light: 'list.activeSelectionBackground', light: 'list.activeSelectionBackground',
hcDark: 'list.activeSelectionBackground', hc: 'list.activeSelectionBackground',
hcLight: 'list.activeSelectionBackground',
}, },
description: description:
'Background color of the selected board in the Board Selector.', 'Background color of the selected board in the Board Selector.',
} }
); );
} }
registerThemeStyle(theme: ColorTheme, collector: CssStyleCollector): void {
const warningForeground = theme.getColor('warningForeground');
const warningBackground = theme.getColor('warningBackground');
const focusBorder = theme.getColor('focusBorder');
const contrastBorder = theme.getColor('contrastBorder');
const notificationsBackground = theme.getColor('notifications.background');
const buttonBorder = theme.getColor('button.border');
const buttonBackground = theme.getColor('button.background') || 'none';
const dropdownBackground = theme.getColor('dropdown.background');
const arduinoToolbarButtonBackground = theme.getColor(
'arduino.toolbar.button.background'
);
if (isHighContrast(theme.type)) {
// toolbar items
collector.addRule(`
.p-TabBar-toolbar .item.arduino-tool-item.enabled:hover > div.toggle-serial-monitor,
.p-TabBar-toolbar .item.arduino-tool-item.enabled:hover > div.toggle-serial-plotter {
background: transparent;
}
`);
if (contrastBorder) {
collector.addRule(`
.quick-input-widget {
outline: 1px solid ${contrastBorder};
outline-offset: -1px;
}
`);
}
if (focusBorder) {
// customized react-select widget
collector.addRule(`
.arduino-select__option--is-selected {
outline: 1px solid ${focusBorder};
}
`);
collector.addRule(`
.arduino-select__option--is-focused {
outline: 1px dashed ${focusBorder};
}
`);
// boards selector dropdown
collector.addRule(`
#select-board-dialog .selectBoardContainer .list .item:hover {
outline: 1px dashed ${focusBorder};
}
`);
// button hover
collector.addRule(`
.theia-button:hover,
button.theia-button:hover {
outline: 1px dashed ${focusBorder};
}
`);
collector.addRule(`
.theia-button {
border: 1px solid ${focusBorder};
}
`);
collector.addRule(`
.component-list-item .header .installed-version:hover:before {
background-color: transparent;
outline: 1px dashed ${focusBorder};
}
`);
// tree node
collector.addRule(`
.theia-TreeNode:hover {
outline: 1px dashed ${focusBorder};
}
`);
collector.addRule(`
.quick-input-list .monaco-list-row.focused,
.theia-Tree .theia-TreeNode.theia-mod-selected {
outline: 1px dotted ${focusBorder};
}
`);
collector.addRule(`
div#select-board-dialog .selectBoardContainer .list .item.selected,
.theia-Tree:focus .theia-TreeNode.theia-mod-selected,
.theia-Tree .ReactVirtualized__List:focus .theia-TreeNode.theia-mod-selected {
outline: 1px solid ${focusBorder};
}
`);
// quick input
collector.addRule(`
.quick-input-list .monaco-list-row:hover {
outline: 1px dashed ${focusBorder};
}
`);
// editor tab-bar
collector.addRule(`
.p-TabBar.theia-app-centers .p-TabBar-tab.p-mod-closable > .p-TabBar-tabCloseIcon:hover {
outline: 1px dashed ${focusBorder};
}
`);
collector.addRule(`
#theia-main-content-panel .p-TabBar .p-TabBar-tab:hover {
outline: 1px dashed ${focusBorder};
outline-offset: -4px;
}
`);
collector.addRule(`
#theia-main-content-panel .p-TabBar .p-TabBar-tab.p-mod-current {
outline: 1px solid ${focusBorder};
outline-offset: -4px;
}
`);
// boards selector dropdown
collector.addRule(`
.arduino-boards-dropdown-item:hover {
outline: 1px dashed ${focusBorder};
outline-offset: -2px;
}
`);
if (notificationsBackground) {
// notification
collector.addRule(`
.theia-notification-list-item:hover:not(:focus) {
background-color: ${notificationsBackground};
outline: 1px dashed ${focusBorder};
outline-offset: -2px;
}
`);
}
if (arduinoToolbarButtonBackground) {
// toolbar item
collector.addRule(`
.item.arduino-tool-item.toggled .arduino-upload-sketch--toolbar,
.item.arduino-tool-item.toggled .arduino-verify-sketch--toolbar {
background-color: ${arduinoToolbarButtonBackground} !important;
outline: 1px solid ${focusBorder};
}
`);
collector.addRule(`
.p-TabBar-toolbar .item.arduino-tool-item.enabled:hover > div {
background: ${arduinoToolbarButtonBackground};
outline: 1px dashed ${focusBorder};
}
`);
}
}
if (dropdownBackground) {
// boards selector dropdown
collector.addRule(`
.arduino-boards-dropdown-item:hover {
background: ${dropdownBackground};
}
`);
}
if (warningForeground && warningBackground) {
// <input> widget with inverted foreground and background colors
collector.addRule(`
.theia-input.warning:focus,
.theia-input.warning::placeholder,
.theia-input.warning {
color: ${warningBackground};
background-color: ${warningForeground};
}
`);
}
if (buttonBorder) {
collector.addRule(`
button.theia-button,
button.theia-button.secondary,
.component-list-item .theia-button.secondary.no-border,
.component-list-item .theia-button.secondary.no-border:hover {
border: 1px solid ${buttonBorder};
}
`);
collector.addRule(`
.component-list-item .header .installed-version:before {
color: ${buttonBackground};
border: 1px solid ${buttonBorder};
}
`);
}
}
}
} }

View File

@@ -1,9 +1,5 @@
import '../../src/browser/style/index.css'; import '../../src/browser/style/index.css';
import { import { Container, ContainerModule } from '@theia/core/shared/inversify';
Container,
ContainerModule,
interfaces,
} from '@theia/core/shared/inversify';
import { WidgetFactory } from '@theia/core/lib/browser/widget-manager'; import { WidgetFactory } from '@theia/core/lib/browser/widget-manager';
import { CommandContribution } from '@theia/core/lib/common/command'; import { CommandContribution } from '@theia/core/lib/common/command';
import { bindViewContribution } from '@theia/core/lib/browser/shell/view-contribution'; import { bindViewContribution } from '@theia/core/lib/browser/shell/view-contribution';
@@ -13,7 +9,10 @@ import {
FrontendApplicationContribution, FrontendApplicationContribution,
FrontendApplication as TheiaFrontendApplication, FrontendApplication as TheiaFrontendApplication,
} from '@theia/core/lib/browser/frontend-application'; } from '@theia/core/lib/browser/frontend-application';
import { LibraryListWidget } from './library/library-list-widget'; import {
LibraryListWidget,
LibraryListWidgetSearchOptions,
} from './library/library-list-widget';
import { ArduinoFrontendContribution } from './arduino-frontend-contribution'; import { ArduinoFrontendContribution } from './arduino-frontend-contribution';
import { import {
LibraryService, LibraryService,
@@ -29,12 +28,12 @@ import {
} from '../common/protocol/sketches-service'; } from '../common/protocol/sketches-service';
import { SketchesServiceClientImpl } from './sketches-service-client-impl'; import { SketchesServiceClientImpl } from './sketches-service-client-impl';
import { CoreService, CoreServicePath } from '../common/protocol/core-service'; import { CoreService, CoreServicePath } from '../common/protocol/core-service';
import { BoardsListWidget } from './boards/boards-list-widget';
import { BoardsListWidgetFrontendContribution } from './boards/boards-widget-frontend-contribution';
import { import {
BoardListDumper, BoardsListWidget,
BoardsServiceProvider, BoardsListWidgetSearchOptions,
} from './boards/boards-service-provider'; } from './boards/boards-list-widget';
import { BoardsListWidgetFrontendContribution } from './boards/boards-widget-frontend-contribution';
import { BoardsServiceProvider } from './boards/boards-service-provider';
import { WorkspaceService as TheiaWorkspaceService } from '@theia/workspace/lib/browser/workspace-service'; import { WorkspaceService as TheiaWorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
import { WorkspaceService } from './theia/workspace/workspace-service'; import { WorkspaceService } from './theia/workspace/workspace-service';
import { OutlineViewContribution as TheiaOutlineViewContribution } from '@theia/outline-view/lib/browser/outline-view-contribution'; import { OutlineViewContribution as TheiaOutlineViewContribution } from '@theia/outline-view/lib/browser/outline-view-contribution';
@@ -57,8 +56,6 @@ import {
DockPanelRenderer as TheiaDockPanelRenderer, DockPanelRenderer as TheiaDockPanelRenderer,
TabBarRendererFactory, TabBarRendererFactory,
ContextMenuRenderer, ContextMenuRenderer,
createTreeContainer,
TreeWidget,
} from '@theia/core/lib/browser'; } from '@theia/core/lib/browser';
import { MenuContribution } from '@theia/core/lib/common/menu'; import { MenuContribution } from '@theia/core/lib/common/menu';
import { import {
@@ -70,6 +67,7 @@ import {
BoardsConfigDialog, BoardsConfigDialog,
BoardsConfigDialogProps, BoardsConfigDialogProps,
} from './boards/boards-config-dialog'; } from './boards/boards-config-dialog';
import { BoardsConfigDialogWidget } from './boards/boards-config-dialog-widget';
import { ScmContribution as TheiaScmContribution } from '@theia/scm/lib/browser/scm-contribution'; import { ScmContribution as TheiaScmContribution } from '@theia/scm/lib/browser/scm-contribution';
import { ScmContribution } from './theia/scm/scm-contribution'; import { ScmContribution } from './theia/scm/scm-contribution';
import { SearchInWorkspaceFrontendContribution as TheiaSearchInWorkspaceFrontendContribution } from '@theia/search-in-workspace/lib/browser/search-in-workspace-frontend-contribution'; import { SearchInWorkspaceFrontendContribution as TheiaSearchInWorkspaceFrontendContribution } from '@theia/search-in-workspace/lib/browser/search-in-workspace-frontend-contribution';
@@ -81,7 +79,10 @@ import {
} from '../common/protocol/config-service'; } from '../common/protocol/config-service';
import { MonitorWidget } from './serial/monitor/monitor-widget'; import { MonitorWidget } from './serial/monitor/monitor-widget';
import { MonitorViewContribution } from './serial/monitor/monitor-view-contribution'; import { MonitorViewContribution } from './serial/monitor/monitor-view-contribution';
import { TabBarDecoratorService as TheiaTabBarDecoratorService } from '@theia/core/lib/browser/shell/tab-bar-decorator'; import {
TabBarDecorator,
TabBarDecoratorService as TheiaTabBarDecoratorService,
} from '@theia/core/lib/browser/shell/tab-bar-decorator';
import { TabBarDecoratorService } from './theia/core/tab-bar-decorator'; import { TabBarDecoratorService } from './theia/core/tab-bar-decorator';
import { ProblemManager as TheiaProblemManager } from '@theia/markers/lib/browser'; import { ProblemManager as TheiaProblemManager } from '@theia/markers/lib/browser';
import { ProblemManager } from './theia/markers/problem-manager'; import { ProblemManager } from './theia/markers/problem-manager';
@@ -108,7 +109,7 @@ import {
FrontendConnectionStatusService as TheiaFrontendConnectionStatusService, FrontendConnectionStatusService as TheiaFrontendConnectionStatusService,
ApplicationConnectionStatusContribution as TheiaApplicationConnectionStatusContribution, ApplicationConnectionStatusContribution as TheiaApplicationConnectionStatusContribution,
} from '@theia/core/lib/browser/connection-status-service'; } from '@theia/core/lib/browser/connection-status-service';
import { BoardsDataMenuUpdater } from './contributions/boards-data-menu-updater'; import { BoardsDataMenuUpdater } from './boards/boards-data-menu-updater';
import { BoardsDataStore } from './boards/boards-data-store'; import { BoardsDataStore } from './boards/boards-data-store';
import { ILogger } from '@theia/core/lib/common/logger'; import { ILogger } from '@theia/core/lib/common/logger';
import { bindContributionProvider } from '@theia/core/lib/common/contribution-provider'; import { bindContributionProvider } from '@theia/core/lib/common/contribution-provider';
@@ -186,7 +187,7 @@ import { TabBarRenderer } from './theia/core/tab-bars';
import { EditorCommandContribution } from './theia/editor/editor-command'; import { EditorCommandContribution } from './theia/editor/editor-command';
import { NavigatorTabBarDecorator as TheiaNavigatorTabBarDecorator } from '@theia/navigator/lib/browser/navigator-tab-bar-decorator'; import { NavigatorTabBarDecorator as TheiaNavigatorTabBarDecorator } from '@theia/navigator/lib/browser/navigator-tab-bar-decorator';
import { NavigatorTabBarDecorator } from './theia/navigator/navigator-tab-bar-decorator'; import { NavigatorTabBarDecorator } from './theia/navigator/navigator-tab-bar-decorator';
import { Debug, DebugDisabledStatusMessageSource } from './contributions/debug'; import { Debug } from './contributions/debug';
import { Sketchbook } from './contributions/sketchbook'; import { Sketchbook } from './contributions/sketchbook';
import { DebugFrontendApplicationContribution } from './theia/debug/debug-frontend-application-contribution'; import { DebugFrontendApplicationContribution } from './theia/debug/debug-frontend-application-contribution';
import { DebugFrontendApplicationContribution as TheiaDebugFrontendApplicationContribution } from '@theia/debug/lib/browser/debug-frontend-application-contribution'; import { DebugFrontendApplicationContribution as TheiaDebugFrontendApplicationContribution } from '@theia/debug/lib/browser/debug-frontend-application-contribution';
@@ -216,6 +217,7 @@ import {
MonacoEditorFactory, MonacoEditorFactory,
MonacoEditorProvider as TheiaMonacoEditorProvider, MonacoEditorProvider as TheiaMonacoEditorProvider,
} from '@theia/monaco/lib/browser/monaco-editor-provider'; } from '@theia/monaco/lib/browser/monaco-editor-provider';
import { StorageWrapper } from './storage-wrapper';
import { NotificationManager } from './theia/messages/notifications-manager'; import { NotificationManager } from './theia/messages/notifications-manager';
import { NotificationManager as TheiaNotificationManager } from '@theia/messages/lib/browser/notifications-manager'; import { NotificationManager as TheiaNotificationManager } from '@theia/messages/lib/browser/notifications-manager';
import { NotificationsRenderer as TheiaNotificationsRenderer } from '@theia/messages/lib/browser/notifications-renderer'; import { NotificationsRenderer as TheiaNotificationsRenderer } from '@theia/messages/lib/browser/notifications-renderer';
@@ -245,6 +247,7 @@ import {
UploadFirmwareDialog, UploadFirmwareDialog,
UploadFirmwareDialogProps, UploadFirmwareDialogProps,
} from './dialogs/firmware-uploader/firmware-uploader-dialog'; } from './dialogs/firmware-uploader/firmware-uploader-dialog';
import { UploadCertificate } from './contributions/upload-certificate'; import { UploadCertificate } from './contributions/upload-certificate';
import { import {
ArduinoFirmwareUploader, ArduinoFirmwareUploader,
@@ -277,8 +280,8 @@ import { MonitorModel } from './monitor-model';
import { MonitorManagerProxyClientImpl } from './monitor-manager-proxy-client-impl'; import { MonitorManagerProxyClientImpl } from './monitor-manager-proxy-client-impl';
import { EditorManager as TheiaEditorManager } from '@theia/editor/lib/browser/editor-manager'; import { EditorManager as TheiaEditorManager } from '@theia/editor/lib/browser/editor-manager';
import { EditorManager } from './theia/editor/editor-manager'; import { EditorManager } from './theia/editor/editor-manager';
import { HostedPluginEvents } from './hosted/hosted-plugin-events'; import { HostedPluginEvents } from './hosted-plugin-events';
import { HostedPluginSupportImpl } from './theia/plugin-ext/hosted-plugin'; import { HostedPluginSupport } from './theia/plugin-ext/hosted-plugin';
import { HostedPluginSupport as TheiaHostedPluginSupport } from '@theia/plugin-ext/lib/hosted/browser/hosted-plugin'; import { HostedPluginSupport as TheiaHostedPluginSupport } from '@theia/plugin-ext/lib/hosted/browser/hosted-plugin';
import { Formatter, FormatterPath } from '../common/protocol/formatter'; import { Formatter, FormatterPath } from '../common/protocol/formatter';
import { Format } from './contributions/format'; import { Format } from './contributions/format';
@@ -302,7 +305,7 @@ import { CoreErrorHandler } from './contributions/core-error-handler';
import { CompilerErrors } from './contributions/compiler-errors'; import { CompilerErrors } from './contributions/compiler-errors';
import { WidgetManager } from './theia/core/widget-manager'; import { WidgetManager } from './theia/core/widget-manager';
import { WidgetManager as TheiaWidgetManager } from '@theia/core/lib/browser/widget-manager'; import { WidgetManager as TheiaWidgetManager } from '@theia/core/lib/browser/widget-manager';
import { StartupTasksExecutor } from './contributions/startup-tasks-executor'; import { StartupTasks } from './contributions/startup-task';
import { IndexesUpdateProgress } from './contributions/indexes-update-progress'; import { IndexesUpdateProgress } from './contributions/indexes-update-progress';
import { Daemon } from './contributions/daemon'; import { Daemon } from './contributions/daemon';
import { FirstStartupInstaller } from './contributions/first-startup-installer'; import { FirstStartupInstaller } from './contributions/first-startup-installer';
@@ -319,10 +322,10 @@ import { PreferencesEditorWidget } from './theia/preferences/preference-editor-w
import { PreferencesWidget } from '@theia/preferences/lib/browser/views/preference-widget'; import { PreferencesWidget } from '@theia/preferences/lib/browser/views/preference-widget';
import { createPreferencesWidgetContainer } from '@theia/preferences/lib/browser/views/preference-widget-bindings'; import { createPreferencesWidgetContainer } from '@theia/preferences/lib/browser/views/preference-widget-bindings';
import { import {
BoardsFilterRenderer, CheckForUpdates,
LibraryFilterRenderer, BoardsUpdates,
} from './widgets/component-list/filter-renderer'; LibraryUpdates,
import { CheckForUpdates } from './contributions/check-for-updates'; } from './contributions/check-for-updates';
import { OutputEditorFactory } from './theia/output/output-editor-factory'; import { OutputEditorFactory } from './theia/output/output-editor-factory';
import { StartupTaskProvider } from '../electron-common/startup-task'; import { StartupTaskProvider } from '../electron-common/startup-task';
import { DeleteSketch } from './contributions/delete-sketch'; import { DeleteSketch } from './contributions/delete-sketch';
@@ -334,13 +337,9 @@ import { NewCloudSketch } from './contributions/new-cloud-sketch';
import { SketchbookCompositeWidget } from './widgets/sketchbook/sketchbook-composite-widget'; import { SketchbookCompositeWidget } from './widgets/sketchbook/sketchbook-composite-widget';
import { WindowTitleUpdater } from './theia/core/window-title-updater'; import { WindowTitleUpdater } from './theia/core/window-title-updater';
import { WindowTitleUpdater as TheiaWindowTitleUpdater } from '@theia/core/lib/browser/window/window-title-updater'; import { WindowTitleUpdater as TheiaWindowTitleUpdater } from '@theia/core/lib/browser/window/window-title-updater';
import { import { ThemeServiceWithDB } from './theia/core/theming';
MonacoThemingService, import { ThemeServiceWithDB as TheiaThemeServiceWithDB } from '@theia/monaco/lib/browser/monaco-indexed-db';
CleanupObsoleteThemes, import { MonacoThemingService } from './theia/monaco/monaco-theming-service';
ThemesRegistrationSummary,
MonacoThemeRegistry,
} from './theia/monaco/monaco-theming-service';
import { MonacoThemeRegistry as TheiaMonacoThemeRegistry } from '@theia/monaco/lib/browser/textmate/monaco-theme-registry';
import { MonacoThemingService as TheiaMonacoThemingService } from '@theia/monaco/lib/browser/monaco-theming-service'; import { MonacoThemingService as TheiaMonacoThemingService } from '@theia/monaco/lib/browser/monaco-theming-service';
import { TypeHierarchyServiceProvider } from './theia/typehierarchy/type-hierarchy-service'; import { TypeHierarchyServiceProvider } from './theia/typehierarchy/type-hierarchy-service';
import { TypeHierarchyServiceProvider as TheiaTypeHierarchyServiceProvider } from '@theia/typehierarchy/lib/browser/typehierarchy-service'; import { TypeHierarchyServiceProvider as TheiaTypeHierarchyServiceProvider } from '@theia/typehierarchy/lib/browser/typehierarchy-service';
@@ -348,6 +347,16 @@ import { TypeHierarchyContribution } from './theia/typehierarchy/type-hierarchy-
import { TypeHierarchyContribution as TheiaTypeHierarchyContribution } from '@theia/typehierarchy/lib/browser/typehierarchy-contribution'; import { TypeHierarchyContribution as TheiaTypeHierarchyContribution } from '@theia/typehierarchy/lib/browser/typehierarchy-contribution';
import { DefaultDebugSessionFactory } from './theia/debug/debug-session-contribution'; import { DefaultDebugSessionFactory } from './theia/debug/debug-session-contribution';
import { DebugSessionFactory } from '@theia/debug/lib/browser/debug-session-contribution'; import { DebugSessionFactory } from '@theia/debug/lib/browser/debug-session-contribution';
import { DebugToolbar } from './theia/debug/debug-toolbar-widget';
import { DebugToolBar as TheiaDebugToolbar } from '@theia/debug/lib/browser/view/debug-toolbar-widget';
import { PluginMenuCommandAdapter } from './theia/plugin-ext/plugin-menu-command-adapter';
import { PluginMenuCommandAdapter as TheiaPluginMenuCommandAdapter } from '@theia/plugin-ext/lib/main/browser/menus/plugin-menu-command-adapter';
import { DebugSessionManager } from './theia/debug/debug-session-manager';
import { DebugSessionManager as TheiaDebugSessionManager } from '@theia/debug/lib/browser/debug-session-manager';
import { DebugWidget } from '@theia/debug/lib/browser/view/debug-widget';
import { DebugViewModel } from '@theia/debug/lib/browser/view/debug-view-model';
import { DebugSessionWidget } from '@theia/debug/lib/browser/view/debug-session-widget';
import { DebugConfigurationWidget } from '@theia/debug/lib/browser/view/debug-configuration-widget';
import { ConfigServiceClient } from './config/config-service-client'; import { ConfigServiceClient } from './config/config-service-client';
import { ValidateSketch } from './contributions/validate-sketch'; import { ValidateSketch } from './contributions/validate-sketch';
import { RenameCloudSketch } from './contributions/rename-cloud-sketch'; import { RenameCloudSketch } from './contributions/rename-cloud-sketch';
@@ -356,65 +365,26 @@ import { Account } from './contributions/account';
import { SidebarBottomMenuWidget } from './theia/core/sidebar-bottom-menu-widget'; import { SidebarBottomMenuWidget } from './theia/core/sidebar-bottom-menu-widget';
import { SidebarBottomMenuWidget as TheiaSidebarBottomMenuWidget } from '@theia/core/lib/browser/shell/sidebar-bottom-menu-widget'; import { SidebarBottomMenuWidget as TheiaSidebarBottomMenuWidget } from '@theia/core/lib/browser/shell/sidebar-bottom-menu-widget';
import { CreateCloudCopy } from './contributions/create-cloud-copy'; import { CreateCloudCopy } from './contributions/create-cloud-copy';
import { FileResourceResolver } from './theia/filesystem/file-resource';
import { FileResourceResolver as TheiaFileResourceResolver } from '@theia/filesystem/lib/browser/file-resource';
import { StylingParticipant } from '@theia/core/lib/browser/styling-service';
import { MonacoEditorMenuContribution } from './theia/monaco/monaco-menu';
import { MonacoEditorMenuContribution as TheiaMonacoEditorMenuContribution } from '@theia/monaco/lib/browser/monaco-menu';
import { UpdateArduinoState } from './contributions/update-arduino-state';
import { TerminalFrontendContribution } from './theia/terminal/terminal-frontend-contribution';
import { TerminalFrontendContribution as TheiaTerminalFrontendContribution } from '@theia/terminal/lib/browser/terminal-frontend-contribution';
import { SelectionService } from '@theia/core/lib/common/selection-service';
import { CommandService } from '@theia/core/lib/common/command';
import { CorePreferences } from '@theia/core/lib/browser/core-preferences';
import { AutoSelectProgrammer } from './contributions/auto-select-programmer';
import { HostedPluginSupport } from './hosted/hosted-plugin-support';
import { DebugSessionManager as TheiaDebugSessionManager } from '@theia/debug/lib/browser/debug-session-manager';
import { DebugSessionManager } from './theia/debug/debug-session-manager';
import { DebugWidget as TheiaDebugWidget } from '@theia/debug/lib/browser/view/debug-widget';
import { DebugWidget } from './theia/debug/debug-widget';
import { DebugViewModel } from '@theia/debug/lib/browser/view/debug-view-model';
import { DebugSessionWidget } from '@theia/debug/lib/browser/view/debug-session-widget';
import { DebugConfigurationWidget } from './theia/debug/debug-configuration-widget';
import { DebugConfigurationWidget as TheiaDebugConfigurationWidget } from '@theia/debug/lib/browser/view/debug-configuration-widget';
import { DebugToolBar } from '@theia/debug/lib/browser/view/debug-toolbar-widget';
import { import {
PluginTree, BoardsListWidgetTabBarDecorator,
PluginTreeModel, LibraryListWidgetTabBarDecorator,
TreeViewWidgetOptions, } from './widgets/component-list/list-widget-tabbar-decorator';
VIEW_ITEM_CONTEXT_MENU, import { HoverService } from './theia/core/hover-service';
} from '@theia/plugin-ext/lib/main/browser/view/tree-view-widget';
import { TreeViewDecoratorService } from '@theia/plugin-ext/lib/main/browser/view/tree-view-decorator-service';
import { PLUGIN_VIEW_DATA_FACTORY_ID } from '@theia/plugin-ext/lib/main/browser/view/plugin-view-registry';
import { TreeViewWidget } from './theia/plugin-ext/tree-view-widget';
// Hack to fix copy/cut/paste issue after electron version update in Theia.
// https://github.com/eclipse-theia/theia/issues/12487
import('@theia/core/lib/browser/common-frontend-contribution.js').then(
(theiaCommonContribution) => {
theiaCommonContribution['supportCopy'] = true;
theiaCommonContribution['supportCut'] = true;
theiaCommonContribution['supportPaste'] = true;
}
);
export default new ContainerModule((bind, unbind, isBound, rebind) => { export default new ContainerModule((bind, unbind, isBound, rebind) => {
// Commands, colors, theme adjustments, and toolbar items // Commands and toolbar items
bind(ArduinoFrontendContribution).toSelf().inSingletonScope(); bind(ArduinoFrontendContribution).toSelf().inSingletonScope();
bind(CommandContribution).toService(ArduinoFrontendContribution); bind(CommandContribution).toService(ArduinoFrontendContribution);
bind(MenuContribution).toService(ArduinoFrontendContribution); bind(MenuContribution).toService(ArduinoFrontendContribution);
bind(TabBarToolbarContribution).toService(ArduinoFrontendContribution); bind(TabBarToolbarContribution).toService(ArduinoFrontendContribution);
bind(FrontendApplicationContribution).toService(ArduinoFrontendContribution); bind(FrontendApplicationContribution).toService(ArduinoFrontendContribution);
bind(ColorContribution).toService(ArduinoFrontendContribution); bind(ColorContribution).toService(ArduinoFrontendContribution);
bind(StylingParticipant).toService(ArduinoFrontendContribution);
bind(ArduinoToolbarContribution).toSelf().inSingletonScope(); bind(ArduinoToolbarContribution).toSelf().inSingletonScope();
bind(FrontendApplicationContribution).toService(ArduinoToolbarContribution); bind(FrontendApplicationContribution).toService(ArduinoToolbarContribution);
// Renderer for both the library and the core widgets. // Renderer for both the library and the core widgets.
bind(ListItemRenderer).toSelf().inSingletonScope(); bind(ListItemRenderer).toSelf().inSingletonScope();
bind(LibraryFilterRenderer).toSelf().inSingletonScope();
bind(BoardsFilterRenderer).toSelf().inSingletonScope();
// Library service // Library service
bind(LibraryService) bind(LibraryService)
@@ -437,6 +407,11 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
LibraryListWidgetFrontendContribution LibraryListWidgetFrontendContribution
); );
bind(OpenHandler).toService(LibraryListWidgetFrontendContribution); bind(OpenHandler).toService(LibraryListWidgetFrontendContribution);
bind(TabBarToolbarContribution).toService(
LibraryListWidgetFrontendContribution
);
bind(CommandContribution).toService(LibraryListWidgetFrontendContribution);
bind(LibraryListWidgetSearchOptions).toSelf().inSingletonScope();
// Sketch list service // Sketch list service
bind(SketchesService) bind(SketchesService)
@@ -475,14 +450,13 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
bind(BoardsServiceProvider).toSelf().inSingletonScope(); bind(BoardsServiceProvider).toSelf().inSingletonScope();
bind(FrontendApplicationContribution).toService(BoardsServiceProvider); bind(FrontendApplicationContribution).toService(BoardsServiceProvider);
bind(CommandContribution).toService(BoardsServiceProvider); bind(CommandContribution).toService(BoardsServiceProvider);
bind(BoardListDumper).toSelf().inSingletonScope();
// To be able to track, and update the menu based on the core settings (aka. board details) of the currently selected board. // To be able to track, and update the menu based on the core settings (aka. board details) of the currently selected board.
bind(FrontendApplicationContribution)
.to(BoardsDataMenuUpdater)
.inSingletonScope();
bind(BoardsDataStore).toSelf().inSingletonScope(); bind(BoardsDataStore).toSelf().inSingletonScope();
bind(FrontendApplicationContribution).toService(BoardsDataStore); bind(FrontendApplicationContribution).toService(BoardsDataStore);
bind(CommandContribution).toService(BoardsDataStore);
bind(StartupTaskProvider).toService(BoardsDataStore); // to inherit the boards config options, programmer, etc in a new window
// Logger for the Arduino daemon // Logger for the Arduino daemon
bind(ILogger) bind(ILogger)
.toDynamicValue((ctx) => { .toDynamicValue((ctx) => {
@@ -507,8 +481,14 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
BoardsListWidgetFrontendContribution BoardsListWidgetFrontendContribution
); );
bind(OpenHandler).toService(BoardsListWidgetFrontendContribution); bind(OpenHandler).toService(BoardsListWidgetFrontendContribution);
bind(TabBarToolbarContribution).toService(
BoardsListWidgetFrontendContribution
);
bind(CommandContribution).toService(BoardsListWidgetFrontendContribution);
bind(BoardsListWidgetSearchOptions).toSelf().inSingletonScope();
// Board select dialog // Board select dialog
bind(BoardsConfigDialogWidget).toSelf().inSingletonScope();
bind(BoardsConfigDialog).toSelf().inSingletonScope(); bind(BoardsConfigDialog).toSelf().inSingletonScope();
bind(BoardsConfigDialogProps).toConstantValue({ bind(BoardsConfigDialogProps).toConstantValue({
title: nls.localize( title: nls.localize(
@@ -536,7 +516,15 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
bind(TabBarToolbarContribution).toService(MonitorViewContribution); bind(TabBarToolbarContribution).toService(MonitorViewContribution);
bind(WidgetFactory).toDynamicValue((context) => ({ bind(WidgetFactory).toDynamicValue((context) => ({
id: MonitorWidget.ID, id: MonitorWidget.ID,
createWidget: () => context.container.get(MonitorWidget), createWidget: () => {
return new MonitorWidget(
context.container.get<MonitorModel>(MonitorModel),
context.container.get<MonitorManagerProxyClient>(
MonitorManagerProxyClient
),
context.container.get<BoardsServiceProvider>(BoardsServiceProvider)
);
},
})); }));
bind(MonitorManagerProxyFactory).toFactory( bind(MonitorManagerProxyFactory).toFactory(
@@ -759,7 +747,7 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
Contribution.configure(bind, PlotterFrontendContribution); Contribution.configure(bind, PlotterFrontendContribution);
Contribution.configure(bind, Format); Contribution.configure(bind, Format);
Contribution.configure(bind, CompilerErrors); Contribution.configure(bind, CompilerErrors);
Contribution.configure(bind, StartupTasksExecutor); Contribution.configure(bind, StartupTasks);
Contribution.configure(bind, IndexesUpdateProgress); Contribution.configure(bind, IndexesUpdateProgress);
Contribution.configure(bind, Daemon); Contribution.configure(bind, Daemon);
Contribution.configure(bind, FirstStartupInstaller); Contribution.configure(bind, FirstStartupInstaller);
@@ -780,15 +768,10 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
Contribution.configure(bind, Account); Contribution.configure(bind, Account);
Contribution.configure(bind, CloudSketchbookContribution); Contribution.configure(bind, CloudSketchbookContribution);
Contribution.configure(bind, CreateCloudCopy); Contribution.configure(bind, CreateCloudCopy);
Contribution.configure(bind, UpdateArduinoState);
Contribution.configure(bind, BoardsDataMenuUpdater);
Contribution.configure(bind, AutoSelectProgrammer);
bindContributionProvider(bind, StartupTaskProvider); bindContributionProvider(bind, StartupTaskProvider);
bind(StartupTaskProvider).toService(BoardsServiceProvider); // to reuse the boards config in another window bind(StartupTaskProvider).toService(BoardsServiceProvider); // to reuse the boards config in another window
bind(DebugDisabledStatusMessageSource).toService(Debug);
// Disabled the quick-pick customization from Theia when multiple formatters are available. // Disabled the quick-pick customization from Theia when multiple formatters are available.
// Use the default VS Code behavior, and pick the first one. In the IDE2, clang-format has `exclusive` selectors. // Use the default VS Code behavior, and pick the first one. In the IDE2, clang-format has `exclusive` selectors.
bind(MonacoFormattingConflictsContribution).toSelf().inSingletonScope(); bind(MonacoFormattingConflictsContribution).toSelf().inSingletonScope();
@@ -831,19 +814,10 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
); );
const iconThemeService = const iconThemeService =
context.container.get<IconThemeService>(IconThemeService); context.container.get<IconThemeService>(IconThemeService);
const selectionService =
context.container.get<SelectionService>(SelectionService);
const commandService =
context.container.get<CommandService>(CommandService);
const corePreferences =
context.container.get<CorePreferences>(CorePreferences);
return new TabBarRenderer( return new TabBarRenderer(
contextMenuRenderer, contextMenuRenderer,
decoratorService, decoratorService,
iconThemeService, iconThemeService
selectionService,
commandService,
corePreferences
); );
}); });
@@ -886,28 +860,6 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
// To be able to use a `launch.json` from outside of the workspace. // To be able to use a `launch.json` from outside of the workspace.
bind(DebugConfigurationManager).toSelf().inSingletonScope(); bind(DebugConfigurationManager).toSelf().inSingletonScope();
rebind(TheiaDebugConfigurationManager).toService(DebugConfigurationManager); rebind(TheiaDebugConfigurationManager).toService(DebugConfigurationManager);
// To update the currently selected debug config <select> option when starting a debug session.
bind(DebugSessionManager).toSelf().inSingletonScope();
rebind(TheiaDebugSessionManager).toService(DebugSessionManager);
// Customized debug widget with its customized config <select> to update it programmatically.
bind(WidgetFactory)
.toDynamicValue(({ container }) => ({
id: TheiaDebugWidget.ID,
createWidget: () => {
const child = new Container({ defaultScope: 'Singleton' });
child.parent = container;
child.bind(DebugViewModel).toSelf();
child.bind(DebugToolBar).toSelf();
child.bind(DebugSessionWidget).toSelf();
child.bind(DebugConfigurationWidget).toSelf(); // with the patched select
child // use the customized one in the Theia DI
.bind(TheiaDebugConfigurationWidget)
.toService(DebugConfigurationWidget);
child.bind(DebugWidget).toSelf();
return child.get(DebugWidget);
},
}))
.inSingletonScope();
// To avoid duplicate tabs use deepEqual instead of string equal: https://github.com/eclipse-theia/theia/issues/11309 // To avoid duplicate tabs use deepEqual instead of string equal: https://github.com/eclipse-theia/theia/issues/11309
bind(WidgetManager).toSelf().inSingletonScope(); bind(WidgetManager).toSelf().inSingletonScope();
@@ -944,6 +896,9 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
), ),
}); });
bind(StorageWrapper).toSelf().inSingletonScope();
bind(CommandContribution).toService(StorageWrapper);
bind(NotificationManager).toSelf().inSingletonScope(); bind(NotificationManager).toSelf().inSingletonScope();
rebind(TheiaNotificationManager).toService(NotificationManager); rebind(TheiaNotificationManager).toService(NotificationManager);
bind(NotificationsRenderer).toSelf().inSingletonScope(); bind(NotificationsRenderer).toSelf().inSingletonScope();
@@ -1036,9 +991,8 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
}) })
.inSingletonScope(); .inSingletonScope();
bind(HostedPluginSupportImpl).toSelf().inSingletonScope(); bind(HostedPluginSupport).toSelf().inSingletonScope();
bind(HostedPluginSupport).toService(HostedPluginSupportImpl); rebind(TheiaHostedPluginSupport).toService(HostedPluginSupport);
rebind(TheiaHostedPluginSupport).toService(HostedPluginSupportImpl);
bind(HostedPluginEvents).toSelf().inSingletonScope(); bind(HostedPluginEvents).toSelf().inSingletonScope();
bind(FrontendApplicationContribution).toService(HostedPluginEvents); bind(FrontendApplicationContribution).toService(HostedPluginEvents);
@@ -1047,17 +1001,11 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
rebind(TheiaWindowTitleUpdater).toService(WindowTitleUpdater); rebind(TheiaWindowTitleUpdater).toService(WindowTitleUpdater);
// register Arduino themes // register Arduino themes
bind(ThemeServiceWithDB).toSelf().inSingletonScope();
rebind(TheiaThemeServiceWithDB).toService(ThemeServiceWithDB);
bind(MonacoThemingService).toSelf().inSingletonScope(); bind(MonacoThemingService).toSelf().inSingletonScope();
rebind(TheiaMonacoThemingService).toService(MonacoThemingService); rebind(TheiaMonacoThemingService).toService(MonacoThemingService);
// workaround for themes cannot be removed after registration
// https://github.com/eclipse-theia/theia/issues/11151
bind(CleanupObsoleteThemes).toSelf().inSingletonScope();
bind(FrontendApplicationContribution).toService(CleanupObsoleteThemes);
bind(ThemesRegistrationSummary).toSelf().inSingletonScope();
bind(MonacoThemeRegistry).toSelf().inSingletonScope();
rebind(TheiaMonacoThemeRegistry).toService(MonacoThemeRegistry);
// disable type-hierarchy support // disable type-hierarchy support
// https://github.com/eclipse-theia/theia/commit/16c88a584bac37f5cf3cc5eb92ffdaa541bda5be // https://github.com/eclipse-theia/theia/commit/16c88a584bac37f5cf3cc5eb92ffdaa541bda5be
bind(TypeHierarchyServiceProvider).toSelf().inSingletonScope(); bind(TypeHierarchyServiceProvider).toSelf().inSingletonScope();
@@ -1067,8 +1015,37 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
bind(TypeHierarchyContribution).toSelf().inSingletonScope(); bind(TypeHierarchyContribution).toSelf().inSingletonScope();
rebind(TheiaTypeHierarchyContribution).toService(TypeHierarchyContribution); rebind(TheiaTypeHierarchyContribution).toService(TypeHierarchyContribution);
// patched the debugger for `cortex-debug@1.5.1`
// https://github.com/eclipse-theia/theia/issues/11871
// https://github.com/eclipse-theia/theia/issues/11879
// https://github.com/eclipse-theia/theia/issues/11880
// https://github.com/eclipse-theia/theia/issues/11885
// https://github.com/eclipse-theia/theia/issues/11886
// https://github.com/eclipse-theia/theia/issues/11916
// based on: https://github.com/eclipse-theia/theia/compare/master...kittaakos:theia:%2311871
bind(DefaultDebugSessionFactory).toSelf().inSingletonScope(); bind(DefaultDebugSessionFactory).toSelf().inSingletonScope();
rebind(DebugSessionFactory).toService(DefaultDebugSessionFactory); rebind(DebugSessionFactory).toService(DefaultDebugSessionFactory);
bind(DebugSessionManager).toSelf().inSingletonScope();
rebind(TheiaDebugSessionManager).toService(DebugSessionManager);
bind(DebugToolbar).toSelf().inSingletonScope();
rebind(TheiaDebugToolbar).toService(DebugToolbar);
bind(PluginMenuCommandAdapter).toSelf().inSingletonScope();
rebind(TheiaPluginMenuCommandAdapter).toService(PluginMenuCommandAdapter);
bind(WidgetFactory)
.toDynamicValue(({ container }) => ({
id: DebugWidget.ID,
createWidget: () => {
const child = new Container({ defaultScope: 'Singleton' });
child.parent = container;
child.bind(DebugViewModel).toSelf();
child.bind(DebugToolbar).toSelf(); // patched toolbar
child.bind(DebugSessionWidget).toSelf();
child.bind(DebugConfigurationWidget).toSelf();
child.bind(DebugWidget).toSelf();
return child.get(DebugWidget);
},
}))
.inSingletonScope();
bind(SidebarBottomMenuWidget).toSelf(); bind(SidebarBottomMenuWidget).toSelf();
rebind(TheiaSidebarBottomMenuWidget).toService(SidebarBottomMenuWidget); rebind(TheiaSidebarBottomMenuWidget).toService(SidebarBottomMenuWidget);
@@ -1080,60 +1057,19 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
bind(IsOnline).toSelf().inSingletonScope(); bind(IsOnline).toSelf().inSingletonScope();
bind(FrontendApplicationContribution).toService(IsOnline); bind(FrontendApplicationContribution).toService(IsOnline);
// https://github.com/arduino/arduino-ide/issues/437 bind(HoverService).toSelf().inSingletonScope();
bind(FileResourceResolver).toSelf().inSingletonScope(); bind(LibraryUpdates).toSelf().inSingletonScope();
rebind(TheiaFileResourceResolver).toService(FileResourceResolver); bind(FrontendApplicationContribution).toService(LibraryUpdates);
bind(LibraryListWidgetTabBarDecorator).toSelf().inSingletonScope();
// Full control over the editor context menu to filter undesired menu items contributed by Theia. bind(TabBarDecorator).toService(LibraryListWidgetTabBarDecorator);
// https://github.com/arduino/arduino-ide/issues/1394 bind(FrontendApplicationContribution).toService(
// https://github.com/arduino/arduino-ide/pull/2027#pullrequestreview-1414246614 LibraryListWidgetTabBarDecorator
bind(MonacoEditorMenuContribution).toSelf().inSingletonScope();
rebind(TheiaMonacoEditorMenuContribution).toService(
MonacoEditorMenuContribution
); );
bind(BoardsUpdates).toSelf().inSingletonScope();
// Patch terminal issues. bind(FrontendApplicationContribution).toService(BoardsUpdates);
bind(TerminalFrontendContribution).toSelf().inSingletonScope(); bind(BoardsListWidgetTabBarDecorator).toSelf().inSingletonScope();
rebind(TheiaTerminalFrontendContribution).toService( bind(TabBarDecorator).toService(BoardsListWidgetTabBarDecorator);
TerminalFrontendContribution bind(FrontendApplicationContribution).toService(
BoardsListWidgetTabBarDecorator
); );
bindViewsWelcome_TheiaGH14309({ bind, widget: TreeViewWidget });
}); });
// Align the viewsWelcome rendering with VS Code (https://github.com/eclipse-theia/theia/issues/14309)
// Copied from Theia code but with customized TreeViewWidget with the customized viewsWelcome rendering
// https://github.com/eclipse-theia/theia/blob/0c5f69455d9ee355b1a7ca510ffa63d2b20f0c77/packages/plugin-ext/src/main/browser/plugin-ext-frontend-module.ts#L159-L181
function bindViewsWelcome_TheiaGH14309({
bind,
widget,
}: {
bind: interfaces.Bind;
widget: interfaces.Newable<TreeWidget>;
}) {
bind(WidgetFactory)
.toDynamicValue(({ container }) => ({
id: PLUGIN_VIEW_DATA_FACTORY_ID,
createWidget: (options: TreeViewWidgetOptions) => {
const props = {
contextMenuPath: VIEW_ITEM_CONTEXT_MENU,
expandOnlyOnExpansionToggleClick: true,
expansionTogglePadding: 22,
globalSelection: true,
leftPadding: 8,
search: true,
multiSelect: options.multiSelect,
};
const child = createTreeContainer(container, {
props,
tree: PluginTree,
model: PluginTreeModel,
widget,
decoratorService: TreeViewDecoratorService,
});
child.bind(TreeViewWidgetOptions).toConstantValue(options);
return child.get(TreeWidget);
},
}))
.inSingletonScope();
}

View File

@@ -1,15 +1,12 @@
import {
PreferenceContribution,
PreferenceProxy,
PreferenceSchema,
PreferenceService,
createPreferenceProxy,
} from '@theia/core/lib/browser/preferences';
import { ApplicationShell } from '@theia/core/lib/browser/shell/application-shell';
import { nls } from '@theia/core/lib/common/nls';
import { PreferenceSchemaProperty } from '@theia/core/lib/common/preferences/preference-schema';
import { interfaces } from '@theia/core/shared/inversify'; import { interfaces } from '@theia/core/shared/inversify';
import { serialMonitorWidgetLabel } from '../common/nls'; import {
createPreferenceProxy,
PreferenceProxy,
PreferenceService,
PreferenceContribution,
PreferenceSchema,
} from '@theia/core/lib/browser/preferences';
import { nls } from '@theia/core/lib/common';
import { CompilerWarningLiterals, CompilerWarnings } from '../common/protocol'; import { CompilerWarningLiterals, CompilerWarnings } from '../common/protocol';
export enum UpdateChannel { export enum UpdateChannel {
@@ -34,7 +31,7 @@ export const ErrorRevealStrategyLiterals = [
*/ */
'centerIfOutsideViewport', 'centerIfOutsideViewport',
] as const; ] as const;
export type ErrorRevealStrategy = (typeof ErrorRevealStrategyLiterals)[number]; export type ErrorRevealStrategy = typeof ErrorRevealStrategyLiterals[number];
export namespace ErrorRevealStrategy { export namespace ErrorRevealStrategy {
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
export function is(arg: any): arg is ErrorRevealStrategy { export function is(arg: any): arg is ErrorRevealStrategy {
@@ -43,30 +40,9 @@ export namespace ErrorRevealStrategy {
export const Default: ErrorRevealStrategy = 'centerIfOutsideViewport'; export const Default: ErrorRevealStrategy = 'centerIfOutsideViewport';
} }
export type MonitorWidgetDockPanel = Extract< export const ArduinoConfigSchema: PreferenceSchema = {
ApplicationShell.Area, type: 'object',
'bottom' | 'right' properties: {
>;
export const defaultMonitorWidgetDockPanel: MonitorWidgetDockPanel = 'bottom';
export function isMonitorWidgetDockPanel(
arg: unknown
): arg is MonitorWidgetDockPanel {
return arg === 'bottom' || arg === 'right';
}
export const defaultAsyncWorkers = 0 as const;
export const minAsyncWorkers = defaultAsyncWorkers;
export const maxAsyncWorkers = 8 as const;
type StrictPreferenceSchemaProperties<T extends object> = {
[p in keyof T]: PreferenceSchemaProperty;
};
type ArduinoPreferenceSchemaProperties =
StrictPreferenceSchemaProperties<ArduinoConfiguration> & {
'arduino.window.zoomLevel': PreferenceSchemaProperty;
};
const properties: ArduinoPreferenceSchemaProperties = {
'arduino.language.log': { 'arduino.language.log': {
type: 'boolean', type: 'boolean',
description: nls.localize( description: nls.localize(
@@ -83,16 +59,6 @@ const properties: ArduinoPreferenceSchemaProperties = {
), ),
default: false, default: false,
}, },
'arduino.language.asyncWorkers': {
type: 'number',
description: nls.localize(
'arduino/preferences/language.asyncWorkers',
'Number of async workers used by the Arduino Language Server (clangd). Background index also uses this many workers. The minimum value is 0, and the maximum is 8. When it is 0, the language server uses all available cores. The default value is 0.'
),
minimum: minAsyncWorkers,
maximum: maxAsyncWorkers,
default: defaultAsyncWorkers,
},
'arduino.compile.verbose': { 'arduino.compile.verbose': {
type: 'boolean', type: 'boolean',
description: nls.localize( description: nls.localize(
@@ -228,14 +194,6 @@ const properties: ArduinoPreferenceSchemaProperties = {
), ),
default: 'https://api2.arduino.cc/create', default: 'https://api2.arduino.cc/create',
}, },
'arduino.cloud.sharedSpaceID': {
type: 'string',
description: nls.localize(
'arduino/preferences/cloud.sharedSpaceId',
'The ID of the Arduino Cloud shared space to load the sketchbook from. If empty, your private space is selected.'
),
default: '',
},
'arduino.auth.clientID': { 'arduino.auth.clientID': {
type: 'string', type: 'string',
description: nls.localize( description: nls.localize(
@@ -300,27 +258,12 @@ const properties: ArduinoPreferenceSchemaProperties = {
), ),
default: undefined, default: undefined,
}, },
'arduino.monitor.dockPanel': {
type: 'string',
enum: ['bottom', 'right'],
markdownDescription: nls.localize(
'arduino/preferences/monitor/dockPanel',
'The area of the application shell where the _{0}_ widget will reside. It is either "bottom" or "right". It defaults to "{1}".',
serialMonitorWidgetLabel,
defaultMonitorWidgetDockPanel
),
default: defaultMonitorWidgetDockPanel,
}, },
}; };
export const ArduinoConfigSchema: PreferenceSchema = {
type: 'object',
properties,
};
export interface ArduinoConfiguration { export interface ArduinoConfiguration {
'arduino.language.log': boolean; 'arduino.language.log': boolean;
'arduino.language.realTimeDiagnostics': boolean; 'arduino.language.realTimeDiagnostics': boolean;
'arduino.language.asyncWorkers': number;
'arduino.compile.verbose': boolean; 'arduino.compile.verbose': boolean;
'arduino.compile.experimental': boolean; 'arduino.compile.experimental': boolean;
'arduino.compile.revealRange': ErrorRevealStrategy; 'arduino.compile.revealRange': ErrorRevealStrategy;
@@ -337,7 +280,6 @@ export interface ArduinoConfiguration {
'arduino.cloud.push.warn': boolean; 'arduino.cloud.push.warn': boolean;
'arduino.cloud.pushpublic.warn': boolean; 'arduino.cloud.pushpublic.warn': boolean;
'arduino.cloud.sketchSyncEndpoint': string; 'arduino.cloud.sketchSyncEndpoint': string;
'arduino.cloud.sharedSpaceID': string;
'arduino.auth.clientID': string; 'arduino.auth.clientID': string;
'arduino.auth.domain': string; 'arduino.auth.domain': string;
'arduino.auth.audience': string; 'arduino.auth.audience': string;
@@ -346,7 +288,6 @@ export interface ArduinoConfiguration {
'arduino.cli.daemon.debug': boolean; 'arduino.cli.daemon.debug': boolean;
'arduino.sketch.inoBlueprint': string; 'arduino.sketch.inoBlueprint': string;
'arduino.checkForUpdates': boolean; 'arduino.checkForUpdates': boolean;
'arduino.monitor.dockPanel': MonitorWidgetDockPanel;
} }
export const ArduinoPreferences = Symbol('ArduinoPreferences'); export const ArduinoPreferences = Symbol('ArduinoPreferences');

View File

@@ -9,13 +9,13 @@ import {
CommandContribution, CommandContribution,
} from '@theia/core/lib/common/command'; } from '@theia/core/lib/common/command';
import { import {
AuthOptions,
AuthenticationService, AuthenticationService,
AuthenticationServiceClient, AuthenticationServiceClient,
AuthenticationSession, AuthenticationSession,
authServerPort,
} from '../../common/protocol/authentication-service'; } from '../../common/protocol/authentication-service';
import { CloudUserCommands } from './cloud-user-commands'; import { CloudUserCommands } from './cloud-user-commands';
import { serverPort } from '../../node/auth/authentication-server';
import { AuthOptions } from '../../node/auth/types';
import { ArduinoPreferences } from '../arduino-preferences'; import { ArduinoPreferences } from '../arduino-preferences';
@injectable() @injectable()
@@ -61,7 +61,7 @@ export class AuthenticationClientService
setOptions(): Promise<void> { setOptions(): Promise<void> {
return this.service.setOptions({ return this.service.setOptions({
redirectUri: `http://localhost:${authServerPort}/callback`, redirectUri: `http://localhost:${serverPort}/callback`,
responseType: 'code', responseType: 'code',
clientID: this.arduinoPreferences['arduino.auth.clientID'], clientID: this.arduinoPreferences['arduino.auth.clientID'],
domain: this.arduinoPreferences['arduino.auth.domain'], domain: this.arduinoPreferences['arduino.auth.domain'],

View File

@@ -1,201 +1,243 @@
import { FrontendApplicationContribution } from '@theia/core/lib/browser/frontend-application'; import { injectable, inject } from '@theia/core/shared/inversify';
import { DisposableCollection } from '@theia/core/lib/common/disposable';
import { MessageService } from '@theia/core/lib/common/message-service'; import { MessageService } from '@theia/core/lib/common/message-service';
import { MessageType } from '@theia/core/lib/common/message-service-protocol'; import { FrontendApplicationContribution } from '@theia/core/lib/browser/frontend-application';
import { nls } from '@theia/core/lib/common/nls';
import { notEmpty } from '@theia/core/lib/common/objects';
import { inject, injectable } from '@theia/core/shared/inversify';
import { NotificationManager } from '@theia/messages/lib/browser/notifications-manager';
import { InstallManually } from '../../common/nls';
import { Installable, ResponseServiceClient } from '../../common/protocol';
import { import {
BoardIdentifier,
BoardsPackage,
BoardsService, BoardsService,
createPlatformIdentifier, BoardsPackage,
isBoardIdentifierChangeEvent, Board,
PlatformIdentifier, Port,
platformIdentifierEquals,
serializePlatformIdentifier,
} from '../../common/protocol/boards-service'; } from '../../common/protocol/boards-service';
import { NotificationCenter } from '../notification-center';
import { BoardsServiceProvider } from './boards-service-provider'; import { BoardsServiceProvider } from './boards-service-provider';
import { Installable, ResponseServiceClient } from '../../common/protocol';
import { BoardsListWidgetFrontendContribution } from './boards-widget-frontend-contribution'; import { BoardsListWidgetFrontendContribution } from './boards-widget-frontend-contribution';
import { nls } from '@theia/core/lib/common';
import { NotificationCenter } from '../notification-center';
import { InstallManually } from '../../common/nls';
interface AutoInstallPromptAction {
// isAcceptance, whether or not the action indicates acceptance of auto-install proposal
isAcceptance?: boolean;
key: string;
handler: (...args: unknown[]) => unknown;
}
type AutoInstallPromptActions = AutoInstallPromptAction[];
/** /**
* Listens on `BoardsConfigChangeEvent`s, if a board is selected which does not * Listens on `BoardsConfig.Config` changes, if a board is selected which does not
* have the corresponding core installed, it proposes the user to install the core. * have the corresponding core installed, it proposes the user to install the core.
*/ */
// * Cases in which we do not show the auto-install prompt:
// 1. When a related platform is already installed
// 2. When a prompt is already showing in the UI
// 3. When a board is unplugged
@injectable() @injectable()
export class BoardsAutoInstaller implements FrontendApplicationContribution { export class BoardsAutoInstaller implements FrontendApplicationContribution {
@inject(NotificationCenter) @inject(NotificationCenter)
private readonly notificationCenter: NotificationCenter; private readonly notificationCenter: NotificationCenter;
@inject(MessageService) @inject(MessageService)
private readonly messageService: MessageService; protected readonly messageService: MessageService;
@inject(NotificationManager)
private readonly notificationManager: NotificationManager;
@inject(BoardsService) @inject(BoardsService)
private readonly boardsService: BoardsService; protected readonly boardsService: BoardsService;
@inject(BoardsServiceProvider) @inject(BoardsServiceProvider)
private readonly boardsServiceProvider: BoardsServiceProvider; protected readonly boardsServiceClient: BoardsServiceProvider;
@inject(ResponseServiceClient) @inject(ResponseServiceClient)
private readonly responseService: ResponseServiceClient; protected readonly responseService: ResponseServiceClient;
@inject(BoardsListWidgetFrontendContribution) @inject(BoardsListWidgetFrontendContribution)
private readonly boardsManagerWidgetContribution: BoardsListWidgetFrontendContribution; protected readonly boardsManagerFrontendContribution: BoardsListWidgetFrontendContribution;
// Workaround for https://github.com/eclipse-theia/theia/issues/9349 // Workaround for https://github.com/eclipse-theia/theia/issues/9349
private readonly installNotificationInfos: Readonly<{ protected notifications: Board[] = [];
boardName: string;
platformId: string; // * "refusal" meaning a "prompt action" not accepting the auto-install offer ("X" or "install manually")
notificationId: string; // we can use "portSelectedOnLastRefusal" to deduce when a board is unplugged after a user has "refused"
}>[] = []; // an auto-install prompt. Important to know as we do not want "an unplug" to trigger a "refused" prompt
private readonly toDispose = new DisposableCollection(); // showing again
private portSelectedOnLastRefusal: Port | undefined;
private lastRefusedPackageId: string | undefined;
onStart(): void { onStart(): void {
this.toDispose.pushAll([ const setEventListeners = () => {
this.boardsServiceProvider.onBoardsConfigDidChange((event) => { this.boardsServiceClient.onBoardsConfigChanged((config) => {
if (isBoardIdentifierChangeEvent(event)) { const { selectedBoard, selectedPort } = config;
this.ensureCoreExists(event.selectedBoard);
const boardWasUnplugged =
!selectedPort && this.portSelectedOnLastRefusal;
this.clearLastRefusedPromptInfo();
if (
boardWasUnplugged ||
!selectedBoard ||
this.promptAlreadyShowingForBoard(selectedBoard)
) {
return;
} }
}),
this.notificationCenter.onPlatformDidInstall((event) => this.ensureCoreExists(selectedBoard, selectedPort);
this.clearAllNotificationForPlatform(event.item.id) });
),
]); // we "clearRefusedPackageInfo" if a "refused" package is eventually
this.boardsServiceProvider.ready.then(() => { // installed, though this is not strictly necessary. It's more of a
const { selectedBoard } = this.boardsServiceProvider.boardsConfig; // cleanup, to ensure the related variables are representative of
this.ensureCoreExists(selectedBoard); // current state.
this.notificationCenter.onPlatformDidInstall((installed) => {
if (this.lastRefusedPackageId === installed.item.id) {
this.clearLastRefusedPromptInfo();
}
});
};
// we should invoke this.ensureCoreExists only once we're sure
// everything has been reconciled
this.boardsServiceClient.reconciled.then(() => {
const { selectedBoard, selectedPort } =
this.boardsServiceClient.boardsConfig;
if (selectedBoard) {
this.ensureCoreExists(selectedBoard, selectedPort);
}
setEventListeners();
}); });
} }
private async findPlatformToInstall( private removeNotificationByBoard(selectedBoard: Board): void {
selectedBoard: BoardIdentifier const index = this.notifications.findIndex((notification) =>
): Promise<BoardsPackage | undefined> { Board.sameAs(notification, selectedBoard)
const platformId = await this.findPlatformIdToInstall(selectedBoard); );
if (!platformId) { if (index !== -1) {
return undefined; this.notifications.splice(index, 1);
} }
const id = serializePlatformIdentifier(platformId);
const platform = await this.boardsService.getBoardPackage({ id });
if (!platform) {
console.warn(`Could not resolve platform for ID: ${id}`);
return undefined;
}
if (platform.installedVersion) {
return undefined;
}
return platform;
} }
private async findPlatformIdToInstall( private clearLastRefusedPromptInfo(): void {
selectedBoard: BoardIdentifier this.lastRefusedPackageId = undefined;
): Promise<PlatformIdentifier | undefined> { this.portSelectedOnLastRefusal = undefined;
const selectedBoardPlatformId = createPlatformIdentifier(selectedBoard);
// The board is installed or the FQBN is available from the `board list watch` for Arduino boards. The latter might change!
if (selectedBoardPlatformId) {
const installedPlatforms =
await this.boardsService.getInstalledPlatforms();
const installedPlatformIds = installedPlatforms
.map((platform) => createPlatformIdentifier(platform.id))
.filter(notEmpty);
if (
installedPlatformIds.every(
(installedPlatformId) =>
!platformIdentifierEquals(
installedPlatformId,
selectedBoardPlatformId
)
)
) {
return selectedBoardPlatformId;
} }
private setLastRefusedPromptInfo(
packageId: string,
selectedPort?: Port
): void {
this.lastRefusedPackageId = packageId;
this.portSelectedOnLastRefusal = selectedPort;
}
private promptAlreadyShowingForBoard(board: Board): boolean {
return Boolean(
this.notifications.find((notification) =>
Board.sameAs(notification, board)
)
);
}
protected ensureCoreExists(selectedBoard: Board, selectedPort?: Port): void {
this.notifications.push(selectedBoard);
this.boardsService.search({}).then((packages) => {
const candidate = this.getInstallCandidate(packages, selectedBoard);
if (candidate) {
this.showAutoInstallPrompt(candidate, selectedBoard, selectedPort);
} else { } else {
// IDE2 knows that selected board is not installed. Look for board `name` match in not yet installed platforms. this.removeNotificationByBoard(selectedBoard);
// The order should be correct when there is a board name collision (e.g. Arduino Nano RP2040 from Arduino Mbed OS Nano Boards, [DEPRECATED] Arduino Mbed OS Nano Boards). The CLI boosts the platforms, so picking the first name match should be fine.
const platforms = await this.boardsService.search({});
for (const platform of platforms) {
// Ignore installed platforms
if (platform.installedVersion) {
continue;
} }
if ( });
platform.boards.some((board) => board.name === selectedBoard.name)
) {
const platformId = createPlatformIdentifier(platform.id);
if (platformId) {
return platformId;
}
}
}
}
return undefined;
} }
private async ensureCoreExists( private getInstallCandidate(
selectedBoard: BoardIdentifier | undefined packages: BoardsPackage[],
): Promise<void> { selectedBoard: Board
if (!selectedBoard) { ): BoardsPackage | undefined {
return; // filter packagesForBoard selecting matches from the cli (installed packages)
} // and matches based on the board name
const candidate = await this.findPlatformToInstall(selectedBoard); // NOTE: this ensures the Deprecated & new packages are all in the array
if (!candidate) { // so that we can check if any of the valid packages is already installed
return; const packagesForBoard = packages.filter(
} (pkg) =>
const platformIdToInstall = candidate.id; BoardsPackage.contains(selectedBoard, pkg) ||
const selectedBoardName = selectedBoard.name; pkg.boards.some((board) => board.name === selectedBoard.name)
if ( );
this.installNotificationInfos.some(
({ boardName, platformId }) =>
platformIdToInstall === platformId && selectedBoardName === boardName
)
) {
// Already has a notification for the board with the same platform. Nothing to do.
return;
}
this.clearAllNotificationForPlatform(platformIdToInstall);
// check if one of the packages for the board is already installed. if so, no hint
if (packagesForBoard.some(({ installedVersion }) => !!installedVersion)) {
return;
}
// filter the installable (not installed) packages,
// CLI returns the packages already sorted with the deprecated ones at the end of the list
// in order to ensure the new ones are preferred
const candidates = packagesForBoard.filter(
({ installedVersion }) => !installedVersion
);
return candidates[0];
}
private showAutoInstallPrompt(
candidate: BoardsPackage,
selectedBoard: Board,
selectedPort?: Port
): void {
const candidateName = candidate.name;
const version = candidate.availableVersions[0] const version = candidate.availableVersions[0]
? `[v ${candidate.availableVersions[0]}]` ? `[v ${candidate.availableVersions[0]}]`
: ''; : '';
const yes = nls.localize('vscode/extensionsUtils/yes', 'Yes');
const message = nls.localize( const info = this.generatePromptInfoText(
'arduino/board/installNow', candidateName,
'The "{0} {1}" core has to be installed for the currently selected "{2}" board. Do you want to install it now?',
candidate.name,
version, version,
selectedBoard.name selectedBoard.name
); );
const notificationId = this.notificationId(message, InstallManually, yes);
this.installNotificationInfos.push({ const actions = this.createPromptActions(candidate);
boardName: selectedBoardName,
platformId: platformIdToInstall, const onRefuse = () => {
notificationId, this.setLastRefusedPromptInfo(candidate.id, selectedPort);
}); };
const answer = await this.messageService.info( const handleAction = this.createOnAnswerHandler(actions, onRefuse);
message,
InstallManually, const onAnswer = (answer: string) => {
yes this.removeNotificationByBoard(selectedBoard);
);
if (answer) { handleAction(answer);
const index = this.installNotificationInfos.findIndex( };
({ boardName, platformId }) =>
platformIdToInstall === platformId && selectedBoardName === boardName this.messageService
); .info(info, ...actions.map((action) => action.key))
if (index !== -1) { .then(onAnswer);
this.installNotificationInfos.splice(index, 1);
} }
if (answer === yes) {
await Installable.installWithProgress({ private generatePromptInfoText(
installable: this.boardsService, candidateName: string,
item: candidate, version: string,
messageService: this.messageService, boardName: string
responseService: this.responseService, ): string {
version: candidate.availableVersions[0], return nls.localize(
}); 'arduino/board/installNow',
return; 'The "{0} {1}" core has to be installed for the currently selected "{2}" board. Do you want to install it now?',
candidateName,
version,
boardName
);
} }
if (answer === InstallManually) {
this.boardsManagerWidgetContribution private createPromptActions(
candidate: BoardsPackage
): AutoInstallPromptActions {
const yes = nls.localize('vscode/extensionsUtils/yes', 'Yes');
const actions: AutoInstallPromptActions = [
{
key: InstallManually,
handler: () => {
this.boardsManagerFrontendContribution
.openView({ reveal: true }) .openView({ reveal: true })
.then((widget) => .then((widget) =>
widget.refresh({ widget.refresh({
@@ -203,27 +245,37 @@ export class BoardsAutoInstaller implements FrontendApplicationContribution {
type: 'All', type: 'All',
}) })
); );
} },
} },
} {
isAcceptance: true,
private clearAllNotificationForPlatform(predicatePlatformId: string): void { key: yes,
// Discard all install notifications for the same platform. handler: () => {
const notificationsLength = this.installNotificationInfos.length; return Installable.installWithProgress({
for (let i = notificationsLength - 1; i >= 0; i--) { installable: this.boardsService,
const { notificationId, platformId } = this.installNotificationInfos[i]; item: candidate,
if (platformId === predicatePlatformId) { messageService: this.messageService,
this.installNotificationInfos.splice(i, 1); responseService: this.responseService,
this.notificationManager.clear(notificationId); version: candidate.availableVersions[0],
}
}
}
private notificationId(message: string, ...actions: string[]): string {
return this.notificationManager['getMessageId']({
text: message,
actions,
type: MessageType.Info,
}); });
},
},
];
return actions;
}
private createOnAnswerHandler(
actions: AutoInstallPromptActions,
onRefuse?: () => void
): (answer: string) => void {
return (answer) => {
const actionToHandle = actions.find((action) => action.key === answer);
actionToHandle?.handler();
if (!actionToHandle?.isAcceptance && onRefuse) {
onRefuse();
}
};
} }
} }

View File

@@ -1,345 +0,0 @@
import { DisposableCollection } from '@theia/core/lib/common/disposable';
import { Event } from '@theia/core/lib/common/event';
import { FrontendApplicationState } from '@theia/core/lib/common/frontend-application-state';
import { nls } from '@theia/core/lib/common/nls';
import React from '@theia/core/shared/react';
import { EditBoardsConfigActionParams } from '../../common/protocol/board-list';
import {
Board,
BoardIdentifier,
BoardWithPackage,
DetectedPort,
findMatchingPortIndex,
Port,
PortIdentifier,
} from '../../common/protocol/boards-service';
import type { Defined } from '../../common/types';
import { NotificationCenter } from '../notification-center';
import { BoardsConfigDialogState } from './boards-config-dialog';
namespace BoardsConfigComponent {
export interface Props {
/**
* This is not the real config, it's only living in the dialog. Users can change it without update and can cancel any modifications.
*/
readonly boardsConfig: BoardsConfigDialogState;
readonly searchSet: BoardIdentifier[] | undefined;
readonly notificationCenter: NotificationCenter;
readonly appState: FrontendApplicationState;
readonly onFocusNodeSet: (element: HTMLElement | undefined) => void;
readonly onFilteredTextDidChangeEvent: Event<
Defined<EditBoardsConfigActionParams['query']>
>;
readonly onAppStateDidChange: Event<FrontendApplicationState>;
readonly onBoardSelected: (board: BoardIdentifier) => void;
readonly onPortSelected: (port: PortIdentifier) => void;
readonly searchBoards: (query?: {
query?: string;
}) => Promise<BoardWithPackage[]>;
readonly ports: (
predicate?: (port: DetectedPort) => boolean
) => readonly DetectedPort[];
}
export interface State {
searchResults: Array<BoardWithPackage>;
showAllPorts: boolean;
query: string;
}
}
class Item<T> extends React.Component<{
item: T;
label: string;
selected: boolean;
onClick: (item: T) => void;
missing?: boolean;
details?: string;
title?: string | ((item: T) => string);
}> {
override render(): React.ReactNode {
const { selected, label, missing, details, item } = this.props;
const classNames = ['item'];
if (selected) {
classNames.push('selected');
}
if (missing === true) {
classNames.push('missing');
}
let title = this.props.title ?? `${label}${!details ? '' : details}`;
if (typeof title === 'function') {
title = title(item);
}
return (
<div
onClick={this.onClick}
className={classNames.join(' ')}
title={title}
>
<div className="label">{label}</div>
{!details ? '' : <div className="details">{details}</div>}
{!selected ? (
''
) : (
<div className="selected-icon">
<i className="fa fa-check" />
</div>
)}
</div>
);
}
private readonly onClick = () => {
this.props.onClick(this.props.item);
};
}
export class BoardsConfigComponent extends React.Component<
BoardsConfigComponent.Props,
BoardsConfigComponent.State
> {
private readonly toDispose: DisposableCollection;
constructor(props: BoardsConfigComponent.Props) {
super(props);
this.state = {
searchResults: [],
showAllPorts: false,
query: '',
};
this.toDispose = new DisposableCollection();
}
override componentDidMount(): void {
this.toDispose.pushAll([
this.props.onAppStateDidChange(async (state) => {
if (state === 'ready') {
const searchResults = await this.queryBoards({});
this.setState({ searchResults });
}
}),
this.props.notificationCenter.onPlatformDidInstall(() =>
this.updateBoards(this.state.query)
),
this.props.notificationCenter.onPlatformDidUninstall(() =>
this.updateBoards(this.state.query)
),
this.props.notificationCenter.onIndexUpdateDidComplete(() =>
this.updateBoards(this.state.query)
),
this.props.notificationCenter.onDaemonDidStart(() =>
this.updateBoards(this.state.query)
),
this.props.notificationCenter.onDaemonDidStop(() =>
this.setState({ searchResults: [] })
),
this.props.onFilteredTextDidChangeEvent((query) => {
if (typeof query === 'string') {
this.setState({ query }, () => this.updateBoards(this.state.query));
}
}),
]);
}
override componentWillUnmount(): void {
this.toDispose.dispose();
}
private readonly updateBoards = (
eventOrQuery: React.ChangeEvent<HTMLInputElement> | string = ''
) => {
const query =
typeof eventOrQuery === 'string'
? eventOrQuery
: eventOrQuery.target.value.toLowerCase();
this.setState({ query });
this.queryBoards({ query }).then((searchResults) =>
this.setState({ searchResults })
);
};
private readonly queryBoards = async (
options: { query?: string } = {}
): Promise<Array<BoardWithPackage>> => {
const result = await this.props.searchBoards(options);
const { searchSet } = this.props;
if (searchSet) {
return result.filter((board) =>
searchSet.some(
(restriction) =>
restriction.fqbn === board.fqbn || restriction.name === board.fqbn
)
);
}
return result;
};
private readonly toggleFilterPorts = () => {
this.setState({ showAllPorts: !this.state.showAllPorts });
};
private readonly selectPort = (selectedPort: PortIdentifier) => {
this.props.onPortSelected(selectedPort);
};
private readonly selectBoard = (selectedBoard: BoardWithPackage) => {
this.props.onBoardSelected(selectedBoard);
};
private readonly focusNodeSet = (element: HTMLElement | null) => {
this.props.onFocusNodeSet(element || undefined);
};
override render(): React.ReactNode {
return (
<>
{this.renderContainer(
nls.localize('arduino/board/boards', 'boards'),
this.renderBoards.bind(this)
)}
{this.renderContainer(
nls.localize('arduino/board/ports', 'ports'),
this.renderPorts.bind(this),
this.renderPortsFooter.bind(this)
)}
</>
);
}
private renderContainer(
title: string,
contentRenderer: () => React.ReactNode,
footerRenderer?: () => React.ReactNode
): React.ReactNode {
return (
<div className="container">
<div className="content">
<div className="title">{title}</div>
{contentRenderer()}
<div className="footer">{footerRenderer ? footerRenderer() : ''}</div>
</div>
</div>
);
}
private renderBoards(): React.ReactNode {
const { boardsConfig } = this.props;
const { searchResults, query } = this.state;
// Board names are not unique per core https://github.com/arduino/arduino-pro-ide/issues/262#issuecomment-661019560
// It is tricky when the core is not yet installed, no FQBNs are available.
const distinctBoards = new Map<string, Board.Detailed>();
const toKey = ({ name, packageName, fqbn }: Board.Detailed) =>
!!fqbn ? `${name}-${packageName}-${fqbn}` : `${name}-${packageName}`;
for (const board of Board.decorateBoards(
boardsConfig.selectedBoard,
searchResults
)) {
const key = toKey(board);
if (!distinctBoards.has(key)) {
distinctBoards.set(key, board);
}
}
const title = (board: Board.Detailed): string => {
const { details, manuallyInstalled } = board;
let label = board.name;
if (details) {
label += details;
}
if (manuallyInstalled) {
label += nls.localize('arduino/board/inSketchbook', ' (in Sketchbook)');
}
return label;
};
const boardsList = Array.from(distinctBoards.values()).map((board) => (
<Item<Board.Detailed>
key={toKey(board)}
item={board}
label={board.name}
details={board.details}
selected={board.selected}
onClick={this.selectBoard}
missing={board.missing}
title={title}
/>
));
return (
<React.Fragment>
<div className="search">
<input
type="search"
value={query}
className="theia-input"
placeholder={nls.localize(
'arduino/board/searchBoard',
'Search board'
)}
onChange={this.updateBoards}
ref={this.focusNodeSet}
/>
<i className="fa fa-search"></i>
</div>
{boardsList.length > 0 ? (
<div className="boards list">{boardsList}</div>
) : (
<div className="no-result">
{nls.localize(
'arduino/board/noBoardsFound',
'No boards found for "{0}"',
query
)}
</div>
)}
</React.Fragment>
);
}
private renderPorts(): React.ReactNode {
const predicate = this.state.showAllPorts ? undefined : Port.isVisiblePort;
const detectedPorts = this.props.ports(predicate);
const matchingIndex = findMatchingPortIndex(
this.props.boardsConfig.selectedPort,
detectedPorts
);
return !detectedPorts.length ? (
<div className="no-result">
{nls.localize('arduino/board/noPortsDiscovered', 'No ports discovered')}
</div>
) : (
<div className="ports list">
{detectedPorts.map((detectedPort, index) => (
<Item<Port>
key={`${Port.keyOf(detectedPort.port)}`}
item={detectedPort.port}
label={Port.toString(detectedPort.port)}
selected={index === matchingIndex}
onClick={this.selectPort}
/>
))}
</div>
);
}
private renderPortsFooter(): React.ReactNode {
return (
<div className="noselect">
<label
title={nls.localize(
'arduino/board/showAllAvailablePorts',
'Shows all available ports when enabled'
)}
>
<input
type="checkbox"
defaultChecked={this.state.showAllPorts}
onChange={this.toggleFilterPorts}
/>
<span>
{nls.localize('arduino/board/showAllPorts', 'Show all ports')}
</span>
</label>
</div>
);
}
}

View File

@@ -0,0 +1,71 @@
import * as React from '@theia/core/shared/react';
import { injectable, inject } from '@theia/core/shared/inversify';
import { Emitter } from '@theia/core/lib/common/event';
import { ReactWidget, Message } from '@theia/core/lib/browser';
import { BoardsService } from '../../common/protocol/boards-service';
import { BoardsConfig } from './boards-config';
import { BoardsServiceProvider } from './boards-service-provider';
import { NotificationCenter } from '../notification-center';
@injectable()
export class BoardsConfigDialogWidget extends ReactWidget {
@inject(BoardsService)
protected readonly boardsService: BoardsService;
@inject(BoardsServiceProvider)
protected readonly boardsServiceClient: BoardsServiceProvider;
@inject(NotificationCenter)
protected readonly notificationCenter: NotificationCenter;
protected readonly onFilterTextDidChangeEmitter = new Emitter<string>();
protected readonly onBoardConfigChangedEmitter =
new Emitter<BoardsConfig.Config>();
readonly onBoardConfigChanged = this.onBoardConfigChangedEmitter.event;
protected focusNode: HTMLElement | undefined;
constructor() {
super();
this.id = 'select-board-dialog';
this.toDispose.pushAll([
this.onBoardConfigChangedEmitter,
this.onFilterTextDidChangeEmitter,
]);
}
search(query: string): void {
this.onFilterTextDidChangeEmitter.fire(query);
}
protected fireConfigChanged = (config: BoardsConfig.Config) => {
this.onBoardConfigChangedEmitter.fire(config);
};
protected setFocusNode = (element: HTMLElement | undefined) => {
this.focusNode = element;
};
protected render(): React.ReactNode {
return (
<div className="selectBoardContainer">
<BoardsConfig
boardsServiceProvider={this.boardsServiceClient}
notificationCenter={this.notificationCenter}
onConfigChange={this.fireConfigChanged}
onFocusNodeSet={this.setFocusNode}
onFilteredTextDidChangeEvent={this.onFilterTextDidChangeEmitter.event}
onAppStateDidChange={this.notificationCenter.onAppStateDidChange}
/>
</div>
);
}
protected override onActivateRequest(msg: Message): void {
super.onActivateRequest(msg);
if (this.focusNode instanceof HTMLInputElement) {
this.focusNode.select();
}
(this.focusNode || this.node).focus();
}
}

View File

@@ -0,0 +1,142 @@
import {
injectable,
inject,
postConstruct,
} from '@theia/core/shared/inversify';
import { Message } from '@theia/core/shared/@phosphor/messaging';
import { DialogProps, Widget, DialogError } from '@theia/core/lib/browser';
import { AbstractDialog } from '../theia/dialogs/dialogs';
import { BoardsConfig } from './boards-config';
import { BoardsService } from '../../common/protocol/boards-service';
import { BoardsServiceProvider } from './boards-service-provider';
import { BoardsConfigDialogWidget } from './boards-config-dialog-widget';
import { nls } from '@theia/core/lib/common';
@injectable()
export class BoardsConfigDialogProps extends DialogProps {}
@injectable()
export class BoardsConfigDialog extends AbstractDialog<BoardsConfig.Config> {
@inject(BoardsConfigDialogWidget)
protected readonly widget: BoardsConfigDialogWidget;
@inject(BoardsService)
protected readonly boardService: BoardsService;
@inject(BoardsServiceProvider)
protected readonly boardsServiceClient: BoardsServiceProvider;
protected config: BoardsConfig.Config = {};
constructor(
@inject(BoardsConfigDialogProps)
protected override readonly props: BoardsConfigDialogProps
) {
super({ ...props, maxWidth: 500 });
this.node.id = 'select-board-dialog-container';
this.contentNode.classList.add('select-board-dialog');
this.contentNode.appendChild(this.createDescription());
this.appendCloseButton(
nls.localize('vscode/issueMainService/cancel', 'Cancel')
);
this.appendAcceptButton(nls.localize('vscode/issueMainService/ok', 'OK'));
}
@postConstruct()
protected init(): void {
this.toDispose.push(
this.boardsServiceClient.onBoardsConfigChanged((config) => {
this.config = config;
this.update();
})
);
}
/**
* Pass in an empty string if you want to reset the search term. Using `undefined` has no effect.
*/
override async open(
query: string | undefined = undefined
): Promise<BoardsConfig.Config | undefined> {
if (typeof query === 'string') {
this.widget.search(query);
}
return super.open();
}
protected createDescription(): HTMLElement {
const head = document.createElement('div');
head.classList.add('head');
const text = document.createElement('div');
text.classList.add('text');
head.appendChild(text);
for (const paragraph of [
nls.localize(
'arduino/board/configDialog1',
'Select both a Board and a Port if you want to upload a sketch.'
),
nls.localize(
'arduino/board/configDialog2',
'If you only select a Board you will be able to compile, but not to upload your sketch.'
),
]) {
const p = document.createElement('div');
p.textContent = paragraph;
text.appendChild(p);
}
return head;
}
protected override onAfterAttach(msg: Message): void {
if (this.widget.isAttached) {
Widget.detach(this.widget);
}
Widget.attach(this.widget, this.contentNode);
this.toDisposeOnDetach.push(
this.widget.onBoardConfigChanged((config) => {
this.config = config;
this.update();
})
);
super.onAfterAttach(msg);
this.update();
}
protected override onUpdateRequest(msg: Message): void {
super.onUpdateRequest(msg);
this.widget.update();
}
protected override onActivateRequest(msg: Message): void {
super.onActivateRequest(msg);
this.widget.activate();
}
protected override handleEnter(event: KeyboardEvent): boolean | void {
if (event.target instanceof HTMLTextAreaElement) {
return false;
}
}
protected override isValid(value: BoardsConfig.Config): DialogError {
if (!value.selectedBoard) {
if (value.selectedPort) {
return nls.localize(
'arduino/board/pleasePickBoard',
'Please pick a board connected to the port you have selected.'
);
}
return false;
}
return '';
}
get value(): BoardsConfig.Config {
return this.config;
}
}

View File

@@ -1,202 +0,0 @@
import { DialogError, DialogProps } from '@theia/core/lib/browser/dialogs';
import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';
import { Emitter } from '@theia/core/lib/common/event';
import { nls } from '@theia/core/lib/common/nls';
import { deepClone } from '@theia/core/lib/common/objects';
import type { Message } from '@theia/core/shared/@phosphor/messaging';
import {
inject,
injectable,
postConstruct,
} from '@theia/core/shared/inversify';
import React from '@theia/core/shared/react';
import type { ReactNode } from '@theia/core/shared/react/index';
import { EditBoardsConfigActionParams } from '../../common/protocol/board-list';
import {
BoardIdentifier,
BoardsConfig,
BoardWithPackage,
DetectedPort,
emptyBoardsConfig,
PortIdentifier,
} from '../../common/protocol/boards-service';
import type { Defined } from '../../common/types';
import { NotificationCenter } from '../notification-center';
import { ReactDialog } from '../theia/dialogs/dialogs';
import { BoardsConfigComponent } from './boards-config-component';
import { BoardsServiceProvider } from './boards-service-provider';
@injectable()
export class BoardsConfigDialogProps extends DialogProps {}
export type BoardsConfigDialogState = Omit<BoardsConfig, 'selectedBoard'> & {
selectedBoard: BoardsConfig['selectedBoard'] | BoardWithPackage;
};
@injectable()
export class BoardsConfigDialog extends ReactDialog<BoardsConfigDialogState> {
@inject(BoardsServiceProvider)
private readonly boardsServiceProvider: BoardsServiceProvider;
@inject(NotificationCenter)
private readonly notificationCenter: NotificationCenter;
@inject(FrontendApplicationStateService)
private readonly appStateService: FrontendApplicationStateService;
private readonly onFilterTextDidChangeEmitter: Emitter<
Defined<EditBoardsConfigActionParams['query']>
>;
private readonly onBoardSelected = (board: BoardWithPackage): void => {
this._boardsConfig.selectedBoard = board;
this.update();
};
private readonly onPortSelected = (port: PortIdentifier): void => {
this._boardsConfig.selectedPort = port;
this.update();
};
private readonly setFocusNode = (element: HTMLElement | undefined): void => {
this.focusNode = element;
};
private readonly searchBoards = (options: {
query?: string;
}): Promise<BoardWithPackage[]> => {
return this.boardsServiceProvider.searchBoards(options);
};
private readonly ports = (
predicate?: (port: DetectedPort) => boolean
): readonly DetectedPort[] => {
return this.boardsServiceProvider.boardList.ports(predicate);
};
private _boardsConfig: BoardsConfigDialogState;
/**
* When the dialog's boards result set is limited to a subset of boards when searching, this field is set.
*/
private _searchSet: BoardIdentifier[] | undefined;
private focusNode: HTMLElement | undefined;
constructor(
@inject(BoardsConfigDialogProps)
protected override readonly props: BoardsConfigDialogProps
) {
super({ ...props, maxWidth: 500 });
this.node.id = 'select-board-dialog-container';
this.contentNode.classList.add('select-board-dialog');
this.appendCloseButton(
nls.localize('vscode/issueMainService/cancel', 'Cancel')
);
this.appendAcceptButton(nls.localize('vscode/issueMainService/ok', 'OK'));
this._boardsConfig = emptyBoardsConfig();
this.onFilterTextDidChangeEmitter = new Emitter();
}
@postConstruct()
protected init(): void {
this.boardsServiceProvider.onBoardListDidChange(() => {
this._boardsConfig = deepClone(this.boardsServiceProvider.boardsConfig);
this.update();
});
this._boardsConfig = deepClone(this.boardsServiceProvider.boardsConfig);
}
override async open(
params?: EditBoardsConfigActionParams
): Promise<BoardsConfig | undefined> {
this._searchSet = undefined;
this._boardsConfig.selectedBoard =
this.boardsServiceProvider.boardsConfig.selectedBoard;
this._boardsConfig.selectedPort =
this.boardsServiceProvider.boardsConfig.selectedPort;
if (params) {
if (typeof params.query === 'string') {
this.onFilterTextDidChangeEmitter.fire(params.query);
}
if (params.portToSelect) {
this._boardsConfig.selectedPort = params.portToSelect;
}
if (params.boardToSelect) {
this._boardsConfig.selectedBoard = params.boardToSelect;
}
if (params.searchSet) {
this._searchSet = params.searchSet.slice();
}
}
return super.open();
}
protected override onAfterAttach(msg: Message): void {
super.onAfterAttach(msg);
this.update();
}
protected override render(): ReactNode {
return (
<>
<div className="head">
<div className="text">
<div>
{nls.localize(
'arduino/board/configDialog1',
'Select both a Board and a Port if you want to upload a sketch.'
)}
</div>
<div>
{nls.localize(
'arduino/board/configDialog2',
'If you only select a Board you will be able to compile, but not to upload your sketch.'
)}
</div>
</div>
</div>
<div id="select-board-dialog" className="p-Widget ps">
<div className="selectBoardContainer">
<BoardsConfigComponent
boardsConfig={this._boardsConfig}
searchSet={this._searchSet}
onBoardSelected={this.onBoardSelected}
onPortSelected={this.onPortSelected}
notificationCenter={this.notificationCenter}
onFocusNodeSet={this.setFocusNode}
onFilteredTextDidChangeEvent={
this.onFilterTextDidChangeEmitter.event
}
appState={this.appStateService.state}
onAppStateDidChange={this.notificationCenter.onAppStateDidChange}
searchBoards={this.searchBoards}
ports={this.ports}
/>
</div>
</div>
</>
);
}
protected override onActivateRequest(msg: Message): void {
super.onActivateRequest(msg);
if (this.focusNode instanceof HTMLInputElement) {
this.focusNode.select();
}
(this.focusNode || this.node).focus();
}
protected override handleEnter(event: KeyboardEvent): boolean | void {
if (event.target instanceof HTMLTextAreaElement) {
return false;
}
}
protected override isValid(value: BoardsConfig): DialogError {
if (!value.selectedBoard) {
if (value.selectedPort) {
return nls.localize(
'arduino/board/pleasePickBoard',
'Please pick a board connected to the port you have selected.'
);
}
return false;
}
return '';
}
get value(): BoardsConfigDialogState {
return this._boardsConfig;
}
}

View File

@@ -0,0 +1,432 @@
import * as React from '@theia/core/shared/react';
import { Event } from '@theia/core/lib/common/event';
import { notEmpty } from '@theia/core/lib/common/objects';
import { MaybePromise } from '@theia/core/lib/common/types';
import { DisposableCollection } from '@theia/core/lib/common/disposable';
import {
Board,
Port,
BoardConfig as ProtocolBoardConfig,
BoardWithPackage,
} from '../../common/protocol/boards-service';
import { NotificationCenter } from '../notification-center';
import {
AvailableBoard,
BoardsServiceProvider,
} from './boards-service-provider';
import { naturalCompare } from '../../common/utils';
import { nls } from '@theia/core/lib/common';
import { FrontendApplicationState } from '@theia/core/lib/common/frontend-application-state';
export namespace BoardsConfig {
export type Config = ProtocolBoardConfig;
export interface Props {
readonly boardsServiceProvider: BoardsServiceProvider;
readonly notificationCenter: NotificationCenter;
readonly onConfigChange: (config: Config) => void;
readonly onFocusNodeSet: (element: HTMLElement | undefined) => void;
readonly onFilteredTextDidChangeEvent: Event<string>;
readonly onAppStateDidChange: Event<FrontendApplicationState>;
}
export interface State extends Config {
searchResults: Array<BoardWithPackage>;
knownPorts: Port[];
showAllPorts: boolean;
query: string;
}
}
export abstract class Item<T> extends React.Component<{
item: T;
label: string;
selected: boolean;
onClick: (item: T) => void;
missing?: boolean;
details?: string;
}> {
override render(): React.ReactNode {
const { selected, label, missing, details } = this.props;
const classNames = ['item'];
if (selected) {
classNames.push('selected');
}
if (missing === true) {
classNames.push('missing');
}
return (
<div
onClick={this.onClick}
className={classNames.join(' ')}
title={`${label}${!details ? '' : details}`}
>
<div className="label">{label}</div>
{!details ? '' : <div className="details">{details}</div>}
{!selected ? (
''
) : (
<div className="selected-icon">
<i className="fa fa-check" />
</div>
)}
</div>
);
}
protected onClick = () => {
this.props.onClick(this.props.item);
};
}
export class BoardsConfig extends React.Component<
BoardsConfig.Props,
BoardsConfig.State
> {
protected toDispose = new DisposableCollection();
constructor(props: BoardsConfig.Props) {
super(props);
const { boardsConfig } = props.boardsServiceProvider;
this.state = {
searchResults: [],
knownPorts: [],
showAllPorts: false,
query: '',
...boardsConfig,
};
}
override componentDidMount(): void {
this.toDispose.pushAll([
this.props.onAppStateDidChange((state) => {
if (state === 'ready') {
this.updateBoards();
this.updatePorts(
this.props.boardsServiceProvider.availableBoards
.map(({ port }) => port)
.filter(notEmpty)
);
}
}),
this.props.boardsServiceProvider.onAvailablePortsChanged(
({ newState, oldState }) => {
const removedPorts = oldState.filter(
(oldPort) =>
!newState.find((newPort) => Port.sameAs(newPort, oldPort))
);
this.updatePorts(newState, removedPorts);
}
),
this.props.boardsServiceProvider.onBoardsConfigChanged(
({ selectedBoard, selectedPort }) => {
this.setState({ selectedBoard, selectedPort }, () =>
this.fireConfigChanged()
);
}
),
this.props.notificationCenter.onPlatformDidInstall(() =>
this.updateBoards(this.state.query)
),
this.props.notificationCenter.onPlatformDidUninstall(() =>
this.updateBoards(this.state.query)
),
this.props.notificationCenter.onIndexUpdateDidComplete(() =>
this.updateBoards(this.state.query)
),
this.props.notificationCenter.onDaemonDidStart(() =>
this.updateBoards(this.state.query)
),
this.props.notificationCenter.onDaemonDidStop(() =>
this.setState({ searchResults: [] })
),
this.props.onFilteredTextDidChangeEvent((query) =>
this.setState({ query }, () => this.updateBoards(this.state.query))
),
]);
}
override componentWillUnmount(): void {
this.toDispose.dispose();
}
protected fireConfigChanged(): void {
const { selectedBoard, selectedPort } = this.state;
this.props.onConfigChange({ selectedBoard, selectedPort });
}
protected updateBoards = (
eventOrQuery: React.ChangeEvent<HTMLInputElement> | string = ''
) => {
const query =
typeof eventOrQuery === 'string'
? eventOrQuery
: eventOrQuery.target.value.toLowerCase();
this.setState({ query });
this.queryBoards({ query }).then((searchResults) =>
this.setState({ searchResults })
);
};
protected updatePorts = (ports: Port[] = [], removedPorts: Port[] = []) => {
this.queryPorts(Promise.resolve(ports)).then(({ knownPorts }) => {
let { selectedPort } = this.state;
// If the currently selected port is not available anymore, unset the selected port.
if (removedPorts.some((port) => Port.sameAs(port, selectedPort))) {
selectedPort = undefined;
}
this.setState({ knownPorts, selectedPort }, () =>
this.fireConfigChanged()
);
});
};
protected queryBoards = (
options: { query?: string } = {}
): Promise<Array<BoardWithPackage>> => {
return this.props.boardsServiceProvider.searchBoards(options);
};
protected get availablePorts(): MaybePromise<Port[]> {
return this.props.boardsServiceProvider.availableBoards
.map(({ port }) => port)
.filter(notEmpty);
}
protected get availableBoards(): AvailableBoard[] {
return this.props.boardsServiceProvider.availableBoards;
}
protected queryPorts = async (
availablePorts: MaybePromise<Port[]> = this.availablePorts
) => {
// Available ports must be sorted in this order:
// 1. Serial with recognized boards
// 2. Serial with guessed boards
// 3. Serial with incomplete boards
// 4. Network with recognized boards
// 5. Other protocols with recognized boards
const ports = (await availablePorts).sort((left: Port, right: Port) => {
if (left.protocol === 'serial' && right.protocol !== 'serial') {
return -1;
} else if (left.protocol !== 'serial' && right.protocol === 'serial') {
return 1;
} else if (left.protocol === 'network' && right.protocol !== 'network') {
return -1;
} else if (left.protocol !== 'network' && right.protocol === 'network') {
return 1;
} else if (left.protocol === right.protocol) {
// We show ports, including those that have guessed
// or unrecognized boards, so we must sort those too.
const leftBoard = this.availableBoards.find(
(board) => board.port === left
);
const rightBoard = this.availableBoards.find(
(board) => board.port === right
);
if (leftBoard && !rightBoard) {
return -1;
} else if (!leftBoard && rightBoard) {
return 1;
} else if (leftBoard?.state! < rightBoard?.state!) {
return -1;
} else if (leftBoard?.state! > rightBoard?.state!) {
return 1;
}
}
return naturalCompare(left.address, right.address);
});
return { knownPorts: ports };
};
protected toggleFilterPorts = () => {
this.setState({ showAllPorts: !this.state.showAllPorts });
};
protected selectPort = (selectedPort: Port | undefined) => {
this.setState({ selectedPort }, () => this.fireConfigChanged());
};
protected selectBoard = (selectedBoard: BoardWithPackage | undefined) => {
this.setState({ selectedBoard }, () => this.fireConfigChanged());
};
protected focusNodeSet = (element: HTMLElement | null) => {
this.props.onFocusNodeSet(element || undefined);
};
override render(): React.ReactNode {
return (
<>
{this.renderContainer(
nls.localize('arduino/board/boards', 'boards'),
this.renderBoards.bind(this)
)}
{this.renderContainer(
nls.localize('arduino/board/ports', 'ports'),
this.renderPorts.bind(this),
this.renderPortsFooter.bind(this)
)}
</>
);
}
protected renderContainer(
title: string,
contentRenderer: () => React.ReactNode,
footerRenderer?: () => React.ReactNode
): React.ReactNode {
return (
<div className="container">
<div className="content">
<div className="title">{title}</div>
{contentRenderer()}
<div className="footer">{footerRenderer ? footerRenderer() : ''}</div>
</div>
</div>
);
}
protected renderBoards(): React.ReactNode {
const { selectedBoard, searchResults, query } = this.state;
// Board names are not unique per core https://github.com/arduino/arduino-pro-ide/issues/262#issuecomment-661019560
// It is tricky when the core is not yet installed, no FQBNs are available.
const distinctBoards = new Map<string, Board.Detailed>();
const toKey = ({ name, packageName, fqbn }: Board.Detailed) =>
!!fqbn ? `${name}-${packageName}-${fqbn}` : `${name}-${packageName}`;
for (const board of Board.decorateBoards(selectedBoard, searchResults)) {
const key = toKey(board);
if (!distinctBoards.has(key)) {
distinctBoards.set(key, board);
}
}
const boardsList = Array.from(distinctBoards.values()).map((board) => (
<Item<BoardWithPackage>
key={toKey(board)}
item={board}
label={board.name}
details={board.details}
selected={board.selected}
onClick={this.selectBoard}
missing={board.missing}
/>
));
return (
<React.Fragment>
<div className="search">
<input
type="search"
value={query}
className="theia-input"
placeholder={nls.localize(
'arduino/board/searchBoard',
'Search board'
)}
onChange={this.updateBoards}
ref={this.focusNodeSet}
/>
<i className="fa fa-search"></i>
</div>
{boardsList.length > 0 ? (
<div className="boards list">{boardsList}</div>
) : (
<div className="no-result">
{nls.localize(
'arduino/board/noBoardsFound',
'No boards found for "{0}"',
query
)}
</div>
)}
</React.Fragment>
);
}
protected renderPorts(): React.ReactNode {
let ports = [] as Port[];
if (this.state.showAllPorts) {
ports = this.state.knownPorts;
} else {
ports = this.state.knownPorts.filter(
Port.visiblePorts(this.availableBoards)
);
}
return !ports.length ? (
<div className="no-result">
{nls.localize('arduino/board/noPortsDiscovered', 'No ports discovered')}
</div>
) : (
<div className="ports list">
{ports.map((port) => (
<Item<Port>
key={`${Port.keyOf(port)}`}
item={port}
label={Port.toString(port)}
selected={Port.sameAs(this.state.selectedPort, port)}
onClick={this.selectPort}
/>
))}
</div>
);
}
protected renderPortsFooter(): React.ReactNode {
return (
<div className="noselect">
<label
title={nls.localize(
'arduino/board/showAllAvailablePorts',
'Shows all available ports when enabled'
)}
>
<input
type="checkbox"
defaultChecked={this.state.showAllPorts}
onChange={this.toggleFilterPorts}
/>
<span>
{nls.localize('arduino/board/showAllPorts', 'Show all ports')}
</span>
</label>
</div>
);
}
}
export namespace BoardsConfig {
export namespace Config {
export function sameAs(config: Config, other: Config | Board): boolean {
const { selectedBoard, selectedPort } = config;
if (Board.is(other)) {
return (
!!selectedBoard &&
Board.equals(other, selectedBoard) &&
Port.sameAs(selectedPort, other.port)
);
}
return sameAs(config, other);
}
export function equals(left: Config, right: Config): boolean {
return (
left.selectedBoard === right.selectedBoard &&
left.selectedPort === right.selectedPort
);
}
export function toString(
config: Config,
options: { default: string } = { default: '' }
): string {
const { selectedBoard, selectedPort: port } = config;
if (!selectedBoard) {
return options.default;
}
const { name } = selectedBoard;
return `${name}${port ? ` at ${port.address}` : ''}`;
}
}
}

View File

@@ -1,66 +1,67 @@
import * as PQueue from 'p-queue';
import { inject, injectable } from '@theia/core/shared/inversify';
import { CommandRegistry } from '@theia/core/lib/common/command';
import { MenuModelRegistry } from '@theia/core/lib/common/menu';
import { import {
Disposable, Disposable,
DisposableCollection, DisposableCollection,
} from '@theia/core/lib/common/disposable'; } from '@theia/core/lib/common/disposable';
import { nls } from '@theia/core/lib/common/nls'; import { BoardsServiceProvider } from './boards-service-provider';
import { inject, injectable } from '@theia/core/shared/inversify'; import { Board, ConfigOption, Programmer } from '../../common/protocol';
import PQueue from 'p-queue'; import { FrontendApplicationContribution } from '@theia/core/lib/browser';
import { import { BoardsDataStore } from './boards-data-store';
BoardIdentifier, import { MainMenuManager } from '../../common/main-menu-manager';
ConfigOption,
isBoardIdentifierChangeEvent,
Programmer,
} from '../../common/protocol';
import { BoardsDataStore } from '../boards/boards-data-store';
import { BoardsServiceProvider } from '../boards/boards-service-provider';
import { ArduinoMenus, unregisterSubmenu } from '../menu/arduino-menus'; import { ArduinoMenus, unregisterSubmenu } from '../menu/arduino-menus';
import { import { nls } from '@theia/core/lib/common';
CommandRegistry, import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';
Contribution,
MenuModelRegistry,
} from './contribution';
@injectable() @injectable()
export class BoardsDataMenuUpdater extends Contribution { export class BoardsDataMenuUpdater implements FrontendApplicationContribution {
@inject(CommandRegistry) @inject(CommandRegistry)
private readonly commandRegistry: CommandRegistry; protected readonly commandRegistry: CommandRegistry;
@inject(MenuModelRegistry) @inject(MenuModelRegistry)
private readonly menuRegistry: MenuModelRegistry; protected readonly menuRegistry: MenuModelRegistry;
@inject(MainMenuManager)
protected readonly mainMenuManager: MainMenuManager;
@inject(BoardsDataStore) @inject(BoardsDataStore)
private readonly boardsDataStore: BoardsDataStore; protected readonly boardsDataStore: BoardsDataStore;
@inject(BoardsServiceProvider) @inject(BoardsServiceProvider)
private readonly boardsServiceProvider: BoardsServiceProvider; protected readonly boardsServiceClient: BoardsServiceProvider;
private readonly queue = new PQueue({ autoStart: true, concurrency: 1 }); @inject(FrontendApplicationStateService)
private readonly toDisposeOnBoardChange = new DisposableCollection(); private readonly appStateService: FrontendApplicationStateService;
override onStart(): void { protected readonly queue = new PQueue({ autoStart: true, concurrency: 1 });
this.boardsDataStore.onDidChange(() => protected readonly toDisposeOnBoardChange = new DisposableCollection();
async onStart(): Promise<void> {
this.appStateService
.reachedState('ready')
.then(() =>
this.updateMenuActions( this.updateMenuActions(
this.boardsServiceProvider.boardsConfig.selectedBoard this.boardsServiceClient.boardsConfig.selectedBoard
) )
); );
this.boardsServiceProvider.onBoardsConfigDidChange((event) => { this.boardsDataStore.onChanged(() =>
if (isBoardIdentifierChangeEvent(event)) {
this.updateMenuActions(event.selectedBoard);
}
});
}
override onReady(): void {
this.boardsServiceProvider.ready.then(() =>
this.updateMenuActions( this.updateMenuActions(
this.boardsServiceProvider.boardsConfig.selectedBoard this.boardsServiceClient.boardsConfig.selectedBoard
) )
); );
this.boardsServiceClient.onBoardsConfigChanged(({ selectedBoard }) =>
this.updateMenuActions(selectedBoard)
);
} }
private async updateMenuActions( protected async updateMenuActions(
selectedBoard: BoardIdentifier | undefined selectedBoard: Board | undefined
): Promise<void> { ): Promise<void> {
return this.queue.add(async () => { return this.queue.add(async () => {
this.toDisposeOnBoardChange.dispose(); this.toDisposeOnBoardChange.dispose();
this.menuManager.update(); this.mainMenuManager.update();
if (selectedBoard) { if (selectedBoard) {
const { fqbn } = selectedBoard; const { fqbn } = selectedBoard;
if (fqbn) { if (fqbn) {
@@ -87,7 +88,8 @@ export class BoardsDataMenuUpdater extends Contribution {
execute: () => execute: () =>
this.boardsDataStore.selectConfigOption({ this.boardsDataStore.selectConfigOption({
fqbn, fqbn,
optionsToUpdate: [{ option, selectedValue: value.value }], option,
selectedValue: value.value,
}), }),
isToggled: () => value.selected, isToggled: () => value.selected,
}; };
@@ -170,7 +172,7 @@ export class BoardsDataMenuUpdater extends Contribution {
]); ]);
} }
} }
this.menuManager.update(); this.mainMenuManager.update();
} }
} }
}); });

View File

@@ -1,202 +1,77 @@
import { FrontendApplicationContribution } from '@theia/core/lib/browser/frontend-application'; import { injectable, inject, named } from '@theia/core/shared/inversify';
import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';
import { StorageService } from '@theia/core/lib/browser/storage-service';
import type {
Command,
CommandContribution,
CommandRegistry,
} from '@theia/core/lib/common/command';
import { DisposableCollection } from '@theia/core/lib/common/disposable';
import { Emitter, Event } from '@theia/core/lib/common/event';
import { ILogger } from '@theia/core/lib/common/logger'; import { ILogger } from '@theia/core/lib/common/logger';
import { deepClone, deepFreeze } from '@theia/core/lib/common/objects'; import { deepClone } from '@theia/core/lib/common/objects';
import type { Mutable } from '@theia/core/lib/common/types'; import { Event, Emitter } from '@theia/core/lib/common/event';
import { inject, injectable, named } from '@theia/core/shared/inversify'; import {
import { FQBN } from 'fqbn'; FrontendApplicationContribution,
LocalStorageService,
} from '@theia/core/lib/browser';
import { notEmpty } from '../../common/utils';
import { import {
BoardDetails,
BoardsService, BoardsService,
ConfigOption, ConfigOption,
ConfigValue, BoardDetails,
Programmer, Programmer,
isBoardIdentifierChangeEvent,
isProgrammer,
sanitizeFqbn,
} from '../../common/protocol'; } from '../../common/protocol';
import { notEmpty } from '../../common/utils';
import type {
StartupTask,
StartupTaskProvider,
} from '../../electron-common/startup-task';
import { NotificationCenter } from '../notification-center'; import { NotificationCenter } from '../notification-center';
import { BoardsServiceProvider } from './boards-service-provider';
export interface SelectConfigOptionParams {
readonly fqbn: string;
readonly optionsToUpdate: readonly Readonly<{
option: string;
selectedValue: string;
}>[];
}
@injectable() @injectable()
export class BoardsDataStore export class BoardsDataStore implements FrontendApplicationContribution {
implements
FrontendApplicationContribution,
StartupTaskProvider,
CommandContribution
{
@inject(ILogger) @inject(ILogger)
@named('store') @named('store')
private readonly logger: ILogger; protected readonly logger: ILogger;
@inject(BoardsService)
private readonly boardsService: BoardsService;
@inject(NotificationCenter)
private readonly notificationCenter: NotificationCenter;
// When `@theia/workspace` is part of the application, the workspace-scoped storage service is the default implementation, and the `StorageService` symbol must be used for the injection.
// https://github.com/eclipse-theia/theia/blob/ba3722b04ff91eb6a4af6a571c9e263c77cdd8b5/packages/workspace/src/browser/workspace-frontend-module.ts#L97-L98
// In other words, store the data (such as the board configs) per sketch, not per IDE2 installation. https://github.com/arduino/arduino-ide/issues/2240
@inject(StorageService)
private readonly storageService: StorageService;
@inject(BoardsServiceProvider)
private readonly boardsServiceProvider: BoardsServiceProvider;
@inject(FrontendApplicationStateService)
private readonly appStateService: FrontendApplicationStateService;
private readonly onDidChangeEmitter = @inject(BoardsService)
new Emitter<BoardsDataStoreChangeEvent>(); protected readonly boardsService: BoardsService;
private readonly toDispose = new DisposableCollection(
this.onDidChangeEmitter @inject(NotificationCenter)
); protected readonly notificationCenter: NotificationCenter;
private _selectedBoardData: BoardsDataStoreChange | undefined;
@inject(LocalStorageService)
protected readonly storageService: LocalStorageService;
protected readonly onChangedEmitter = new Emitter<string[]>();
onStart(): void { onStart(): void {
this.toDispose.pushAll([
this.boardsServiceProvider.onBoardsConfigDidChange((event) => {
if (isBoardIdentifierChangeEvent(event)) {
this.updateSelectedBoardData(
event.selectedBoard?.fqbn,
// If the change event comes from toolbar and the FQBN contains custom board options, change the currently selected options
// https://github.com/arduino/arduino-ide/issues/1588
event.reason === 'toolbar'
);
}
}),
this.notificationCenter.onPlatformDidInstall(async ({ item }) => { this.notificationCenter.onPlatformDidInstall(async ({ item }) => {
const boardsWithFqbn = item.boards const dataDidChangePerFqbn: string[] = [];
for (const fqbn of item.boards
.map(({ fqbn }) => fqbn) .map(({ fqbn }) => fqbn)
.filter(notEmpty); .filter(notEmpty)
const changes: BoardsDataStoreChange[] = []; .filter((fqbn) => !!fqbn)) {
for (const fqbn of boardsWithFqbn) {
const key = this.getStorageKey(fqbn); const key = this.getStorageKey(fqbn);
const storedData = let data = await this.storageService.getData<
await this.storageService.getData<BoardsDataStore.Data>(key); ConfigOption[] | undefined
if (!storedData) { >(key);
// if no previously value is available for the board, do not update the cache if (!data || !data.length) {
continue; const details = await this.getBoardDetailsSafe(fqbn);
}
const details = await this.loadBoardDetails(fqbn);
if (details) { if (details) {
const data = createDataStoreEntry(details); data = details.configOptions;
if (data.length) {
await this.storageService.setData(key, data); await this.storageService.setData(key, data);
changes.push({ fqbn, data }); dataDidChangePerFqbn.push(fqbn);
}
}
if (changes.length) {
this.fireChanged(...changes);
}
}),
this.onDidChange((event) => {
const selectedFqbn =
this.boardsServiceProvider.boardsConfig.selectedBoard?.fqbn;
if (event.changes.find((change) => change.fqbn === selectedFqbn)) {
this.updateSelectedBoardData(selectedFqbn);
}
}),
]);
Promise.all([
this.boardsServiceProvider.ready,
this.appStateService.reachedState('ready'),
]).then(() =>
this.updateSelectedBoardData(
this.boardsServiceProvider.boardsConfig.selectedBoard?.fqbn
)
);
}
private async getSelectedBoardData(
fqbn: string | undefined
): Promise<BoardsDataStoreChange | undefined> {
if (!fqbn) {
return undefined;
} else {
const data = await this.getData(sanitizeFqbn(fqbn));
if (data === BoardsDataStore.Data.EMPTY) {
return undefined;
}
return { fqbn, data };
}
}
private async updateSelectedBoardData(
fqbn: string | undefined,
updateConfigOptions = false
): Promise<void> {
this._selectedBoardData = await this.getSelectedBoardData(fqbn);
if (fqbn && updateConfigOptions) {
const { options } = new FQBN(fqbn);
if (options) {
const optionsToUpdate = Object.entries(options).map(([key, value]) => ({
option: key,
selectedValue: value,
}));
const params = { fqbn, optionsToUpdate };
await this.selectConfigOption(params);
this._selectedBoardData = await this.getSelectedBoardData(fqbn); // reload the updated data
} }
} }
} }
onStop(): void {
this.toDispose.dispose();
} }
if (dataDidChangePerFqbn.length) {
registerCommands(registry: CommandRegistry): void { this.fireChanged(...dataDidChangePerFqbn);
registry.registerCommand(USE_INHERITED_DATA, {
execute: async (arg: unknown) => {
if (isBoardsDataStoreChange(arg)) {
await this.setData(arg);
this.fireChanged(arg);
} }
},
}); });
} }
tasks(): StartupTask[] { get onChanged(): Event<string[]> {
if (!this._selectedBoardData) { return this.onChangedEmitter.event;
return [];
}
return [
{
command: USE_INHERITED_DATA.id,
args: [this._selectedBoardData],
},
];
}
get onDidChange(): Event<BoardsDataStoreChangeEvent> {
return this.onDidChangeEmitter.event;
} }
async appendConfigToFqbn( async appendConfigToFqbn(
fqbn: string | undefined fqbn: string | undefined,
): Promise<string | undefined> { ): Promise<string | undefined> {
if (!fqbn) { if (!fqbn) {
return undefined; return undefined;
} }
const { configOptions } = await this.getData(fqbn); const { configOptions } = await this.getData(fqbn);
return new FQBN(fqbn).withConfigOptions(...configOptions).toString(); return ConfigOption.decorate(fqbn, configOptions);
} }
async getData(fqbn: string | undefined): Promise<BoardsDataStore.Data> { async getData(fqbn: string | undefined): Promise<BoardsDataStore.Data> {
@@ -205,106 +80,83 @@ export class BoardsDataStore
} }
const key = this.getStorageKey(fqbn); const key = this.getStorageKey(fqbn);
const storedData = await this.storageService.getData< let data = await this.storageService.getData<
BoardsDataStore.Data | undefined BoardsDataStore.Data | undefined
>(key, undefined); >(key, undefined);
if (BoardsDataStore.Data.is(storedData)) { if (BoardsDataStore.Data.is(data)) {
return storedData; return data;
} }
const boardDetails = await this.loadBoardDetails(fqbn); const boardDetails = await this.getBoardDetailsSafe(fqbn);
if (!boardDetails) { if (!boardDetails) {
return BoardsDataStore.Data.EMPTY; return BoardsDataStore.Data.EMPTY;
} }
const data = createDataStoreEntry(boardDetails); data = {
configOptions: boardDetails.configOptions,
programmers: boardDetails.programmers,
};
await this.storageService.setData(key, data); await this.storageService.setData(key, data);
return data; return data;
} }
async reloadBoardData(fqbn: string | undefined): Promise<void> { async selectProgrammer(
if (!fqbn) { {
return;
}
const key = this.getStorageKey(fqbn);
const details = await this.loadBoardDetails(fqbn, true);
if (!details) {
return;
}
const data = createDataStoreEntry(details);
await this.storageService.setData(key, data);
this.fireChanged({ fqbn, data });
}
async selectProgrammer({
fqbn, fqbn,
selectedProgrammer, selectedProgrammer,
}: { }: { fqbn: string; selectedProgrammer: Programmer },
fqbn: string; ): Promise<boolean> {
selectedProgrammer: Programmer; const data = deepClone(await this.getData(fqbn));
}): Promise<boolean> { const { programmers } = data;
const sanitizedFQBN = sanitizeFqbn(fqbn);
const storedData = deepClone(await this.getData(sanitizedFQBN));
const { programmers } = storedData;
if (!programmers.find((p) => Programmer.equals(selectedProgrammer, p))) { if (!programmers.find((p) => Programmer.equals(selectedProgrammer, p))) {
return false; return false;
} }
const change: BoardsDataStoreChange = { await this.setData({
fqbn: sanitizedFQBN, fqbn,
data: { ...storedData, selectedProgrammer }, data: { ...data, selectedProgrammer },
}; });
await this.setData(change); this.fireChanged(fqbn);
this.fireChanged(change);
return true; return true;
} }
async selectConfigOption(params: SelectConfigOptionParams): Promise<boolean> { async selectConfigOption(
const { fqbn, optionsToUpdate } = params; {
if (!optionsToUpdate.length) { fqbn,
return false; option,
} selectedValue,
}: { fqbn: string; option: string; selectedValue: string }
const sanitizedFQBN = sanitizeFqbn(fqbn); ): Promise<boolean> {
const mutableData = deepClone(await this.getData(sanitizedFQBN)); const data = deepClone(await this.getData(fqbn));
let didChange = false; const { configOptions } = data;
for (const { option, selectedValue } of optionsToUpdate) {
const { configOptions } = mutableData;
const configOption = configOptions.find((c) => c.option === option); const configOption = configOptions.find((c) => c.option === option);
if (configOption) { if (!configOption) {
const configOptionValueIndex = configOption.values.findIndex(
(configOptionValue) => configOptionValue.value === selectedValue
);
if (configOptionValueIndex >= 0) {
// unselect all
configOption.values
.map((value) => value as Mutable<ConfigValue>)
.forEach((value) => (value.selected = false));
const mutableConfigValue: Mutable<ConfigValue> =
configOption.values[configOptionValueIndex];
// make the new value `selected`
mutableConfigValue.selected = true;
didChange = true;
}
}
}
if (!didChange) {
return false; return false;
} }
let updated = false;
const change: BoardsDataStoreChange = { for (const value of configOption.values) {
fqbn: sanitizedFQBN, if (value.value === selectedValue) {
data: mutableData, (value as any).selected = true;
}; updated = true;
await this.setData(change); } else {
this.fireChanged(change); (value as any).selected = false;
}
}
if (!updated) {
return false;
}
await this.setData({ fqbn, data });
this.fireChanged(fqbn);
return true; return true;
} }
protected async setData(change: BoardsDataStoreChange): Promise<void> { protected async setData({
const { fqbn, data } = change; fqbn,
data,
}: {
fqbn: string;
data: BoardsDataStore.Data;
}): Promise<void> {
const key = this.getStorageKey(fqbn); const key = this.getStorageKey(fqbn);
return this.storageService.setData(key, data); return this.storageService.setData(key, data);
} }
@@ -313,15 +165,11 @@ export class BoardsDataStore
return `.arduinoIDE-configOptions-${fqbn}`; return `.arduinoIDE-configOptions-${fqbn}`;
} }
async loadBoardDetails( protected async getBoardDetailsSafe(
fqbn: string, fqbn: string
forceRefresh = false
): Promise<BoardDetails | undefined> { ): Promise<BoardDetails | undefined> {
try { try {
const details = await this.boardsService.getBoardDetails({ const details = this.boardsService.getBoardDetails({ fqbn });
fqbn,
forceRefresh,
});
return details; return details;
} catch (err) { } catch (err) {
if ( if (
@@ -342,8 +190,8 @@ export class BoardsDataStore
} }
} }
protected fireChanged(...changes: BoardsDataStoreChange[]): void { protected fireChanged(...fqbn: string[]): void {
this.onDidChangeEmitter.fire({ changes }); this.onChangedEmitter.fire(fqbn);
} }
} }
@@ -352,86 +200,20 @@ export namespace BoardsDataStore {
readonly configOptions: ConfigOption[]; readonly configOptions: ConfigOption[];
readonly programmers: Programmer[]; readonly programmers: Programmer[];
readonly selectedProgrammer?: Programmer; readonly selectedProgrammer?: Programmer;
readonly defaultProgrammerId?: string;
} }
export namespace Data { export namespace Data {
export const EMPTY: Data = deepFreeze({ export const EMPTY: Data = {
configOptions: [], configOptions: [],
programmers: [], programmers: [],
});
export function is(arg: unknown): arg is Data {
return (
typeof arg === 'object' &&
arg !== null &&
Array.isArray((<Data>arg).configOptions) &&
Array.isArray((<Data>arg).programmers) &&
((<Data>arg).selectedProgrammer === undefined ||
isProgrammer((<Data>arg).selectedProgrammer)) &&
((<Data>arg).defaultProgrammerId === undefined ||
typeof (<Data>arg).defaultProgrammerId === 'string')
);
}
}
}
export function isEmptyData(data: BoardsDataStore.Data): boolean {
return (
Boolean(!data.configOptions.length) &&
Boolean(!data.programmers.length) &&
Boolean(!data.selectedProgrammer) &&
Boolean(!data.defaultProgrammerId)
);
}
export function findDefaultProgrammer(
programmers: readonly Programmer[],
defaultProgrammerId: string | undefined | BoardsDataStore.Data
): Programmer | undefined {
if (!defaultProgrammerId) {
return undefined;
}
const id =
typeof defaultProgrammerId === 'string'
? defaultProgrammerId
: defaultProgrammerId.defaultProgrammerId;
return programmers.find((p) => p.id === id);
}
function createDataStoreEntry(details: BoardDetails): BoardsDataStore.Data {
const configOptions = details.configOptions.slice();
const programmers = details.programmers.slice();
const { defaultProgrammerId } = details;
const selectedProgrammer = findDefaultProgrammer(
programmers,
defaultProgrammerId
);
const data = {
configOptions,
programmers,
...(selectedProgrammer ? { selectedProgrammer } : {}),
...(defaultProgrammerId ? { defaultProgrammerId } : {}),
}; };
return data; export function is(arg: any): arg is Data {
}
export interface BoardsDataStoreChange {
readonly fqbn: string;
readonly data: BoardsDataStore.Data;
}
function isBoardsDataStoreChange(arg: unknown): arg is BoardsDataStoreChange {
return ( return (
typeof arg === 'object' && !!arg &&
arg !== null && 'configOptions' in arg &&
typeof (<BoardsDataStoreChange>arg).fqbn === 'string' && Array.isArray(arg['configOptions']) &&
BoardsDataStore.Data.is((<BoardsDataStoreChange>arg).data) 'programmers' in arg &&
Array.isArray(arg['programmers'])
); );
} }
export interface BoardsDataStoreChangeEvent {
readonly changes: readonly BoardsDataStoreChange[];
} }
}
const USE_INHERITED_DATA: Command = {
id: 'arduino-use-inherited-boards-data',
};

View File

@@ -1,3 +1,4 @@
import { nls } from '@theia/core/lib/common';
import { import {
inject, inject,
injectable, injectable,
@@ -8,10 +9,18 @@ import {
BoardsPackage, BoardsPackage,
BoardsService, BoardsService,
} from '../../common/protocol/boards-service'; } from '../../common/protocol/boards-service';
import { ListWidget } from '../widgets/component-list/list-widget';
import { ListItemRenderer } from '../widgets/component-list/list-item-renderer'; import { ListItemRenderer } from '../widgets/component-list/list-item-renderer';
import { nls } from '@theia/core/lib/common'; import {
import { BoardsFilterRenderer } from '../widgets/component-list/filter-renderer'; ListWidget,
ListWidgetSearchOptions,
} from '../widgets/component-list/list-widget';
@injectable()
export class BoardsListWidgetSearchOptions extends ListWidgetSearchOptions<BoardSearch> {
get defaultOptions(): Required<BoardSearch> {
return { query: '', type: 'All' };
}
}
@injectable() @injectable()
export class BoardsListWidget extends ListWidget<BoardsPackage, BoardSearch> { export class BoardsListWidget extends ListWidget<BoardsPackage, BoardSearch> {
@@ -21,7 +30,8 @@ export class BoardsListWidget extends ListWidget<BoardsPackage, BoardSearch> {
constructor( constructor(
@inject(BoardsService) service: BoardsService, @inject(BoardsService) service: BoardsService,
@inject(ListItemRenderer) itemRenderer: ListItemRenderer<BoardsPackage>, @inject(ListItemRenderer) itemRenderer: ListItemRenderer<BoardsPackage>,
@inject(BoardsFilterRenderer) filterRenderer: BoardsFilterRenderer @inject(BoardsListWidgetSearchOptions)
searchOptions: BoardsListWidgetSearchOptions
) { ) {
super({ super({
id: BoardsListWidget.WIDGET_ID, id: BoardsListWidget.WIDGET_ID,
@@ -31,8 +41,7 @@ export class BoardsListWidget extends ListWidget<BoardsPackage, BoardSearch> {
installable: service, installable: service,
itemLabel: (item: BoardsPackage) => item.name, itemLabel: (item: BoardsPackage) => item.name,
itemRenderer, itemRenderer,
filterRenderer, searchOptions,
defaultSearchOptions: { query: '', type: 'All' },
}); });
} }

View File

@@ -1,21 +1,16 @@
import { TabBarToolbar } from '@theia/core/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar'; import * as React from '@theia/core/shared/react';
import { codicon } from '@theia/core/lib/browser/widgets/widget'; import * as ReactDOM from '@theia/core/shared/react-dom';
import { CommandRegistry } from '@theia/core/lib/common/command'; import { CommandRegistry } from '@theia/core/lib/common/command';
import { DisposableCollection } from '@theia/core/lib/common/disposable';
import { Port } from '../../common/protocol';
import { OpenBoardsConfig } from '../contributions/open-boards-config';
import { import {
Disposable,
DisposableCollection,
} from '@theia/core/lib/common/disposable';
import { nls } from '@theia/core/lib/common/nls';
import React from '@theia/core/shared/react';
import ReactDOM from '@theia/core/shared/react-dom';
import classNames from 'classnames';
import { boardIdentifierLabel, Port } from '../../common/protocol';
import { BoardListItemUI } from '../../common/protocol/board-list';
import { assertUnreachable } from '../../common/utils';
import type {
BoardListUI,
BoardsServiceProvider, BoardsServiceProvider,
AvailableBoard,
} from './boards-service-provider'; } from './boards-service-provider';
import { nls } from '@theia/core/lib/common';
import classNames from 'classnames';
import { BoardsConfig } from './boards-config';
export interface BoardsDropDownListCoords { export interface BoardsDropDownListCoords {
readonly top: number; readonly top: number;
@@ -27,18 +22,18 @@ export interface BoardsDropDownListCoords {
export namespace BoardsDropDown { export namespace BoardsDropDown {
export interface Props { export interface Props {
readonly coords: BoardsDropDownListCoords | 'hidden'; readonly coords: BoardsDropDownListCoords | 'hidden';
readonly boardList: BoardListUI; readonly items: Array<AvailableBoard & { onClick: () => void; port: Port }>;
readonly openBoardsConfig: () => void; readonly openBoardsConfig: () => void;
readonly hide: () => void;
} }
} }
export class BoardListDropDown extends React.Component<BoardsDropDown.Props> { export class BoardsDropDown extends React.Component<BoardsDropDown.Props> {
private dropdownElement: HTMLElement; protected dropdownElement: HTMLElement;
private listRef: React.RefObject<HTMLDivElement>; private listRef: React.RefObject<HTMLDivElement>;
constructor(props: BoardsDropDown.Props) { constructor(props: BoardsDropDown.Props) {
super(props); super(props);
this.listRef = React.createRef(); this.listRef = React.createRef();
let list = document.getElementById('boards-dropdown-container'); let list = document.getElementById('boards-dropdown-container');
if (!list) { if (!list) {
@@ -56,14 +51,11 @@ export class BoardListDropDown extends React.Component<BoardsDropDown.Props> {
} }
override render(): React.ReactNode { override render(): React.ReactNode {
return ReactDOM.createPortal( return ReactDOM.createPortal(this.renderNode(), this.dropdownElement);
this.renderBoardListItems(),
this.dropdownElement
);
} }
private renderBoardListItems(): React.ReactNode { protected renderNode(): React.ReactNode {
const { coords, boardList } = this.props; const { coords, items } = this.props;
if (coords === 'hidden') { if (coords === 'hidden') {
return ''; return '';
} }
@@ -82,12 +74,14 @@ export class BoardListDropDown extends React.Component<BoardsDropDown.Props> {
tabIndex={0} tabIndex={0}
> >
<div className="arduino-boards-dropdown-list--items-container"> <div className="arduino-boards-dropdown-list--items-container">
{boardList.items.map((item, index) => {items
this.renderBoardListItem({ .map(({ name, port, selected, onClick }) => ({
item, boardLabel: name,
selected: index === boardList.selectedIndex, port,
}) selected,
)} onClick,
}))
.map(this.renderItem)}
</div> </div>
<div <div
key={footerLabel} key={footerLabel}
@@ -101,43 +95,31 @@ export class BoardListDropDown extends React.Component<BoardsDropDown.Props> {
); );
} }
private readonly onDefaultAction = (item: BoardListItemUI): unknown => { protected renderItem({
const { boardList, hide } = this.props; boardLabel,
const { type, params } = item.defaultAction; port,
hide(); selected,
switch (type) { onClick,
case 'select-boards-config': { }: {
return boardList.select(params); boardLabel: string;
} port: Port;
case 'edit-boards-config': { selected?: boolean;
return boardList.edit(params); onClick: () => void;
} }): React.ReactNode {
default: const protocolIcon = iconNameFromProtocol(port.protocol);
return assertUnreachable(type); const onKeyUp = (e: React.KeyboardEvent) => {
if (e.key === 'Enter') {
onClick();
} }
}; };
private renderBoardListItem({
item,
selected,
}: {
item: BoardListItemUI;
selected: boolean;
}): React.ReactNode {
const { boardLabel, portLabel, portProtocol, tooltip } = item.labels;
const port = item.port;
const onKeyUp = (e: React.KeyboardEvent) => {
if (e.key === 'Enter') {
this.onDefaultAction(item);
}
};
return ( return (
<div <div
key={`board-item--${Port.keyOf(port)}`} key={`board-item--${boardLabel}-${port.address}`}
className={classNames('arduino-boards-dropdown-item', { className={classNames('arduino-boards-dropdown-item', {
'arduino-boards-dropdown-item--selected': selected, 'arduino-boards-dropdown-item--selected': selected,
})} })}
onClick={() => this.onDefaultAction(item)} onClick={onClick}
onKeyUp={onKeyUp} onKeyUp={onKeyUp}
tabIndex={0} tabIndex={0}
> >
@@ -145,81 +127,21 @@ export class BoardListDropDown extends React.Component<BoardsDropDown.Props> {
className={classNames( className={classNames(
'arduino-boards-dropdown-item--protocol', 'arduino-boards-dropdown-item--protocol',
'fa', 'fa',
iconNameFromProtocol(portProtocol) protocolIcon
)} )}
/> />
<div className="arduino-boards-dropdown-item--label" title={tooltip}> <div
<div className="arduino-boards-dropdown-item--board-header"> className="arduino-boards-dropdown-item--label"
title={`${boardLabel}\n${port.address}`}
>
<div className="arduino-boards-dropdown-item--board-label noWrapInfo noselect"> <div className="arduino-boards-dropdown-item--board-label noWrapInfo noselect">
{boardLabel} {boardLabel}
</div> </div>
</div>
<div className="arduino-boards-dropdown-item--port-label noWrapInfo noselect"> <div className="arduino-boards-dropdown-item--port-label noWrapInfo noselect">
{portLabel} {port.addressLabel}
</div> </div>
</div> </div>
{this.renderActions(item)} {selected ? <div className="fa fa-check" /> : ''}
</div>
);
}
private renderActions(item: BoardListItemUI): React.ReactNode {
const { boardList, hide } = this.props;
const { revert, edit } = item.otherActions;
if (!edit && !revert) {
return undefined;
}
const handleOnClick = (
event: React.MouseEvent<HTMLElement, MouseEvent>,
callback: () => void
) => {
event.preventDefault();
event.stopPropagation();
hide();
callback();
};
return (
<div className={TabBarToolbar.Styles.TAB_BAR_TOOLBAR}>
{edit && (
<div
className={`${TabBarToolbar.Styles.TAB_BAR_TOOLBAR_ITEM} enabled`}
>
{
<div
id="edit"
className={codicon('pencil', true)}
title={nls.localize(
'arduino/board/editBoardsConfig',
'Edit Board and Port...'
)}
onClick={(event) =>
handleOnClick(event, () => boardList.edit(edit.params))
}
/>
}
</div>
)}
{revert && (
<div
className={`${TabBarToolbar.Styles.TAB_BAR_TOOLBAR_ITEM} enabled`}
>
{
<div
id="revert"
className={codicon('discard', true)}
title={nls.localize(
'arduino/board/revertBoardsConfig',
"Use '{0}' discovered on '{1}'",
boardIdentifierLabel(revert.params.selectedBoard),
item.labels.portLabel
)}
onClick={(event) =>
handleOnClick(event, () => boardList.select(revert.params))
}
/>
}
</div>
)}
</div> </div>
); );
} }
@@ -231,27 +153,26 @@ export class BoardsToolBarItem extends React.Component<
> { > {
static TOOLBAR_ID: 'boards-toolbar'; static TOOLBAR_ID: 'boards-toolbar';
private readonly toDispose: DisposableCollection; protected readonly toDispose: DisposableCollection =
new DisposableCollection();
constructor(props: BoardsToolBarItem.Props) { constructor(props: BoardsToolBarItem.Props) {
super(props); super(props);
const { boardList } = props.boardsServiceProvider;
const { availableBoards } = props.boardsServiceProvider;
this.state = { this.state = {
boardList, availableBoards,
coords: 'hidden', coords: 'hidden',
}; };
const listener = () => this.setState({ coords: 'hidden' });
document.addEventListener('click', listener); document.addEventListener('click', () => {
this.toDispose = new DisposableCollection( this.setState({ coords: 'hidden' });
Disposable.create(() => document.removeEventListener('click', listener)) });
);
} }
override componentDidMount(): void { override componentDidMount(): void {
this.toDispose.push( this.props.boardsServiceProvider.onAvailableBoardsChanged(
this.props.boardsServiceProvider.onBoardListDidChange((boardList) => (availableBoards) => this.setState({ availableBoards })
this.setState({ boardList })
)
); );
} }
@@ -259,7 +180,7 @@ export class BoardsToolBarItem extends React.Component<
this.toDispose.dispose(); this.toDispose.dispose();
} }
private readonly show = (event: React.MouseEvent<HTMLElement>): void => { protected readonly show = (event: React.MouseEvent<HTMLElement>): void => {
const { currentTarget: element } = event; const { currentTarget: element } = event;
if (element instanceof HTMLElement) { if (element instanceof HTMLElement) {
if (this.state.coords === 'hidden') { if (this.state.coords === 'hidden') {
@@ -280,26 +201,31 @@ export class BoardsToolBarItem extends React.Component<
event.nativeEvent.stopImmediatePropagation(); event.nativeEvent.stopImmediatePropagation();
}; };
private readonly hide = () => {
this.setState({ coords: 'hidden' });
};
override render(): React.ReactNode { override render(): React.ReactNode {
const { coords, boardList } = this.state; const { coords, availableBoards } = this.state;
const { boardLabel, selected, portProtocol, tooltip } = boardList.labels; const { selectedBoard, selectedPort } =
const protocolIcon = portProtocol this.props.boardsServiceProvider.boardsConfig;
? iconNameFromProtocol(portProtocol)
const boardLabel =
selectedBoard?.name ||
nls.localize('arduino/board/selectBoard', 'Select Board');
const selectedPortLabel = portLabel(selectedPort?.address);
const isConnected = Boolean(selectedBoard && selectedPort);
const protocolIcon = isConnected
? iconNameFromProtocol(selectedPort?.protocol || '')
: null; : null;
const protocolIconClassNames = classNames( const protocolIconClassNames = classNames(
'arduino-boards-toolbar-item--protocol', 'arduino-boards-toolbar-item--protocol',
'fa', 'fa',
protocolIcon protocolIcon
); );
return ( return (
<React.Fragment> <React.Fragment>
<div <div
className="arduino-boards-toolbar-item-container" className="arduino-boards-toolbar-item-container"
title={tooltip} title={selectedPortLabel}
onClick={this.show} onClick={this.show}
> >
{protocolIcon && <div className={protocolIconClassNames} />} {protocolIcon && <div className={protocolIconClassNames} />}
@@ -308,22 +234,57 @@ export class BoardsToolBarItem extends React.Component<
'arduino-boards-toolbar-item--label', 'arduino-boards-toolbar-item--label',
'noWrapInfo', 'noWrapInfo',
'noselect', 'noselect',
{ 'arduino-boards-toolbar-item--label-connected': selected } { 'arduino-boards-toolbar-item--label-connected': isConnected }
)} )}
> >
{boardLabel} {boardLabel}
</div> </div>
<div className="fa fa-caret-down caret" /> <div className="fa fa-caret-down caret" />
</div> </div>
<BoardListDropDown <BoardsDropDown
coords={coords} coords={coords}
boardList={boardList} items={availableBoards
openBoardsConfig={() => boardList.edit({ query: '' })} .filter(AvailableBoard.hasPort)
hide={this.hide} .map((board) => ({
/> ...board,
onClick: () => {
if (!board.fqbn) {
const previousBoardConfig =
this.props.boardsServiceProvider.boardsConfig;
this.props.boardsServiceProvider.boardsConfig = {
selectedPort: board.port,
};
this.openDialog(previousBoardConfig);
} else {
this.props.boardsServiceProvider.boardsConfig = {
selectedBoard: board,
selectedPort: board.port,
};
}
this.setState({ coords: 'hidden' });
},
}))}
openBoardsConfig={this.openDialog}
></BoardsDropDown>
</React.Fragment> </React.Fragment>
); );
} }
protected openDialog = async (
previousBoardConfig?: BoardsConfig.Config
): Promise<void> => {
const selectedBoardConfig =
await this.props.commands.executeCommand<BoardsConfig.Config>(
OpenBoardsConfig.Commands.OPEN_DIALOG.id
);
if (
previousBoardConfig &&
(!selectedBoardConfig?.selectedPort ||
!selectedBoardConfig?.selectedBoard)
) {
this.props.boardsServiceProvider.boardsConfig = previousBoardConfig;
}
};
} }
export namespace BoardsToolBarItem { export namespace BoardsToolBarItem {
export interface Props { export interface Props {
@@ -332,7 +293,7 @@ export namespace BoardsToolBarItem {
} }
export interface State { export interface State {
boardList: BoardListUI; availableBoards: AvailableBoard[];
coords: BoardsDropDownListCoords | 'hidden'; coords: BoardsDropDownListCoords | 'hidden';
} }
} }
@@ -343,10 +304,19 @@ function iconNameFromProtocol(protocol: string): string {
return 'fa-arduino-technology-usb'; return 'fa-arduino-technology-usb';
case 'network': case 'network':
return 'fa-arduino-technology-connection'; return 'fa-arduino-technology-connection';
// it is fine to assign dedicated icons to the protocols used by the official boards, /*
// but other than that it is best to avoid implementing any special handling Bluetooth ports are not listed yet from the CLI;
// for specific protocols in the IDE codebase. Not sure about the naming ('bluetooth'); make sure it's correct before uncommenting the following lines
*/
// case 'bluetooth':
// return 'fa-arduino-technology-bluetooth';
default: default:
return 'fa-arduino-technology-3dimensionscube'; return 'fa-arduino-technology-3dimensionscube';
} }
} }
function portLabel(portName?: string): string {
return portName
? nls.localize('arduino/board/portLabel', 'Port: {0}', portName)
: nls.localize('arduino/board/disconnected', 'Disconnected');
}

View File

@@ -1,17 +1,28 @@
import { injectable } from '@theia/core/shared/inversify'; import { MenuPath } from '@theia/core';
import { Command } from '@theia/core/lib/common/command';
import { nls } from '@theia/core/lib/common/nls';
import { inject, injectable } from '@theia/core/shared/inversify';
import { Type as TypeLabel } from '../../common/nls';
import { import {
BoardSearch, BoardSearch,
BoardsPackage, BoardsPackage,
} from '../../common/protocol/boards-service'; } from '../../common/protocol/boards-service';
import { URI } from '../contributions/contribution'; import { URI } from '../contributions/contribution';
import { MenuActionTemplate, SubmenuTemplate } from '../menu/register-menu';
import { ListWidgetFrontendContribution } from '../widgets/component-list/list-widget-frontend-contribution'; import { ListWidgetFrontendContribution } from '../widgets/component-list/list-widget-frontend-contribution';
import { BoardsListWidget } from './boards-list-widget'; import {
BoardsListWidget,
BoardsListWidgetSearchOptions,
} from './boards-list-widget';
@injectable() @injectable()
export class BoardsListWidgetFrontendContribution extends ListWidgetFrontendContribution< export class BoardsListWidgetFrontendContribution extends ListWidgetFrontendContribution<
BoardsPackage, BoardsPackage,
BoardSearch BoardSearch
> { > {
@inject(BoardsListWidgetSearchOptions)
protected readonly searchOptions: BoardsListWidgetSearchOptions;
constructor() { constructor() {
super({ super({
widgetId: BoardsListWidget.WIDGET_ID, widgetId: BoardsListWidget.WIDGET_ID,
@@ -37,4 +48,51 @@ export class BoardsListWidgetFrontendContribution extends ListWidgetFrontendCont
protected parse(uri: URI): BoardSearch | undefined { protected parse(uri: URI): BoardSearch | undefined {
return BoardSearch.UriParser.parse(uri); return BoardSearch.UriParser.parse(uri);
} }
protected buildFilterMenuGroup(
menuPath: MenuPath
): Array<MenuActionTemplate | SubmenuTemplate> {
const typeSubmenuPath = [...menuPath, TypeLabel];
return [
{
submenuPath: typeSubmenuPath,
menuLabel: `${TypeLabel}: "${
BoardSearch.TypeLabels[this.searchOptions.options.type]
}"`,
options: { order: String(0) },
},
...this.buildMenuActions<BoardSearch.Type>(
typeSubmenuPath,
BoardSearch.TypeLiterals.slice(),
(type) => this.searchOptions.options.type === type,
(type) => this.searchOptions.update({ type }),
(type) => BoardSearch.TypeLabels[type]
),
];
}
protected get showViewFilterContextMenuCommand(): Command & {
label: string;
} {
return BoardsListWidgetFrontendContribution.Commands
.SHOW_BOARDS_LIST_WIDGET_FILTER_CONTEXT_MENU;
}
protected get showInstalledCommandId(): string {
return 'arduino-show-installed-boards';
}
protected get showUpdatesCommandId(): string {
return 'arduino-show-boards-updates';
}
}
export namespace BoardsListWidgetFrontendContribution {
export namespace Commands {
export const SHOW_BOARDS_LIST_WIDGET_FILTER_CONTEXT_MENU: Command & {
label: string;
} = {
id: 'arduino-boards-list-widget-show-filter-context-menu',
label: nls.localize('arduino/boards/filterBoards', 'Filter Boards...'),
};
}
} }

View File

@@ -1,4 +1,4 @@
import React from '@theia/core/shared/react'; import * as React from '@theia/core/shared/react';
export type ProgressBarProps = { export type ProgressBarProps = {
percent?: number; percent?: number;

View File

@@ -1,24 +1,26 @@
import { inject, injectable } from '@theia/core/shared/inversify';
import * as moment from 'moment';
import * as remote from '@theia/core/electron-shared/@electron/remote';
import { isOSX, isWindows } from '@theia/core/lib/common/os';
import { ClipboardService } from '@theia/core/lib/browser/clipboard-service'; import { ClipboardService } from '@theia/core/lib/browser/clipboard-service';
import { FrontendApplicationConfigProvider } from '@theia/core/lib/browser/frontend-application-config-provider'; import { FrontendApplicationConfigProvider } from '@theia/core/lib/browser/frontend-application-config-provider';
import { nls } from '@theia/core/lib/common/nls';
import { isOSX, isWindows } from '@theia/core/lib/common/os';
import { inject, injectable } from '@theia/core/shared/inversify';
import moment from 'moment';
import { AppService } from '../app-service';
import { ArduinoMenus } from '../menu/arduino-menus';
import { import {
Command,
CommandRegistry,
Contribution, Contribution,
Command,
MenuModelRegistry, MenuModelRegistry,
CommandRegistry,
} from './contribution'; } from './contribution';
import { ArduinoMenus } from '../menu/arduino-menus';
import { ConfigService } from '../../common/protocol';
import { nls } from '@theia/core/lib/common';
@injectable() @injectable()
export class About extends Contribution { export class About extends Contribution {
@inject(ClipboardService) @inject(ClipboardService)
private readonly clipboardService: ClipboardService; protected readonly clipboardService: ClipboardService;
@inject(AppService)
private readonly appService: AppService; @inject(ConfigService)
protected readonly configService: ConfigService;
override registerCommands(registry: CommandRegistry): void { override registerCommands(registry: CommandRegistry): void {
registry.registerCommand(About.Commands.ABOUT_APP, { registry.registerCommand(About.Commands.ABOUT_APP, {
@@ -38,18 +40,17 @@ export class About extends Contribution {
}); });
} }
private async showAbout(): Promise<void> { async showAbout(): Promise<void> {
const appInfo = await this.appService.info(); const version = await this.configService.getVersion();
const { appVersion, cliVersion, buildDate } = appInfo; const buildDate = this.buildDate;
const detail = (showAll: boolean) => const detail = (showAll: boolean) =>
nls.localize( nls.localize(
'arduino/about/detail', 'arduino/about/detail',
'Version: {0}\nDate: {1}{2}\nCLI Version: {3}\n\n{4}', 'Version: {0}\nDate: {1}{2}\nCLI Version: {3}\n\n{4}',
appVersion, remote.app.getVersion(),
buildDate ? buildDate : nls.localize('', 'dev build'), buildDate ? buildDate : nls.localize('', 'dev build'),
buildDate && showAll ? ` (${this.ago(buildDate)})` : '', buildDate && showAll ? ` (${this.ago(buildDate)})` : '',
cliVersion, version,
nls.localize( nls.localize(
'arduino/about/copyright', 'arduino/about/copyright',
'Copyright © {0} Arduino SA', 'Copyright © {0} Arduino SA',
@@ -59,7 +60,9 @@ export class About extends Contribution {
const ok = nls.localize('vscode/issueMainService/ok', 'OK'); const ok = nls.localize('vscode/issueMainService/ok', 'OK');
const copy = nls.localize('vscode/textInputActions/copy', 'Copy'); const copy = nls.localize('vscode/textInputActions/copy', 'Copy');
const buttons = !isWindows && !isOSX ? [copy, ok] : [ok, copy]; const buttons = !isWindows && !isOSX ? [copy, ok] : [ok, copy];
const { response } = await this.dialogService.showMessageBox({ const { response } = await remote.dialog.showMessageBox(
remote.getCurrentWindow(),
{
message: `${this.applicationName}`, message: `${this.applicationName}`,
title: `${this.applicationName}`, title: `${this.applicationName}`,
type: 'info', type: 'info',
@@ -68,18 +71,23 @@ export class About extends Contribution {
noLink: true, noLink: true,
defaultId: buttons.indexOf(ok), defaultId: buttons.indexOf(ok),
cancelId: buttons.indexOf(ok), cancelId: buttons.indexOf(ok),
}); }
);
if (buttons[response] === copy) { if (buttons[response] === copy) {
await this.clipboardService.writeText(detail(false).trim()); await this.clipboardService.writeText(detail(false).trim());
} }
} }
private get applicationName(): string { protected get applicationName(): string {
return FrontendApplicationConfigProvider.get().applicationName; return FrontendApplicationConfigProvider.get().applicationName;
} }
private ago(isoTime: string): string { protected get buildDate(): string | undefined {
return FrontendApplicationConfigProvider.get().buildDate;
}
protected ago(isoTime: string): string {
const now = moment(Date.now()); const now = moment(Date.now());
const other = moment(isoTime); const other = moment(isoTime);
let result = now.diff(other, 'minute'); let result = now.diff(other, 'minute');

View File

@@ -1,21 +1,22 @@
import { nls } from '@theia/core/lib/common/nls';
import { inject, injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import { FileDialogService } from '@theia/filesystem/lib/browser'; import * as remote from '@theia/core/electron-shared/@electron/remote';
import { ArduinoMenus } from '../menu/arduino-menus'; import { ArduinoMenus } from '../menu/arduino-menus';
import { CurrentSketch } from '../sketches-service-client-impl';
import { import {
SketchContribution,
Command, Command,
CommandRegistry, CommandRegistry,
MenuModelRegistry, MenuModelRegistry,
Sketch,
SketchContribution,
URI, URI,
Sketch,
} from './contribution'; } from './contribution';
import { FileDialogService } from '@theia/filesystem/lib/browser';
import { nls } from '@theia/core/lib/common';
import { CurrentSketch } from '../sketches-service-client-impl';
@injectable() @injectable()
export class AddFile extends SketchContribution { export class AddFile extends SketchContribution {
@inject(FileDialogService) @inject(FileDialogService)
private readonly fileDialogService: FileDialogService; // TODO: use dialogService private readonly fileDialogService: FileDialogService;
override registerCommands(registry: CommandRegistry): void { override registerCommands(registry: CommandRegistry): void {
registry.registerCommand(AddFile.Commands.ADD_FILE, { registry.registerCommand(AddFile.Commands.ADD_FILE, {
@@ -49,7 +50,7 @@ export class AddFile extends SketchContribution {
const { uri: targetUri, filename } = this.resolveTarget(sketch, toAddUri); const { uri: targetUri, filename } = this.resolveTarget(sketch, toAddUri);
const exists = await this.fileService.exists(targetUri); const exists = await this.fileService.exists(targetUri);
if (exists) { if (exists) {
const { response } = await this.dialogService.showMessageBox({ const { response } = await remote.dialog.showMessageBox({
type: 'question', type: 'question',
title: nls.localize('arduino/contributions/replaceTitle', 'Replace'), title: nls.localize('arduino/contributions/replaceTitle', 'Replace'),
buttons: [ buttons: [

View File

@@ -1,4 +1,5 @@
import { inject, injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import * as remote from '@theia/core/electron-shared/@electron/remote';
import URI from '@theia/core/lib/common/uri'; import URI from '@theia/core/lib/common/uri';
import { ConfirmDialog } from '@theia/core/lib/browser/dialogs'; import { ConfirmDialog } from '@theia/core/lib/browser/dialogs';
import { ArduinoMenus } from '../menu/arduino-menus'; import { ArduinoMenus } from '../menu/arduino-menus';
@@ -41,7 +42,9 @@ export class AddZipLibrary extends SketchContribution {
private async addZipLibrary(): Promise<void> { private async addZipLibrary(): Promise<void> {
const homeUri = await this.envVariableServer.getHomeDirUri(); const homeUri = await this.envVariableServer.getHomeDirUri();
const defaultPath = await this.fileService.fsPath(new URI(homeUri)); const defaultPath = await this.fileService.fsPath(new URI(homeUri));
const { canceled, filePaths } = await this.dialogService.showOpenDialog({ const { canceled, filePaths } = await remote.dialog.showOpenDialog(
remote.getCurrentWindow(),
{
title: nls.localize( title: nls.localize(
'arduino/selectZip', 'arduino/selectZip',
"Select a zip file containing the library you'd like to add" "Select a zip file containing the library you'd like to add"
@@ -54,7 +57,8 @@ export class AddZipLibrary extends SketchContribution {
extensions: ['zip'], extensions: ['zip'],
}, },
], ],
}); }
);
if (!canceled && filePaths.length) { if (!canceled && filePaths.length) {
const zipUri = await this.fileSystemExt.getUri(filePaths[0]); const zipUri = await this.fileSystemExt.getUri(filePaths[0]);
try { try {

View File

@@ -1,5 +1,6 @@
import { injectable } from '@theia/core/shared/inversify'; import { injectable } from '@theia/core/shared/inversify';
import dateFormat from 'dateformat'; import * as remote from '@theia/core/electron-shared/@electron/remote';
import * as dateFormat from 'dateformat';
import { ArduinoMenus } from '../menu/arduino-menus'; import { ArduinoMenus } from '../menu/arduino-menus';
import { import {
SketchContribution, SketchContribution,
@@ -38,13 +39,16 @@ export class ArchiveSketch extends SketchContribution {
const defaultContainerUri = await this.defaultUri(); const defaultContainerUri = await this.defaultUri();
const defaultUri = defaultContainerUri.resolve(archiveBasename); const defaultUri = defaultContainerUri.resolve(archiveBasename);
const defaultPath = await this.fileService.fsPath(defaultUri); const defaultPath = await this.fileService.fsPath(defaultUri);
const { filePath, canceled } = await this.dialogService.showSaveDialog({ const { filePath, canceled } = await remote.dialog.showSaveDialog(
remote.getCurrentWindow(),
{
title: nls.localize( title: nls.localize(
'arduino/sketch/saveSketchAs', 'arduino/sketch/saveSketchAs',
'Save sketch folder as...' 'Save sketch folder as...'
), ),
defaultPath, defaultPath,
}); }
);
if (!filePath || canceled) { if (!filePath || canceled) {
return; return;
} }

View File

@@ -1,123 +0,0 @@
import type { MaybePromise } from '@theia/core/lib/common/types';
import { inject, injectable } from '@theia/core/shared/inversify';
import {
BoardDetails,
Programmer,
isBoardIdentifierChangeEvent,
} from '../../common/protocol';
import {
BoardsDataStore,
findDefaultProgrammer,
isEmptyData,
} from '../boards/boards-data-store';
import { BoardsServiceProvider } from '../boards/boards-service-provider';
import { Contribution } from './contribution';
/**
* Before CLI 0.35.0-rc.3, there was no `programmer#default` property in the `board details` response.
* This method does the programmer migration in the data store. If there is a programmer selected, it's a noop.
* If no programmer is selected, it forcefully reloads the details from the CLI and updates it in the local storage.
*/
@injectable()
export class AutoSelectProgrammer extends Contribution {
@inject(BoardsServiceProvider)
private readonly boardsServiceProvider: BoardsServiceProvider;
@inject(BoardsDataStore)
private readonly boardsDataStore: BoardsDataStore;
override onStart(): void {
this.boardsServiceProvider.onBoardsConfigDidChange((event) => {
if (isBoardIdentifierChangeEvent(event)) {
this.ensureProgrammerIsSelected();
}
});
}
override onReady(): void {
this.boardsServiceProvider.ready.then(() =>
this.ensureProgrammerIsSelected()
);
}
private async ensureProgrammerIsSelected(): Promise<boolean> {
return ensureProgrammerIsSelected({
fqbn: this.boardsServiceProvider.boardsConfig.selectedBoard?.fqbn,
getData: (fqbn) => this.boardsDataStore.getData(fqbn),
loadBoardDetails: (fqbn) => this.boardsDataStore.loadBoardDetails(fqbn),
selectProgrammer: (arg) => this.boardsDataStore.selectProgrammer(arg),
});
}
}
interface EnsureProgrammerIsSelectedParams {
fqbn: string | undefined;
getData: (fqbn: string | undefined) => MaybePromise<BoardsDataStore.Data>;
loadBoardDetails: (fqbn: string) => MaybePromise<BoardDetails | undefined>;
selectProgrammer(options: {
fqbn: string;
selectedProgrammer: Programmer;
}): MaybePromise<boolean>;
}
export async function ensureProgrammerIsSelected(
params: EnsureProgrammerIsSelectedParams
): Promise<boolean> {
const { fqbn, getData, loadBoardDetails, selectProgrammer } = params;
if (!fqbn) {
return false;
}
console.debug(`Ensuring a programmer is selected for ${fqbn}...`);
const data = await getData(fqbn);
if (isEmptyData(data)) {
// For example, the platform is not installed.
console.debug(`Skipping. No boards data is available for ${fqbn}.`);
return false;
}
if (data.selectedProgrammer) {
console.debug(
`A programmer is already selected for ${fqbn}: '${data.selectedProgrammer.id}'.`
);
return true;
}
let programmer = findDefaultProgrammer(data.programmers, data);
if (programmer) {
// select the programmer if the default info is available
const result = await selectProgrammer({
fqbn,
selectedProgrammer: programmer,
});
if (result) {
console.debug(`Selected '${programmer.id}' programmer for ${fqbn}.`);
return result;
}
}
console.debug(`Reloading board details for ${fqbn}...`);
const reloadedData = await loadBoardDetails(fqbn);
if (!reloadedData) {
console.debug(`Skipping. No board details found for ${fqbn}.`);
return false;
}
if (!reloadedData.programmers.length) {
console.debug(`Skipping. ${fqbn} does not have programmers.`);
return false;
}
programmer = findDefaultProgrammer(reloadedData.programmers, reloadedData);
if (!programmer) {
console.debug(
`Skipping. Could not find a default programmer for ${fqbn}. Programmers were: `
);
return false;
}
const result = await selectProgrammer({
fqbn,
selectedProgrammer: programmer,
});
if (result) {
console.debug(`Selected '${programmer.id}' programmer for ${fqbn}.`);
} else {
console.debug(
`Could not select '${programmer.id}' programmer for ${fqbn}.`
);
}
return result;
}

View File

@@ -1,61 +1,58 @@
import {
Disposable,
DisposableCollection,
} from '@theia/core/lib/common/disposable';
import { MenuModelRegistry } from '@theia/core/lib/common/menu/menu-model-registry';
import type { MenuPath } from '@theia/core/lib/common/menu/menu-types';
import { nls } from '@theia/core/lib/common/nls';
import { Deferred } from '@theia/core/lib/common/promise-util';
import { inject, injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import { MainMenuManager } from '../../common/main-menu-manager'; import * as remote from '@theia/core/electron-shared/@electron/remote';
import { MenuModelRegistry } from '@theia/core/lib/common/menu';
import { import {
BoardsService, DisposableCollection,
BoardWithPackage, Disposable,
createPlatformIdentifier, } from '@theia/core/lib/common/disposable';
getBoardInfo, import { BoardsConfig } from '../boards/boards-config';
InstalledBoardWithPackage, import { MainMenuManager } from '../../common/main-menu-manager';
platformIdentifierEquals,
Port,
serializePlatformIdentifier,
} from '../../common/protocol';
import type { BoardList } from '../../common/protocol/board-list';
import { BoardsListWidget } from '../boards/boards-list-widget'; import { BoardsListWidget } from '../boards/boards-list-widget';
import { BoardsDataStore } from '../boards/boards-data-store'; import { NotificationCenter } from '../notification-center';
import { BoardsServiceProvider } from '../boards/boards-service-provider'; import { BoardsServiceProvider } from '../boards/boards-service-provider';
import { import {
ArduinoMenus, ArduinoMenus,
PlaceholderMenuNode, PlaceholderMenuNode,
unregisterSubmenu, unregisterSubmenu,
} from '../menu/arduino-menus'; } from '../menu/arduino-menus';
import { NotificationCenter } from '../notification-center'; import {
import { Command, CommandRegistry, SketchContribution } from './contribution'; BoardsService,
InstalledBoardWithPackage,
AvailablePorts,
Port,
getBoardInfo,
} from '../../common/protocol';
import { SketchContribution, Command, CommandRegistry } from './contribution';
import { nls } from '@theia/core/lib/common';
@injectable() @injectable()
export class BoardSelection extends SketchContribution { export class BoardSelection extends SketchContribution {
@inject(CommandRegistry) @inject(CommandRegistry)
private readonly commandRegistry: CommandRegistry; protected readonly commandRegistry: CommandRegistry;
@inject(MainMenuManager)
private readonly mainMenuManager: MainMenuManager;
@inject(MenuModelRegistry)
private readonly menuModelRegistry: MenuModelRegistry;
@inject(NotificationCenter)
private readonly notificationCenter: NotificationCenter;
@inject(BoardsDataStore)
private readonly boardsDataStore: BoardsDataStore;
@inject(BoardsService)
private readonly boardsService: BoardsService;
@inject(BoardsServiceProvider)
private readonly boardsServiceProvider: BoardsServiceProvider;
private readonly toDisposeBeforeMenuRebuild = new DisposableCollection(); @inject(MainMenuManager)
// do not query installed platforms on every change protected readonly mainMenuManager: MainMenuManager;
private _installedBoards: Deferred<InstalledBoardWithPackage[]> | undefined;
@inject(MenuModelRegistry)
protected readonly menuModelRegistry: MenuModelRegistry;
@inject(NotificationCenter)
protected readonly notificationCenter: NotificationCenter;
@inject(BoardsService)
protected readonly boardsService: BoardsService;
@inject(BoardsServiceProvider)
protected readonly boardsServiceProvider: BoardsServiceProvider;
protected readonly toDisposeBeforeMenuRebuild = new DisposableCollection();
override registerCommands(registry: CommandRegistry): void { override registerCommands(registry: CommandRegistry): void {
registry.registerCommand(BoardSelection.Commands.GET_BOARD_INFO, { registry.registerCommand(BoardSelection.Commands.GET_BOARD_INFO, {
execute: async () => { execute: async () => {
const boardInfo = await getBoardInfo( const boardInfo = await getBoardInfo(
this.boardsServiceProvider.boardList this.boardsServiceProvider.boardsConfig.selectedPort,
this.boardsService.getState()
); );
if (typeof boardInfo === 'string') { if (typeof boardInfo === 'string') {
this.messageService.info(boardInfo); this.messageService.info(boardInfo);
@@ -68,7 +65,7 @@ VID: ${VID}
PID: ${PID} PID: ${PID}
SN: ${SN} SN: ${SN}
`.trim(); `.trim();
await this.dialogService.showMessageBox({ await remote.dialog.showMessageBox(remote.getCurrentWindow(), {
message: nls.localize('arduino/board/boardInfo', 'Board Info'), message: nls.localize('arduino/board/boardInfo', 'Board Info'),
title: nls.localize('arduino/board/boardInfo', 'Board Info'), title: nls.localize('arduino/board/boardInfo', 'Board Info'),
type: 'info', type: 'info',
@@ -77,61 +74,37 @@ SN: ${SN}
}); });
}, },
}); });
registry.registerCommand(BoardSelection.Commands.RELOAD_BOARD_DATA, {
execute: async () => {
const selectedFqbn =
this.boardsServiceProvider.boardList.boardsConfig.selectedBoard?.fqbn;
let message: string;
if (selectedFqbn) {
await this.boardsDataStore.reloadBoardData(selectedFqbn);
message = nls.localize(
'arduino/board/boardDataReloaded',
'Board data reloaded.'
);
} else {
message = nls.localize(
'arduino/board/selectBoardToReload',
'Please select a board first.'
);
}
this.messageService.info(message, { timeout: 2000 });
},
});
} }
override onStart(): void { override onStart(): void {
this.notificationCenter.onPlatformDidInstall(() => this.updateMenus(true)); this.notificationCenter.onPlatformDidInstall(() => this.updateMenus());
this.notificationCenter.onPlatformDidUninstall(() => this.notificationCenter.onPlatformDidUninstall(() => this.updateMenus());
this.updateMenus(true) this.boardsServiceProvider.onBoardsConfigChanged(() => this.updateMenus());
this.boardsServiceProvider.onAvailableBoardsChanged(() =>
this.updateMenus()
);
this.boardsServiceProvider.onAvailablePortsChanged(() =>
this.updateMenus()
); );
this.boardsServiceProvider.onBoardListDidChange(() => this.updateMenus());
} }
override async onReady(): Promise<void> { override async onReady(): Promise<void> {
this.updateMenus(); this.updateMenus();
} }
private async updateMenus(discardCache = false): Promise<void> { protected async updateMenus(): Promise<void> {
if (discardCache) { const [installedBoards, availablePorts, config] = await Promise.all([
this._installedBoards?.reject(); this.installedBoards(),
this._installedBoards = undefined; this.boardsService.getState(),
} this.boardsServiceProvider.boardsConfig,
if (!this._installedBoards) { ]);
this._installedBoards = new Deferred(); this.rebuildMenus(installedBoards, availablePorts, config);
this.installedBoards().then((installedBoards) =>
this._installedBoards?.resolve(installedBoards)
);
}
const installedBoards = await this._installedBoards.promise;
this.rebuildMenus(installedBoards, this.boardsServiceProvider.boardList);
} }
private rebuildMenus( protected rebuildMenus(
installedBoards: InstalledBoardWithPackage[], installedBoards: InstalledBoardWithPackage[],
boardList: BoardList availablePorts: AvailablePorts,
config: BoardsConfig.Config
): void { ): void {
this.toDisposeBeforeMenuRebuild.dispose(); this.toDisposeBeforeMenuRebuild.dispose();
@@ -140,8 +113,7 @@ SN: ${SN}
...ArduinoMenus.TOOLS__BOARD_SELECTION_GROUP, ...ArduinoMenus.TOOLS__BOARD_SELECTION_GROUP,
'1_boards', '1_boards',
]; ];
const { selectedBoard, selectedPort } = boardList.boardsConfig; const boardsSubmenuLabel = config.selectedBoard?.name;
const boardsSubmenuLabel = selectedBoard?.name;
// Note: The submenu order starts from `100` because `Auto Format`, `Serial Monitor`, etc starts from `0` index. // Note: The submenu order starts from `100` because `Auto Format`, `Serial Monitor`, etc starts from `0` index.
// The board specific items, and the rest, have order with `z`. We needed something between `0` and `z` with natural-order. // The board specific items, and the rest, have order with `z`. We needed something between `0` and `z` with natural-order.
this.menuModelRegistry.registerSubmenu( this.menuModelRegistry.registerSubmenu(
@@ -161,7 +133,7 @@ SN: ${SN}
// Ports submenu // Ports submenu
const portsSubmenuPath = ArduinoMenus.TOOLS__PORTS_SUBMENU; const portsSubmenuPath = ArduinoMenus.TOOLS__PORTS_SUBMENU;
const portsSubmenuLabel = selectedPort?.address; const portsSubmenuLabel = config.selectedPort?.address;
this.menuModelRegistry.registerSubmenu( this.menuModelRegistry.registerSubmenu(
portsSubmenuPath, portsSubmenuPath,
nls.localize( nls.localize(
@@ -177,21 +149,6 @@ SN: ${SN}
) )
); );
const reloadBoardData = {
commandId: BoardSelection.Commands.RELOAD_BOARD_DATA.id,
label: nls.localize('arduino/board/reloadBoardData', 'Reload Board Data'),
order: '102',
};
this.menuModelRegistry.registerMenuAction(
ArduinoMenus.TOOLS__BOARD_SELECTION_GROUP,
reloadBoardData
);
this.toDisposeBeforeMenuRebuild.push(
Disposable.create(() =>
this.menuModelRegistry.unregisterMenuAction(reloadBoardData)
)
);
const getBoardInfo = { const getBoardInfo = {
commandId: BoardSelection.Commands.GET_BOARD_INFO.id, commandId: BoardSelection.Commands.GET_BOARD_INFO.id,
label: nls.localize('arduino/board/getBoardInfo', 'Get Board Info'), label: nls.localize('arduino/board/getBoardInfo', 'Get Board Info'),
@@ -215,85 +172,45 @@ SN: ${SN}
label: `${BoardsListWidget.WIDGET_LABEL}...`, label: `${BoardsListWidget.WIDGET_LABEL}...`,
}); });
const selectedBoardPlatformId = selectedBoard
? createPlatformIdentifier(selectedBoard)
: undefined;
// Keys are the vendor IDs
type BoardsPerVendor = Record<string, BoardWithPackage[]>;
// Group boards by their platform names. The keys are the platform names as menu labels.
// If there is a platform name (menu label) collision, refine the menu label with the vendor ID.
const groupedBoards = new Map<string, BoardsPerVendor>();
for (const board of installedBoards) {
const { packageId, packageName } = board;
const { vendorId } = packageId;
let boardsPerPackageName = groupedBoards.get(packageName);
if (!boardsPerPackageName) {
boardsPerPackageName = {} as BoardsPerVendor;
groupedBoards.set(packageName, boardsPerPackageName);
}
let boardPerVendor: BoardWithPackage[] | undefined =
boardsPerPackageName[vendorId];
if (!boardPerVendor) {
boardPerVendor = [];
boardsPerPackageName[vendorId] = boardPerVendor;
}
boardPerVendor.push(board);
}
// Installed boards // Installed boards
Array.from(groupedBoards.entries()).forEach( installedBoards.forEach((board, index) => {
([packageName, boardsPerPackage]) => { const { packageId, packageName, fqbn, name, manuallyInstalled } = board;
const useVendorSuffix = Object.keys(boardsPerPackage).length > 1;
Object.entries(boardsPerPackage).forEach(([vendorId, boards]) => { const packageLabel =
let platformMenuPath: MenuPath | undefined = undefined;
boards.forEach((board, index) => {
const { packageId, fqbn, name, manuallyInstalled } = board;
// create the platform submenu once.
// creating and registering the same submenu twice in Theia is a noop, though.
if (!platformMenuPath) {
let packageLabel =
packageName + packageName +
`${ `${
manuallyInstalled manuallyInstalled
? nls.localize( ? nls.localize('arduino/board/inSketchbook', ' (in Sketchbook)')
'arduino/board/inSketchbook',
' (in Sketchbook)'
)
: '' : ''
}`; }`;
if (
selectedBoardPlatformId &&
platformIdentifierEquals(packageId, selectedBoardPlatformId)
) {
packageLabel = `${packageLabel}`;
}
if (useVendorSuffix) {
packageLabel += ` (${vendorId})`;
}
// Platform submenu // Platform submenu
platformMenuPath = [ const platformMenuPath = [...boardsPackagesGroup, packageId];
...boardsPackagesGroup, // Note: Registering the same submenu twice is a noop. No need to group the boards per platform.
serializePlatformIdentifier(packageId), this.menuModelRegistry.registerSubmenu(platformMenuPath, packageLabel, {
];
this.menuModelRegistry.registerSubmenu(
platformMenuPath,
packageLabel,
{
order: packageName.toLowerCase(), order: packageName.toLowerCase(),
} });
);
}
const id = `arduino-select-board--${fqbn}`; const id = `arduino-select-board--${fqbn}`;
const command = { id }; const command = { id };
const handler = { const handler = {
execute: () => execute: () => {
this.boardsServiceProvider.updateConfig({ if (
name: name, fqbn !== this.boardsServiceProvider.boardsConfig.selectedBoard?.fqbn
fqbn: fqbn, ) {
}), this.boardsServiceProvider.boardsConfig = {
isToggled: () => fqbn === selectedBoard?.fqbn, selectedBoard: {
name,
fqbn,
port: this.boardsServiceProvider.boardsConfig.selectedBoard
?.port, // TODO: verify!
},
selectedPort:
this.boardsServiceProvider.boardsConfig.selectedPort,
};
}
},
isToggled: () =>
fqbn === this.boardsServiceProvider.boardsConfig.selectedBoard?.fqbn,
}; };
// Board menu // Board menu
@@ -304,27 +221,20 @@ SN: ${SN}
}; };
this.commandRegistry.registerCommand(command, handler); this.commandRegistry.registerCommand(command, handler);
this.toDisposeBeforeMenuRebuild.push( this.toDisposeBeforeMenuRebuild.push(
Disposable.create(() => Disposable.create(() => this.commandRegistry.unregisterCommand(command))
this.commandRegistry.unregisterCommand(command)
)
);
this.menuModelRegistry.registerMenuAction(
platformMenuPath,
menuAction
); );
this.menuModelRegistry.registerMenuAction(platformMenuPath, menuAction);
// Note: we do not dispose the menu actions individually. Calling `unregisterSubmenu` on the parent will wipe the children menu nodes recursively. // Note: we do not dispose the menu actions individually. Calling `unregisterSubmenu` on the parent will wipe the children menu nodes recursively.
}); });
});
}
);
// Detected ports // Installed ports
const registerPorts = ( const registerPorts = (
protocol: string, protocol: string,
ports: ReturnType<BoardList['ports']>, protocolOrder: number,
protocolOrder: number ports: AvailablePorts
) => { ) => {
if (!ports.length) { const portIDs = Object.keys(ports);
if (!portIDs.length) {
return; return;
} }
@@ -349,26 +259,46 @@ SN: ${SN}
) )
); );
for (let i = 0; i < ports.length; i++) { // First we show addresses with recognized boards connected,
const { port, boards } = ports[i]; // then all the rest.
const portKey = Port.keyOf(port); const sortedIDs = Object.keys(ports).sort(
(left: string, right: string): number => {
const [, leftBoards] = ports[left];
const [, rightBoards] = ports[right];
return rightBoards.length - leftBoards.length;
}
);
for (let i = 0; i < sortedIDs.length; i++) {
const portID = sortedIDs[i];
const [port, boards] = ports[portID];
let label = `${port.addressLabel}`; let label = `${port.addressLabel}`;
if (boards?.length) { if (boards.length) {
const boardsList = boards.map((board) => board.name).join(', '); const boardsList = boards.map((board) => board.name).join(', ');
label = `${label} (${boardsList})`; label = `${label} (${boardsList})`;
} }
const id = `arduino-select-port--${portKey}`; const id = `arduino-select-port--${portID}`;
const command = { id }; const command = { id };
const handler = { const handler = {
execute: () => { execute: () => {
this.boardsServiceProvider.updateConfig({ if (
protocol: port.protocol, !Port.sameAs(
address: port.address, port,
}); this.boardsServiceProvider.boardsConfig.selectedPort
}, )
isToggled: () => { ) {
return i === ports.matchingIndex; this.boardsServiceProvider.boardsConfig = {
selectedBoard:
this.boardsServiceProvider.boardsConfig.selectedBoard,
selectedPort: port,
};
}
}, },
isToggled: () =>
Port.sameAs(
port,
this.boardsServiceProvider.boardsConfig.selectedPort
),
}; };
const menuAction = { const menuAction = {
commandId: id, commandId: id,
@@ -385,12 +315,22 @@ SN: ${SN}
} }
}; };
const groupedPorts = boardList.portsGroupedByProtocol(); const grouped = AvailablePorts.groupByProtocol(availablePorts);
let protocolOrder = 100; let protocolOrder = 100;
Object.entries(groupedPorts).forEach(([protocol, ports]) => { // We first show serial and network ports, then all the rest
registerPorts(protocol, ports, protocolOrder); ['serial', 'network'].forEach((protocol) => {
protocolOrder += 100; const ports = grouped.get(protocol);
if (ports) {
registerPorts(protocol, protocolOrder, ports);
grouped.delete(protocol);
protocolOrder = protocolOrder + 100;
}
}); });
grouped.forEach((ports, protocol) => {
registerPorts(protocol, protocolOrder, ports);
protocolOrder = protocolOrder + 100;
});
this.mainMenuManager.update(); this.mainMenuManager.update();
} }
@@ -402,8 +342,5 @@ SN: ${SN}
export namespace BoardSelection { export namespace BoardSelection {
export namespace Commands { export namespace Commands {
export const GET_BOARD_INFO: Command = { id: 'arduino-get-board-info' }; export const GET_BOARD_INFO: Command = { id: 'arduino-get-board-info' };
export const RELOAD_BOARD_DATA: Command = {
id: 'arduino-reload-board-data',
};
} }
} }

View File

@@ -37,15 +37,11 @@ export class BurnBootloader extends CoreServiceContribution {
'arduino/bootloader/burningBootloader', 'arduino/bootloader/burningBootloader',
'Burning bootloader...' 'Burning bootloader...'
), ),
task: (progressId, coreService, token) => task: (progressId, coreService) =>
coreService.burnBootloader( coreService.burnBootloader({
{
...options, ...options,
progressId, progressId,
}, }),
token
),
cancelable: true,
}); });
this.messageService.info( this.messageService.info(
nls.localize( nls.localize(

View File

@@ -1,45 +1,55 @@
import { DisposableCollection } from '@theia/core/lib/common/disposable';
import { FrontendApplicationContribution } from '@theia/core/lib/browser';
import type { AbstractViewContribution } from '@theia/core/lib/browser/shell/view-contribution'; import type { AbstractViewContribution } from '@theia/core/lib/browser/shell/view-contribution';
import { nls } from '@theia/core/lib/common/nls'; import { nls } from '@theia/core/lib/common/nls';
import { inject, injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import { InstallManually, Later } from '../../common/nls'; import { InstallManually, Later } from '../../common/nls';
import { import {
ArduinoComponent, ArduinoComponent,
BoardSearch,
BoardsPackage, BoardsPackage,
BoardsService, BoardsService,
LibraryPackage, LibraryPackage,
LibrarySearch,
LibraryService, LibraryService,
ResponseServiceClient, ResponseServiceClient,
Searchable, Searchable,
Updatable,
} from '../../common/protocol'; } from '../../common/protocol';
import { Installable } from '../../common/protocol/installable'; import { Installable } from '../../common/protocol/installable';
import { ExecuteWithProgress } from '../../common/protocol/progressible'; import { ExecuteWithProgress } from '../../common/protocol/progressible';
import { BoardsListWidgetFrontendContribution } from '../boards/boards-widget-frontend-contribution'; import { BoardsListWidgetFrontendContribution } from '../boards/boards-widget-frontend-contribution';
import { LibraryListWidgetFrontendContribution } from '../library/library-widget-frontend-contribution'; import { LibraryListWidgetFrontendContribution } from '../library/library-widget-frontend-contribution';
import { NotificationCenter } from '../notification-center';
import { WindowServiceExt } from '../theia/core/window-service-ext'; import { WindowServiceExt } from '../theia/core/window-service-ext';
import type { ListWidget } from '../widgets/component-list/list-widget'; import type { ListWidget } from '../widgets/component-list/list-widget';
import { Command, CommandRegistry, Contribution } from './contribution'; import { Command, CommandRegistry, Contribution } from './contribution';
import { Emitter } from '@theia/core';
import debounce = require('lodash.debounce');
import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';
import { ArduinoPreferences } from '../arduino-preferences';
const NoUpdates = nls.localize( const noUpdates = nls.localize(
'arduino/checkForUpdates/noUpdates', 'arduino/checkForUpdates/noUpdates',
'There are no recent updates available.' 'There are no recent updates available.'
); );
const PromptUpdateBoards = nls.localize( const promptUpdateBoards = nls.localize(
'arduino/checkForUpdates/promptUpdateBoards', 'arduino/checkForUpdates/promptUpdateBoards',
'Updates are available for some of your boards.' 'Updates are available for some of your boards.'
); );
const PromptUpdateLibraries = nls.localize( const promptUpdateLibraries = nls.localize(
'arduino/checkForUpdates/promptUpdateLibraries', 'arduino/checkForUpdates/promptUpdateLibraries',
'Updates are available for some of your libraries.' 'Updates are available for some of your libraries.'
); );
const UpdatingBoards = nls.localize( const updatingBoards = nls.localize(
'arduino/checkForUpdates/updatingBoards', 'arduino/checkForUpdates/updatingBoards',
'Updating boards...' 'Updating boards...'
); );
const UpdatingLibraries = nls.localize( const updatingLibraries = nls.localize(
'arduino/checkForUpdates/updatingLibraries', 'arduino/checkForUpdates/updatingLibraries',
'Updating libraries...' 'Updating libraries...'
); );
const InstallAll = nls.localize( const installAll = nls.localize(
'arduino/checkForUpdates/installAll', 'arduino/checkForUpdates/installAll',
'Install All' 'Install All'
); );
@@ -49,7 +59,24 @@ interface Task<T extends ArduinoComponent> {
readonly item: T; readonly item: T;
} }
const Updatable = { type: 'Updatable' } as const; const updatableLibrariesSearchOption: LibrarySearch = {
query: '',
topic: 'All',
...Updatable,
};
const updatableBoardsSearchOption: BoardSearch = {
query: '',
...Updatable,
};
const installedLibrariesSearchOptions: LibrarySearch = {
query: '',
topic: 'All',
type: 'Installed',
};
const installedBoardsSearchOptions: BoardSearch = {
query: '',
type: 'Installed',
};
@injectable() @injectable()
export class CheckForUpdates extends Contribution { export class CheckForUpdates extends Contribution {
@@ -70,6 +97,37 @@ export class CheckForUpdates extends Contribution {
register.registerCommand(CheckForUpdates.Commands.CHECK_FOR_UPDATES, { register.registerCommand(CheckForUpdates.Commands.CHECK_FOR_UPDATES, {
execute: () => this.checkForUpdates(false), execute: () => this.checkForUpdates(false),
}); });
register.registerCommand(CheckForUpdates.Commands.SHOW_BOARDS_UPDATES, {
execute: () =>
this.showUpdatableItems(
this.boardsContribution,
updatableBoardsSearchOption
),
});
register.registerCommand(CheckForUpdates.Commands.SHOW_LIBRARY_UPDATES, {
execute: () =>
this.showUpdatableItems(
this.librariesContribution,
updatableLibrariesSearchOption
),
});
register.registerCommand(CheckForUpdates.Commands.SHOW_INSTALLED_BOARDS, {
execute: () =>
this.showUpdatableItems(
this.boardsContribution,
installedBoardsSearchOptions
),
});
register.registerCommand(
CheckForUpdates.Commands.SHOW_INSTALLED_LIBRARIES,
{
execute: () =>
this.showUpdatableItems(
this.librariesContribution,
installedLibrariesSearchOptions
),
}
);
} }
override async onReady(): Promise<void> { override async onReady(): Promise<void> {
@@ -85,13 +143,13 @@ export class CheckForUpdates extends Contribution {
private async checkForUpdates(silent = true) { private async checkForUpdates(silent = true) {
const [boardsPackages, libraryPackages] = await Promise.all([ const [boardsPackages, libraryPackages] = await Promise.all([
this.boardsService.search(Updatable), this.boardsService.search(updatableBoardsSearchOption),
this.libraryService.search(Updatable), this.libraryService.search(updatableLibrariesSearchOption),
]); ]);
this.promptUpdateBoards(boardsPackages); this.promptUpdateBoards(boardsPackages);
this.promptUpdateLibraries(libraryPackages); this.promptUpdateLibraries(libraryPackages);
if (!libraryPackages.length && !boardsPackages.length && !silent) { if (!libraryPackages.length && !boardsPackages.length && !silent) {
this.messageService.info(NoUpdates); this.messageService.info(noUpdates);
} }
} }
@@ -100,9 +158,9 @@ export class CheckForUpdates extends Contribution {
items, items,
installable: this.boardsService, installable: this.boardsService,
viewContribution: this.boardsContribution, viewContribution: this.boardsContribution,
viewSearchOptions: { query: '', ...Updatable }, viewSearchOptions: updatableBoardsSearchOption,
promptMessage: PromptUpdateBoards, promptMessage: promptUpdateBoards,
updatingMessage: UpdatingBoards, updatingMessage: updatingBoards,
}); });
} }
@@ -111,9 +169,9 @@ export class CheckForUpdates extends Contribution {
items, items,
installable: this.libraryService, installable: this.libraryService,
viewContribution: this.librariesContribution, viewContribution: this.librariesContribution,
viewSearchOptions: { query: '', topic: 'All', ...Updatable }, viewSearchOptions: updatableLibrariesSearchOption,
promptMessage: PromptUpdateLibraries, promptMessage: promptUpdateLibraries,
updatingMessage: UpdatingLibraries, updatingMessage: updatingLibraries,
}); });
} }
@@ -141,21 +199,30 @@ export class CheckForUpdates extends Contribution {
return; return;
} }
this.messageService this.messageService
.info(message, Later, InstallManually, InstallAll) .info(message, Later, InstallManually, installAll)
.then((answer) => { .then((answer) => {
if (answer === InstallAll) { if (answer === installAll) {
const tasks = items.map((item) => const tasks = items.map((item) =>
this.createInstallTask(item, installable) this.createInstallTask(item, installable)
); );
this.executeTasks(updatingMessage, tasks); return this.executeTasks(updatingMessage, tasks);
} else if (answer === InstallManually) { } else if (answer === InstallManually) {
viewContribution return this.showUpdatableItems(viewContribution, viewSearchOptions);
.openView({ reveal: true })
.then((widget) => widget.refresh(viewSearchOptions));
} }
}); });
} }
private async showUpdatableItems<
T extends ArduinoComponent,
S extends Searchable.Options
>(
viewContribution: AbstractViewContribution<ListWidget<T, S>>,
viewSearchOptions: S
): Promise<void> {
const widget = await viewContribution.openView({ reveal: true });
widget.refresh(viewSearchOptions);
}
private async executeTasks( private async executeTasks(
message: string, message: string,
tasks: Task<ArduinoComponent>[] tasks: Task<ArduinoComponent>[]
@@ -217,5 +284,127 @@ export namespace CheckForUpdates {
}, },
'arduino/checkForUpdates/checkForUpdates' 'arduino/checkForUpdates/checkForUpdates'
); );
export const SHOW_BOARDS_UPDATES: Command & { label: string } = {
id: 'arduino-show-boards-updates',
label: nls.localize(
'arduino/checkForUpdates/showBoardsUpdates',
'Boards Updates'
),
category: 'Arduino',
};
export const SHOW_LIBRARY_UPDATES: Command & { label: string } = {
id: 'arduino-show-library-updates',
label: nls.localize(
'arduino/checkForUpdates/showLibraryUpdates',
'Library Updates'
),
category: 'Arduino',
};
export const SHOW_INSTALLED_BOARDS: Command & { label: string } = {
id: 'arduino-show-installed-boards',
label: nls.localize(
'arduino/checkForUpdates/showInstalledBoards',
'Installed Boards'
),
category: 'Arduino',
};
export const SHOW_INSTALLED_LIBRARIES: Command & { label: string } = {
id: 'arduino-show-installed-libraries',
label: nls.localize(
'arduino/checkForUpdates/showInstalledLibraries',
'Installed Libraries'
),
category: 'Arduino',
};
}
}
@injectable()
abstract class ComponentUpdates<T extends ArduinoComponent>
implements FrontendApplicationContribution
{
@inject(FrontendApplicationStateService)
private readonly appStateService: FrontendApplicationStateService;
@inject(ArduinoPreferences)
private readonly preferences: ArduinoPreferences;
@inject(NotificationCenter)
protected readonly notificationCenter: NotificationCenter;
private _updates: T[] | undefined;
private readonly onDidChangeEmitter = new Emitter<T[]>();
protected readonly toDispose = new DisposableCollection(
this.onDidChangeEmitter
);
readonly onDidChange = this.onDidChangeEmitter.event;
readonly refresh = debounce(() => this.refreshDebounced(), 200);
onStart(): void {
this.appStateService.reachedState('ready').then(() => this.refresh());
this.toDispose.push(
this.preferences.onPreferenceChanged(({ preferenceName, newValue }) => {
if (
preferenceName === 'arduino.checkForUpdates' &&
typeof newValue === 'boolean'
) {
this.refresh();
}
})
);
}
onStop(): void {
this.toDispose.dispose();
}
get updates(): T[] | undefined {
return this._updates;
}
/**
* Search updatable components (libraries and platforms) via the CLI.
*/
abstract searchUpdates(): Promise<T[]>;
private async refreshDebounced(): Promise<void> {
const checkForUpdates = this.preferences['arduino.checkForUpdates'];
this._updates = checkForUpdates ? await this.searchUpdates() : [];
this.onDidChangeEmitter.fire(this._updates.slice());
}
}
@injectable()
export class LibraryUpdates extends ComponentUpdates<LibraryPackage> {
@inject(LibraryService)
private readonly libraryService: LibraryService;
override onStart(): void {
super.onStart();
this.toDispose.pushAll([
this.notificationCenter.onLibraryDidInstall(() => this.refresh()),
this.notificationCenter.onLibraryDidUninstall(() => this.refresh()),
]);
}
override searchUpdates(): Promise<LibraryPackage[]> {
return this.libraryService.search(updatableLibrariesSearchOption);
}
}
@injectable()
export class BoardsUpdates extends ComponentUpdates<BoardsPackage> {
@inject(BoardsService)
private readonly boardsService: BoardsService;
override onStart(): void {
super.onStart();
this.toDispose.pushAll([
this.notificationCenter.onPlatformDidInstall(() => this.refresh()),
this.notificationCenter.onPlatformDidUninstall(() => this.refresh()),
this.notificationCenter.onIndexUpdateDidComplete(() => this.refresh()),
]);
}
override searchUpdates(): Promise<BoardsPackage[]> {
return this.boardsService.search(updatableBoardsSearchOption);
} }
} }

View File

@@ -1,26 +1,26 @@
import { Dialog } from '@theia/core/lib/browser/dialogs'; import { injectable } from '@theia/core/shared/inversify';
import { toArray } from '@theia/core/shared/@phosphor/algorithm';
import * as remote from '@theia/core/electron-shared/@electron/remote';
import { MonacoEditor } from '@theia/monaco/lib/browser/monaco-editor';
import type { MaybePromise } from '@theia/core/lib/common/types';
import type { import type {
FrontendApplication, FrontendApplication,
OnWillStopAction, OnWillStopAction,
} from '@theia/core/lib/browser/frontend-application'; } from '@theia/core/lib/browser/frontend-application';
import { ApplicationShell } from '@theia/core/lib/browser/shell/application-shell';
import { nls } from '@theia/core/lib/common/nls'; import { nls } from '@theia/core/lib/common/nls';
import type { MaybePromise } from '@theia/core/lib/common/types'; import { ApplicationShell } from '@theia/core/lib/browser/shell/application-shell';
import { toArray } from '@theia/core/shared/@phosphor/algorithm';
import { inject, injectable } from '@theia/core/shared/inversify';
import { MonacoEditor } from '@theia/monaco/lib/browser/monaco-editor';
import { ArduinoMenus } from '../menu/arduino-menus'; import { ArduinoMenus } from '../menu/arduino-menus';
import { CurrentSketch } from '../sketches-service-client-impl';
import { WindowServiceExt } from '../theia/core/window-service-ext';
import { import {
SketchContribution,
Command, Command,
CommandRegistry, CommandRegistry,
KeybindingRegistry,
MenuModelRegistry, MenuModelRegistry,
KeybindingRegistry,
Sketch, Sketch,
SketchContribution,
URI, URI,
} from './contribution'; } from './contribution';
import { Dialog } from '@theia/core/lib/browser/dialogs';
import { CurrentSketch } from '../sketches-service-client-impl';
import { SaveAsSketch } from './save-as-sketch'; import { SaveAsSketch } from './save-as-sketch';
/** /**
@@ -28,9 +28,6 @@ import { SaveAsSketch } from './save-as-sketch';
*/ */
@injectable() @injectable()
export class Close extends SketchContribution { export class Close extends SketchContribution {
@inject(WindowServiceExt)
private readonly windowServiceExt: WindowServiceExt;
private shell: ApplicationShell | undefined; private shell: ApplicationShell | undefined;
override onStart(app: FrontendApplication): MaybePromise<void> { override onStart(app: FrontendApplication): MaybePromise<void> {
@@ -59,7 +56,7 @@ export class Close extends SketchContribution {
} }
} }
} }
return this.windowServiceExt.close(); return remote.getCurrentWindow().close();
}, },
}); });
} }
@@ -153,7 +150,9 @@ export class Close extends SketchContribution {
} }
private async prompt(isTemp: boolean): Promise<Prompt> { private async prompt(isTemp: boolean): Promise<Prompt> {
const { response } = await this.dialogService.showMessageBox({ const { response } = await remote.dialog.showMessageBox(
remote.getCurrentWindow(),
{
message: nls.localize( message: nls.localize(
'arduino/sketch/saveSketch', 'arduino/sketch/saveSketch',
'Save your sketch to open it again later.' 'Save your sketch to open it again later.'
@@ -169,7 +168,8 @@ export class Close extends SketchContribution {
nls.localizeByDefault(isTemp ? 'Save As...' : 'Save'), nls.localizeByDefault(isTemp ? 'Save As...' : 'Save'),
], ],
defaultId: 2, // `Save`/`Save As...` button index is the default. defaultId: 2, // `Save`/`Save As...` button index is the default.
}); }
);
switch (response) { switch (response) {
case 0: case 0:
return Prompt.DoNotSave; return Prompt.DoNotSave;

View File

@@ -1,89 +1,76 @@
import { ClipboardService } from '@theia/core/lib/browser/clipboard-service';
import {
FrontendApplication,
FrontendApplicationContribution,
} from '@theia/core/lib/browser/frontend-application';
import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';
import {
KeybindingContribution,
KeybindingRegistry,
} from '@theia/core/lib/browser/keybinding';
import { LabelProvider } from '@theia/core/lib/browser/label-provider';
import { OpenerService, open } from '@theia/core/lib/browser/opener-service';
import { Saveable } from '@theia/core/lib/browser/saveable';
import { ApplicationShell } from '@theia/core/lib/browser/shell/application-shell';
import {
TabBarToolbarContribution,
TabBarToolbarRegistry,
} from '@theia/core/lib/browser/shell/tab-bar-toolbar';
import { CancellationToken } from '@theia/core/lib/common/cancellation';
import {
Command,
CommandContribution,
CommandRegistry,
CommandService,
} from '@theia/core/lib/common/command';
import {
Disposable,
DisposableCollection,
} from '@theia/core/lib/common/disposable';
import { EnvVariablesServer } from '@theia/core/lib/common/env-variables';
import { ILogger } from '@theia/core/lib/common/logger';
import {
MenuContribution,
MenuModelRegistry,
} from '@theia/core/lib/common/menu';
import { MessageService } from '@theia/core/lib/common/message-service';
import { MessageType } from '@theia/core/lib/common/message-service-protocol';
import { nls } from '@theia/core/lib/common/nls';
import { MaybePromise, isObject } from '@theia/core/lib/common/types';
import URI from '@theia/core/lib/common/uri';
import { import {
inject, inject,
injectable, injectable,
interfaces, interfaces,
postConstruct, postConstruct,
} from '@theia/core/shared/inversify'; } from '@theia/core/shared/inversify';
import { EditorManager } from '@theia/editor/lib/browser/editor-manager'; import URI from '@theia/core/lib/common/uri';
import { ILogger } from '@theia/core/lib/common/logger';
import { Saveable } from '@theia/core/lib/browser/saveable';
import { FileService } from '@theia/filesystem/lib/browser/file-service'; import { FileService } from '@theia/filesystem/lib/browser/file-service';
import { NotificationManager } from '@theia/messages/lib/browser/notifications-manager'; import { MaybePromise } from '@theia/core/lib/common/types';
import { OutputChannelSeverity } from '@theia/output/lib/browser/output-channel'; import { LabelProvider } from '@theia/core/lib/browser/label-provider';
import { MainMenuManager } from '../../common/main-menu-manager'; import { EditorManager } from '@theia/editor/lib/browser/editor-manager';
import { userAbort } from '../../common/nls'; import { MessageService } from '@theia/core/lib/common/message-service';
import { EnvVariablesServer } from '@theia/core/lib/common/env-variables';
import { open, OpenerService } from '@theia/core/lib/browser/opener-service';
import { import {
CoreError, MenuModelRegistry,
CoreService, MenuContribution,
FileSystemExt, } from '@theia/core/lib/common/menu';
ResponseServiceClient,
Sketch,
SketchesService,
} from '../../common/protocol';
import { import {
ExecuteWithProgress, KeybindingRegistry,
UserAbortApplicationError, KeybindingContribution,
} from '../../common/protocol/progressible'; } from '@theia/core/lib/browser/keybinding';
import { ArduinoPreferences } from '../arduino-preferences'; import {
import { BoardsDataStore } from '../boards/boards-data-store'; TabBarToolbarContribution,
import { BoardsServiceProvider } from '../boards/boards-service-provider'; TabBarToolbarRegistry,
import { ConfigServiceClient } from '../config/config-service-client'; } from '@theia/core/lib/browser/shell/tab-bar-toolbar';
import { DialogService } from '../dialog-service'; import {
FrontendApplicationContribution,
FrontendApplication,
} from '@theia/core/lib/browser/frontend-application';
import {
Command,
CommandRegistry,
CommandContribution,
CommandService,
} from '@theia/core/lib/common/command';
import { SettingsService } from '../dialogs/settings/settings'; import { SettingsService } from '../dialogs/settings/settings';
import { import {
CurrentSketch, CurrentSketch,
SketchesServiceClientImpl, SketchesServiceClientImpl,
} from '../sketches-service-client-impl'; } from '../sketches-service-client-impl';
import { ApplicationConnectionStatusContribution } from '../theia/core/connection-status-service'; import {
SketchesService,
FileSystemExt,
Sketch,
CoreService,
CoreError,
ResponseServiceClient,
} from '../../common/protocol';
import { ArduinoPreferences } from '../arduino-preferences';
import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';
import { nls } from '@theia/core';
import { OutputChannelManager } from '../theia/output/output-channel'; import { OutputChannelManager } from '../theia/output/output-channel';
import { ClipboardService } from '@theia/core/lib/browser/clipboard-service';
import { ExecuteWithProgress } from '../../common/protocol/progressible';
import { BoardsServiceProvider } from '../boards/boards-service-provider';
import { BoardsDataStore } from '../boards/boards-data-store';
import { NotificationManager } from '@theia/messages/lib/browser/notifications-manager';
import { MessageType } from '@theia/core/lib/common/message-service-protocol';
import { WorkspaceService } from '../theia/workspace/workspace-service'; import { WorkspaceService } from '../theia/workspace/workspace-service';
import { MainMenuManager } from '../../common/main-menu-manager';
import { ConfigServiceClient } from '../config/config-service-client';
export { export {
Command, Command,
CommandRegistry, CommandRegistry,
KeybindingRegistry,
MenuModelRegistry, MenuModelRegistry,
Sketch, KeybindingRegistry,
TabBarToolbarRegistry, TabBarToolbarRegistry,
URI, URI,
Sketch,
open, open,
}; };
@@ -123,9 +110,6 @@ export abstract class Contribution
@inject(MainMenuManager) @inject(MainMenuManager)
protected readonly menuManager: MainMenuManager; protected readonly menuManager: MainMenuManager;
@inject(DialogService)
protected readonly dialogService: DialogService;
@postConstruct() @postConstruct()
protected init(): void { protected init(): void {
this.appStateService.reachedState('ready').then(() => this.onReady()); this.appStateService.reachedState('ready').then(() => this.onReady());
@@ -179,9 +163,6 @@ export abstract class SketchContribution extends Contribution {
@inject(EnvVariablesServer) @inject(EnvVariablesServer)
protected readonly envVariableServer: EnvVariablesServer; protected readonly envVariableServer: EnvVariablesServer;
@inject(ApplicationConnectionStatusContribution)
protected readonly connectionStatusService: ApplicationConnectionStatusContribution;
protected async sourceOverride(): Promise<Record<string, string>> { protected async sourceOverride(): Promise<Record<string, string>> {
const override: Record<string, string> = {}; const override: Record<string, string> = {};
const sketch = await this.sketchServiceClient.currentSketch(); const sketch = await this.sketchServiceClient.currentSketch();
@@ -236,9 +217,6 @@ export abstract class CoreServiceContribution extends SketchContribution {
@inject(NotificationManager) @inject(NotificationManager)
private readonly notificationManager: NotificationManager; private readonly notificationManager: NotificationManager;
@inject(ApplicationShell)
private readonly shell: ApplicationShell;
/** /**
* This is the internal (Theia) ID of the notification that is currently visible. * This is the internal (Theia) ID of the notification that is currently visible.
* It's stored here as a field to be able to close it before executing any new core command (such as verify, upload, etc.) * It's stored here as a field to be able to close it before executing any new core command (such as verify, upload, etc.)
@@ -253,12 +231,6 @@ export abstract class CoreServiceContribution extends SketchContribution {
} }
protected handleError(error: unknown): void { protected handleError(error: unknown): void {
if (isObject(error) && UserAbortApplicationError.is(error)) {
this.outputChannelManager
.getChannel('Arduino')
.appendLine(userAbort, OutputChannelSeverity.Warning);
return;
}
this.tryToastErrorMessage(error); this.tryToastErrorMessage(error);
} }
@@ -305,17 +277,8 @@ export abstract class CoreServiceContribution extends SketchContribution {
protected async doWithProgress<T>(options: { protected async doWithProgress<T>(options: {
progressText: string; progressText: string;
keepOutput?: boolean; keepOutput?: boolean;
task: ( task: (progressId: string, coreService: CoreService) => Promise<T>;
progressId: string,
coreService: CoreService,
cancellationToken?: CancellationToken
) => Promise<T>;
// false by default
cancelable?: boolean;
}): Promise<T> { }): Promise<T> {
const toDisposeOnComplete = new DisposableCollection(
this.maybeActivateMonitorWidget()
);
const { progressText, keepOutput, task } = options; const { progressText, keepOutput, task } = options;
this.outputChannelManager this.outputChannelManager
.getChannel('Arduino') .getChannel('Arduino')
@@ -324,29 +287,12 @@ export abstract class CoreServiceContribution extends SketchContribution {
messageService: this.messageService, messageService: this.messageService,
responseService: this.responseService, responseService: this.responseService,
progressText, progressText,
run: ({ progressId, cancellationToken }) => run: ({ progressId }) => task(progressId, this.coreService),
task(progressId, this.coreService, cancellationToken),
keepOutput, keepOutput,
cancelable: options.cancelable,
}); });
toDisposeOnComplete.dispose();
return result; return result;
} }
// TODO: cleanup!
// this dependency does not belong here
// support core command contribution handlers, the monitor-widget should implement it and register itself as a handler
// the monitor widget should reveal itself after a successful core command execution
private maybeActivateMonitorWidget(): Disposable {
const currentWidget = this.shell.bottomPanel.currentTitle?.owner;
if (currentWidget?.id === 'serial-monitor') {
return Disposable.create(() =>
this.shell.bottomPanel.activateWidget(currentWidget)
);
}
return Disposable.NULL;
}
private notificationId(message: string, ...actions: string[]): string { private notificationId(message: string, ...actions: string[]): string {
return this.notificationManager['getMessageId']({ return this.notificationManager['getMessageId']({
text: message, text: message,

View File

@@ -1,173 +1,102 @@
import { Emitter, Event } from '@theia/core/lib/common/event';
import { MenuModelRegistry } from '@theia/core/lib/common/menu/menu-model-registry';
import { nls } from '@theia/core/lib/common/nls';
import { MaybePromise } from '@theia/core/lib/common/types';
import { inject, injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import { noBoardSelected } from '../../common/nls'; import { Event, Emitter } from '@theia/core/lib/common/event';
import { import { HostedPluginSupport } from '@theia/plugin-ext/lib/hosted/browser/hosted-plugin';
BoardDetails,
BoardIdentifier,
BoardsService,
CheckDebugEnabledParams,
ExecutableService,
SketchRef,
isBoardIdentifierChangeEvent,
isCompileSummary,
} from '../../common/protocol';
import { BoardsDataStore } from '../boards/boards-data-store';
import { BoardsServiceProvider } from '../boards/boards-service-provider';
import { HostedPluginSupport } from '../hosted/hosted-plugin-support';
import { ArduinoMenus } from '../menu/arduino-menus';
import { NotificationCenter } from '../notification-center';
import { CurrentSketch } from '../sketches-service-client-impl';
import { ArduinoToolbar } from '../toolbar/arduino-toolbar'; import { ArduinoToolbar } from '../toolbar/arduino-toolbar';
import { NotificationCenter } from '../notification-center';
import { import {
Board,
BoardsService,
ExecutableService,
Sketch,
} from '../../common/protocol';
import { BoardsServiceProvider } from '../boards/boards-service-provider';
import {
URI,
Command, Command,
CommandRegistry, CommandRegistry,
SketchContribution, SketchContribution,
TabBarToolbarRegistry, TabBarToolbarRegistry,
URI,
} from './contribution'; } from './contribution';
import { MaybePromise, MenuModelRegistry, nls } from '@theia/core/lib/common';
import { CurrentSketch } from '../sketches-service-client-impl';
import { ArduinoMenus } from '../menu/arduino-menus';
const COMPILE_FOR_DEBUG_KEY = 'arduino-compile-for-debug'; const COMPILE_FOR_DEBUG_KEY = 'arduino-compile-for-debug';
interface StartDebugParams {
/**
* Absolute filesystem path to the Arduino CLI executable.
*/
readonly cliPath: string;
/**
* The the board to debug.
*/
readonly board: Readonly<{ fqbn: string; name?: string }>;
/**
* Absolute filesystem path of the sketch to debug.
*/
readonly sketchPath: string;
/**
* Location where the `launch.json` will be created on the fly before starting every debug session.
* If not defined, it falls back to `sketchPath/.vscode/launch.json`.
*/
readonly launchConfigsDirPath?: string;
/**
* Absolute path to the `arduino-cli.yaml` file. If not specified, it falls back to `~/.arduinoIDE/arduino-cli.yaml`.
*/
readonly cliConfigPath?: string;
/**
* Programmer for the debugging.
*/
readonly programmer?: string;
/**
* Custom progress title to use when getting the debug information from the CLI.
*/
readonly title?: string;
}
type StartDebugResult = boolean;
export const DebugDisabledStatusMessageSource = Symbol(
'DebugDisabledStatusMessageSource'
);
export interface DebugDisabledStatusMessageSource {
/**
* `undefined` if debugging is enabled (for the currently selected board + programmer + config options).
* Otherwise, it's the human readable message why it's disabled.
*/
get message(): string | undefined;
/**
* Emits an event when {@link message} changes.
*/
get onDidChangeMessage(): Event<string | undefined>;
}
@injectable() @injectable()
export class Debug export class Debug extends SketchContribution {
extends SketchContribution
implements DebugDisabledStatusMessageSource
{
@inject(HostedPluginSupport) @inject(HostedPluginSupport)
private readonly hostedPluginSupport: HostedPluginSupport; private readonly hostedPluginSupport: HostedPluginSupport;
@inject(NotificationCenter) @inject(NotificationCenter)
private readonly notificationCenter: NotificationCenter; private readonly notificationCenter: NotificationCenter;
@inject(ExecutableService) @inject(ExecutableService)
private readonly executableService: ExecutableService; private readonly executableService: ExecutableService;
@inject(BoardsService) @inject(BoardsService)
private readonly boardService: BoardsService; private readonly boardService: BoardsService;
@inject(BoardsServiceProvider) @inject(BoardsServiceProvider)
private readonly boardsServiceProvider: BoardsServiceProvider; private readonly boardsServiceProvider: BoardsServiceProvider;
@inject(BoardsDataStore)
private readonly boardsDataStore: BoardsDataStore;
/** /**
* If `undefined`, debugging is enabled. Otherwise, the human-readable reason why it's disabled. * If `undefined`, debugging is enabled. Otherwise, the reason why it's disabled.
*/ */
private _message?: string = noBoardSelected; // Initial pessimism. private _disabledMessages?: string = nls.localize(
private readonly didChangeMessageEmitter = new Emitter<string | undefined>(); 'arduino/common/noBoardSelected',
readonly onDidChangeMessage = this.didChangeMessageEmitter.event; 'No board selected'
); // Initial pessimism.
private disabledMessageDidChangeEmitter = new Emitter<string | undefined>();
private onDisabledMessageDidChange =
this.disabledMessageDidChangeEmitter.event;
get message(): string | undefined { private get disabledMessage(): string | undefined {
return this._message; return this._disabledMessages;
} }
private set message(message: string | undefined) { private set disabledMessage(message: string | undefined) {
this._message = message; this._disabledMessages = message;
this.didChangeMessageEmitter.fire(this._message); this.disabledMessageDidChangeEmitter.fire(this._disabledMessages);
} }
private readonly debugToolbarItem = { private readonly debugToolbarItem = {
id: Debug.Commands.START_DEBUGGING.id, id: Debug.Commands.START_DEBUGGING.id,
command: Debug.Commands.START_DEBUGGING.id, command: Debug.Commands.START_DEBUGGING.id,
tooltip: `${ tooltip: `${
this.message this.disabledMessage
? nls.localize( ? nls.localize(
'arduino/debug/debugWithMessage', 'arduino/debug/debugWithMessage',
'Debug - {0}', 'Debug - {0}',
this.message this.disabledMessage
) )
: Debug.Commands.START_DEBUGGING.label : Debug.Commands.START_DEBUGGING.label
}`, }`,
priority: 3, priority: 3,
onDidChange: this.onDidChangeMessage as Event<void>, onDidChange: this.onDisabledMessageDidChange as Event<void>,
}; };
override onStart(): void { override onStart(): void {
this.onDidChangeMessage( this.onDisabledMessageDidChange(
() => () =>
(this.debugToolbarItem.tooltip = `${ (this.debugToolbarItem.tooltip = `${
this.message this.disabledMessage
? nls.localize( ? nls.localize(
'arduino/debug/debugWithMessage', 'arduino/debug/debugWithMessage',
'Debug - {0}', 'Debug - {0}',
this.message this.disabledMessage
) )
: Debug.Commands.START_DEBUGGING.label : Debug.Commands.START_DEBUGGING.label
}`) }`)
); );
this.boardsServiceProvider.onBoardsConfigDidChange((event) => { this.boardsServiceProvider.onBoardsConfigChanged(({ selectedBoard }) =>
if (isBoardIdentifierChangeEvent(event)) { this.refreshState(selectedBoard)
this.updateMessage(); );
} this.notificationCenter.onPlatformDidInstall(() => this.refreshState());
}); this.notificationCenter.onPlatformDidUninstall(() => this.refreshState());
this.notificationCenter.onPlatformDidInstall(() => this.updateMessage());
this.notificationCenter.onPlatformDidUninstall(() => this.updateMessage());
this.boardsDataStore.onDidChange((event) => {
const selectedFqbn =
this.boardsServiceProvider.boardsConfig.selectedBoard?.fqbn;
if (event.changes.find((change) => change.fqbn === selectedFqbn)) {
this.updateMessage();
}
});
this.commandService.onDidExecuteCommand((event) => {
const { commandId, args } = event;
if (
commandId === 'arduino.languageserver.notifyBuildDidComplete' &&
isCompileSummary(args[0])
) {
this.updateMessage();
}
});
} }
override onReady(): void { override onReady(): MaybePromise<void> {
this.boardsServiceProvider.ready.then(() => this.updateMessage()); this.refreshState();
} }
override registerCommands(registry: CommandRegistry): void { override registerCommands(registry: CommandRegistry): void {
@@ -175,7 +104,7 @@ export class Debug
execute: () => this.startDebug(), execute: () => this.startDebug(),
isVisible: (widget) => isVisible: (widget) =>
ArduinoToolbar.is(widget) && widget.side === 'left', ArduinoToolbar.is(widget) && widget.side === 'left',
isEnabled: () => !this.message, isEnabled: () => !this.disabledMessage,
}); });
registry.registerCommand(Debug.Commands.TOGGLE_OPTIMIZE_FOR_DEBUG, { registry.registerCommand(Debug.Commands.TOGGLE_OPTIMIZE_FOR_DEBUG, {
execute: () => this.toggleCompileForDebug(), execute: () => this.toggleCompileForDebug(),
@@ -198,56 +127,94 @@ export class Debug
}); });
} }
private async updateMessage(): Promise<void> { private async refreshState(
try { board: Board | undefined = this.boardsServiceProvider.boardsConfig
await this.isDebugEnabled();
this.message = undefined;
} catch (err) {
let message = String(err);
if (err instanceof Error) {
message = err.message;
}
this.message = message;
}
}
private async isDebugEnabled(
board: BoardIdentifier | undefined = this.boardsServiceProvider.boardsConfig
.selectedBoard .selectedBoard
): Promise<string> { ): Promise<void> {
const debugFqbn = await isDebugEnabled( if (!board) {
board, this.disabledMessage = nls.localize(
(fqbn) => this.boardService.getBoardDetails({ fqbn }), 'arduino/common/noBoardSelected',
(fqbn) => this.boardsDataStore.getData(fqbn), 'No board selected'
(fqbn) => this.boardsDataStore.appendConfigToFqbn(fqbn),
(params) => this.boardService.checkDebugEnabled(params)
); );
return debugFqbn; return;
}
const fqbn = board.fqbn;
if (!fqbn) {
this.disabledMessage = nls.localize(
'arduino/debug/noPlatformInstalledFor',
"Platform is not installed for '{0}'",
board.name
);
return;
}
const details = await this.boardService.getBoardDetails({ fqbn });
if (!details) {
this.disabledMessage = nls.localize(
'arduino/debug/noPlatformInstalledFor',
"Platform is not installed for '{0}'",
board.name
);
return;
}
const { debuggingSupported } = details;
if (!debuggingSupported) {
this.disabledMessage = nls.localize(
'arduino/debug/debuggingNotSupported',
"Debugging is not supported by '{0}'",
board.name
);
} else {
this.disabledMessage = undefined;
}
} }
private async startDebug( private async startDebug(
board: BoardIdentifier | undefined = this.boardsServiceProvider.boardsConfig board: Board | undefined = this.boardsServiceProvider.boardsConfig
.selectedBoard, .selectedBoard
sketch: ): Promise<void> {
| CurrentSketch if (!board) {
| undefined = this.sketchServiceClient.tryGetCurrentSketch() return;
): Promise<StartDebugResult> {
if (!CurrentSketch.isValid(sketch)) {
return false;
} }
const params = await this.createStartDebugParams(board); const { name, fqbn } = board;
if (!params) { if (!fqbn) {
return false; return;
} }
await this.hostedPluginSupport.didStart; await this.hostedPluginSupport.didStart;
const [sketch, executables] = await Promise.all([
this.sketchServiceClient.currentSketch(),
this.executableService.list(),
]);
if (!CurrentSketch.isValid(sketch)) {
return;
}
const ideTempFolderUri = await this.sketchesService.getIdeTempFolderUri(
sketch
);
const [cliPath, sketchPath, configPath] = await Promise.all([
this.fileService.fsPath(new URI(executables.cliUri)),
this.fileService.fsPath(new URI(sketch.uri)),
this.fileService.fsPath(new URI(ideTempFolderUri)),
]);
const config = {
cliPath,
board: {
fqbn,
name,
},
sketchPath,
configPath,
};
try { try {
const result = await this.debug(params); await this.commandService.executeCommand('arduino.debug.start', config);
return Boolean(result);
} catch (err) { } catch (err) {
if (await this.isSketchNotVerifiedError(err, sketch)) { if (await this.isSketchNotVerifiedError(err, sketch)) {
const yes = nls.localize('vscode/extensionsUtils/yes', 'Yes'); const yes = nls.localize('vscode/extensionsUtils/yes', 'Yes');
const answer = await this.messageService.error( const answer = await this.messageService.error(
sketchIsNotCompiled(sketch.name), nls.localize(
'arduino/debug/sketchIsNotCompiled',
"Sketch '{0}' must be verified before starting a debug session. Please verify the sketch and start debugging again. Do you want to verify the sketch now?",
sketch.name
),
yes yes
); );
if (answer === yes) { if (answer === yes) {
@@ -259,16 +226,6 @@ export class Debug
); );
} }
} }
return false;
}
private async debug(
params: StartDebugParams
): Promise<StartDebugResult | undefined> {
return this.commandService.executeCommand<StartDebugResult>(
'arduino.debug.start',
params
);
} }
get compileForDebug(): boolean { get compileForDebug(): boolean {
@@ -276,7 +233,7 @@ export class Debug
return value === 'true'; return value === 'true';
} }
private toggleCompileForDebug(): void { async toggleCompileForDebug(): Promise<void> {
const oldState = this.compileForDebug; const oldState = this.compileForDebug;
const newState = !oldState; const newState = !oldState;
window.localStorage.setItem(COMPILE_FOR_DEBUG_KEY, String(newState)); window.localStorage.setItem(COMPILE_FOR_DEBUG_KEY, String(newState));
@@ -285,12 +242,12 @@ export class Debug
private async isSketchNotVerifiedError( private async isSketchNotVerifiedError(
err: unknown, err: unknown,
sketch: SketchRef sketch: Sketch
): Promise<boolean> { ): Promise<boolean> {
if (err instanceof Error) { if (err instanceof Error) {
try { try {
const buildPaths = await this.sketchesService.getBuildPath(sketch); const tempBuildPaths = await this.sketchesService.tempBuildPath(sketch);
return buildPaths.some((tempBuildPath) => return tempBuildPaths.some((tempBuildPath) =>
err.message.includes(tempBuildPath) err.message.includes(tempBuildPath)
); );
} catch { } catch {
@@ -299,48 +256,6 @@ export class Debug
} }
return false; return false;
} }
private async createStartDebugParams(
board: BoardIdentifier | undefined
): Promise<StartDebugParams | undefined> {
if (!board || !board.fqbn) {
return undefined;
}
let debugFqbn: string | undefined = undefined;
try {
debugFqbn = await this.isDebugEnabled(board);
} catch {}
if (!debugFqbn) {
return undefined;
}
const [sketch, executables, boardsData] = await Promise.all([
this.sketchServiceClient.currentSketch(),
this.executableService.list(),
this.boardsDataStore.getData(board.fqbn),
]);
if (!CurrentSketch.isValid(sketch)) {
return undefined;
}
const ideTempFolderUri = await this.sketchesService.getIdeTempFolderUri(
sketch
);
const [cliPath, sketchPath, launchConfigsDirPath] = await Promise.all([
this.fileService.fsPath(new URI(executables.cliUri)),
this.fileService.fsPath(new URI(sketch.uri)),
this.fileService.fsPath(new URI(ideTempFolderUri)),
]);
return {
board: { fqbn: debugFqbn, name: board.name },
cliPath,
sketchPath,
launchConfigsDirPath,
programmer: boardsData.selectedProgrammer?.id,
title: nls.localize(
'arduino/debug/getDebugInfo',
'Getting debug info...'
),
};
}
} }
export namespace Debug { export namespace Debug {
export namespace Commands { export namespace Commands {
@@ -365,78 +280,3 @@ export namespace Debug {
}; };
} }
} }
/**
* Resolves with the FQBN to use for the `debug --info --programmer p --fqbn $FQBN` command. Otherwise, rejects.
*
* (non-API)
*/
export async function isDebugEnabled(
board: BoardIdentifier | undefined,
getDetails: (fqbn: string) => MaybePromise<BoardDetails | undefined>,
getData: (fqbn: string) => MaybePromise<BoardsDataStore.Data>,
appendConfigToFqbn: (fqbn: string) => MaybePromise<string | undefined>,
checkDebugEnabled: (params: CheckDebugEnabledParams) => MaybePromise<string>
): Promise<string> {
if (!board) {
throw new Error(noBoardSelected);
}
const { fqbn } = board;
if (!fqbn) {
throw new Error(noPlatformInstalledFor(board.name));
}
const [details, data, fqbnWithConfig] = await Promise.all([
getDetails(fqbn),
getData(fqbn),
appendConfigToFqbn(fqbn),
]);
if (!details) {
throw new Error(noPlatformInstalledFor(board.name));
}
if (!fqbnWithConfig) {
throw new Error(
`Failed to append boards config to the FQBN. Original FQBN was: ${fqbn}`
);
}
const params = {
fqbn: fqbnWithConfig,
programmer: data.selectedProgrammer?.id,
};
try {
const debugFqbn = await checkDebugEnabled(params);
return debugFqbn;
} catch (err) {
throw new Error(debuggingNotSupported(board.name));
}
}
/**
* (non-API)
*/
export function sketchIsNotCompiled(sketchName: string): string {
return nls.localize(
'arduino/debug/sketchIsNotCompiled',
"Sketch '{0}' must be verified before starting a debug session. Please verify the sketch and start debugging again. Do you want to verify the sketch now?",
sketchName
);
}
/**
* (non-API)
*/
export function noPlatformInstalledFor(boardName: string): string {
return nls.localize(
'arduino/debug/noPlatformInstalledFor',
"Platform is not installed for '{0}'",
boardName
);
}
/**
* (non-API)
*/
export function debuggingNotSupported(boardName: string): string {
return nls.localize(
'arduino/debug/debuggingNotSupported',
"Debugging is not supported by '{0}'",
boardName
);
}

View File

@@ -1,3 +1,5 @@
import * as remote from '@theia/core/electron-shared/@electron/remote';
import { ipcRenderer } from '@theia/core/electron-shared/electron';
import { Dialog } from '@theia/core/lib/browser/dialogs'; import { Dialog } from '@theia/core/lib/browser/dialogs';
import { NavigatableWidget } from '@theia/core/lib/browser/navigatable-types'; import { NavigatableWidget } from '@theia/core/lib/browser/navigatable-types';
import { ApplicationShell } from '@theia/core/lib/browser/shell/application-shell'; import { ApplicationShell } from '@theia/core/lib/browser/shell/application-shell';
@@ -8,11 +10,11 @@ import URI from '@theia/core/lib/common/uri';
import type { Widget } from '@theia/core/shared/@phosphor/widgets'; import type { Widget } from '@theia/core/shared/@phosphor/widgets';
import { inject, injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import { SketchesError } from '../../common/protocol'; import { SketchesError } from '../../common/protocol';
import { SCHEDULE_DELETION_SIGNAL } from '../../electron-common/electron-messages';
import { Sketch } from '../contributions/contribution'; import { Sketch } from '../contributions/contribution';
import { isNotFound } from '../create/typings'; import { isNotFound } from '../create/typings';
import { Command, CommandRegistry } from './contribution'; import { Command, CommandRegistry } from './contribution';
import { CloudSketchContribution } from './cloud-contribution'; import { CloudSketchContribution } from './cloud-contribution';
import { AppService } from '../app-service';
export interface DeleteSketchParams { export interface DeleteSketchParams {
/** /**
@@ -36,8 +38,6 @@ export class DeleteSketch extends CloudSketchContribution {
private readonly shell: ApplicationShell; private readonly shell: ApplicationShell;
@inject(WindowService) @inject(WindowService)
private readonly windowService: WindowService; private readonly windowService: WindowService;
@inject(AppService)
private readonly appService: AppService;
override registerCommands(registry: CommandRegistry): void { override registerCommands(registry: CommandRegistry): void {
registry.registerCommand(DeleteSketch.Commands.DELETE_SKETCH, { registry.registerCommand(DeleteSketch.Commands.DELETE_SKETCH, {
@@ -66,7 +66,7 @@ export class DeleteSketch extends CloudSketchContribution {
} }
const cloudUri = this.createFeatures.cloudUri(sketch); const cloudUri = this.createFeatures.cloudUri(sketch);
if (willNavigateAway !== 'force') { if (willNavigateAway !== 'force') {
const { response } = await this.dialogService.showMessageBox({ const { response } = await remote.dialog.showMessageBox({
title: nls.localizeByDefault('Delete'), title: nls.localizeByDefault('Delete'),
type: 'question', type: 'question',
buttons: [Dialog.CANCEL, Dialog.OK], buttons: [Dialog.CANCEL, Dialog.OK],
@@ -120,7 +120,7 @@ export class DeleteSketch extends CloudSketchContribution {
} }
private scheduleDeletion(sketch: Sketch): void { private scheduleDeletion(sketch: Sketch): void {
this.appService.scheduleDeletion(sketch); ipcRenderer.send(SCHEDULE_DELETION_SIGNAL, sketch);
} }
private async loadSketch(uri: string): Promise<Sketch | undefined> { private async loadSketch(uri: string): Promise<Sketch | undefined> {

View File

@@ -1,7 +1,11 @@
import PQueue from 'p-queue'; import * as PQueue from 'p-queue';
import { inject, injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import { CommandHandler, CommandService } from '@theia/core/lib/common/command'; import { CommandHandler, CommandService } from '@theia/core/lib/common/command';
import { MenuPath, SubMenuOptions } from '@theia/core/lib/common/menu'; import {
MenuPath,
CompositeMenuNode,
SubMenuOptions,
} from '@theia/core/lib/common/menu';
import { import {
Disposable, Disposable,
DisposableCollection, DisposableCollection,
@@ -28,8 +32,6 @@ import {
CoreService, CoreService,
SketchesService, SketchesService,
Sketch, Sketch,
isBoardIdentifierChangeEvent,
BoardIdentifier,
} from '../../common/protocol'; } from '../../common/protocol';
import { nls } from '@theia/core/lib/common/nls'; import { nls } from '@theia/core/lib/common/nls';
import { unregisterSubmenu } from '../menu/arduino-menus'; import { unregisterSubmenu } from '../menu/arduino-menus';
@@ -110,7 +112,7 @@ export abstract class Examples extends SketchContribution {
protected readonly coreService: CoreService; protected readonly coreService: CoreService;
@inject(BoardsServiceProvider) @inject(BoardsServiceProvider)
protected readonly boardsServiceProvider: BoardsServiceProvider; protected readonly boardsServiceClient: BoardsServiceProvider;
@inject(NotificationCenter) @inject(NotificationCenter)
protected readonly notificationCenter: NotificationCenter; protected readonly notificationCenter: NotificationCenter;
@@ -119,14 +121,12 @@ export abstract class Examples extends SketchContribution {
protected override init(): void { protected override init(): void {
super.init(); super.init();
this.boardsServiceProvider.onBoardsConfigDidChange((event) => { this.boardsServiceClient.onBoardsConfigChanged(({ selectedBoard }) =>
if (isBoardIdentifierChangeEvent(event)) { this.handleBoardChanged(selectedBoard)
this.handleBoardChanged(event.selectedBoard); );
}
});
this.notificationCenter.onDidReinitialize(() => this.notificationCenter.onDidReinitialize(() =>
this.update({ this.update({
board: this.boardsServiceProvider.boardsConfig.selectedBoard, board: this.boardsServiceClient.boardsConfig.selectedBoard,
// No force refresh. The core client was already refreshed. // No force refresh. The core client was already refreshed.
}) })
); );
@@ -138,11 +138,24 @@ export abstract class Examples extends SketchContribution {
} }
protected abstract update(options?: { protected abstract update(options?: {
board?: BoardIdentifier | undefined; board?: Board | undefined;
forceRefresh?: boolean; forceRefresh?: boolean;
}): void; }): void;
override registerMenus(registry: MenuModelRegistry): void { override registerMenus(registry: MenuModelRegistry): void {
try {
// This is a hack the ensures the desired menu ordering! We cannot use https://github.com/eclipse-theia/theia/pull/8377 due to ATL-222.
const index = ArduinoMenus.FILE__EXAMPLES_SUBMENU.length - 1;
const menuId = ArduinoMenus.FILE__EXAMPLES_SUBMENU[index];
const groupPath =
index === 0 ? [] : ArduinoMenus.FILE__EXAMPLES_SUBMENU.slice(0, index);
const parent: CompositeMenuNode = (registry as any).findGroup(groupPath);
const examples = new CompositeMenuNode(menuId, '', { order: '4' });
parent.addNode(examples);
} catch (e) {
console.error(e);
console.warn('Could not patch menu ordering.');
}
// Registering the same submenu multiple times has no side-effect. // Registering the same submenu multiple times has no side-effect.
// TODO: unregister submenu? https://github.com/eclipse-theia/theia/issues/7300 // TODO: unregister submenu? https://github.com/eclipse-theia/theia/issues/7300
registry.registerSubmenu( registry.registerSubmenu(
@@ -229,7 +242,7 @@ export abstract class Examples extends SketchContribution {
protected createHandler(uri: string): CommandHandler { protected createHandler(uri: string): CommandHandler {
const forceUpdate = () => const forceUpdate = () =>
this.update({ this.update({
board: this.boardsServiceProvider.boardsConfig.selectedBoard, board: this.boardsServiceClient.boardsConfig.selectedBoard,
forceRefresh: true, forceRefresh: true,
}); });
return { return {
@@ -300,8 +313,8 @@ export class LibraryExamples extends Examples {
this.notificationCenter.onLibraryDidUninstall(() => this.update()); this.notificationCenter.onLibraryDidUninstall(() => this.update());
} }
override onReady(): void { override async onReady(): Promise<void> {
this.boardsServiceProvider.ready.then(() => this.update()); this.update(); // no `await`
} }
protected override handleBoardChanged(board: Board | undefined): void { protected override handleBoardChanged(board: Board | undefined): void {
@@ -310,7 +323,7 @@ export class LibraryExamples extends Examples {
protected override async update( protected override async update(
options: { board?: Board; forceRefresh?: boolean } = { options: { board?: Board; forceRefresh?: boolean } = {
board: this.boardsServiceProvider.boardsConfig.selectedBoard, board: this.boardsServiceClient.boardsConfig.selectedBoard,
} }
): Promise<void> { ): Promise<void> {
const { board, forceRefresh } = options; const { board, forceRefresh } = options;

View File

@@ -1,7 +1,8 @@
import PQueue from 'p-queue'; import * as PQueue from 'p-queue';
import { inject, injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import URI from '@theia/core/lib/common/uri'; import URI from '@theia/core/lib/common/uri';
import { MonacoEditor } from '@theia/monaco/lib/browser/monaco-editor'; import { MonacoEditor } from '@theia/monaco/lib/browser/monaco-editor';
import { EditorManager } from '@theia/editor/lib/browser';
import { MenuModelRegistry, MenuPath } from '@theia/core/lib/common/menu'; import { MenuModelRegistry, MenuPath } from '@theia/core/lib/common/menu';
import { import {
Disposable, Disposable,
@@ -21,28 +22,31 @@ import { CurrentSketch } from '../sketches-service-client-impl';
@injectable() @injectable()
export class IncludeLibrary extends SketchContribution { export class IncludeLibrary extends SketchContribution {
@inject(CommandRegistry) @inject(CommandRegistry)
private readonly commandRegistry: CommandRegistry; protected readonly commandRegistry: CommandRegistry;
@inject(MenuModelRegistry) @inject(MenuModelRegistry)
private readonly menuRegistry: MenuModelRegistry; protected readonly menuRegistry: MenuModelRegistry;
@inject(MainMenuManager) @inject(MainMenuManager)
private readonly mainMenuManager: MainMenuManager; protected readonly mainMenuManager: MainMenuManager;
@inject(EditorManager)
protected override readonly editorManager: EditorManager;
@inject(NotificationCenter) @inject(NotificationCenter)
private readonly notificationCenter: NotificationCenter; protected readonly notificationCenter: NotificationCenter;
@inject(BoardsServiceProvider) @inject(BoardsServiceProvider)
private readonly boardsServiceProvider: BoardsServiceProvider; protected readonly boardsServiceClient: BoardsServiceProvider;
@inject(LibraryService) @inject(LibraryService)
private readonly libraryService: LibraryService; protected readonly libraryService: LibraryService;
private readonly queue = new PQueue({ autoStart: true, concurrency: 1 }); protected readonly queue = new PQueue({ autoStart: true, concurrency: 1 });
private readonly toDispose = new DisposableCollection(); protected readonly toDispose = new DisposableCollection();
override onStart(): void { override onStart(): void {
this.boardsServiceProvider.onBoardsConfigDidChange(() => this.boardsServiceClient.onBoardsConfigChanged(() =>
this.updateMenuActions() this.updateMenuActions()
); );
this.notificationCenter.onLibraryDidInstall(() => this.updateMenuActions()); this.notificationCenter.onLibraryDidInstall(() => this.updateMenuActions());
@@ -52,8 +56,8 @@ export class IncludeLibrary extends SketchContribution {
this.notificationCenter.onDidReinitialize(() => this.updateMenuActions()); this.notificationCenter.onDidReinitialize(() => this.updateMenuActions());
} }
override onReady(): void { override async onReady(): Promise<void> {
this.boardsServiceProvider.ready.then(() => this.updateMenuActions()); this.updateMenuActions();
} }
override registerMenus(registry: MenuModelRegistry): void { override registerMenus(registry: MenuModelRegistry): void {
@@ -89,12 +93,12 @@ export class IncludeLibrary extends SketchContribution {
}); });
} }
private async updateMenuActions(): Promise<void> { protected async updateMenuActions(): Promise<void> {
return this.queue.add(async () => { return this.queue.add(async () => {
this.toDispose.dispose(); this.toDispose.dispose();
this.mainMenuManager.update(); this.mainMenuManager.update();
const libraries: LibraryPackage[] = []; const libraries: LibraryPackage[] = [];
const fqbn = this.boardsServiceProvider.boardsConfig.selectedBoard?.fqbn; const fqbn = this.boardsServiceClient.boardsConfig.selectedBoard?.fqbn;
// Show all libraries, when no board is selected. // Show all libraries, when no board is selected.
// Otherwise, show libraries only for the selected board. // Otherwise, show libraries only for the selected board.
libraries.push(...(await this.libraryService.list({ fqbn }))); libraries.push(...(await this.libraryService.list({ fqbn })));
@@ -135,7 +139,7 @@ export class IncludeLibrary extends SketchContribution {
}); });
} }
private registerLibrary( protected registerLibrary(
libraryOrPlaceholder: LibraryPackage | string, libraryOrPlaceholder: LibraryPackage | string,
menuPath: MenuPath menuPath: MenuPath
): Disposable { ): Disposable {
@@ -168,7 +172,7 @@ export class IncludeLibrary extends SketchContribution {
); );
} }
private async includeLibrary(library: LibraryPackage): Promise<void> { protected async includeLibrary(library: LibraryPackage): Promise<void> {
const sketch = await this.sketchServiceClient.currentSketch(); const sketch = await this.sketchServiceClient.currentSketch();
if (!CurrentSketch.isValid(sketch)) { if (!CurrentSketch.isValid(sketch)) {
return; return;

View File

@@ -1,110 +1,41 @@
import { import { DisposableCollection } from '@theia/core/lib/common/disposable';
Disposable,
DisposableCollection,
} from '@theia/core/lib/common/disposable';
import { inject, injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import { Mutex } from 'async-mutex'; import { Mutex } from 'async-mutex';
import { import {
ArduinoDaemon, ArduinoDaemon,
BoardIdentifier, assertSanitizedFqbn,
BoardsService, BoardsService,
ExecutableService, ExecutableService,
isBoardIdentifierChangeEvent,
sanitizeFqbn, sanitizeFqbn,
} from '../../common/protocol'; } from '../../common/protocol';
import {
defaultAsyncWorkers,
maxAsyncWorkers,
minAsyncWorkers,
} from '../arduino-preferences';
import { BoardsDataStore } from '../boards/boards-data-store';
import { BoardsServiceProvider } from '../boards/boards-service-provider';
import { HostedPluginEvents } from '../hosted/hosted-plugin-events';
import { NotificationCenter } from '../notification-center';
import { CurrentSketch } from '../sketches-service-client-impl'; import { CurrentSketch } from '../sketches-service-client-impl';
import { BoardsConfig } from '../boards/boards-config';
import { BoardsServiceProvider } from '../boards/boards-service-provider';
import { HostedPluginEvents } from '../hosted-plugin-events';
import { NotificationCenter } from '../notification-center';
import { SketchContribution, URI } from './contribution'; import { SketchContribution, URI } from './contribution';
import { BoardsDataStore } from '../boards/boards-data-store';
interface DaemonAddress {
/**
* The host where the Arduino CLI daemon is available.
*/
readonly hostname: string;
/**
* The port where the Arduino CLI daemon is listening.
*/
readonly port: number;
/**
* The [id](https://arduino.github.io/arduino-cli/latest/rpc/commands/#instance) of the initialized core Arduino client instance.
*/
readonly instance: number;
}
interface StartLanguageServerParams {
/**
* Absolute filesystem path to the Arduino Language Server executable.
*/
readonly lsPath: string;
/**
* The hostname and the port for the gRPC channel connecting to the Arduino CLI daemon.
* The `instance` number is for the initialized core Arduino client.
*/
readonly daemonAddress: DaemonAddress;
/**
* Absolute filesystem path to [`clangd`](https://clangd.llvm.org/).
*/
readonly clangdPath: string;
/**
* The board is relevant to start a specific "flavor" of the language.
*/
readonly board: { fqbn: string; name?: string };
/**
* `true` if the LS should generate the log files into the default location. The default location is the `cwd` of the process.
* It's very often the same as the workspace root of the IDE, aka the sketch folder.
* When it is a string, it is the absolute filesystem path to the folder to generate the log files.
* If `string`, but the path is inaccessible, the log files will be generated into the default location.
*/
readonly log?: boolean | string;
/**
* Optional `env` for the language server process.
*/
readonly env?: NodeJS.ProcessEnv;
/**
* Additional flags for the Arduino Language server process.
*/
readonly flags?: readonly string[];
/**
* Set to `true`, to enable `Diagnostics`.
*/
readonly realTimeDiagnostics?: boolean;
/**
* If `true`, the logging is not forwarded to the _Output_ view via the language client.
*/
readonly silentOutput?: boolean;
/**
* Number of async workers used by `clangd`. Background index also uses this many workers. If `0`, `clangd` uses all available cores. It's `0` by default.
*/
readonly jobs?: number;
}
/**
* The FQBN the language server runs with or `undefined` if it could not start.
*/
type StartLanguageServerResult = string | undefined;
@injectable() @injectable()
export class InoLanguage extends SketchContribution { export class InoLanguage extends SketchContribution {
@inject(HostedPluginEvents) @inject(HostedPluginEvents)
private readonly hostedPluginEvents: HostedPluginEvents; private readonly hostedPluginEvents: HostedPluginEvents;
@inject(ExecutableService) @inject(ExecutableService)
private readonly executableService: ExecutableService; private readonly executableService: ExecutableService;
@inject(ArduinoDaemon) @inject(ArduinoDaemon)
private readonly daemon: ArduinoDaemon; private readonly daemon: ArduinoDaemon;
@inject(BoardsService) @inject(BoardsService)
private readonly boardsService: BoardsService; private readonly boardsService: BoardsService;
@inject(BoardsServiceProvider) @inject(BoardsServiceProvider)
private readonly boardsServiceProvider: BoardsServiceProvider; private readonly boardsServiceProvider: BoardsServiceProvider;
@inject(NotificationCenter) @inject(NotificationCenter)
private readonly notificationCenter: NotificationCenter; private readonly notificationCenter: NotificationCenter;
@inject(BoardsDataStore) @inject(BoardsDataStore)
private readonly boardDataStore: BoardsDataStore; private readonly boardDataStore: BoardsDataStore;
@@ -114,7 +45,7 @@ export class InoLanguage extends SketchContribution {
override onReady(): void { override onReady(): void {
const start = ( const start = (
selectedBoard: BoardIdentifier | undefined, { selectedBoard }: BoardsConfig.Config,
forceStart = false forceStart = false
) => { ) => {
if (selectedBoard) { if (selectedBoard) {
@@ -125,16 +56,12 @@ export class InoLanguage extends SketchContribution {
} }
}; };
const forceRestart = () => { const forceRestart = () => {
start(this.boardsServiceProvider.boardsConfig.selectedBoard, true); start(this.boardsServiceProvider.boardsConfig, true);
}; };
this.toDispose.pushAll([ this.toDispose.pushAll([
this.boardsServiceProvider.onBoardsConfigDidChange((event) => { this.boardsServiceProvider.onBoardsConfigChanged(start),
if (isBoardIdentifierChangeEvent(event)) {
start(event.selectedBoard);
}
}),
this.hostedPluginEvents.onPluginsDidStart(() => this.hostedPluginEvents.onPluginsDidStart(() =>
start(this.boardsServiceProvider.boardsConfig.selectedBoard) start(this.boardsServiceProvider.boardsConfig)
), ),
this.hostedPluginEvents.onPluginsWillUnload( this.hostedPluginEvents.onPluginsWillUnload(
() => (this.languageServerFqbn = undefined) () => (this.languageServerFqbn = undefined)
@@ -145,7 +72,6 @@ export class InoLanguage extends SketchContribution {
switch (preferenceName) { switch (preferenceName) {
case 'arduino.language.log': case 'arduino.language.log':
case 'arduino.language.realTimeDiagnostics': case 'arduino.language.realTimeDiagnostics':
case 'arduino.language.asyncWorkers':
forceRestart(); forceRestart();
} }
} }
@@ -156,30 +82,28 @@ export class InoLanguage extends SketchContribution {
this.notificationCenter.onPlatformDidInstall(() => forceRestart()), this.notificationCenter.onPlatformDidInstall(() => forceRestart()),
this.notificationCenter.onPlatformDidUninstall(() => forceRestart()), this.notificationCenter.onPlatformDidUninstall(() => forceRestart()),
this.notificationCenter.onDidReinitialize(() => forceRestart()), this.notificationCenter.onDidReinitialize(() => forceRestart()),
this.boardDataStore.onDidChange((event) => { this.boardDataStore.onChanged((dataChangePerFqbn) => {
if (this.languageServerFqbn) { if (this.languageServerFqbn) {
const sanitizedFQBN = sanitizeFqbn(this.languageServerFqbn); const sanitizedFqbn = sanitizeFqbn(this.languageServerFqbn);
// The incoming FQBNs might contain custom boards configs, sanitize them before the comparison. if (!sanitizeFqbn) {
// https://github.com/arduino/arduino-ide/pull/2113#pullrequestreview-1499998328 throw new Error(
const matchingChange = event.changes.find( `Failed to sanitize the FQBN of the running language server. FQBN with the board settings was: ${this.languageServerFqbn}`
(change) => sanitizedFQBN === sanitizeFqbn(change.fqbn) );
}
const matchingFqbn = dataChangePerFqbn.find(
(fqbn) => sanitizedFqbn === fqbn
); );
const { boardsConfig } = this.boardsServiceProvider; const { boardsConfig } = this.boardsServiceProvider;
if ( if (
matchingChange && matchingFqbn &&
boardsConfig.selectedBoard?.fqbn === matchingChange.fqbn boardsConfig.selectedBoard?.fqbn === matchingFqbn
) { ) {
start(boardsConfig.selectedBoard); start(boardsConfig);
} }
} }
}), }),
]); ]);
Promise.all([ start(this.boardsServiceProvider.boardsConfig);
this.boardsServiceProvider.ready,
this.preferences.ready,
]).then(() => {
start(this.boardsServiceProvider.boardsConfig.selectedBoard);
});
} }
onStop(): void { onStop(): void {
@@ -192,11 +116,10 @@ export class InoLanguage extends SketchContribution {
forceStart = false forceStart = false
): Promise<void> { ): Promise<void> {
const port = await this.daemon.tryGetPort(); const port = await this.daemon.tryGetPort();
if (typeof port !== 'number') { if (!port) {
return; return;
} }
const release = await this.languageServerStartMutex.acquire(); const release = await this.languageServerStartMutex.acquire();
const toDisposeOnRelease = new DisposableCollection();
try { try {
await this.hostedPluginEvents.didStart; await this.hostedPluginEvents.didStart;
const details = await this.boardsService.getBoardDetails({ fqbn }); const details = await this.boardsService.getBoardDetails({ fqbn });
@@ -224,6 +147,7 @@ export class InoLanguage extends SketchContribution {
} }
return; return;
} }
assertSanitizedFqbn(fqbn);
const fqbnWithConfig = await this.boardDataStore.appendConfigToFqbn(fqbn); const fqbnWithConfig = await this.boardDataStore.appendConfigToFqbn(fqbn);
if (!fqbnWithConfig) { if (!fqbnWithConfig) {
throw new Error( throw new Error(
@@ -234,16 +158,11 @@ export class InoLanguage extends SketchContribution {
// NOOP // NOOP
return; return;
} }
this.logger.info(`Starting language server: ${fqbnWithConfig}`);
const log = this.preferences.get('arduino.language.log'); const log = this.preferences.get('arduino.language.log');
const realTimeDiagnostics = this.preferences.get( const realTimeDiagnostics = this.preferences.get(
'arduino.language.realTimeDiagnostics' 'arduino.language.realTimeDiagnostics'
); );
const jobs = this.getAsyncWorkersPreferenceSafe();
this.logger.info(
`Starting language server: ${fqbnWithConfig}${
jobs ? ` (async worker count: ${jobs})` : ''
}`
);
let currentSketchPath: string | undefined = undefined; let currentSketchPath: string | undefined = undefined;
if (log) { if (log) {
const currentSketch = await this.sketchServiceClient.currentSketch(); const currentSketch = await this.sketchServiceClient.currentSketch();
@@ -260,61 +179,34 @@ export class InoLanguage extends SketchContribution {
]); ]);
this.languageServerFqbn = await Promise.race([ this.languageServerFqbn = await Promise.race([
new Promise<undefined>((_, reject) => { new Promise<undefined>((_, reject) =>
const timer = setTimeout( setTimeout(
() => reject(new Error(`Timeout after ${20_000} ms.`)), () => reject(new Error(`Timeout after ${20_000} ms.`)),
20_000 20_000
); )
toDisposeOnRelease.push(Disposable.create(() => clearTimeout(timer))); ),
}), this.commandService.executeCommand<string>(
this.start({ 'arduino.languageserver.start',
{
lsPath, lsPath,
daemonAddress: { cliDaemonAddr: `localhost:${port}`,
hostname: 'localhost',
port,
instance: 1, // TODO: get it from the backend
},
clangdPath, clangdPath,
log: currentSketchPath ? currentSketchPath : log, log: currentSketchPath ? currentSketchPath : log,
cliDaemonInstance: '1',
board: { board: {
fqbn: fqbnWithConfig, fqbn: fqbnWithConfig,
name, name: name ? `"${name}"` : undefined,
}, },
realTimeDiagnostics, realTimeDiagnostics,
silentOutput: true, silentOutput: true,
jobs, }
}), ),
]); ]);
} catch (e) { } catch (e) {
console.log(`Failed to start language server. Original FQBN: ${fqbn}`, e); console.log(`Failed to start language server. Original FQBN: ${fqbn}`, e);
this.languageServerFqbn = undefined; this.languageServerFqbn = undefined;
} finally { } finally {
toDisposeOnRelease.dispose();
release(); release();
} }
} }
// The Theia preference UI validation is bogus.
// To restrict the number of jobs to a valid value.
private getAsyncWorkersPreferenceSafe(): number {
const jobs = this.preferences.get(
'arduino.language.asyncWorkers',
defaultAsyncWorkers
);
if (jobs < minAsyncWorkers) {
return minAsyncWorkers;
}
if (jobs > maxAsyncWorkers) {
return maxAsyncWorkers;
}
return jobs;
}
private async start(
params: StartLanguageServerParams
): Promise<StartLanguageServerResult | undefined> {
return this.commandService.executeCommand<StartLanguageServerResult>(
'arduino.languageserver.start',
params
);
}
} }

View File

@@ -8,7 +8,7 @@ import {
import { ArduinoMenus } from '../menu/arduino-menus'; import { ArduinoMenus } from '../menu/arduino-menus';
import { CommandRegistry, MaybePromise, nls } from '@theia/core/lib/common'; import { CommandRegistry, MaybePromise, nls } from '@theia/core/lib/common';
import { Settings } from '../dialogs/settings/settings'; import { Settings } from '../dialogs/settings/settings';
import debounce from 'lodash.debounce'; import debounce = require('lodash.debounce');
@injectable() @injectable()
export class InterfaceScale extends Contribution { export class InterfaceScale extends Contribution {

View File

@@ -1,18 +1,25 @@
import type { Command, CommandRegistry } from '@theia/core/lib/common/command'; import { CommandRegistry } from '@theia/core';
import { inject, injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import type { EditBoardsConfigActionParams } from '../../common/protocol/board-list';
import { BoardsConfigDialog } from '../boards/boards-config-dialog'; import { BoardsConfigDialog } from '../boards/boards-config-dialog';
import { Contribution } from './contribution'; import { BoardsServiceProvider } from '../boards/boards-service-provider';
import { Contribution, Command } from './contribution';
@injectable() @injectable()
export class OpenBoardsConfig extends Contribution { export class OpenBoardsConfig extends Contribution {
@inject(BoardsServiceProvider)
private readonly boardsServiceProvider: BoardsServiceProvider;
@inject(BoardsConfigDialog) @inject(BoardsConfigDialog)
private readonly boardsConfigDialog: BoardsConfigDialog; private readonly boardsConfigDialog: BoardsConfigDialog;
override registerCommands(registry: CommandRegistry): void { override registerCommands(registry: CommandRegistry): void {
registry.registerCommand(OpenBoardsConfig.Commands.OPEN_DIALOG, { registry.registerCommand(OpenBoardsConfig.Commands.OPEN_DIALOG, {
execute: async (params?: EditBoardsConfigActionParams) => execute: async (query?: string | undefined) => {
this.boardsConfigDialog.open(params), const boardsConfig = await this.boardsConfigDialog.open(query);
if (boardsConfig) {
return (this.boardsServiceProvider.boardsConfig = boardsConfig);
}
},
}); });
} }
} }

View File

@@ -1,4 +1,5 @@
import { injectable } from '@theia/core/shared/inversify'; import { injectable } from '@theia/core/shared/inversify';
import * as remote from '@theia/core/electron-shared/@electron/remote';
import URI from '@theia/core/lib/common/uri'; import URI from '@theia/core/lib/common/uri';
import { ArduinoMenus } from '../menu/arduino-menus'; import { ArduinoMenus } from '../menu/arduino-menus';
import { import {
@@ -8,7 +9,7 @@ import {
MenuModelRegistry, MenuModelRegistry,
KeybindingRegistry, KeybindingRegistry,
} from './contribution'; } from './contribution';
import { nls } from '@theia/core/lib/common/nls'; import { nls } from '@theia/core/lib/common';
@injectable() @injectable()
export class OpenSketchExternal extends SketchContribution { export class OpenSketchExternal extends SketchContribution {
@@ -40,7 +41,7 @@ export class OpenSketchExternal extends SketchContribution {
if (exists) { if (exists) {
const fsPath = await this.fileService.fsPath(new URI(uri)); const fsPath = await this.fileService.fsPath(new URI(uri));
if (fsPath) { if (fsPath) {
window.electronTheiaCore.showItemInFolder(fsPath); remote.shell.showItemInFolder(fsPath);
} }
} }
} }

View File

@@ -45,11 +45,7 @@ export class OpenSketchFiles extends SketchContribution {
await this.ensureOpened(uri); await this.ensureOpened(uri);
} }
if (focusMainSketchFile) { if (focusMainSketchFile) {
await this.ensureOpened(mainFileUri, true, { await this.ensureOpened(mainFileUri, true, { mode: 'activate' });
mode: 'activate',
preview: false,
counter: 0,
});
} }
if (mainFileUri.endsWith('.pde')) { if (mainFileUri.endsWith('.pde')) {
const message = nls.localize( const message = nls.localize(
@@ -118,7 +114,6 @@ export class OpenSketchFiles extends SketchContribution {
fileService: this.fileService, fileService: this.fileService,
sketchesService: this.sketchesService, sketchesService: this.sketchesService,
labelProvider: this.labelProvider, labelProvider: this.labelProvider,
dialogService: this.dialogService,
}); });
if (movedSketch) { if (movedSketch) {
this.workspaceService.open(new URI(movedSketch.uri), { this.workspaceService.open(new URI(movedSketch.uri), {

View File

@@ -1,3 +1,4 @@
import * as remote from '@theia/core/electron-shared/@electron/remote';
import { nls } from '@theia/core/lib/common/nls'; import { nls } from '@theia/core/lib/common/nls';
import { injectable } from '@theia/core/shared/inversify'; import { injectable } from '@theia/core/shared/inversify';
import { FileService } from '@theia/filesystem/lib/browser/file-service'; import { FileService } from '@theia/filesystem/lib/browser/file-service';
@@ -17,7 +18,6 @@ import {
SketchContribution, SketchContribution,
URI, URI,
} from './contribution'; } from './contribution';
import { DialogService } from '../dialog-service';
export type SketchLocation = string | URI | SketchRef; export type SketchLocation = string | URI | SketchRef;
export namespace SketchLocation { export namespace SketchLocation {
@@ -83,7 +83,9 @@ export class OpenSketch extends SketchContribution {
private async selectSketch(): Promise<Sketch | undefined> { private async selectSketch(): Promise<Sketch | undefined> {
const defaultPath = await this.defaultPath(); const defaultPath = await this.defaultPath();
const { filePaths } = await this.dialogService.showOpenDialog({ const { filePaths } = await remote.dialog.showOpenDialog(
remote.getCurrentWindow(),
{
defaultPath, defaultPath,
properties: ['createDirectory', 'openFile'], properties: ['createDirectory', 'openFile'],
filters: [ filters: [
@@ -92,7 +94,8 @@ export class OpenSketch extends SketchContribution {
extensions: ['ino', 'pde'], extensions: ['ino', 'pde'],
}, },
], ],
}); }
);
if (!filePaths.length) { if (!filePaths.length) {
return undefined; return undefined;
} }
@@ -112,7 +115,6 @@ export class OpenSketch extends SketchContribution {
fileService: this.fileService, fileService: this.fileService,
sketchesService: this.sketchesService, sketchesService: this.sketchesService,
labelProvider: this.labelProvider, labelProvider: this.labelProvider,
dialogService: this.dialogService,
}); });
} }
} }
@@ -132,16 +134,14 @@ export async function promptMoveSketch(
fileService: FileService; fileService: FileService;
sketchesService: SketchesService; sketchesService: SketchesService;
labelProvider: LabelProvider; labelProvider: LabelProvider;
dialogService: DialogService;
} }
): Promise<Sketch | undefined> { ): Promise<Sketch | undefined> {
const { fileService, sketchesService, labelProvider, dialogService } = const { fileService, sketchesService, labelProvider } = options;
options;
const uri = const uri =
sketchFileUri instanceof URI ? sketchFileUri : new URI(sketchFileUri); sketchFileUri instanceof URI ? sketchFileUri : new URI(sketchFileUri);
const name = uri.path.name; const name = uri.path.name;
const nameWithExt = labelProvider.getName(uri); const nameWithExt = labelProvider.getName(uri);
const { response } = await dialogService.showMessageBox({ const { response } = await remote.dialog.showMessageBox({
title: nls.localize('arduino/sketch/moving', 'Moving'), title: nls.localize('arduino/sketch/moving', 'Moving'),
type: 'question', type: 'question',
buttons: [ buttons: [
@@ -160,7 +160,7 @@ export async function promptMoveSketch(
const newSketchUri = uri.parent.resolve(name); const newSketchUri = uri.parent.resolve(name);
const exists = await fileService.exists(newSketchUri); const exists = await fileService.exists(newSketchUri);
if (exists) { if (exists) {
await dialogService.showMessageBox({ await remote.dialog.showMessageBox({
type: 'error', type: 'error',
title: nls.localize('vscode/dialog/dialogErrorMessage', 'Error'), title: nls.localize('vscode/dialog/dialogErrorMessage', 'Error'),
message: nls.localize( message: nls.localize(

View File

@@ -1,4 +1,5 @@
import { inject, injectable } from '@theia/core/shared/inversify'; import { injectable } from '@theia/core/shared/inversify';
import * as remote from '@theia/core/electron-shared/@electron/remote';
import { isOSX } from '@theia/core/lib/common/os'; import { isOSX } from '@theia/core/lib/common/os';
import { import {
Contribution, Contribution,
@@ -8,18 +9,14 @@ import {
CommandRegistry, CommandRegistry,
} from './contribution'; } from './contribution';
import { ArduinoMenus } from '../menu/arduino-menus'; import { ArduinoMenus } from '../menu/arduino-menus';
import { nls } from '@theia/core/lib/common/nls'; import { nls } from '@theia/core/lib/common';
import { AppService } from '../app-service';
@injectable() @injectable()
export class QuitApp extends Contribution { export class QuitApp extends Contribution {
@inject(AppService)
private readonly appService: AppService;
override registerCommands(registry: CommandRegistry): void { override registerCommands(registry: CommandRegistry): void {
if (!isOSX) { if (!isOSX) {
registry.registerCommand(QuitApp.Commands.QUIT_APP, { registry.registerCommand(QuitApp.Commands.QUIT_APP, {
execute: () => this.appService.quit(), execute: () => remote.app.quit(),
}); });
} }
} }

View File

@@ -1,15 +1,14 @@
import * as remote from '@theia/core/electron-shared/@electron/remote';
import { Dialog } from '@theia/core/lib/browser/dialogs'; import { Dialog } from '@theia/core/lib/browser/dialogs';
import { NavigatableWidget } from '@theia/core/lib/browser/navigatable'; import { NavigatableWidget } from '@theia/core/lib/browser/navigatable';
import { Saveable } from '@theia/core/lib/browser/saveable'; import { Saveable } from '@theia/core/lib/browser/saveable';
import { ApplicationShell } from '@theia/core/lib/browser/shell/application-shell'; import { ApplicationShell } from '@theia/core/lib/browser/shell/application-shell';
import { WindowService } from '@theia/core/lib/browser/window/window-service'; import { WindowService } from '@theia/core/lib/browser/window/window-service';
import { ApplicationError } from '@theia/core/lib/common/application-error';
import { nls } from '@theia/core/lib/common/nls'; import { nls } from '@theia/core/lib/common/nls';
import { inject, injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import { EditorManager } from '@theia/editor/lib/browser/editor-manager'; import { EditorManager } from '@theia/editor/lib/browser/editor-manager';
import { WorkspaceInput } from '@theia/workspace/lib/browser/workspace-service'; import { WorkspaceInput } from '@theia/workspace/lib/browser/workspace-service';
import { SketchesError } from '../../common/protocol'; import { StartupTask } from '../../electron-common/startup-task';
import { StartupTasks } from '../../electron-common/startup-task';
import { ArduinoMenus } from '../menu/arduino-menus'; import { ArduinoMenus } from '../menu/arduino-menus';
import { CurrentSketch } from '../sketches-service-client-impl'; import { CurrentSketch } from '../sketches-service-client-impl';
import { CloudSketchContribution } from './cloud-contribution'; import { CloudSketchContribution } from './cloud-contribution';
@@ -26,7 +25,6 @@ import {
RenameCloudSketch, RenameCloudSketch,
RenameCloudSketchParams, RenameCloudSketchParams,
} from './rename-cloud-sketch'; } from './rename-cloud-sketch';
import { assertConnectedToBackend } from './save-sketch';
@injectable() @injectable()
export class SaveAsSketch extends CloudSketchContribution { export class SaveAsSketch extends CloudSketchContribution {
@@ -37,29 +35,7 @@ export class SaveAsSketch extends CloudSketchContribution {
override registerCommands(registry: CommandRegistry): void { override registerCommands(registry: CommandRegistry): void {
registry.registerCommand(SaveAsSketch.Commands.SAVE_AS_SKETCH, { registry.registerCommand(SaveAsSketch.Commands.SAVE_AS_SKETCH, {
execute: async (args) => { execute: (args) => this.saveAs(args),
try {
return await this.saveAs(args);
} catch (err) {
let message = String(err);
if (ApplicationError.is(err)) {
if (SketchesError.SketchAlreadyContainsThisFile.is(err)) {
message = nls.localize(
'arduino/sketch/sketchAlreadyContainsThisFileMessage',
'Failed to save sketch "{0}" as "{1}". {2}',
err.data.sourceSketchName,
err.data.targetSketchName,
err.message
);
} else {
message = err.message;
}
} else if (err instanceof Error) {
message = err.message;
}
this.messageService.error(message);
}
},
}); });
} }
@@ -82,18 +58,13 @@ export class SaveAsSketch extends CloudSketchContribution {
* Resolves `true` if the sketch was successfully saved as something. * Resolves `true` if the sketch was successfully saved as something.
*/ */
private async saveAs( private async saveAs(
params = SaveAsSketch.Options.DEFAULT {
): Promise<boolean> {
const {
execOnlyIfTemp, execOnlyIfTemp,
openAfterMove, openAfterMove,
wipeOriginal, wipeOriginal,
markAsRecentlyOpened, markAsRecentlyOpened,
} = params; }: SaveAsSketch.Options = SaveAsSketch.Options.DEFAULT
assertConnectedToBackend({ ): Promise<boolean> {
connectionStatusService: this.connectionStatusService,
messageService: this.messageService,
});
const sketch = await this.sketchServiceClient.currentSketch(); const sketch = await this.sketchServiceClient.currentSketch();
if (!CurrentSketch.isValid(sketch)) { if (!CurrentSketch.isValid(sketch)) {
return false; return false;
@@ -124,7 +95,7 @@ export class SaveAsSketch extends CloudSketchContribution {
if (markAsRecentlyOpened) { if (markAsRecentlyOpened) {
this.sketchesService.markAsRecentlyOpened(newWorkspaceUri); this.sketchesService.markAsRecentlyOpened(newWorkspaceUri);
} }
const options: WorkspaceInput & StartupTasks = { const options: WorkspaceInput & StartupTask.Owner = {
preserveWindow: true, preserveWindow: true,
tasks: [], tasks: [],
}; };
@@ -194,13 +165,16 @@ export class SaveAsSketch extends CloudSketchContribution {
): Promise<string | undefined> { ): Promise<string | undefined> {
let sketchFolderDestinationUri: string | undefined; let sketchFolderDestinationUri: string | undefined;
while (!sketchFolderDestinationUri) { while (!sketchFolderDestinationUri) {
const { filePath } = await this.dialogService.showSaveDialog({ const { filePath } = await remote.dialog.showSaveDialog(
remote.getCurrentWindow(),
{
title: nls.localize( title: nls.localize(
'arduino/sketch/saveFolderAs', 'arduino/sketch/saveFolderAs',
'Save sketch folder as...' 'Save sketch folder as...'
), ),
defaultPath, defaultPath,
}); }
);
if (!filePath) { if (!filePath) {
return undefined; return undefined;
} }
@@ -251,10 +225,13 @@ ${dialogContent.details}
${dialogContent.question}`.trim(); ${dialogContent.question}`.trim();
defaultPath = filePath; defaultPath = filePath;
const { response } = await this.dialogService.showMessageBox({ const { response } = await remote.dialog.showMessageBox(
remote.getCurrentWindow(),
{
message, message,
buttons: [Dialog.CANCEL, Dialog.YES], buttons: [Dialog.CANCEL, Dialog.YES],
}); }
);
// cancel // cancel
if (response === 0) { if (response === 0) {
return undefined; return undefined;

View File

@@ -1,18 +1,16 @@
import { CommonCommands } from '@theia/core/lib/browser/common-frontend-contribution';
import { MessageService } from '@theia/core/lib/common/message-service';
import { nls } from '@theia/core/lib/common/nls';
import { injectable } from '@theia/core/shared/inversify'; import { injectable } from '@theia/core/shared/inversify';
import { CommonCommands } from '@theia/core/lib/browser/common-frontend-contribution';
import { ArduinoMenus } from '../menu/arduino-menus'; import { ArduinoMenus } from '../menu/arduino-menus';
import { CurrentSketch } from '../sketches-service-client-impl'; import { SaveAsSketch } from './save-as-sketch';
import { ApplicationConnectionStatusContribution } from '../theia/core/connection-status-service';
import { import {
SketchContribution,
Command, Command,
CommandRegistry, CommandRegistry,
KeybindingRegistry,
MenuModelRegistry, MenuModelRegistry,
SketchContribution, KeybindingRegistry,
} from './contribution'; } from './contribution';
import { SaveAsSketch } from './save-as-sketch'; import { nls } from '@theia/core/lib/common';
import { CurrentSketch } from '../sketches-service-client-impl';
@injectable() @injectable()
export class SaveSketch extends SketchContribution { export class SaveSketch extends SketchContribution {
@@ -38,10 +36,6 @@ export class SaveSketch extends SketchContribution {
} }
async saveSketch(): Promise<void> { async saveSketch(): Promise<void> {
assertConnectedToBackend({
connectionStatusService: this.connectionStatusService,
messageService: this.messageService,
});
const sketch = await this.sketchServiceClient.currentSketch(); const sketch = await this.sketchServiceClient.currentSketch();
if (!CurrentSketch.isValid(sketch)) { if (!CurrentSketch.isValid(sketch)) {
return; return;
@@ -69,18 +63,3 @@ export namespace SaveSketch {
}; };
} }
} }
// https://github.com/arduino/arduino-ide/issues/2081
export function assertConnectedToBackend(param: {
connectionStatusService: ApplicationConnectionStatusContribution;
messageService: MessageService;
}): void {
if (param.connectionStatusService.offlineStatus === 'backend') {
const message = nls.localize(
'theia/core/couldNotSave',
'Could not save the sketch. Please copy your unsaved work into your favorite text editor, and restart the IDE.'
);
param.messageService.error(message);
throw new Error(message);
}
}

View File

@@ -4,10 +4,7 @@ import {
} from '@theia/core/lib/browser/status-bar/status-bar'; } from '@theia/core/lib/browser/status-bar/status-bar';
import { nls } from '@theia/core/lib/common/nls'; import { nls } from '@theia/core/lib/common/nls';
import { inject, injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import type { import { BoardsConfig } from '../boards/boards-config';
BoardList,
BoardListItem,
} from '../../common/protocol/board-list';
import { BoardsServiceProvider } from '../boards/boards-service-provider'; import { BoardsServiceProvider } from '../boards/boards-service-provider';
import { Contribution } from './contribution'; import { Contribution } from './contribution';
@@ -15,23 +12,21 @@ import { Contribution } from './contribution';
export class SelectedBoard extends Contribution { export class SelectedBoard extends Contribution {
@inject(StatusBar) @inject(StatusBar)
private readonly statusBar: StatusBar; private readonly statusBar: StatusBar;
@inject(BoardsServiceProvider) @inject(BoardsServiceProvider)
private readonly boardsServiceProvider: BoardsServiceProvider; private readonly boardsServiceProvider: BoardsServiceProvider;
override onStart(): void { override onStart(): void {
this.boardsServiceProvider.onBoardListDidChange((boardList) => this.boardsServiceProvider.onBoardsConfigChanged((config) =>
this.update(boardList) this.update(config)
); );
} }
override onReady(): void { override onReady(): void {
this.boardsServiceProvider.ready.then(() => this.update()); this.update(this.boardsServiceProvider.boardsConfig);
} }
private update( private update({ selectedBoard, selectedPort }: BoardsConfig.Config): void {
boardList: BoardList = this.boardsServiceProvider.boardList
): void {
const { selectedBoard, selectedPort } = boardList.boardsConfig;
this.statusBar.setElement('arduino-selected-board', { this.statusBar.setElement('arduino-selected-board', {
alignment: StatusBarAlignment.RIGHT, alignment: StatusBarAlignment.RIGHT,
text: selectedBoard text: selectedBoard
@@ -43,30 +38,17 @@ export class SelectedBoard extends Contribution {
className: 'arduino-selected-board', className: 'arduino-selected-board',
}); });
if (selectedBoard) { if (selectedBoard) {
const notConnectedLabel = nls.localize( this.statusBar.setElement('arduino-selected-port', {
'arduino/common/notConnected', alignment: StatusBarAlignment.RIGHT,
'[not connected]' text: selectedPort
); ? nls.localize(
let portLabel = notConnectedLabel;
if (selectedPort) {
portLabel = nls.localize(
'arduino/common/selectedOn', 'arduino/common/selectedOn',
'on {0}', 'on {0}',
selectedPort.address selectedPort.address
); )
const selectedItem: BoardListItem | undefined = : nls.localize('arduino/common/notConnected', '[not connected]'),
boardList.items[boardList.selectedIndex];
if (!selectedItem) {
portLabel += ` ${notConnectedLabel}`; // append ` [not connected]` when the port is selected but it's not detected by the CLI
}
}
this.statusBar.setElement('arduino-selected-port', {
alignment: StatusBarAlignment.RIGHT,
text: portLabel,
className: 'arduino-selected-port', className: 'arduino-selected-port',
}); });
} else {
this.statusBar.removeElement('arduino-selected-port');
} }
} }
} }

View File

@@ -8,7 +8,10 @@ import {
import { nls } from '@theia/core/lib/common/nls'; import { nls } from '@theia/core/lib/common/nls';
import { inject, injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import { WorkspaceCommands } from '@theia/workspace/lib/browser/workspace-commands'; import { WorkspaceCommands } from '@theia/workspace/lib/browser/workspace-commands';
import { ArduinoMenus } from '../menu/arduino-menus'; import {
ArduinoMenus,
showDisabledContextMenuOptions,
} from '../menu/arduino-menus';
import { CurrentSketch } from '../sketches-service-client-impl'; import { CurrentSketch } from '../sketches-service-client-impl';
import { import {
Command, Command,
@@ -119,7 +122,7 @@ export class SketchControl extends SketchContribution {
) )
); );
} }
const options = { const options = showDisabledContextMenuOptions({
menuPath: ArduinoMenus.SKETCH_CONTROL__CONTEXT, menuPath: ArduinoMenus.SKETCH_CONTROL__CONTEXT,
anchor: { anchor: {
x: parentElement.getBoundingClientRect().left, x: parentElement.getBoundingClientRect().left,
@@ -127,8 +130,7 @@ export class SketchControl extends SketchContribution {
parentElement.getBoundingClientRect().top + parentElement.getBoundingClientRect().top +
parentElement.offsetHeight, parentElement.offsetHeight,
}, },
showDisabled: true, });
};
this.contextMenuRenderer.render(options); this.contextMenuRenderer.render(options);
}, },
} }

View File

@@ -0,0 +1,52 @@
import * as remote from '@theia/core/electron-shared/@electron/remote';
import type { IpcRendererEvent } from '@theia/core/electron-shared/electron';
import { ipcRenderer } from '@theia/core/electron-shared/electron';
import { injectable } from '@theia/core/shared/inversify';
import { StartupTask } from '../../electron-common/startup-task';
import { Contribution } from './contribution';
@injectable()
export class StartupTasks extends Contribution {
override onReady(): void {
ipcRenderer.once(
StartupTask.Messaging.STARTUP_TASKS_SIGNAL,
(_: IpcRendererEvent, args: unknown) => {
console.debug(
`Received the startup tasks from the electron main process. Args: ${JSON.stringify(
args
)}`
);
if (!StartupTask.has(args)) {
console.warn(`Could not detect 'tasks' from the signal. Skipping.`);
return;
}
const tasks = args.tasks;
if (tasks.length) {
console.log(`Executing startup tasks:`);
tasks.forEach(({ command, args = [] }) => {
console.log(
` - '${command}' ${
args.length ? `, args: ${JSON.stringify(args)}` : ''
}`
);
this.commandService
.executeCommand(command, ...args)
.catch((err) =>
console.error(
`Error occurred when executing the startup task '${command}'${
args?.length ? ` with args: '${JSON.stringify(args)}` : ''
}.`,
err
)
);
});
}
}
);
const { id } = remote.getCurrentWindow();
console.debug(
`Signalling app ready event to the electron main process. Sender ID: ${id}.`
);
ipcRenderer.send(StartupTask.Messaging.APP_READY_SIGNAL(id));
}
}

View File

@@ -1,65 +0,0 @@
import { DisposableCollection } from '@theia/core/lib/common/disposable';
import {
inject,
injectable,
postConstruct,
} from '@theia/core/shared/inversify';
import {
hasStartupTasks,
StartupTasks,
} from '../../electron-common/startup-task';
import { AppService } from '../app-service';
import { Contribution } from './contribution';
@injectable()
export class StartupTasksExecutor extends Contribution {
@inject(AppService)
private readonly appService: AppService;
private readonly toDispose = new DisposableCollection();
@postConstruct()
protected override init(): void {
super.init();
this.toDispose.push(
this.appService.registerStartupTasksHandler((tasks) =>
this.handleStartupTasks(tasks)
)
);
}
onStop(): void {
this.toDispose.dispose();
}
private async handleStartupTasks(tasks: StartupTasks): Promise<void> {
console.debug(
`Received the startup tasks from the electron main process. Args: ${JSON.stringify(
tasks
)}`
);
if (!hasStartupTasks(tasks)) {
console.warn(`Could not detect 'tasks' from the signal. Skipping.`);
return;
}
await this.appStateService.reachedState('ready');
console.log(`Executing startup tasks:`);
tasks.tasks.forEach(({ command, args = [] }) => {
console.log(
` - '${command}' ${
args.length ? `, args: ${JSON.stringify(args)}` : ''
}`
);
this.commandService
.executeCommand(command, ...args)
.catch((err) =>
console.error(
`Error occurred when executing the startup task '${command}'${
args?.length ? ` with args: '${JSON.stringify(args)}` : ''
}.`,
err
)
);
});
}
}

View File

@@ -1,184 +0,0 @@
import { DisposableCollection } from '@theia/core/lib/common/disposable';
import URI from '@theia/core/lib/common/uri';
import { inject, injectable } from '@theia/core/shared/inversify';
import { HostedPluginSupport } from '../hosted/hosted-plugin-support';
import type { ArduinoState } from 'vscode-arduino-api';
import {
BoardsService,
CompileSummary,
isCompileSummary,
BoardsConfig,
PortIdentifier,
resolveDetectedPort,
} from '../../common/protocol';
import {
toApiBoardDetails,
toApiCompileSummary,
toApiPort,
} from '../../common/protocol/arduino-context-mapper';
import { BoardsDataStore } from '../boards/boards-data-store';
import { BoardsServiceProvider } from '../boards/boards-service-provider';
import { CurrentSketch } from '../sketches-service-client-impl';
import { SketchContribution } from './contribution';
/**
* (non-API) exported for tests
*/
export interface UpdateStateParams<T extends ArduinoState = ArduinoState> {
readonly key: keyof T;
readonly value: T[keyof T];
}
/**
* Contribution for updating the Arduino state, such as the FQBN, selected port, and sketch path changes via commands, so other VS Code extensions can access it.
* See [`vscode-arduino-api`](https://github.com/dankeboy36/vscode-arduino-api#api) for more details.
*/
@injectable()
export class UpdateArduinoState extends SketchContribution {
@inject(BoardsService)
private readonly boardsService: BoardsService;
@inject(BoardsServiceProvider)
private readonly boardsServiceProvider: BoardsServiceProvider;
@inject(BoardsDataStore)
private readonly boardsDataStore: BoardsDataStore;
@inject(HostedPluginSupport)
private readonly hostedPluginSupport: HostedPluginSupport;
private readonly toDispose = new DisposableCollection();
override onStart(): void {
this.toDispose.pushAll([
this.boardsServiceProvider.onBoardsConfigDidChange(() =>
this.updateBoardsConfig(this.boardsServiceProvider.boardsConfig)
),
this.sketchServiceClient.onCurrentSketchDidChange((sketch) =>
this.updateSketchPath(sketch)
),
this.configService.onDidChangeDataDirUri((dataDirUri) =>
this.updateDataDirPath(dataDirUri)
),
this.configService.onDidChangeSketchDirUri((userDirUri) =>
this.updateUserDirPath(userDirUri)
),
this.commandService.onDidExecuteCommand(({ commandId, args }) => {
if (
commandId === 'arduino.languageserver.notifyBuildDidComplete' &&
isCompileSummary(args[0])
) {
this.updateCompileSummary(args[0]);
}
}),
this.boardsDataStore.onDidChange((event) => {
const selectedFqbn =
this.boardsServiceProvider.boardsConfig.selectedBoard?.fqbn;
if (
selectedFqbn &&
event.changes.find((change) => change.fqbn === selectedFqbn)
) {
this.updateBoardDetails(selectedFqbn);
}
}),
]);
}
override onReady(): void {
this.boardsServiceProvider.ready.then(() => {
this.updateBoardsConfig(this.boardsServiceProvider.boardsConfig);
});
this.updateSketchPath(this.sketchServiceClient.tryGetCurrentSketch());
this.updateUserDirPath(this.configService.tryGetSketchDirUri());
this.updateDataDirPath(this.configService.tryGetDataDirUri());
}
onStop(): void {
this.toDispose.dispose();
}
private async updateSketchPath(
sketch: CurrentSketch | undefined
): Promise<void> {
const sketchPath = CurrentSketch.isValid(sketch)
? new URI(sketch.uri).path.fsPath()
: undefined;
return this.updateState({ key: 'sketchPath', value: sketchPath });
}
private async updateCompileSummary(
compileSummary: CompileSummary
): Promise<void> {
const apiCompileSummary = toApiCompileSummary(compileSummary);
return this.updateState({
key: 'compileSummary',
value: apiCompileSummary,
});
}
private async updateBoardsConfig(boardsConfig: BoardsConfig): Promise<void> {
const fqbn = boardsConfig.selectedBoard?.fqbn;
const port = boardsConfig.selectedPort;
await this.updateFqbn(fqbn);
await this.updateBoardDetails(fqbn);
await this.updatePort(port);
}
private async updateFqbn(fqbn: string | undefined): Promise<void> {
await this.updateState({ key: 'fqbn', value: fqbn });
}
private async updateBoardDetails(fqbn: string | undefined): Promise<void> {
const unset = () =>
this.updateState({ key: 'boardDetails', value: undefined });
if (!fqbn) {
return unset();
}
const [details, persistedData] = await Promise.all([
this.boardsService.getBoardDetails({ fqbn }),
this.boardsDataStore.getData(fqbn),
]);
if (!details) {
return unset();
}
const apiBoardDetails = toApiBoardDetails({
...details,
configOptions:
BoardsDataStore.Data.EMPTY === persistedData
? details.configOptions
: persistedData.configOptions.slice(),
});
return this.updateState({
key: 'boardDetails',
value: apiBoardDetails,
});
}
private async updatePort(port: PortIdentifier | undefined): Promise<void> {
const resolvedPort =
port &&
resolveDetectedPort(port, this.boardsServiceProvider.detectedPorts);
const apiPort = resolvedPort && toApiPort(resolvedPort);
return this.updateState({ key: 'port', value: apiPort });
}
private async updateUserDirPath(userDirUri: URI | undefined): Promise<void> {
const userDirPath = userDirUri?.path.fsPath();
return this.updateState({
key: 'userDirPath',
value: userDirPath,
});
}
private async updateDataDirPath(dataDirUri: URI | undefined): Promise<void> {
const dataDirPath = dataDirUri?.path.fsPath();
return this.updateState({
key: 'dataDirPath',
value: dataDirPath,
});
}
private async updateState<T extends ArduinoState>(
params: UpdateStateParams<T>
): Promise<void> {
await this.hostedPluginSupport.didStart;
return this.commandService.executeCommand('arduinoAPI.updateState', params);
}
}

View File

@@ -16,10 +16,7 @@ import {
arduinoCert, arduinoCert,
certificateList, certificateList,
} from '../dialogs/certificate-uploader/utils'; } from '../dialogs/certificate-uploader/utils';
import { import { ArduinoFirmwareUploader } from '../../common/protocol/arduino-firmware-uploader';
ArduinoFirmwareUploader,
UploadCertificateParams,
} from '../../common/protocol/arduino-firmware-uploader';
import { nls } from '@theia/core/lib/common'; import { nls } from '@theia/core/lib/common';
@injectable() @injectable()
@@ -77,8 +74,12 @@ export class UploadCertificate extends Contribution {
}); });
registry.registerCommand(UploadCertificate.Commands.UPLOAD_CERT, { registry.registerCommand(UploadCertificate.Commands.UPLOAD_CERT, {
execute: async (params: UploadCertificateParams) => { execute: async ({ fqbn, address, urls }) => {
return this.arduinoFirmwareUploader.uploadCertificates(params); return this.arduinoFirmwareUploader.uploadCertificates(
`-b ${fqbn} -a ${address} ${urls
.map((url: string) => `-u ${url}`)
.join(' ')}`
);
}, },
}); });

View File

@@ -45,7 +45,10 @@ export namespace UploadFirmware {
export namespace Commands { export namespace Commands {
export const OPEN: Command = { export const OPEN: Command = {
id: 'arduino-upload-firmware-open', id: 'arduino-upload-firmware-open',
label: nls.localize('arduino/firmware/updater', 'Firmware Updater'), label: nls.localize(
'arduino/firmware/updater',
'WiFi101 / WiFiNINA Firmware Updater'
),
category: 'Arduino', category: 'Arduino',
}; };
} }

View File

@@ -1,31 +1,30 @@
import { Emitter } from '@theia/core/lib/common/event';
import { nls } from '@theia/core/lib/common/nls';
import { inject, injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import { FQBN } from 'fqbn'; import { Emitter } from '@theia/core/lib/common/event';
import { CoreService } from '../../common/protocol'; import { CoreService, Port, sanitizeFqbn } from '../../common/protocol';
import { ArduinoMenus } from '../menu/arduino-menus'; import { ArduinoMenus } from '../menu/arduino-menus';
import { CurrentSketch } from '../sketches-service-client-impl';
import { ArduinoToolbar } from '../toolbar/arduino-toolbar'; import { ArduinoToolbar } from '../toolbar/arduino-toolbar';
import { import {
Command, Command,
CommandRegistry, CommandRegistry,
CoreServiceContribution,
KeybindingRegistry,
MenuModelRegistry, MenuModelRegistry,
KeybindingRegistry,
TabBarToolbarRegistry, TabBarToolbarRegistry,
CoreServiceContribution,
} from './contribution'; } from './contribution';
import { UserFields } from './user-fields'; import { deepClone, nls } from '@theia/core/lib/common';
import { CurrentSketch } from '../sketches-service-client-impl';
import type { VerifySketchParams } from './verify-sketch'; import type { VerifySketchParams } from './verify-sketch';
import { UserFields } from './user-fields';
@injectable() @injectable()
export class UploadSketch extends CoreServiceContribution { export class UploadSketch extends CoreServiceContribution {
@inject(UserFields)
private readonly userFields: UserFields;
private readonly onDidChangeEmitter = new Emitter<void>(); private readonly onDidChangeEmitter = new Emitter<void>();
private readonly onDidChange = this.onDidChangeEmitter.event; private readonly onDidChange = this.onDidChangeEmitter.event;
private uploadInProgress = false; private uploadInProgress = false;
@inject(UserFields)
private readonly userFields: UserFields;
override registerCommands(registry: CommandRegistry): void { override registerCommands(registry: CommandRegistry): void {
registry.registerCommand(UploadSketch.Commands.UPLOAD_SKETCH, { registry.registerCommand(UploadSketch.Commands.UPLOAD_SKETCH, {
execute: async () => { execute: async () => {
@@ -108,6 +107,7 @@ export class UploadSketch extends CoreServiceContribution {
// uploadInProgress will be set to false whether the upload fails or not // uploadInProgress will be set to false whether the upload fails or not
this.uploadInProgress = true; this.uploadInProgress = true;
this.menuManager.update(); this.menuManager.update();
this.boardsServiceProvider.snapshotBoardDiscoveryOnUpload();
this.onDidChangeEmitter.fire(); this.onDidChangeEmitter.fire();
this.clearVisibleNotification(); this.clearVisibleNotification();
@@ -127,7 +127,6 @@ export class UploadSketch extends CoreServiceContribution {
usingProgrammer, usingProgrammer,
verifyOptions verifyOptions
); );
if (!uploadOptions) { if (!uploadOptions) {
return; return;
} }
@@ -136,42 +135,13 @@ export class UploadSketch extends CoreServiceContribution {
return; return;
} }
const uploadResponse = await this.doWithProgress({ await this.doWithProgress({
progressText: nls.localize('arduino/sketch/uploading', 'Uploading...'), progressText: nls.localize('arduino/sketch/uploading', 'Uploading...'),
task: async (progressId, coreService, token) => { task: (progressId, coreService) =>
try { coreService.upload({ ...uploadOptions, progressId }),
return await coreService.upload(
{ ...uploadOptions, progressId },
token
);
} catch (err) {
if (err.code === 4005) {
const uploadWithProgrammerOptions = await this.uploadOptions(
true,
verifyOptions
);
if (uploadWithProgrammerOptions) {
return coreService.upload(
{ ...uploadWithProgrammerOptions, progressId },
token
);
}
} else {
throw err;
}
}
},
keepOutput: true, keepOutput: true,
cancelable: true,
}); });
if (!uploadResponse) {
return;
}
// the port update is NOOP if nothing has changed
this.boardsServiceProvider.updateConfig(uploadResponse.portAfterUpload);
this.messageService.info( this.messageService.info(
nls.localize('arduino/sketch/doneUploading', 'Done uploading.'), nls.localize('arduino/sketch/doneUploading', 'Done uploading.'),
{ timeout: 3000 } { timeout: 3000 }
@@ -180,10 +150,9 @@ export class UploadSketch extends CoreServiceContribution {
this.userFields.notifyFailedWithError(e); this.userFields.notifyFailedWithError(e);
this.handleError(e); this.handleError(e);
} finally { } finally {
// TODO: here comes the port change if happened during the upload
// https://github.com/arduino/arduino-cli/issues/2245
this.uploadInProgress = false; this.uploadInProgress = false;
this.menuManager.update(); this.menuManager.update();
this.boardsServiceProvider.attemptPostUploadAutoSelect();
this.onDidChangeEmitter.fire(); this.onDidChangeEmitter.fire();
} }
} }
@@ -201,15 +170,11 @@ export class UploadSketch extends CoreServiceContribution {
const [fqbn, { selectedProgrammer: programmer }, verify, verbose] = const [fqbn, { selectedProgrammer: programmer }, verify, verbose] =
await Promise.all([ await Promise.all([
verifyOptions.fqbn, // already decorated FQBN verifyOptions.fqbn, // already decorated FQBN
this.boardsDataStore.getData( this.boardsDataStore.getData(sanitizeFqbn(verifyOptions.fqbn)),
verifyOptions.fqbn
? new FQBN(verifyOptions.fqbn).toString(true)
: undefined
),
this.preferences.get('arduino.upload.verify'), this.preferences.get('arduino.upload.verify'),
this.preferences.get('arduino.upload.verbose'), this.preferences.get('arduino.upload.verbose'),
]); ]);
const port = boardsConfig.selectedPort; const port = this.maybeUpdatePortProperties(boardsConfig.selectedPort);
return { return {
sketch, sketch,
fqbn, fqbn,
@@ -220,6 +185,28 @@ export class UploadSketch extends CoreServiceContribution {
userFields, userFields,
}; };
} }
/**
* This is a hack to ensure that the port object has the `properties` when uploading.(https://github.com/arduino/arduino-ide/issues/740)
* This method works around a bug when restoring a `port` persisted by an older version of IDE2. See the bug [here](https://github.com/arduino/arduino-ide/pull/1335#issuecomment-1224355236).
*
* Before the upload, this method checks the available ports and makes sure that the `properties` of an available port, and the port selected by the user have the same `properties`.
* This method does not update any state (for example, the `BoardsConfig.Config`) but uses the correct `properties` for the `upload`.
*/
private maybeUpdatePortProperties(port: Port | undefined): Port | undefined {
if (port) {
const key = Port.keyOf(port);
for (const candidate of this.boardsServiceProvider.availablePorts) {
if (key === Port.keyOf(candidate) && candidate.properties) {
return {
...port,
properties: deepClone(candidate.properties),
};
}
}
}
return port;
}
} }
export namespace UploadSketch { export namespace UploadSketch {

View File

@@ -1,10 +1,10 @@
import { nls } from '@theia/core/lib/common/nls';
import { inject, injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import { nls } from '@theia/core/lib/common';
import { BoardUserField, CoreError } from '../../common/protocol'; import { BoardUserField, CoreError } from '../../common/protocol';
import { BoardsServiceProvider } from '../boards/boards-service-provider'; import { BoardsServiceProvider } from '../boards/boards-service-provider';
import { UserFieldsDialog } from '../dialogs/user-fields/user-fields-dialog'; import { UserFieldsDialog } from '../dialogs/user-fields/user-fields-dialog';
import { ArduinoMenus } from '../menu/arduino-menus'; import { ArduinoMenus } from '../menu/arduino-menus';
import { Contribution, MenuModelRegistry } from './contribution'; import { MenuModelRegistry, Contribution } from './contribution';
import { UploadSketch } from './upload-sketch'; import { UploadSketch } from './upload-sketch';
@injectable() @injectable()
@@ -21,11 +21,12 @@ export class UserFields extends Contribution {
protected override init(): void { protected override init(): void {
super.init(); super.init();
this.boardsServiceProvider.onBoardsConfigDidChange(() => this.refresh()); this.boardsServiceProvider.onBoardsConfigChanged(async () => {
} const userFields =
await this.boardsServiceProvider.selectedBoardUserFields();
override onReady(): void { this.boardRequiresUserFields = userFields.length > 0;
this.boardsServiceProvider.ready.then(() => this.refresh()); this.menuManager.update();
});
} }
override registerMenus(registry: MenuModelRegistry): void { override registerMenus(registry: MenuModelRegistry): void {
@@ -36,20 +37,16 @@ export class UserFields extends Contribution {
}); });
} }
private async refresh(): Promise<void> {
const userFields =
await this.boardsServiceProvider.selectedBoardUserFields();
this.boardRequiresUserFields = userFields.length > 0;
this.menuManager.update();
}
private selectedFqbnAddress(): string | undefined { private selectedFqbnAddress(): string | undefined {
const { boardsConfig } = this.boardsServiceProvider; const { boardsConfig } = this.boardsServiceProvider;
const fqbn = boardsConfig.selectedBoard?.fqbn; const fqbn = boardsConfig.selectedBoard?.fqbn;
if (!fqbn) { if (!fqbn) {
return undefined; return undefined;
} }
const address = boardsConfig.selectedPort?.address || ''; const address =
boardsConfig.selectedBoard?.port?.address ||
boardsConfig.selectedPort?.address ||
'';
return fqbn + '|' + address; return fqbn + '|' + address;
} }

View File

@@ -1,3 +1,4 @@
import * as remote from '@theia/core/electron-shared/@electron/remote';
import { Dialog } from '@theia/core/lib/browser/dialogs'; import { Dialog } from '@theia/core/lib/browser/dialogs';
import { nls } from '@theia/core/lib/common/nls'; import { nls } from '@theia/core/lib/common/nls';
import { Deferred, waitForEvent } from '@theia/core/lib/common/promise-util'; import { Deferred, waitForEvent } from '@theia/core/lib/common/promise-util';
@@ -179,12 +180,15 @@ export class ValidateSketch extends CloudSketchContribution {
message: string, message: string,
buttons: string[] = [Dialog.CANCEL, Dialog.OK] buttons: string[] = [Dialog.CANCEL, Dialog.OK]
): Promise<boolean> { ): Promise<boolean> {
const { response } = await this.dialogService.showMessageBox({ const { response } = await remote.dialog.showMessageBox(
remote.getCurrentWindow(),
{
title, title,
message, message,
type: 'warning', type: 'warning',
buttons, buttons,
}); }
);
// cancel // cancel
if (response === 0) { if (response === 0) {
return false; return false;

View File

@@ -1,18 +1,18 @@
import { Emitter } from '@theia/core/lib/common/event';
import { nls } from '@theia/core/lib/common/nls';
import { inject, injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import type { CoreService } from '../../common/protocol'; import { Emitter } from '@theia/core/lib/common/event';
import { ArduinoMenus } from '../menu/arduino-menus'; import { ArduinoMenus } from '../menu/arduino-menus';
import { CurrentSketch } from '../sketches-service-client-impl';
import { ArduinoToolbar } from '../toolbar/arduino-toolbar'; import { ArduinoToolbar } from '../toolbar/arduino-toolbar';
import { import {
CoreServiceContribution,
Command, Command,
CommandRegistry, CommandRegistry,
CoreServiceContribution,
KeybindingRegistry,
MenuModelRegistry, MenuModelRegistry,
KeybindingRegistry,
TabBarToolbarRegistry, TabBarToolbarRegistry,
} from './contribution'; } from './contribution';
import { nls } from '@theia/core/lib/common';
import { CurrentSketch } from '../sketches-service-client-impl';
import { CoreService } from '../../common/protocol';
import { CoreErrorHandler } from './core-error-handler'; import { CoreErrorHandler } from './core-error-handler';
export interface VerifySketchParams { export interface VerifySketchParams {
@@ -131,15 +131,11 @@ export class VerifySketch extends CoreServiceContribution {
'arduino/sketch/compile', 'arduino/sketch/compile',
'Compiling sketch...' 'Compiling sketch...'
), ),
task: (progressId, coreService, token) => task: (progressId, coreService) =>
coreService.compile( coreService.compile({
{
...options, ...options,
progressId, progressId,
}, }),
token
),
cancelable: true,
}); });
this.messageService.info( this.messageService.info(
nls.localize('arduino/sketch/doneCompiling', 'Done compiling.'), nls.localize('arduino/sketch/doneCompiling', 'Done compiling.'),

View File

@@ -57,63 +57,36 @@ export class CreateApi {
return result; return result;
} }
/**
* `sketchPath` is not the POSIX path but the path with the user UUID, username, etc.
* See [Create.Resource#path](./typings.ts). If `cache` is `true` and a sketch exists with the path,
* the cache will be updated with the new state of the sketch.
*/
// TODO: no nulls in API
async sketchByPath(
sketchPath: string,
cache = false
): Promise<Create.Sketch | null> {
const url = new URL(`${this.domain()}/sketches/byPath/${sketchPath}`);
const headers = await this.headers();
const sketch = await this.run<Create.Sketch>(url, {
method: 'GET',
headers,
});
if (sketch && cache) {
this.sketchCache.addSketch(sketch);
const posixPath = createPaths.toPosixPath(sketch.path);
this.sketchCache.purgeByPath(posixPath);
}
return sketch;
}
async sketches(limit = 50): Promise<Create.Sketch[]> { async sketches(limit = 50): Promise<Create.Sketch[]> {
const url = new URL(`${this.domain()}/sketches`); const url = new URL(`${this.domain()}/sketches`);
url.searchParams.set('user_id', 'me'); url.searchParams.set('user_id', 'me');
url.searchParams.set('limit', limit.toString()); url.searchParams.set('limit', limit.toString());
const headers = await this.headers(); const headers = await this.headers();
const allSketches: Create.Sketch[] = []; const result: { sketches: Create.Sketch[] } = { sketches: [] };
let partialSketches: Create.Sketch[] = [];
let currentOffset = 0; let currentOffset = 0;
while (true) { do {
url.searchParams.set('offset', currentOffset.toString()); url.searchParams.set('offset', currentOffset.toString());
const { sketches } = await this.run<{ sketches: Create.Sketch[] }>(url, { partialSketches = (
await this.run<{ sketches: Create.Sketch[] }>(url, {
method: 'GET', method: 'GET',
headers, headers,
}); })
allSketches.push(...sketches); ).sketches;
if (sketches.length < limit) { if (partialSketches.length !== 0) {
break; result.sketches = result.sketches.concat(partialSketches);
} }
currentOffset += limit; currentOffset = currentOffset + limit;
// The create API doc show that there is `next` and `prev` pages, but it does not work } while (partialSketches.length !== 0);
// https://api2.arduino.cc/create/docs#!/sketches95v2/sketches_v2_search
// IF sketchCount mod limit === 0, an extra fetch must happen to detect the end of the pagination. result.sketches.forEach((sketch) => this.sketchCache.addSketch(sketch));
} return result.sketches;
allSketches.forEach((sketch) => this.sketchCache.addSketch(sketch));
return allSketches;
} }
async createSketch( async createSketch(
posixPath: string, posixPath: string,
contentProvider: MaybePromise<string> = this.sketchesService.defaultInoContent(), contentProvider: MaybePromise<string> = this.sketchesService.defaultInoContent()
payloadOverride: Record<
string,
string | boolean | number | Record<string, unknown>
> = {}
): Promise<Create.Sketch> { ): Promise<Create.Sketch> {
const url = new URL(`${this.domain()}/sketches`); const url = new URL(`${this.domain()}/sketches`);
const [headers, content] = await Promise.all([ const [headers, content] = await Promise.all([
@@ -124,7 +97,6 @@ export class CreateApi {
ino: btoa(content), ino: btoa(content),
path: posixPath, path: posixPath,
user_id: 'me', user_id: 'me',
...payloadOverride,
}; };
const init = { const init = {
method: 'PUT', method: 'PUT',
@@ -179,8 +151,7 @@ export class CreateApi {
); );
}) })
.catch((reason) => { .catch((reason) => {
if (reason?.status === 404) if (reason?.status === 404) return [] as Create.Resource[];
return [] as Create.Resource[]; // TODO: must not swallow 404
else throw reason; else throw reason;
}); });
} }
@@ -241,17 +212,7 @@ export class CreateApi {
return data; return data;
} }
const posixPath = createPaths.parentPosix(path); const sketch = this.sketchCache.getSketch(createPaths.parentPosix(path));
let sketch = this.sketchCache.getSketch(posixPath);
// Workaround for https://github.com/arduino/arduino-ide/issues/1999.
if (!sketch) {
// Convert the ordinary sketch POSIX path to the Create path.
// For example, `/sketch_apr6a` will be transformed to `8a694e4b83878cc53472bd75ee928053:kittaakos/sketches_v2/sketch_apr6a`.
const createPathPrefix = this.sketchCache.createPathPrefix;
if (createPathPrefix) {
sketch = await this.sketchByPath(createPathPrefix + posixPath, true);
}
}
if ( if (
sketch && sketch &&
@@ -492,6 +453,7 @@ export class CreateApi {
init: RequestInit | undefined, init: RequestInit | undefined,
resultProvider: ResponseResultProvider = ResponseResultProvider.JSON resultProvider: ResponseResultProvider = ResponseResultProvider.JSON
): Promise<T> { ): Promise<T> {
console.debug(`HTTP ${init?.method}: ${requestInfo.toString()}`);
const response = await fetch(requestInfo.toString(), init); const response = await fetch(requestInfo.toString(), init);
if (!response.ok) { if (!response.ok) {
let details: string | undefined = undefined; let details: string | undefined = undefined;
@@ -509,19 +471,11 @@ export class CreateApi {
private async headers(): Promise<Record<string, string>> { private async headers(): Promise<Record<string, string>> {
const token = await this.token(); const token = await this.token();
const headers: Record<string, string> = { return {
'content-type': 'application/json', 'content-type': 'application/json',
accept: 'application/json', accept: 'application/json',
authorization: `Bearer ${token}`, authorization: `Bearer ${token}`,
}; };
const sharedSpaceID =
this.arduinoPreferences['arduino.cloud.sharedSpaceID'];
if (sharedSpaceID) {
headers['x-organization'] = sharedSpaceID;
}
return headers;
} }
private domain(apiVersion = 'v2'): string { private domain(apiVersion = 'v2'): string {

View File

@@ -4,14 +4,10 @@ import { Emitter, Event } from '@theia/core/lib/common/event';
import URI from '@theia/core/lib/common/uri'; import URI from '@theia/core/lib/common/uri';
import { inject, injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import { Sketch } from '../../common/protocol'; import { Sketch } from '../../common/protocol';
import { AuthenticationSession } from '../../common/protocol/authentication-service'; import { AuthenticationSession } from '../../node/auth/types';
import { ArduinoPreferences } from '../arduino-preferences'; import { ArduinoPreferences } from '../arduino-preferences';
import { AuthenticationClientService } from '../auth/authentication-client-service'; import { AuthenticationClientService } from '../auth/authentication-client-service';
import { LocalCacheFsProvider } from '../local-cache/local-cache-fs-provider'; import { LocalCacheFsProvider } from '../local-cache/local-cache-fs-provider';
import {
ARDUINO_CLOUD_FOLDER,
REMOTE_SKETCHBOOK_FOLDER,
} from '../utils/constants';
import { CreateUri } from './create-uri'; import { CreateUri } from './create-uri';
export type CloudSketchState = 'push' | 'pull'; export type CloudSketchState = 'push' | 'pull';
@@ -132,8 +128,8 @@ export class CreateFeatures implements FrontendApplicationContribution {
return undefined; return undefined;
} }
return dataDirUri return dataDirUri
.resolve(REMOTE_SKETCHBOOK_FOLDER) .resolve('RemoteSketchbook')
.resolve(ARDUINO_CLOUD_FOLDER) .resolve('ArduinoCloud')
.isEqualOrParent(new URI(sketch.uri)); .isEqualOrParent(new URI(sketch.uri));
} }

View File

@@ -82,13 +82,6 @@ export function isNotFound(err: unknown): err is NotFoundError {
return isErrorWithStatusOf(err, 404); return isErrorWithStatusOf(err, 404);
} }
export type UnprocessableContentError = CreateError & { status: 422 };
export function isUnprocessableContent(
err: unknown
): err is UnprocessableContentError {
return isErrorWithStatusOf(err, 422);
}
function isErrorWithStatusOf( function isErrorWithStatusOf(
err: unknown, err: unknown,
status: number status: number

View File

@@ -38,7 +38,8 @@
"activityBar.foreground": "#dae3e3", "activityBar.foreground": "#dae3e3",
"activityBar.inactiveForeground": "#4e5b61", "activityBar.inactiveForeground": "#4e5b61",
"activityBar.activeBorder": "#0ca1a6", "activityBar.activeBorder": "#0ca1a6",
"statusBar.background": "#171e21", "activityBarBadge.background": "#008184",
"statusBar.background": "#0ca1a6",
"secondaryButton.background": "#ff000000", "secondaryButton.background": "#ff000000",
"secondaryButton.foreground": "#dae3e3", "secondaryButton.foreground": "#dae3e3",
"secondaryButton.hoverBackground": "#ffffff1a", "secondaryButton.hoverBackground": "#ffffff1a",

View File

@@ -38,6 +38,7 @@
"activityBar.foreground": "#4e5b61", "activityBar.foreground": "#4e5b61",
"activityBar.inactiveForeground": "#bdc7c7", "activityBar.inactiveForeground": "#bdc7c7",
"activityBar.activeBorder": "#008184", "activityBar.activeBorder": "#008184",
"activityBarBadge.background": "#008184",
"statusBar.background": "#006d70", "statusBar.background": "#006d70",
"secondaryButton.background": "#ff000000", "secondaryButton.background": "#ff000000",
"secondaryButton.foreground": "#008184", "secondaryButton.foreground": "#008184",

View File

@@ -1,15 +0,0 @@
import type {
MessageBoxOptions,
MessageBoxReturnValue,
OpenDialogOptions,
OpenDialogReturnValue,
SaveDialogOptions,
SaveDialogReturnValue,
} from '../electron-common/electron-arduino';
export const DialogService = Symbol('DialogService');
export interface DialogService {
showMessageBox(options: MessageBoxOptions): Promise<MessageBoxReturnValue>;
showOpenDialog(options: OpenDialogOptions): Promise<OpenDialogReturnValue>;
showSaveDialog(options: SaveDialogOptions): Promise<SaveDialogReturnValue>;
}

View File

@@ -1,5 +1,5 @@
import { nls } from '@theia/core/lib/common'; import { nls } from '@theia/core/lib/common';
import React from '@theia/core/shared/react'; import * as React from '@theia/core/shared/react';
export const CertificateAddComponent = ({ export const CertificateAddComponent = ({
addCertificate, addCertificate,

View File

@@ -1,4 +1,4 @@
import React from '@theia/core/shared/react'; import * as React from '@theia/core/shared/react';
export const CertificateListComponent = ({ export const CertificateListComponent = ({
certificates, certificates,

View File

@@ -1,27 +1,20 @@
import { nls } from '@theia/core/lib/common/nls'; import * as React from '@theia/core/shared/react';
import React from '@theia/core/shared/react';
import Tippy from '@tippyjs/react'; import Tippy from '@tippyjs/react';
import type { BoardList } from '../../../common/protocol/board-list'; import { AvailableBoard } from '../../boards/boards-service-provider';
import {
boardIdentifierEquals,
portIdentifierEquals,
} from '../../../common/protocol/boards-service';
import { CertificateAddComponent } from './certificate-add-new';
import { CertificateListComponent } from './certificate-list'; import { CertificateListComponent } from './certificate-list';
import { import { SelectBoardComponent } from './select-board-components';
BoardOptionValue, import { CertificateAddComponent } from './certificate-add-new';
SelectBoardComponent, import { nls } from '@theia/core/lib/common';
} from './select-board-components';
export const CertificateUploaderComponent = ({ export const CertificateUploaderComponent = ({
boardList, availableBoards,
certificates, certificates,
addCertificate, addCertificate,
updatableFqbns, updatableFqbns,
uploadCertificates, uploadCertificates,
openContextMenu, openContextMenu,
}: { }: {
boardList: BoardList; availableBoards: AvailableBoard[];
certificates: string[]; certificates: string[];
addCertificate: (cert: string) => void; addCertificate: (cert: string) => void;
updatableFqbns: string[]; updatableFqbns: string[];
@@ -40,15 +33,11 @@ export const CertificateUploaderComponent = ({
const [selectedCerts, setSelectedCerts] = React.useState<string[]>([]); const [selectedCerts, setSelectedCerts] = React.useState<string[]>([]);
const [selectedItem, setSelectedItem] = const [selectedBoard, setSelectedBoard] =
React.useState<BoardOptionValue | null>(null); React.useState<AvailableBoard | null>(null);
const installCertificates = async () => { const installCertificates = async () => {
if (!selectedItem) { if (!selectedBoard || !selectedBoard.fqbn || !selectedBoard.port) {
return;
}
const board = selectedItem.board;
if (!board.fqbn) {
return; return;
} }
@@ -56,8 +45,8 @@ export const CertificateUploaderComponent = ({
try { try {
await uploadCertificates( await uploadCertificates(
board.fqbn, selectedBoard.fqbn,
selectedItem.port.address, selectedBoard.port.address,
selectedCerts selectedCerts
); );
setInstallFeedback('ok'); setInstallFeedback('ok');
@@ -66,26 +55,17 @@ export const CertificateUploaderComponent = ({
} }
}; };
const onItemSelect = React.useCallback( const onBoardSelect = React.useCallback(
(item: BoardOptionValue | null) => { (board: AvailableBoard) => {
if (!item) { const newFqbn = (board && board.fqbn) || null;
setSelectedItem(null); const prevFqbn = (selectedBoard && selectedBoard.fqbn) || null;
return;
}
const board = item.board;
const port = item.port;
const selectedBoard = selectedItem?.board;
const selectedPort = selectedItem?.port;
if ( if (newFqbn !== prevFqbn) {
!boardIdentifierEquals(board, selectedBoard) ||
!portIdentifierEquals(port, selectedPort)
) {
setInstallFeedback(null); setInstallFeedback(null);
setSelectedItem(item); setSelectedBoard(board);
} }
}, },
[selectedItem] [selectedBoard]
); );
return ( return (
@@ -145,10 +125,10 @@ export const CertificateUploaderComponent = ({
<div className="dialogRow"> <div className="dialogRow">
<div className="fl1"> <div className="fl1">
<SelectBoardComponent <SelectBoardComponent
boardList={boardList} availableBoards={availableBoards}
updatableFqbns={updatableFqbns} updatableFqbns={updatableFqbns}
onItemSelect={onItemSelect} onBoardSelect={onBoardSelect}
selectedItem={selectedItem} selectedBoard={selectedBoard}
busy={installFeedback === 'installing'} busy={installFeedback === 'installing'}
/> />
</div> </div>
@@ -187,7 +167,7 @@ export const CertificateUploaderComponent = ({
type="button" type="button"
className="theia-button primary install-cert-btn" className="theia-button primary install-cert-btn"
onClick={installCertificates} onClick={installCertificates}
disabled={selectedCerts.length === 0 || !selectedItem} disabled={selectedCerts.length === 0 || !selectedBoard}
> >
{nls.localize('arduino/certificate/upload', 'Upload')} {nls.localize('arduino/certificate/upload', 'Upload')}
</button> </button>

View File

@@ -1,51 +1,62 @@
import { DialogProps } from '@theia/core/lib/browser/dialogs'; import * as React from '@theia/core/shared/react';
import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';
import {
PreferenceScope,
PreferenceService,
} from '@theia/core/lib/browser/preferences/preference-service';
import { ReactWidget } from '@theia/core/lib/browser/widgets/react-widget';
import { CommandRegistry } from '@theia/core/lib/common/command';
import { nls } from '@theia/core/lib/common/nls';
import type { Message } from '@theia/core/shared/@phosphor/messaging';
import { Widget } from '@theia/core/shared/@phosphor/widgets';
import { import {
inject, inject,
injectable, injectable,
postConstruct, postConstruct,
} from '@theia/core/shared/inversify'; } from '@theia/core/shared/inversify';
import React from '@theia/core/shared/react'; import { DialogProps } from '@theia/core/lib/browser/dialogs';
import { ArduinoFirmwareUploader } from '../../../common/protocol/arduino-firmware-uploader';
import { createBoardList } from '../../../common/protocol/board-list';
import { ArduinoPreferences } from '../../arduino-preferences';
import { BoardsServiceProvider } from '../../boards/boards-service-provider';
import { AbstractDialog } from '../../theia/dialogs/dialogs'; import { AbstractDialog } from '../../theia/dialogs/dialogs';
import { Widget } from '@theia/core/shared/@phosphor/widgets';
import { Message } from '@theia/core/shared/@phosphor/messaging';
import { ReactWidget } from '@theia/core/lib/browser/widgets/react-widget';
import {
AvailableBoard,
BoardsServiceProvider,
} from '../../boards/boards-service-provider';
import { CertificateUploaderComponent } from './certificate-uploader-component'; import { CertificateUploaderComponent } from './certificate-uploader-component';
import { ArduinoPreferences } from '../../arduino-preferences';
import {
PreferenceScope,
PreferenceService,
} from '@theia/core/lib/browser/preferences/preference-service';
import { CommandRegistry } from '@theia/core/lib/common/command';
import { certificateList, sanifyCertString } from './utils'; import { certificateList, sanifyCertString } from './utils';
import { ArduinoFirmwareUploader } from '../../../common/protocol/arduino-firmware-uploader';
import { nls } from '@theia/core/lib/common';
import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';
@injectable() @injectable()
export class UploadCertificateDialogWidget extends ReactWidget { export class UploadCertificateDialogWidget extends ReactWidget {
@inject(BoardsServiceProvider) @inject(BoardsServiceProvider)
private readonly boardsServiceProvider: BoardsServiceProvider; protected readonly boardsServiceClient: BoardsServiceProvider;
@inject(ArduinoPreferences) @inject(ArduinoPreferences)
private readonly arduinoPreferences: ArduinoPreferences; protected readonly arduinoPreferences: ArduinoPreferences;
@inject(PreferenceService) @inject(PreferenceService)
private readonly preferenceService: PreferenceService; protected readonly preferenceService: PreferenceService;
@inject(CommandRegistry) @inject(CommandRegistry)
private readonly commandRegistry: CommandRegistry; protected readonly commandRegistry: CommandRegistry;
@inject(ArduinoFirmwareUploader) @inject(ArduinoFirmwareUploader)
private readonly arduinoFirmwareUploader: ArduinoFirmwareUploader; protected readonly arduinoFirmwareUploader: ArduinoFirmwareUploader;
@inject(FrontendApplicationStateService) @inject(FrontendApplicationStateService)
private readonly appStateService: FrontendApplicationStateService; private readonly appStateService: FrontendApplicationStateService;
private certificates: string[] = []; protected certificates: string[] = [];
private updatableFqbns: string[] = []; protected updatableFqbns: string[] = [];
private boardList = createBoardList({}); protected availableBoards: AvailableBoard[] = [];
busyCallback = (busy: boolean) => { public busyCallback = (busy: boolean) => {
return; return;
}; };
constructor() {
super();
}
@postConstruct() @postConstruct()
protected init(): void { protected init(): void {
this.arduinoPreferences.ready.then(() => { this.arduinoPreferences.ready.then(() => {
@@ -70,8 +81,8 @@ export class UploadCertificateDialogWidget extends ReactWidget {
}) })
); );
this.boardsServiceProvider.onBoardListDidChange((boardList) => { this.boardsServiceClient.onAvailableBoardsChanged((availableBoards) => {
this.boardList = boardList; this.availableBoards = availableBoards;
this.update(); this.update();
}); });
} }
@@ -115,7 +126,7 @@ export class UploadCertificateDialogWidget extends ReactWidget {
protected render(): React.ReactNode { protected render(): React.ReactNode {
return ( return (
<CertificateUploaderComponent <CertificateUploaderComponent
boardList={this.boardList} availableBoards={this.availableBoards}
certificates={this.certificates} certificates={this.certificates}
updatableFqbns={this.updatableFqbns} updatableFqbns={this.updatableFqbns}
addCertificate={this.addCertificate.bind(this)} addCertificate={this.addCertificate.bind(this)}
@@ -132,7 +143,7 @@ export class UploadCertificateDialogProps extends DialogProps {}
@injectable() @injectable()
export class UploadCertificateDialog extends AbstractDialog<void> { export class UploadCertificateDialog extends AbstractDialog<void> {
@inject(UploadCertificateDialogWidget) @inject(UploadCertificateDialogWidget)
private readonly widget: UploadCertificateDialogWidget; protected readonly widget: UploadCertificateDialogWidget;
private busy = false; private busy = false;

Some files were not shown because too many files have changed in this diff Show More