Compare commits

..

No commits in common. "main" and "2.0.3" have entirely different histories.
main ... 2.0.3

555 changed files with 37006 additions and 67725 deletions

View File

@ -1,66 +1,64 @@
module.exports = { module.exports = {
parser: '@typescript-eslint/parser', // Specifies the ESLint parser parser: '@typescript-eslint/parser', // Specifies the ESLint parser
parserOptions: { parserOptions: {
ecmaVersion: 2020, // Allows for the parsing of modern ECMAScript features ecmaVersion: 2020, // Allows for the parsing of modern ECMAScript features
sourceType: 'module', // Allows for the use of imports sourceType: 'module', // Allows for the use of imports
ecmaFeatures: { ecmaFeatures: {
jsx: true, // Allows for the parsing of JSX jsx: true, // Allows for the parsing of JSX
},
}, },
}, 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/*',
'electron-app/src-gen/*', 'electron-app/*',
'electron-app/gen-webpack*.js', 'plugins/*',
'!electron-app/webpack.config.js', 'arduino-ide-extension/src/node/cli-protocol',
'electron-app/plugins/*',
'arduino-ide-extension/src/node/cli-protocol',
'**/lib/*',
],
settings: {
react: {
version: 'detect', // Tells eslint-plugin-react to automatically detect the version of React to use
},
},
extends: [
'plugin:@typescript-eslint/recommended', // Uses the recommended rules from the @typescript-eslint/eslint-plugin
'plugin:react/recommended', // Uses the recommended rules from @eslint-plugin-react
'plugin:react-hooks/recommended', // Uses recommended rules from react hooks
'plugin:prettier/recommended',
'prettier', // Uses eslint-config-prettier to disable ESLint rules from @typescript-eslint/eslint-plugin that would conflict with prettier
],
plugins: ['prettier', 'unused-imports'],
rules: {
'@typescript-eslint/no-unused-expressions': 'off',
'@typescript-eslint/no-namespace': 'off',
'@typescript-eslint/no-var-requires': 'off',
'@typescript-eslint/no-empty-function': 'warn',
'@typescript-eslint/no-empty-interface': 'warn',
'no-unused-vars': 'off',
'unused-imports/no-unused-imports': 'error',
'unused-imports/no-unused-vars': [
'warn',
{
vars: 'all',
varsIgnorePattern: '^_',
args: 'after-used',
argsIgnorePattern: '^_',
},
], ],
'react/display-name': 'warn', settings: {
eqeqeq: ['error', 'smart'], react: {
'guard-for-in': 'off', version: 'detect', // Tells eslint-plugin-react to automatically detect the version of React to use
'id-blacklist': 'off', },
'id-match': 'off', },
'no-underscore-dangle': 'off', extends: [
'no-unused-expressions': 'off', 'plugin:@typescript-eslint/recommended', // Uses the recommended rules from the @typescript-eslint/eslint-plugin
'no-var': 'error', 'plugin:react/recommended', // Uses the recommended rules from @eslint-plugin-react
radix: 'error', 'plugin:react-hooks/recommended', // Uses recommended rules from react hooks
'prettier/prettier': 'warn', 'plugin:prettier/recommended',
}, 'prettier', // Uses eslint-config-prettier to disable ESLint rules from @typescript-eslint/eslint-plugin that would conflict with prettier
],
plugins: ['prettier', 'unused-imports'],
rules: {
'@typescript-eslint/no-unused-expressions': 'off',
'@typescript-eslint/no-namespace': 'off',
'@typescript-eslint/no-var-requires': 'off',
'@typescript-eslint/no-empty-function': 'warn',
'@typescript-eslint/no-empty-interface': 'warn',
'no-unused-vars': 'off',
'unused-imports/no-unused-imports': 'error',
'unused-imports/no-unused-vars': [
'warn',
{
vars: 'all',
varsIgnorePattern: '^_',
args: 'after-used',
argsIgnorePattern: '^_',
},
],
'react/display-name': 'warn',
eqeqeq: ['error', 'smart'],
'guard-for-in': 'off',
'id-blacklist': 'off',
'id-match': 'off',
'no-underscore-dangle': 'off',
'no-unused-expressions': 'off',
'no-var': 'error',
radix: 'error',
'prettier/prettier': 'warn',
},
}; };

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,63 +0,0 @@
# The Arduino IDE Linux build workflow job runs in this container.
# syntax=docker/dockerfile:1
# See: https://hub.docker.com/_/ubuntu/tags
FROM ubuntu:18.10
# This is required in order to use the Ubuntu package repositories for EOL Ubuntu versions:
# https://help.ubuntu.com/community/EOLUpgrades#Update_sources.list
RUN \
sed \
--in-place \
--regexp-extended \
--expression='s/([a-z]{2}\.)?archive.ubuntu.com|security.ubuntu.com/old-releases.ubuntu.com/g' \
"/etc/apt/sources.list"
RUN \
apt-get \
--yes \
update
RUN \
apt-get \
--yes \
install \
"git"
# 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
# container.
RUN \
apt-get \
--yes \
install \
"python3.7-minimal=3.7.3-2~18.10"
# 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-3" \
"libx11-dev=2:1.6.7-1" \
"libxkbfile-dev=1:1.0.9-2"
# Target python3 symlink to Python 3.7 installation. It would otherwise target version 3.6 due to the installation of
# the `python3` package as a transitive dependency.
RUN \
ln \
--symbolic \
--force \
"$(which python3.7)" \
"/usr/bin/python3"

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,517 +22,150 @@ 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.17"
# See: https://github.com/actions/setup-node/#readme JOB_TRANSFER_ARTIFACT: build-artifacts
NODE_VERSION: '18.17'
YARN_VERSION: '1.22'
JOB_TRANSFER_ARTIFACT_PREFIX: build-artifacts-
CHANGELOG_ARTIFACTS: changelog CHANGELOG_ARTIFACTS: changelog
STAGED_CHANNEL_FILE_ARTIFACT_PREFIX: staged-channel-file-
BASE_BUILD_DATA: |
- config:
# Human identifier for the job.
name: Windows
runs-on: [self-hosted, windows-sign-pc]
# The value is a string representing a JSON document.
# Setting this to null causes the job to run directly in the runner machine instead of in a container.
container: |
null
# Name of the secret that contains the certificate.
certificate-secret: INSTALLER_CERT_WINDOWS_CER
# Name of the secret that contains the certificate password.
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
# Arbitrary identifier used to give the workflow artifact uploaded by each "build" matrix job a unique name.
job-transfer-artifact-suffix: Windows_64bit
# 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\"
}
job-transfer-artifact-suffix: Linux_64bit
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:
# 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-password-secret: KEYCHAIN_PASSWORD
certificate-extension: p12
job-transfer-artifact-suffix: macOS_64bit
mergeable-channel-file: 'true'
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
job-transfer-artifact-suffix: macOS_arm64
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: 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 }}
environment: production
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_ROLE_ARN != '' }}" >> $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 \
'map(.artifacts[] + (.config | pick(["job-transfer-artifact-suffix"])))'
)"
# 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 \
'map(.artifacts[] + (.config | pick(["job-transfer-artifact-suffix"])))'
)"
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: build:
name: build (${{ matrix.config.name }}) name: build (${{ matrix.config.os }})
needs:
- build-type-determination
- select-targets
env:
# 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] }}
PUPPETEER_SKIP_DOWNLOAD: true
strategy: strategy:
matrix: matrix:
config: ${{ fromJson(needs.select-targets.outputs.build-matrix) }} config:
runs-on: ${{ matrix.config.runs-on }} - os: windows-2019
container: ${{ fromJSON(matrix.config.container) }} certificate-secret: WINDOWS_SIGNING_CERTIFICATE_PFX # Name of the secret that contains the certificate.
defaults: certificate-password-secret: WINDOWS_SIGNING_CERTIFICATE_PASSWORD # Name of the secret that contains the certificate password.
run: certificate-extension: pfx # File extension for the certificate.
# Avoid problems caused by different default shell for container jobs (sh) vs non-container jobs (bash). - os: ubuntu-18.04 # https://github.com/arduino/arduino-ide/issues/259
shell: bash - os: macos-latest
# 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
certificate-secret: APPLE_SIGNING_CERTIFICATE_P12
certificate-password-secret: KEYCHAIN_PASSWORD
certificate-extension: p12
runs-on: ${{ matrix.config.os }}
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
uses: actions/checkout@v4 uses: actions/checkout@v3
- name: Install Node.js 16.x
- name: Install Node.js uses: actions/setup-node@v3
if: runner.name != 'WINDOWS-SIGN-PC'
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'
# Yarn is a prerequisite for the action's cache feature, so caching should be disabled when running in the
# container where Yarn is not pre-installed.
cache: ${{ fromJSON(matrix.config.container) == null && 'yarn' || null }}
- name: Install Yarn
if: runner.name != 'WINDOWS-SIGN-PC'
run: |
npm \
install \
--global \
"yarn@${{ env.YARN_VERSION }}"
- 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: runner.name != 'WINDOWS-SIGN-PC' uses: actions/setup-go@v3
uses: actions/setup-go@v5
with: with:
go-version: ${{ env.GO_VERSION }} go-version: ${{ env.GO_VERSION }}
- name: Install Taskfile - name: Install Taskfile
if: runner.name != 'WINDOWS-SIGN-PC' uses: arduino/setup-task@v1
uses: arduino/setup-task@v2
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 }}
AC_PASSWORD: ${{ secrets.AC_PASSWORD }} AC_PASSWORD: ${{ secrets.AC_PASSWORD }}
AC_TEAM_ID: ${{ secrets.AC_TEAM_ID }} AC_TEAM_ID: ${{ secrets.AC_TEAM_ID }}
IS_NIGHTLY: ${{ needs.build-type-determination.outputs.is-nightly }} AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
IS_RELEASE: ${{ needs.build-type-determination.outputs.is-release }} AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
IS_NIGHTLY: ${{ github.event_name == 'schedule' || (github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main') }}
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 - name: Upload [GitHub Actions]
yarn --cwd electron-app rebuild uses: actions/upload-artifact@v3
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@v4
if: >
needs.select-targets.outputs.merge-channel-files == 'true' &&
matrix.config.mergeable-channel-file == 'true'
with: with:
if-no-files-found: error name: ${{ env.JOB_TRANSFER_ARTIFACT }}
name: ${{ env.STAGED_CHANNEL_FILE_ARTIFACT_PREFIX }}${{ matrix.config.job-transfer-artifact-suffix }} path: electron/build/dist/build-artifacts/
path: ${{ matrix.config.working-directory && format('{0}/{1}', matrix.config.working-directory, env.STAGED_CHANNEL_FILES_PATH) || env.STAGED_CHANNEL_FILES_PATH }}
- name: Upload builds to job transfer artifact
uses: actions/upload-artifact@v4
with:
name: ${{ env.JOB_TRANSFER_ARTIFACT_PREFIX }}${{ matrix.config.job-transfer-artifact-suffix }}
path: ${{ matrix.config.working-directory && format('{0}/{1}', matrix.config.working-directory, env.BUILD_ARTIFACTS_PATH) || env.BUILD_ARTIFACTS_PATH }}
- 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 file artifacts
uses: actions/download-artifact@v4
with:
merge-multiple: true
path: ${{ env.CHANNEL_FILES_PATH }}
pattern: ${{ env.STAGED_CHANNEL_FILE_ARTIFACT_PREFIX }}*
- name: Remove no longer needed artifacts
uses: geekyeggo/delete-artifact@v5
with:
name: ${{ env.STAGED_CHANNEL_FILE_ARTIFACT_PREFIX }}*
- 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 (Linux only)
if: runner.os == 'Linux'
run: |
sudo apt-get update
sudo apt-get install -y libx11-dev libxkbfile-dev libsecret-1-dev
- 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 job transfer artifact
uses: actions/upload-artifact@v4
with:
if-no-files-found: error
name: ${{ env.JOB_TRANSFER_ARTIFACT_PREFIX }}channel-files
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
env:
BUILD_ARTIFACTS_FOLDER: build-artifacts
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 that contains ${{ matrix.artifact.name }} tester build - name: Download job transfer artifact
uses: actions/download-artifact@v4 uses: actions/download-artifact@v3
with: with:
name: ${{ env.JOB_TRANSFER_ARTIFACT_PREFIX }}${{ matrix.artifact.job-transfer-artifact-suffix }} name: ${{ env.JOB_TRANSFER_ARTIFACT }}
path: ${{ env.BUILD_ARTIFACTS_FOLDER }} path: ${{ env.JOB_TRANSFER_ARTIFACT }}
- name: Upload tester build artifact - name: Upload tester build artifact
uses: actions/upload-artifact@v4 uses: actions/upload-artifact@v3
with: with:
name: ${{ matrix.artifact.name }} name: ${{ matrix.artifact.name }}
path: ${{ env.BUILD_ARTIFACTS_FOLDER }}/${{ 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')
@ -555,99 +180,50 @@ jobs:
fi fi
fi fi
echo -e "$BODY" echo -e "$BODY"
OUTPUT_SAFE_BODY="${BODY//'%'/'%25'}"
# Set workflow step output OUTPUT_SAFE_BODY="${OUTPUT_SAFE_BODY//$'\n'/'%0A'}"
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#multiline-strings OUTPUT_SAFE_BODY="${OUTPUT_SAFE_BODY//$'\r'/'%0D'}"
DELIMITER="$RANDOM" echo "BODY=$OUTPUT_SAFE_BODY" >> $GITHUB_OUTPUT
echo "BODY<<$DELIMITER" >> $GITHUB_OUTPUT
echo "$BODY" >> $GITHUB_OUTPUT
echo "$DELIMITER" >> $GITHUB_OUTPUT
echo "$BODY" > CHANGELOG.txt echo "$BODY" > CHANGELOG.txt
- name: Upload changelog job transfer artifact - 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@v4 uses: actions/upload-artifact@v3
with: with:
name: ${{ env.JOB_TRANSFER_ARTIFACT_PREFIX }}changelog 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
env:
ARTIFACTS_FOLDER: build-artifacts
environment: production
permissions:
id-token: write
contents: read
steps: steps:
- name: Download all job transfer artifacts - name: Download [GitHub Actions]
uses: actions/download-artifact@v4 uses: actions/download-artifact@v3
with: with:
merge-multiple: true name: ${{ env.JOB_TRANSFER_ARTIFACT }}
path: ${{ env.ARTIFACTS_FOLDER }} path: ${{ env.JOB_TRANSFER_ARTIFACT }}
pattern: ${{ env.JOB_TRANSFER_ARTIFACT_PREFIX }}*
- name: Configure AWS Credentials for Nightly [S3]
uses: aws-actions/configure-aws-credentials@v4
with:
role-to-assume: ${{ secrets.AWS_ROLE_ARN }}
aws-region: us-east-1
- name: Publish Nightly [S3] - name: Publish Nightly [S3]
run: | uses: docker://plugins/s3
aws s3 sync ${{ env.ARTIFACTS_FOLDER }} s3://${{ secrets.DOWNLOADS_BUCKET }}/arduino-ide/nightly env:
PLUGIN_SOURCE: '${{ env.JOB_TRANSFER_ARTIFACT }}/*'
PLUGIN_STRIP_PREFIX: '${{ env.JOB_TRANSFER_ARTIFACT }}/'
PLUGIN_TARGET: '/arduino-ide/nightly'
PLUGIN_BUCKET: ${{ secrets.DOWNLOADS_BUCKET }}
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
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
env:
ARTIFACTS_FOLDER: build-artifacts
environment: production
permissions:
id-token: write
contents: write
steps: steps:
- name: Download all job transfer artifacts - name: Download [GitHub Actions]
uses: actions/download-artifact@v4 uses: actions/download-artifact@v3
with: with:
merge-multiple: true name: ${{ env.JOB_TRANSFER_ARTIFACT }}
path: ${{ env.ARTIFACTS_FOLDER }} path: ${{ env.JOB_TRANSFER_ARTIFACT }}
pattern: ${{ env.JOB_TRANSFER_ARTIFACT_PREFIX }}*
- name: Get Tag - name: Get Tag
id: tag_name id: tag_name
@ -655,32 +231,30 @@ 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.3.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 }}
file: ${{ env.ARTIFACTS_FOLDER }}/* file: ${{ env.JOB_TRANSFER_ARTIFACT }}/*
tag: ${{ github.ref }} tag: ${{ github.ref }}
file_glob: true file_glob: true
body: ${{ needs.changelog.outputs.BODY }} body: ${{ needs.changelog.outputs.BODY }}
- name: Configure AWS Credentials for Release [S3]
if: needs.build-type-determination.outputs.publish-to-s3 == 'true'
uses: aws-actions/configure-aws-credentials@v4
with:
role-to-assume: ${{ secrets.AWS_ROLE_ARN }}
aws-region: us-east-1
- name: Publish Release [S3] - name: Publish Release [S3]
if: needs.build-type-determination.outputs.publish-to-s3 == 'true' if: github.repository == 'arduino/arduino-ide'
run: | uses: docker://plugins/s3
aws s3 sync ${{ env.ARTIFACTS_FOLDER }} s3://${{ secrets.DOWNLOADS_BUCKET }}/arduino-ide env:
PLUGIN_SOURCE: '${{ env.JOB_TRANSFER_ARTIFACT }}/*'
PLUGIN_STRIP_PREFIX: '${{ env.JOB_TRANSFER_ARTIFACT }}/'
PLUGIN_TARGET: '/arduino-ide'
PLUGIN_BUCKET: ${{ secrets.DOWNLOADS_BUCKET }}
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
clean: clean:
# 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
@ -688,7 +262,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Remove unneeded job transfer artifacts - name: Remove unneeded job transfer artifact
uses: geekyeggo/delete-artifact@v5 uses: geekyeggo/delete-artifact@v2
with: with:
name: ${{ env.JOB_TRANSFER_ARTIFACT_PREFIX }}* name: ${{ env.JOB_TRANSFER_ARTIFACT }}

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,11 +57,9 @@ 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 \ -noout -passin env:CERTIFICATE_PASSWORD
-noout \
-passin env:CERTIFICATE_PASSWORD
) || ( ) || (
echo "::error::Verification of ${{ matrix.certificate.identifier }} failed!!!" echo "::error::Verification of ${{ matrix.certificate.identifier }} failed!!!"
exit 1 exit 1
@ -124,43 +82,25 @@ 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 \ -in "${{ env.CERTIFICATE_PATH }}" \
-in "${{ env.CERTIFICATE_PATH }}" \ -clcerts \
-clcerts \ -nodes \
-legacy \ -passin env:CERTIFICATE_PASSWORD
-nodes \ ) | (
-passin env:CERTIFICATE_PASSWORD openssl x509 \
) | ( -noout \
openssl x509 \ -enddate
-noout \ ) | (
-enddate grep \
) | ( --max-count=1 \
grep \ --only-matching \
--max-count=1 \ --perl-regexp \
--only-matching \ 'notAfter=(\K.*)'
--perl-regexp \ )
'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@v6
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.17"
# 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,69 +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@v3
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 (Linux only)
if: runner.os == 'Linux'
run: |
sudo apt-get update
sudo apt-get install -y libx11-dev libxkbfile-dev libsecret-1-dev
- name: Install dependencies - name: Install dependencies
run: yarn install --immutable run: yarn
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Check for errors - name: Check for errors
run: yarn i18n:check run: yarn i18n:check

View File

@ -1,94 +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 Dependencies (Linux only)
if: runner.os == 'Linux'
run: |
sudo apt-get update
sudo apt-get install -y libx11-dev libxkbfile-dev libsecret-1-dev
- 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,97 +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 Dependencies (Linux only)
if: runner.os == 'Linux'
run: |
sudo apt-get update
sudo apt-get install -y libx11-dev libxkbfile-dev libsecret-1-dev
- 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,33 +8,22 @@ 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:
if: github.repository == 'arduino/arduino-ide' if: github.repository == 'arduino/arduino-ide'
runs-on: ubuntu-latest runs-on: ubuntu-latest
permissions:
id-token: write
contents: read
environment: production
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'
- name: Install Dependencies (Linux only)
if: runner.os == 'Linux'
run: |
sudo apt-get update
sudo apt-get install -y libx11-dev libxkbfile-dev libsecret-1-dev
- name: Get Tag - name: Get Tag
id: tag_name id: tag_name
run: | run: |
@ -43,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
@ -55,12 +44,12 @@ jobs:
# Compose changelog # Compose changelog
yarn run compose-changelog "${{ github.workspace }}/${{ env.CHANGELOG_ARTIFACTS }}/$CHANGELOG_FILE_NAME" yarn run compose-changelog "${{ github.workspace }}/${{ env.CHANGELOG_ARTIFACTS }}/$CHANGELOG_FILE_NAME"
- name: Configure AWS Credentials for Changelog [S3]
uses: aws-actions/configure-aws-credentials@v4
with:
role-to-assume: ${{ secrets.AWS_ROLE_ARN }}
aws-region: us-east-1
- name: Publish Changelog [S3] - name: Publish Changelog [S3]
run: | uses: docker://plugins/s3
aws s3 sync ${{ env.CHANGELOG_ARTIFACTS }} s3://${{ secrets.DOWNLOADS_BUCKET }}/arduino-ide/changelog env:
PLUGIN_SOURCE: '${{ env.CHANGELOG_ARTIFACTS }}/*'
PLUGIN_STRIP_PREFIX: '${{ env.CHANGELOG_ARTIFACTS }}/'
PLUGIN_TARGET: '/arduino-ide/changelog'
PLUGIN_BUCKET: ${{ secrets.DOWNLOADS_BUCKET }}
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

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.17"
on: on:
schedule: schedule:
@ -14,34 +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@v3
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 (Linux only)
if: runner.os == 'Linux'
run: |
sudo apt-get update
sudo apt-get install -y libx11-dev libxkbfile-dev libsecret-1-dev
- 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.17"
on: on:
schedule: schedule:
@ -14,34 +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@v3
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 (Linux only)
if: runner.os == 'Linux'
run: |
sudo apt-get update
sudo apt-get install -y libx11-dev libxkbfile-dev libsecret-1-dev
- 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
@ -52,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@v7 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@v6
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,21 +5,21 @@ 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:
env: env:
CONFIGURATIONS_FOLDER: .github/label-configuration-files CONFIGURATIONS_FOLDER: .github/label-configuration-files
CONFIGURATIONS_ARTIFACT_PREFIX: label-configuration-file- CONFIGURATIONS_ARTIFACT: label-configuration-files
jobs: jobs:
check: check:
@ -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
@ -71,13 +71,13 @@ jobs:
file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/${{ matrix.filename }} file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/${{ matrix.filename }}
- name: Pass configuration files to next job via workflow artifact - name: Pass configuration files to next job via workflow artifact
uses: actions/upload-artifact@v4 uses: actions/upload-artifact@v3
with: with:
path: | path: |
*.yaml *.yaml
*.yml *.yml
if-no-files-found: error if-no-files-found: error
name: ${{ env.CONFIGURATIONS_ARTIFACT_PREFIX }}${{ matrix.filename }} name: ${{ env.CONFIGURATIONS_ARTIFACT }}
sync: sync:
needs: download needs: download
@ -106,19 +106,18 @@ 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 file artifacts - name: Download configuration files artifact
uses: actions/download-artifact@v4 uses: actions/download-artifact@v3
with: with:
merge-multiple: true name: ${{ env.CONFIGURATIONS_ARTIFACT }}
pattern: ${{ env.CONFIGURATIONS_ARTIFACT_PREFIX }}*
path: ${{ env.CONFIGURATIONS_FOLDER }} path: ${{ env.CONFIGURATIONS_FOLDER }}
- name: Remove unneeded artifacts - name: Remove unneeded artifact
uses: geekyeggo/delete-artifact@v5 uses: geekyeggo/delete-artifact@v2
with: with:
name: ${{ env.CONFIGURATIONS_ARTIFACT_PREFIX }}* name: ${{ env.CONFIGURATIONS_ARTIFACT }}
- name: Merge label configuration files - name: Merge label configuration files
run: | run: |

View File

@ -1,140 +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 Dependencies (Linux only)
if: runner.os == 'Linux'
run: |
sudo apt-get update
sudo apt-get install -y libx11-dev libxkbfile-dev libsecret-1-dev
- 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,42 +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.17"
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@v3
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 (Linux only)
if: runner.os == 'Linux'
run: |
sudo apt-get update
sudo apt-get install -y libx11-dev libxkbfile-dev libsecret-1-dev
- 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
@ -61,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@v7 uses: peter-evans/create-pull-request@v4
with: with:
commit-message: Updated themes commit-message: Updated themes
title: Update themes title: Update themes

17
.gitignore vendored
View File

@ -1,22 +1,23 @@
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/ 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
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
}
}
]
}

74
.vscode/launch.json vendored
View File

@ -4,33 +4,36 @@
{ {
"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", "--no-cluster",
"--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 +42,34 @@
{ {
"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", "--no-cluster",
"--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 +86,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 +96,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 +109,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

@ -2,11 +2,8 @@
"files.exclude": { "files.exclude": {
"**/lib": false "**/lib": false
}, },
"search.exclude": {
"arduino-ide-extension/src/test/node/__test_sketchbook__": true
},
"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,14 +55,12 @@ 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`
### Update **clangd** and **ClangFormat** ### Update **clangd** and **ClangFormat**
@ -74,13 +72,11 @@ 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 - !! download the **new** `arduino-icons.json` file and put it in this repo
- !! download the **new** `arduino-icons.json` file and put it in this repo - Click on "Generate Font" in Icomoon, then download
- Click on "Generate Font" in Icomoon, then download - place the updated fonts in the `src/style/fonts` directory
- place the updated fonts in the `src/style/fonts` directory

File diff suppressed because one or more lines are too long

View File

@ -1,136 +1,129 @@
{ {
"name": "arduino-ide-extension", "name": "arduino-ide-extension",
"version": "2.3.7", "version": "2.0.3",
"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: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.57.0", "@theia/application-package": "1.31.1",
"@theia/core": "1.57.0", "@theia/core": "1.31.1",
"@theia/debug": "1.57.0", "@theia/debug": "1.31.1",
"@theia/editor": "1.57.0", "@theia/editor": "1.31.1",
"@theia/electron": "1.57.0", "@theia/electron": "1.31.1",
"@theia/filesystem": "1.57.0", "@theia/filesystem": "1.31.1",
"@theia/keymaps": "1.57.0", "@theia/keymaps": "1.31.1",
"@theia/markers": "1.57.0", "@theia/markers": "1.31.1",
"@theia/messages": "1.57.0", "@theia/messages": "1.31.1",
"@theia/monaco": "1.57.0", "@theia/monaco": "1.31.1",
"@theia/monaco-editor-core": "1.83.101", "@theia/monaco-editor-core": "1.67.2",
"@theia/navigator": "1.57.0", "@theia/navigator": "1.31.1",
"@theia/outline-view": "1.57.0", "@theia/outline-view": "1.31.1",
"@theia/output": "1.57.0", "@theia/output": "1.31.1",
"@theia/plugin-ext": "1.57.0", "@theia/plugin-ext": "1.31.1",
"@theia/plugin-ext-vscode": "1.57.0", "@theia/preferences": "1.31.1",
"@theia/preferences": "1.57.0", "@theia/scm": "1.31.1",
"@theia/scm": "1.57.0", "@theia/search-in-workspace": "1.31.1",
"@theia/search-in-workspace": "1.57.0", "@theia/terminal": "1.31.1",
"@theia/terminal": "1.57.0", "@theia/typehierarchy": "1.31.1",
"@theia/test": "1.57.0", "@theia/workspace": "1.31.1",
"@theia/typehierarchy": "1.57.0",
"@theia/workspace": "1.57.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/ncp": "^2.0.4",
"@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-virtualized": "^9.21.21",
"@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",
"cross-fetch": "^3.1.5",
"dateformat": "^3.0.3", "dateformat": "^3.0.3",
"deepmerge": "^4.2.2", "deepmerge": "2.0.1",
"dompurify": "^2.4.7",
"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-safe-stringify": "^2.1.1", "fast-safe-stringify": "^2.1.1",
"filename-reserved-regex": "^2.0.0", "glob": "^7.1.6",
"fqbn": "^1.0.5",
"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",
"js-yaml": "^3.13.1", "js-yaml": "^3.13.1",
"jsdom": "^21.1.1",
"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",
"keytar": "7.2.0", "keytar": "7.2.0",
"lodash.debounce": "^4.0.8", "lodash.debounce": "^4.0.8",
"minimatch": "^3.1.2", "minimatch": "^3.1.2",
"ncp": "^2.0.0",
"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",
"react-markdown": "^8.0.0", "react-markdown": "^8.0.0",
"react-perfect-scrollbar": "^1.5.8", "react-perfect-scrollbar": "^1.5.8",
"react-select": "^5.6.0", "react-select": "^5.6.0",
"react-tabs": "^6.1.0", "react-tabs": "^3.1.2",
"react-virtualized": "^9.22.3",
"react-window": "^1.8.6", "react-window": "^1.8.6",
"semver": "^7.3.2", "semver": "^7.3.2",
"string-natural-compare": "^2.0.3", "string-natural-compare": "^2.0.3",
"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", "protoc": "^1.0.4",
"rimraf": "^5.0.0" "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": [
@ -150,9 +143,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"
@ -163,29 +153,22 @@
{ {
"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.2.0" "version": "0.29.0"
}, },
"arduino-fwuploader": { "fwuploader": {
"version": "2.4.1" "version": "2.2.2"
},
"arduino-language-server": {
"version": {
"owner": "arduino",
"repo": "arduino-language-server",
"commitish": "05ec308"
}
}, },
"clangd": { "clangd": {
"version": "14.0.0" "version": "14.0.0"
},
"languageServer": {
"version": "0.7.2"
} }
} }
} }

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.2'; 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.2';
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) { return 'macOS_64bit.tar.gz';
case 'arm64':
return 'macOS_ARM64.tar.gz';
case 'x64':
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, strip: 1,
resourcesFolder, }); // `strip`: the new clangd (12.x) is zipped into a folder, so we have to strip the outmost folder.
clangdExecutablePath,
force,
{
strip: 1,
}
); // `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,88 +1,82 @@
// @ts-check // @ts-check
(async () => { (async () => {
const os = require('node:os');
const path = require('node:path');
const decompress = require('decompress');
const unzip = require('decompress-unzip');
const { mkdirSync, promises: fs, rmSync, existsSync } = require('node:fs');
const { exec } = require('./utils');
const { glob } = require('glob');
const { SemVer, gte, valid: validSemVer, eq } = require('semver');
// Use a node-protoc fork until apple arm32 is supported
// https://github.com/YePpHa/node-protoc/pull/10
const protoc = path.dirname(require('@pingghost/protoc/protoc'));
const { owner, repo, commitish } = (() => { const os = require('os');
const pkg = require(path.join(__dirname, '..', 'package.json')); const path = require('path');
if (!pkg) { const glob = require('glob');
console.log(`Could not parse the 'package.json'.`); const { v4 } = require('uuid');
process.exit(1); const shell = require('shelljs');
const protoc = path.dirname(require('protoc/protoc'));
shell.env.PATH = `${shell.env.PATH}${path.delimiter}${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 defaultVersion = { const { owner, repo, commitish } = (() => {
owner: 'arduino', const pkg = require(path.join(__dirname, '..', 'package.json'));
repo: 'arduino-cli', if (!pkg) {
commitish: undefined, shell.echo(`Could not parse the 'package.json'.`);
}; shell.exit(1);
const { arduino } = pkg; }
if (!arduino) {
return defaultVersion;
}
const cli = arduino['arduino-cli']; const { arduino } = pkg;
if (!cli) { if (!arduino) {
return defaultVersion; return { owner: 'arduino', repo: 'arduino-cli' };
} }
const { version } = cli; const { cli } = arduino;
if (!version) { if (!cli) {
return defaultVersion; return { owner: 'arduino', repo: 'arduino-cli' };
} }
if (typeof version === 'string') { const { version } = cli;
return defaultVersion; if (!version) {
} return { owner: 'arduino', repo: 'arduino-cli' };
}
// We assume an object with `owner`, `repo`, commitish?` properties. if (typeof version === 'string') {
const { owner, repo, commitish } = version; return { owner: 'arduino', repo: 'arduino-cli' };
if (!owner) { }
console.log(`Could not retrieve 'owner' from ${JSON.stringify(version)}`);
process.exit(1);
}
if (!repo) {
console.log(`Could not retrieve 'repo' from ${JSON.stringify(version)}`);
process.exit(1);
}
return { owner, repo, commitish }; // 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 { platform } = process; return { owner, repo, commitish };
const resourcesFolder = path.join( })();
__dirname,
'..', const url = `https://github.com/${owner}/${repo}.git`;
'src', shell.echo(`>>> Cloning repository from '${url}'...`);
'node', if (shell.exec(`git clone ${url} ${repository}`).code !== 0) {
'resources' shell.exit(1);
); }
const cli = path.join( shell.echo(`<<< Repository cloned.`);
resourcesFolder,
`arduino-cli${platform === 'win32' ? '.exe' : ''}` const { platform } = process;
); const build = path.join(__dirname, '..', 'build');
const versionJson = exec(cli, ['version', '--format', 'json'], { const cli = path.join(build, `arduino-cli${platform === 'win32' ? '.exe' : ''}`);
logStdout: true, const versionJson = shell.exec(`${cli} version --format json`).trim();
}).trim(); if (!versionJson) {
if (!versionJson) { shell.echo(`Could not retrieve the CLI version from ${cli}.`);
console.log(`Could not retrieve the CLI version from ${cli}.`); shell.exit(1);
process.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. // - `0.0.0-git` for local builds, we use the `commitish` from the `package.json` to check out the code and generate the APIs.
// - `0.0.0-git` for local builds, we use the `commitish` from the `package.json` to check out the code and generate the APIs. // - `git-snapshot` for local build executed via `task build`. We do not do this.
// - `git-snapshot` for local build executed via `task build`. We do not do this. // - rest, we assume it is a valid semver and has the corresponding tagged code, we use the tag to generate the APIs from the `proto` files.
// - rest, we assume it is a valid semver and has the corresponding tagged code, we use the tag to generate the APIs from the `proto` files. /*
/*
{ {
"Application": "arduino-cli", "Application": "arduino-cli",
"VersionString": "nightly-20210126", "VersionString": "nightly-20210126",
@ -90,200 +84,73 @@
"Status": "alpha", "Status": "alpha",
"Date": "2021-01-26T01:46:31Z" "Date": "2021-01-26T01:46:31Z"
} }
*/ */
const versionObject = JSON.parse(versionJson); const versionObject = JSON.parse(versionJson);
async function globProtos(folder, pattern = '**/*.proto') {
let protos = [];
try {
const matches = await glob(pattern, { cwd: folder });
protos = matches.map((filename) => path.join(folder, filename));
} catch (error) {
console.log(error.stack ?? error.message);
}
return protos;
}
async function getProtosFromRepo(
commitish = '',
version = '',
owner = 'arduino',
repo = 'arduino-cli'
) {
const repoFolder = await fs.mkdtemp(path.join(os.tmpdir(), 'arduino-cli-'));
const url = `https://github.com/${owner}/${repo}.git`;
console.log(`>>> Cloning repository from '${url}'...`);
exec('git', ['clone', url, repoFolder], { logStdout: true });
console.log(`<<< Repository cloned.`);
if (validSemVer(version)) {
let versionTag = version;
// https://github.com/arduino/arduino-cli/pull/2374
if (
gte(new SemVer(version, { loose: true }), new SemVer('0.35.0-rc.1'))
) {
versionTag = `v${version}`;
}
console.log(`>>> Checking out tagged version: '${versionTag}'...`);
exec('git', ['-C', repoFolder, 'fetch', '--all', '--tags'], {
logStdout: true,
});
exec(
'git',
['-C', repoFolder, 'checkout', `tags/${versionTag}`, '-b', versionTag],
{ logStdout: true }
);
console.log(`<<< Checked out tagged version: '${versionTag}'.`);
} else if (commitish) {
console.log(`>>> Checking out commitish: '${commitish}'...`);
exec('git', ['-C', repoFolder, 'checkout', commitish], {
logStdout: true,
});
console.log(`<<< Checked out commitish: '${commitish}'.`);
} else {
console.log(
`WARN: no 'git checkout'. Generating from the HEAD revision.`
);
}
const rpcFolder = await fs.mkdtemp(
path.join(os.tmpdir(), 'arduino-cli-rpc')
);
// Copy the the repository rpc folder so we can remove the repository
await fs.cp(path.join(repoFolder, 'rpc'), path.join(rpcFolder), {
recursive: true,
});
rmSync(repoFolder, { recursive: true, maxRetries: 5, force: true });
// Patch for https://github.com/arduino/arduino-cli/issues/2755
// Google proto files are removed from source since v1.1.0
if (!existsSync(path.join(rpcFolder, 'google'))) {
// Include packaged google proto files from v1.1.1
// See https://github.com/arduino/arduino-cli/pull/2761
console.log(`>>> Missing google proto files. Including from v1.1.1...`);
const v111ProtoFolder = await getProtosFromZip('1.1.1');
// Create an return a folder name google in rpcFolder
const googleFolder = path.join(rpcFolder, 'google');
await fs.cp(path.join(v111ProtoFolder, 'google'), googleFolder, {
recursive: true,
});
console.log(`<<< Included google proto files from v1.1.1.`);
}
return rpcFolder;
}
async function getProtosFromZip(version) {
if (!version) {
console.log(`Could not download proto files: CLI version not provided.`);
process.exit(1);
}
console.log(`>>> Downloading proto files from zip for ${version}.`);
const url = `https://downloads.arduino.cc/arduino-cli/arduino-cli_${version}_proto.zip`;
const protos = await fs.mkdtemp(
path.join(os.tmpdir(), 'arduino-cli-proto')
);
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);
await decompress(data, protos, {
plugins: [unzip()],
filter: (file) => file.path.endsWith('.proto'),
});
console.log(
`<<< Finished downloading and extracting proto files for ${version}.`
);
return protos;
}
let protosFolder;
if (commitish) {
protosFolder = await getProtosFromRepo(commitish, undefined, owner, repo);
} else if (
versionObject.VersionString &&
validSemVer(versionObject.VersionString)
) {
const version = versionObject.VersionString; const version = versionObject.VersionString;
// v1.1.0 does not contains google proto files in zip if (version && !version.startsWith('nightly-') && version !== '0.0.0-git' && version !== 'git-snapshot') {
// See https://github.com/arduino/arduino-cli/issues/2755 shell.echo(`>>> Checking out tagged version: '${version}'...`);
const isV110 = eq(new SemVer(version, { loose: true }), '1.1.0'); shell.exec(`git -C ${repository} fetch --all --tags`);
protosFolder = isV110 if (shell.exec(`git -C ${repository} checkout tags/${version} -b ${version}`).code !== 0) {
? await getProtosFromRepo(undefined, version) shell.exit(1);
: await getProtosFromZip(version); }
} else if (versionObject.Commit) { shell.echo(`<<< Checked out tagged version: '${commitish}'.`);
protosFolder = await getProtosFromRepo(versionObject.Commit); } else if (commitish) {
} shell.echo(`>>> Checking out commitish from 'package.json': '${commitish}'...`);
if (shell.exec(`git -C ${repository} checkout ${commitish}`).code !== 0) {
shell.exit(1);
}
shell.echo(`<<< Checked out commitish from 'package.json': '${commitish}'.`);
} else if (versionObject.Commit) {
shell.echo(`>>> Checking out commitish from the CLI: '${versionObject.Commit}'...`);
if (shell.exec(`git -C ${repository} checkout ${versionObject.Commit}`).code !== 0) {
shell.exit(1);
}
shell.echo(`<<< Checked out commitish from the CLI: '${versionObject.Commit}'.`);
} else {
shell.echo(`WARN: no 'git checkout'. Generating from the HEAD revision.`);
}
if (!protosFolder) { shell.echo('>>> Generating TS/JS API from:');
console.log(`Could not get proto files: missing commitish or version.`); if (shell.exec(`git -C ${repository} rev-parse --abbrev-ref HEAD`).code !== 0) {
process.exit(1); shell.exit(1);
} }
const protos = await globProtos(protosFolder); const rpc = path.join(repository, 'rpc');
const out = path.join(__dirname, '..', 'src', 'node', 'cli-protocol');
shell.mkdir('-p', out);
if (!protos || protos.length === 0) { const protos = await new Promise(resolve =>
rmSync(protosFolder, { recursive: true, maxRetries: 5, force: true }); glob('**/*.proto', { cwd: rpc }, (error, matches) => {
console.log(`Could not find any .proto files under ${protosFolder}.`); if (error) {
process.exit(1); shell.echo(error.stack);
} resolve([]);
return;
}
resolve(matches.map(filename => path.join(rpc, filename)));
}));
if (!protos || protos.length === 0) {
shell.echo(`Could not find any .proto files under ${rpc}.`);
shell.exit(1);
}
console.log('>>> Generating TS/JS API from:');
const out = path.join(__dirname, '..', 'src', 'node', 'cli-protocol');
// Must wipe the gen output folder. Otherwise, dangling service implementation remain in IDE2 code,
// 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 });
try {
// 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);
protosFolder, }
...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',
protosFolder,
...protos,
],
{ logStdout: true }
);
} catch (error) {
console.log(error);
} finally {
rmSync(protosFolder, { recursive: true, maxRetries: 5, force: 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);
console.log(`<<< Verifying ${taskName}...`);
if (!fs.existsSync(destinationPath)) {
process.exit(1);
} }
console.log(`>>> Verified ${taskName}.`); shell.echo(`<<< Copied the ${taskName}.`);
shell.echo(`<<< Verifying ${taskName}...`);
if (!fs.existsSync(destinationPath)) {
shell.exit(1);
}
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,44 @@
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-contribution';
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 {
FrontendApplication,
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 +47,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 +65,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(
@ -81,13 +77,14 @@ export class ArduinoFrontendContribution
} }
} }
onStart(): void { onStart(app: FrontendApplication): void {
this.electronWindowPreferences.onPreferenceChanged((event) => { this.electronWindowPreferences.onPreferenceChanged((event) => {
if (event.newValue !== event.oldValue) { if (event.newValue !== event.oldValue) {
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,11 +92,14 @@ 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);
}) })
); );
// Removes the _Settings_ (cog) icon from the left sidebar
app.shell.leftPanelHandler.removeBottomMenu('settings-menu');
} }
registerToolbarItems(registry: TabBarToolbarRegistry): void { registerToolbarItems(registry: TabBarToolbarRegistry): void {
@ -173,8 +173,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 +183,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 +193,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 +203,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 +213,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 +223,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 +262,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 +272,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 +281,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

@ -5,8 +5,10 @@ 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';
import { TabBarToolbarContribution } from '@theia/core/lib/browser/shell/tab-bar-toolbar'; import { TabBarToolbarContribution } from '@theia/core/lib/browser/shell/tab-bar-toolbar';
import { WebSocketConnectionProvider } from '@theia/core/lib/browser/messaging/ws-connection-provider'; import { WebSocketConnectionProvider } from '@theia/core/lib/browser/messaging/ws-connection-provider';
import { FrontendApplication as TheiaFrontendApplication } from '@theia/core/lib/browser/frontend-application'; import {
import { FrontendApplicationContribution } from '@theia/core/lib/browser/frontend-application-contribution'; FrontendApplicationContribution,
FrontendApplication as TheiaFrontendApplication,
} from '@theia/core/lib/browser/frontend-application';
import { LibraryListWidget } from './library/library-list-widget'; import { LibraryListWidget } from './library/library-list-widget';
import { ArduinoFrontendContribution } from './arduino-frontend-contribution'; import { ArduinoFrontendContribution } from './arduino-frontend-contribution';
import { import {
@ -21,14 +23,11 @@ import {
SketchesService, SketchesService,
SketchesServicePath, SketchesServicePath,
} from '../common/protocol/sketches-service'; } from '../common/protocol/sketches-service';
import { SketchesServiceClientImpl } from './sketches-service-client-impl'; import { SketchesServiceClientImpl } from '../common/protocol/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 { BoardsListWidget } from './boards/boards-list-widget';
import { BoardsListWidgetFrontendContribution } from './boards/boards-widget-frontend-contribution'; import { BoardsListWidgetFrontendContribution } from './boards/boards-widget-frontend-contribution';
import { import { BoardsServiceProvider } from './boards/boards-service-provider';
BoardListDumper,
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';
@ -62,6 +61,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';
@ -79,27 +79,23 @@ import { ProblemManager as TheiaProblemManager } from '@theia/markers/lib/browse
import { ProblemManager } from './theia/markers/problem-manager'; import { ProblemManager } from './theia/markers/problem-manager';
import { BoardsAutoInstaller } from './boards/boards-auto-installer'; import { BoardsAutoInstaller } from './boards/boards-auto-installer';
import { ShellLayoutRestorer } from './theia/core/shell-layout-restorer'; import { ShellLayoutRestorer } from './theia/core/shell-layout-restorer';
import { import { ListItemRenderer } from './widgets/component-list/list-item-renderer';
ArduinoComponentContextMenuRenderer,
ListItemRenderer,
} from './widgets/component-list/list-item-renderer';
import { ColorContribution } from '@theia/core/lib/browser/color-application-contribution'; import { ColorContribution } from '@theia/core/lib/browser/color-application-contribution';
import { import {
ArduinoDaemonPath, ArduinoDaemonPath,
ArduinoDaemon, ArduinoDaemon,
} from '../common/protocol/arduino-daemon'; } from '../common/protocol/arduino-daemon';
import { EditorCommandContribution as TheiaEditorCommandContribution } from '@theia/editor/lib/browser';
import { import {
FrontendConnectionStatusService, FrontendConnectionStatusService,
ApplicationConnectionStatusContribution, ApplicationConnectionStatusContribution,
DaemonPort,
IsOnline,
} from './theia/core/connection-status-service'; } from './theia/core/connection-status-service';
import { 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';
@ -122,10 +118,7 @@ import { OpenSketch } from './contributions/open-sketch';
import { Close } from './contributions/close'; import { Close } from './contributions/close';
import { SaveAsSketch } from './contributions/save-as-sketch'; import { SaveAsSketch } from './contributions/save-as-sketch';
import { SaveSketch } from './contributions/save-sketch'; import { SaveSketch } from './contributions/save-sketch';
import { import { VerifySketch } from './contributions/verify-sketch';
CompileSummaryProvider,
VerifySketch,
} from './contributions/verify-sketch';
import { UploadSketch } from './contributions/upload-sketch'; import { UploadSketch } from './contributions/upload-sketch';
import { CommonFrontendContribution } from './theia/core/common-frontend-contribution'; import { CommonFrontendContribution } from './theia/core/common-frontend-contribution';
import { EditContributions } from './contributions/edit-contributions'; import { EditContributions } from './contributions/edit-contributions';
@ -134,7 +127,7 @@ import { PreferencesContribution as TheiaPreferencesContribution } from '@theia/
import { PreferencesContribution } from './theia/preferences/preferences-contribution'; import { PreferencesContribution } from './theia/preferences/preferences-contribution';
import { QuitApp } from './contributions/quit-app'; import { QuitApp } from './contributions/quit-app';
import { SketchControl } from './contributions/sketch-control'; import { SketchControl } from './contributions/sketch-control';
import { OpenSettings } from './contributions/open-settings'; import { Settings } from './contributions/settings';
import { WorkspaceCommandContribution } from './theia/workspace/workspace-commands'; import { WorkspaceCommandContribution } from './theia/workspace/workspace-commands';
import { WorkspaceDeleteHandler as TheiaWorkspaceDeleteHandler } from '@theia/workspace/lib/browser/workspace-delete-handler'; import { WorkspaceDeleteHandler as TheiaWorkspaceDeleteHandler } from '@theia/workspace/lib/browser/workspace-delete-handler';
import { WorkspaceDeleteHandler } from './theia/workspace/workspace-delete-handler'; import { WorkspaceDeleteHandler } from './theia/workspace/workspace-delete-handler';
@ -177,9 +170,10 @@ import {
import { About } from './contributions/about'; import { About } from './contributions/about';
import { IconThemeService } from '@theia/core/lib/browser/icon-theme-service'; import { IconThemeService } from '@theia/core/lib/browser/icon-theme-service';
import { TabBarRenderer } from './theia/core/tab-bars'; import { TabBarRenderer } from './theia/core/tab-bars';
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';
@ -209,6 +203,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';
@ -238,6 +233,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,
@ -265,13 +261,13 @@ import {
IDEUpdaterDialog, IDEUpdaterDialog,
IDEUpdaterDialogProps, IDEUpdaterDialogProps,
} from './dialogs/ide-updater/ide-updater-dialog'; } from './dialogs/ide-updater/ide-updater-dialog';
import { ElectronIpcConnectionProvider } from '@theia/core/lib/electron-browser/messaging/electron-ipc-connection-source'; import { ElectronIpcConnectionProvider } from '@theia/core/lib/electron-browser/messaging/electron-ipc-connection-provider';
import { MonitorModel } from './monitor-model'; 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';
@ -285,13 +281,17 @@ import { PreferenceTreeGenerator } from './theia/preferences/preference-tree-gen
import { PreferenceTreeGenerator as TheiaPreferenceTreeGenerator } from '@theia/preferences/lib/browser/util/preference-tree-generator'; import { PreferenceTreeGenerator as TheiaPreferenceTreeGenerator } from '@theia/preferences/lib/browser/util/preference-tree-generator';
import { AboutDialog } from './theia/core/about-dialog'; import { AboutDialog } from './theia/core/about-dialog';
import { AboutDialog as TheiaAboutDialog } from '@theia/core/lib/browser/about-dialog'; import { AboutDialog as TheiaAboutDialog } from '@theia/core/lib/browser/about-dialog';
import {
SurveyNotificationService,
SurveyNotificationServicePath,
} from '../common/protocol/survey-service';
import { WindowContribution } from './theia/core/window-contribution'; import { WindowContribution } from './theia/core/window-contribution';
import { WindowContribution as TheiaWindowContribution } from '@theia/core/lib/browser/window-contribution'; import { WindowContribution as TheiaWindowContribution } from '@theia/core/lib/browser/window-contribution';
import { CoreErrorHandler } from './contributions/core-error-handler'; 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';
@ -323,13 +323,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 { ThemeService } from './theia/core/theming';
MonacoThemingService, import { ThemeService as TheiaThemeService } from '@theia/core/lib/browser/theming';
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';
@ -337,63 +333,25 @@ 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 { ConfigServiceClient } from './config/config-service-client'; import { DebugToolbar } from './theia/debug/debug-toolbar-widget';
import { ValidateSketch } from './contributions/validate-sketch'; import { DebugToolBar as TheiaDebugToolbar } from '@theia/debug/lib/browser/view/debug-toolbar-widget';
import { RenameCloudSketch } from './contributions/rename-cloud-sketch'; import { PluginMenuCommandAdapter } from './theia/plugin-ext/plugin-menu-command-adapter';
import { CreateFeatures } from './create/create-features'; import { PluginMenuCommandAdapter as TheiaPluginMenuCommandAdapter } from '@theia/plugin-ext/lib/main/browser/menus/plugin-menu-command-adapter';
import { Account } from './contributions/account';
import { SidebarBottomMenuWidget } from './theia/core/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 { 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 { DebugSessionManager } from './theia/debug/debug-session-manager';
import { DebugWidget as TheiaDebugWidget } from '@theia/debug/lib/browser/view/debug-widget'; import { DebugSessionManager as TheiaDebugSessionManager } from '@theia/debug/lib/browser/debug-session-manager';
import { DebugWidget } from './theia/debug/debug-widget'; import { DebugWidget } from '@theia/debug/lib/browser/view/debug-widget';
import { DebugViewModel } from '@theia/debug/lib/browser/view/debug-view-model'; import { DebugViewModel } from '@theia/debug/lib/browser/view/debug-view-model';
import { DebugSessionWidget } from '@theia/debug/lib/browser/view/debug-session-widget'; import { DebugSessionWidget } from '@theia/debug/lib/browser/view/debug-session-widget';
import { DebugConfigurationWidget } from './theia/debug/debug-configuration-widget'; import { DebugConfigurationWidget } from '@theia/debug/lib/browser/view/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 {
VersionWelcomeDialog,
VersionWelcomeDialogProps,
} from './dialogs/version-welcome-dialog';
import { TestViewContribution as TheiaTestViewContribution } from '@theia/test/lib/browser/view/test-view-contribution';
import { TestViewContribution } from './theia/test/test-view-contribution';
// 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);
@ -446,8 +404,6 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
) )
) )
.inSingletonScope(); .inSingletonScope();
bind(ConfigServiceClient).toSelf().inSingletonScope();
bind(FrontendApplicationContribution).toService(ConfigServiceClient);
// Boards service // Boards service
bind(BoardsService) bind(BoardsService)
@ -462,14 +418,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) => {
@ -496,6 +451,7 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
bind(OpenHandler).toService(BoardsListWidgetFrontendContribution); bind(OpenHandler).toService(BoardsListWidgetFrontendContribution);
// 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(
@ -523,7 +479,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(
@ -554,6 +518,15 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
WorkspaceVariableContribution WorkspaceVariableContribution
); );
bind(SurveyNotificationService)
.toDynamicValue((context) => {
return ElectronIpcConnectionProvider.createProxy(
context.container,
SurveyNotificationServicePath
);
})
.inSingletonScope();
// Layout and shell customizations. // Layout and shell customizations.
rebind(TheiaOutlineViewContribution) rebind(TheiaOutlineViewContribution)
.to(OutlineViewContribution) .to(OutlineViewContribution)
@ -718,7 +691,7 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
Contribution.configure(bind, EditContributions); Contribution.configure(bind, EditContributions);
Contribution.configure(bind, QuitApp); Contribution.configure(bind, QuitApp);
Contribution.configure(bind, SketchControl); Contribution.configure(bind, SketchControl);
Contribution.configure(bind, OpenSettings); Contribution.configure(bind, Settings);
Contribution.configure(bind, BurnBootloader); Contribution.configure(bind, BurnBootloader);
Contribution.configure(bind, BuiltInExamples); Contribution.configure(bind, BuiltInExamples);
Contribution.configure(bind, LibraryExamples); Contribution.configure(bind, LibraryExamples);
@ -737,7 +710,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);
@ -753,22 +726,10 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
Contribution.configure(bind, UpdateIndexes); Contribution.configure(bind, UpdateIndexes);
Contribution.configure(bind, InterfaceScale); Contribution.configure(bind, InterfaceScale);
Contribution.configure(bind, NewCloudSketch); Contribution.configure(bind, NewCloudSketch);
Contribution.configure(bind, ValidateSketch);
Contribution.configure(bind, RenameCloudSketch);
Contribution.configure(bind, Account);
Contribution.configure(bind, CloudSketchbookContribution);
Contribution.configure(bind, CreateCloudCopy);
Contribution.configure(bind, UpdateArduinoState);
Contribution.configure(bind, BoardsDataMenuUpdater);
Contribution.configure(bind, AutoSelectProgrammer);
bind(CompileSummaryProvider).toService(VerifySketch);
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();
@ -811,22 +772,20 @@ 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
); );
}); });
// Workaround for https://github.com/eclipse-theia/theia/issues/8722
// Do not trigger a save on IDE startup if `"editor.autoSave": "on"` was set as a preference.
// Note: `"editor.autoSave" was renamed to `"files.autoSave" and `"on"` was replaced with three
// different cases, but we treat `!== 'off'` as auto save enabled. (https://github.com/eclipse-theia/theia/issues/10812)
bind(EditorCommandContribution).toSelf().inSingletonScope();
rebind(TheiaEditorCommandContribution).toService(EditorCommandContribution);
// Silent the badge decoration in the Explorer view. // Silent the badge decoration in the Explorer view.
bind(NavigatorTabBarDecorator).toSelf().inSingletonScope(); bind(NavigatorTabBarDecorator).toSelf().inSingletonScope();
rebind(TheiaNavigatorTabBarDecorator).toService(NavigatorTabBarDecorator); rebind(TheiaNavigatorTabBarDecorator).toService(NavigatorTabBarDecorator);
@ -859,28 +818,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();
@ -917,6 +854,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();
@ -946,8 +886,6 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
); );
bind(CreateApi).toSelf().inSingletonScope(); bind(CreateApi).toSelf().inSingletonScope();
bind(SketchCache).toSelf().inSingletonScope(); bind(SketchCache).toSelf().inSingletonScope();
bind(CreateFeatures).toSelf().inSingletonScope();
bind(FrontendApplicationContribution).toService(CreateFeatures);
bind(ShareSketchDialog).toSelf().inSingletonScope(); bind(ShareSketchDialog).toSelf().inSingletonScope();
bind(AuthenticationClientService).toSelf().inSingletonScope(); bind(AuthenticationClientService).toSelf().inSingletonScope();
@ -964,6 +902,8 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
bind(CreateFsProvider).toSelf().inSingletonScope(); bind(CreateFsProvider).toSelf().inSingletonScope();
bind(FrontendApplicationContribution).toService(CreateFsProvider); bind(FrontendApplicationContribution).toService(CreateFsProvider);
bind(FileServiceContribution).toService(CreateFsProvider); bind(FileServiceContribution).toService(CreateFsProvider);
bind(CloudSketchbookContribution).toSelf().inSingletonScope();
bind(CommandContribution).toService(CloudSketchbookContribution);
bind(LocalCacheFsProvider).toSelf().inSingletonScope(); bind(LocalCacheFsProvider).toSelf().inSingletonScope();
bind(FileServiceContribution).toService(LocalCacheFsProvider); bind(FileServiceContribution).toService(LocalCacheFsProvider);
bind(CloudSketchbookCompositeWidget).toSelf(); bind(CloudSketchbookCompositeWidget).toSelf();
@ -987,11 +927,6 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
title: 'IDEUpdater', title: 'IDEUpdater',
}); });
bind(VersionWelcomeDialog).toSelf().inSingletonScope();
bind(VersionWelcomeDialogProps).toConstantValue({
title: 'VersionWelcomeDialog',
});
bind(UserFieldsDialog).toSelf().inSingletonScope(); bind(UserFieldsDialog).toSelf().inSingletonScope();
bind(UserFieldsDialogProps).toConstantValue({ bind(UserFieldsDialogProps).toConstantValue({
title: 'UserFields', title: 'UserFields',
@ -1014,9 +949,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);
@ -1025,17 +959,11 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
rebind(TheiaWindowTitleUpdater).toService(WindowTitleUpdater); rebind(TheiaWindowTitleUpdater).toService(WindowTitleUpdater);
// register Arduino themes // register Arduino themes
bind(ThemeService).toSelf().inSingletonScope();
rebind(TheiaThemeService).toService(ThemeService);
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();
@ -1045,38 +973,35 @@ 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();
bind(SidebarBottomMenuWidget).toSelf(); rebind(TheiaDebugSessionManager).toService(DebugSessionManager);
rebind(TheiaSidebarBottomMenuWidget).toService(SidebarBottomMenuWidget); bind(DebugToolbar).toSelf().inSingletonScope();
rebind(TheiaDebugToolbar).toService(DebugToolbar);
bind(ArduinoComponentContextMenuRenderer).toSelf().inSingletonScope(); bind(PluginMenuCommandAdapter).toSelf().inSingletonScope();
rebind(TheiaPluginMenuCommandAdapter).toService(PluginMenuCommandAdapter);
bind(DaemonPort).toSelf().inSingletonScope(); bind(WidgetFactory)
bind(FrontendApplicationContribution).toService(DaemonPort); .toDynamicValue(({ container }) => ({
bind(IsOnline).toSelf().inSingletonScope(); id: DebugWidget.ID,
bind(FrontendApplicationContribution).toService(IsOnline); createWidget: () => {
const child = new Container({ defaultScope: 'Singleton' });
// https://github.com/arduino/arduino-ide/issues/437 child.parent = container;
bind(FileResourceResolver).toSelf().inSingletonScope(); child.bind(DebugViewModel).toSelf();
rebind(TheiaFileResourceResolver).toService(FileResourceResolver); child.bind(DebugToolbar).toSelf(); // patched toolbar
child.bind(DebugSessionWidget).toSelf();
// Full control over the editor context menu to filter undesired menu items contributed by Theia. child.bind(DebugConfigurationWidget).toSelf();
// https://github.com/arduino/arduino-ide/issues/1394 child.bind(DebugWidget).toSelf();
// https://github.com/arduino/arduino-ide/pull/2027#pullrequestreview-1414246614 return child.get(DebugWidget);
bind(MonacoEditorMenuContribution).toSelf().inSingletonScope(); },
rebind(TheiaMonacoEditorMenuContribution).toService( }))
MonacoEditorMenuContribution .inSingletonScope();
);
// Patch terminal issues.
bind(TerminalFrontendContribution).toSelf().inSingletonScope();
rebind(TheiaTerminalFrontendContribution).toService(
TerminalFrontendContribution
);
// Hides the Test Explorer from the side-bar
bind(TestViewContribution).toSelf().inSingletonScope();
rebind(TheiaTestViewContribution).toService(TestViewContribution);
}); });

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,295 +40,236 @@ export namespace ErrorRevealStrategy {
export const Default: ErrorRevealStrategy = 'centerIfOutsideViewport'; export const Default: ErrorRevealStrategy = 'centerIfOutsideViewport';
} }
export type MonitorWidgetDockPanel = Extract<
ApplicationShell.Area,
'bottom' | 'right'
>;
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': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/language.log',
"True if the Arduino Language Server should generate log files into the sketch folder. Otherwise, false. It's false by default."
),
default: false,
},
'arduino.language.realTimeDiagnostics': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/language.realTimeDiagnostics',
"If true, the language server provides real-time diagnostics when typing in the editor. It's false by default."
),
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': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/compile.verbose',
'True for verbose compile output. False by default'
),
default: false,
},
'arduino.compile.experimental': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/compile.experimental',
'True if the IDE should handle multiple compiler errors. False by default'
),
default: false,
},
'arduino.compile.revealRange': {
enum: [...ErrorRevealStrategyLiterals],
description: nls.localize(
'arduino/preferences/compile.revealRange',
"Adjusts how compiler errors are revealed in the editor after a failed verify/upload. Possible values: 'auto': Scroll vertically as necessary and reveal a line. 'center': Scroll vertically as necessary and reveal a line centered vertically. 'top': Scroll vertically as necessary and reveal a line close to the top of the viewport, optimized for viewing a code definition. 'centerIfOutsideViewport': Scroll vertically as necessary and reveal a line centered vertically only if it lies outside the viewport. The default value is '{0}'.",
ErrorRevealStrategy.Default
),
default: ErrorRevealStrategy.Default,
},
'arduino.compile.warnings': {
enum: [...CompilerWarningLiterals],
description: nls.localize(
'arduino/preferences/compile.warnings',
"Tells gcc which warning level to use. It's 'None' by default"
),
default: 'None',
},
'arduino.upload.verbose': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/upload.verbose',
'True for verbose upload output. False by default.'
),
default: false,
},
'arduino.upload.verify': {
type: 'boolean',
default: false,
description: nls.localize(
'arduino/preferences/upload.verify',
'After upload, verify that the contents of the memory on the board match the uploaded binary.'
),
},
'arduino.upload.autoVerify': {
type: 'boolean',
default: true,
description: nls.localize(
'arduino/preferences/upload.autoVerify',
"True if the IDE should automatically verify the code before the upload. True by default. When this value is false, IDE does not recompile the code before uploading the binary to the board. It's highly advised to only set this value to false if you know what you are doing."
),
},
'arduino.window.autoScale': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/window.autoScale',
'True if the user interface automatically scales with the font size.'
),
default: true,
},
'arduino.window.zoomLevel': {
type: 'number',
description: '',
default: 0,
deprecationMessage: nls.localize(
'arduino/preferences/window.zoomLevel/deprecationMessage',
"Deprecated. Use 'window.zoomLevel' instead."
),
},
'arduino.ide.updateChannel': {
type: 'string',
enum: Object.values(UpdateChannel) as UpdateChannel[],
default: UpdateChannel.Stable,
description: nls.localize(
'arduino/preferences/ide.updateChannel',
"Release channel to get updated from. 'stable' is the stable release, 'nightly' is the latest development build."
),
},
'arduino.ide.updateBaseUrl': {
type: 'string',
default: 'https://downloads.arduino.cc/arduino-ide',
description: nls.localize(
'arduino/preferences/ide.updateBaseUrl',
"The base URL where to download updates from. Defaults to 'https://downloads.arduino.cc/arduino-ide'"
),
},
'arduino.board.certificates': {
type: 'string',
description: nls.localize(
'arduino/preferences/board.certificates',
'List of certificates that can be uploaded to boards'
),
default: '',
},
'arduino.sketchbook.showAllFiles': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/sketchbook.showAllFiles',
'True to show all sketch files inside the sketch. It is false by default.'
),
default: false,
},
'arduino.cloud.enabled': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/cloud.enabled',
'True if the sketch sync functions are enabled. Defaults to true.'
),
default: true,
},
'arduino.cloud.pull.warn': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/cloud.pull.warn',
'True if users should be warned before pulling a cloud sketch. Defaults to true.'
),
default: true,
},
'arduino.cloud.push.warn': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/cloud.push.warn',
'True if users should be warned before pushing a cloud sketch. Defaults to true.'
),
default: true,
},
'arduino.cloud.pushpublic.warn': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/cloud.pushpublic.warn',
'True if users should be warned before pushing a public sketch to the cloud. Defaults to true.'
),
default: true,
},
'arduino.cloud.sketchSyncEndpoint': {
type: 'string',
description: nls.localize(
'arduino/preferences/cloud.sketchSyncEndpoint',
'The endpoint used to push and pull sketches from a backend. By default it points to Arduino Cloud API.'
),
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': {
type: 'string',
description: nls.localize(
'arduino/preferences/auth.clientID',
'The OAuth2 client ID.'
),
default: 'C34Ya6ex77jTNxyKWj01lCe1vAHIaPIo',
},
'arduino.auth.domain': {
type: 'string',
description: nls.localize(
'arduino/preferences/auth.domain',
'The OAuth2 domain.'
),
default: 'login.arduino.cc',
},
'arduino.auth.audience': {
type: 'string',
description: nls.localize(
'arduino/preferences/auth.audience',
'The OAuth2 audience.'
),
default: 'https://api.arduino.cc',
},
'arduino.auth.registerUri': {
type: 'string',
description: nls.localize(
'arduino/preferences/auth.registerUri',
'The URI used to register a new user.'
),
default: 'https://auth.arduino.cc/login#/register',
},
'arduino.cli.daemon.debug': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/cli.daemonDebug',
"Enable debug logging of the gRPC calls to the Arduino CLI. A restart of the IDE is needed for this setting to take effect. It's false by default."
),
default: false,
},
'arduino.checkForUpdates': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/checkForUpdate',
"Receive notifications of available updates for the IDE, boards, and libraries. Requires an IDE restart after change. It's true by default."
),
default: true,
},
'arduino.sketch.inoBlueprint': {
type: 'string',
markdownDescription: nls.localize(
'arduino/preferences/sketch/inoBlueprint',
'Absolute filesystem path to the default `.ino` blueprint file. If specified, the content of the blueprint file will be used for every new sketch created by the IDE. The sketches will be generated with the default Arduino content if not specified. Unaccessible blueprint files are ignored. **A restart of the IDE is needed** for this setting to take effect.'
),
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 = { export const ArduinoConfigSchema: PreferenceSchema = {
type: 'object', type: 'object',
properties, properties: {
'arduino.language.log': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/language.log',
"True if the Arduino Language Server should generate log files into the sketch folder. Otherwise, false. It's false by default."
),
default: false,
},
'arduino.language.realTimeDiagnostics': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/language.realTimeDiagnostics',
"If true, the language server provides real-time diagnostics when typing in the editor. It's false by default."
),
default: false,
},
'arduino.compile.verbose': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/compile.verbose',
'True for verbose compile output. False by default'
),
default: false,
},
'arduino.compile.experimental': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/compile.experimental',
'True if the IDE should handle multiple compiler errors. False by default'
),
default: false,
},
'arduino.compile.revealRange': {
enum: [...ErrorRevealStrategyLiterals],
description: nls.localize(
'arduino/preferences/compile.revealRange',
"Adjusts how compiler errors are revealed in the editor after a failed verify/upload. Possible values: 'auto': Scroll vertically as necessary and reveal a line. 'center': Scroll vertically as necessary and reveal a line centered vertically. 'top': Scroll vertically as necessary and reveal a line close to the top of the viewport, optimized for viewing a code definition. 'centerIfOutsideViewport': Scroll vertically as necessary and reveal a line centered vertically only if it lies outside the viewport. The default value is '{0}'.",
ErrorRevealStrategy.Default
),
default: ErrorRevealStrategy.Default,
},
'arduino.compile.warnings': {
enum: [...CompilerWarningLiterals],
description: nls.localize(
'arduino/preferences/compile.warnings',
"Tells gcc which warning level to use. It's 'None' by default"
),
default: 'None',
},
'arduino.upload.verbose': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/upload.verbose',
'True for verbose upload output. False by default.'
),
default: false,
},
'arduino.upload.verify': {
type: 'boolean',
default: false,
},
'arduino.window.autoScale': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/window.autoScale',
'True if the user interface automatically scales with the font size.'
),
default: true,
},
'arduino.window.zoomLevel': {
type: 'number',
description: '',
default: 0,
deprecationMessage: nls.localize(
'arduino/preferences/window.zoomLevel/deprecationMessage',
"Deprecated. Use 'window.zoomLevel' instead."
),
},
'arduino.ide.updateChannel': {
type: 'string',
enum: Object.values(UpdateChannel) as UpdateChannel[],
default: UpdateChannel.Stable,
description: nls.localize(
'arduino/preferences/ide.updateChannel',
"Release channel to get updated from. 'stable' is the stable release, 'nightly' is the latest development build."
),
},
'arduino.ide.updateBaseUrl': {
type: 'string',
default: 'https://downloads.arduino.cc/arduino-ide',
description: nls.localize(
'arduino/preferences/ide.updateBaseUrl',
"The base URL where to download updates from. Defaults to 'https://downloads.arduino.cc/arduino-ide'"
),
},
'arduino.board.certificates': {
type: 'string',
description: nls.localize(
'arduino/preferences/board.certificates',
'List of certificates that can be uploaded to boards'
),
default: '',
},
'arduino.sketchbook.showAllFiles': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/sketchbook.showAllFiles',
'True to show all sketch files inside the sketch. It is false by default.'
),
default: false,
},
'arduino.cloud.enabled': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/cloud.enabled',
'True if the sketch sync functions are enabled. Defaults to true.'
),
default: true,
},
'arduino.cloud.pull.warn': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/cloud.pull.warn',
'True if users should be warned before pulling a cloud sketch. Defaults to true.'
),
default: true,
},
'arduino.cloud.push.warn': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/cloud.push.warn',
'True if users should be warned before pushing a cloud sketch. Defaults to true.'
),
default: true,
},
'arduino.cloud.pushpublic.warn': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/cloud.pushpublic.warn',
'True if users should be warned before pushing a public sketch to the cloud. Defaults to true.'
),
default: true,
},
'arduino.cloud.sketchSyncEndpoint': {
type: 'string',
description: nls.localize(
'arduino/preferences/cloud.sketchSyncEndpoint',
'The endpoint used to push and pull sketches from a backend. By default it points to Arduino Cloud API.'
),
default: 'https://api2.arduino.cc/create',
},
'arduino.auth.clientID': {
type: 'string',
description: nls.localize(
'arduino/preferences/auth.clientID',
'The OAuth2 client ID.'
),
default: 'C34Ya6ex77jTNxyKWj01lCe1vAHIaPIo',
},
'arduino.auth.domain': {
type: 'string',
description: nls.localize(
'arduino/preferences/auth.domain',
'The OAuth2 domain.'
),
default: 'login.arduino.cc',
},
'arduino.auth.audience': {
type: 'string',
description: nls.localize(
'arduino/preferences/auth.audience',
'The OAuth2 audience.'
),
default: 'https://api.arduino.cc',
},
'arduino.auth.registerUri': {
type: 'string',
description: nls.localize(
'arduino/preferences/auth.registerUri',
'The URI used to register a new user.'
),
default: 'https://auth.arduino.cc/login#/register',
},
'arduino.survey.notification': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/survey.notification',
'True if users should be notified if a survey is available. True by default.'
),
default: true,
},
'arduino.cli.daemon.debug': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/cli.daemonDebug',
"Enable debug logging of the gRPC calls to the Arduino CLI. A restart of the IDE is needed for this setting to take effect. It's false by default."
),
default: false,
},
'arduino.checkForUpdates': {
type: 'boolean',
description: nls.localize(
'arduino/preferences/checkForUpdate',
"Receive notifications of available updates for the IDE, boards, and libraries. Requires an IDE restart after change. It's true by default."
),
default: true,
},
'arduino.sketch.inoBlueprint': {
type: 'string',
markdownDescription: nls.localize(
'arduino/preferences/sketch/inoBlueprint',
'Absolute filesystem path to the default `.ino` blueprint file. If specified, the content of the blueprint file will be used for every new sketch created by the IDE. The sketches will be generated with the default Arduino content if not specified. Unaccessible blueprint files are ignored. **A restart of the IDE is needed** for this setting to take effect.'
),
default: undefined,
},
},
}; };
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;
'arduino.compile.warnings': CompilerWarnings; 'arduino.compile.warnings': CompilerWarnings;
'arduino.upload.verbose': boolean; 'arduino.upload.verbose': boolean;
'arduino.upload.verify': boolean; 'arduino.upload.verify': boolean;
'arduino.upload.autoVerify': boolean;
'arduino.window.autoScale': boolean; 'arduino.window.autoScale': boolean;
'arduino.ide.updateChannel': UpdateChannel; 'arduino.ide.updateChannel': UpdateChannel;
'arduino.ide.updateBaseUrl': string; 'arduino.ide.updateBaseUrl': string;
@ -342,15 +280,14 @@ 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;
'arduino.auth.registerUri': string; 'arduino.auth.registerUri': string;
'arduino.survey.notification': boolean;
'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

@ -0,0 +1,68 @@
import { URI } from '@theia/core/shared/vscode-uri';
import { isWindows } from '@theia/core/lib/common/os';
import { notEmpty } from '@theia/core/lib/common/objects';
import { MaybePromise } from '@theia/core/lib/common/types';
/**
* Class for determining the default workspace location from the
* `location.hash`, the historical workspace locations, and recent sketch files.
*
* The following logic is used for determining the default workspace location:
* - `hash` points to an existing location?
* - Yes
* - `validate location`. Is valid sketch location?
* - Yes
* - Done.
* - No
* - `try open recent workspace roots`, then `try open last modified sketches`, finally `create new sketch`.
* - No
* - `try open recent workspace roots`, then `try open last modified sketches`, finally `create new sketch`.
*/
namespace ArduinoWorkspaceRootResolver {
export interface InitOptions {
readonly isValid: (uri: string) => MaybePromise<boolean>;
}
export interface ResolveOptions {
readonly hash?: string;
readonly recentWorkspaces: string[];
// Gathered from the default sketch folder. The default sketch folder is defined by the CLI.
readonly recentSketches: string[];
}
}
export class ArduinoWorkspaceRootResolver {
constructor(protected options: ArduinoWorkspaceRootResolver.InitOptions) {}
async resolve(
options: ArduinoWorkspaceRootResolver.ResolveOptions
): Promise<{ uri: string } | undefined> {
const { hash, recentWorkspaces, recentSketches } = options;
for (const uri of [
this.hashToUri(hash),
...recentWorkspaces,
...recentSketches,
].filter(notEmpty)) {
const valid = await this.isValid(uri);
if (valid) {
return { uri };
}
}
return undefined;
}
protected isValid(uri: string): MaybePromise<boolean> {
return this.options.isValid(uri);
}
// Note: here, the `hash` was defined as new `URI(yourValidFsPath).path` so we have to map it to a valid FS path first.
// This is important for Windows only and a NOOP on POSIX.
// Note: we set the `new URI(myValidUri).path.toString()` as the `hash`. See:
// - https://github.com/eclipse-theia/theia/blob/8196e9dcf9c8de8ea0910efeb5334a974f426966/packages/workspace/src/browser/workspace-service.ts#L143 and
// - https://github.com/eclipse-theia/theia/blob/8196e9dcf9c8de8ea0910efeb5334a974f426966/packages/workspace/src/browser/workspace-service.ts#L423
protected hashToUri(hash: string | undefined): string | undefined {
if (hash && hash.length > 1 && hash.startsWith('#')) {
const path = decodeURI(hash.slice(1)).replace(/\\/g, '/'); // Trim the leading `#`, decode the URI and replace Windows separators
return URI.file(path.slice(isWindows && hash.startsWith('/') ? 1 : 0)).toString();
}
return undefined;
}
}

View File

@ -3,19 +3,19 @@ import { Emitter } from '@theia/core/lib/common/event';
import { JsonRpcProxy } from '@theia/core/lib/common/messaging/proxy-factory'; import { JsonRpcProxy } from '@theia/core/lib/common/messaging/proxy-factory';
import { WindowService } from '@theia/core/lib/browser/window/window-service'; import { WindowService } from '@theia/core/lib/browser/window/window-service';
import { DisposableCollection } from '@theia/core/lib/common/disposable'; import { DisposableCollection } from '@theia/core/lib/common/disposable';
import { FrontendApplicationContribution } from '@theia/core/lib/browser/frontend-application-contribution'; import { FrontendApplicationContribution } from '@theia/core/lib/browser/frontend-application';
import { import {
CommandRegistry, CommandRegistry,
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'],
@ -83,13 +83,9 @@ export class AuthenticationClientService
registerCommands(registry: CommandRegistry): void { registerCommands(registry: CommandRegistry): void {
registry.registerCommand(CloudUserCommands.LOGIN, { registry.registerCommand(CloudUserCommands.LOGIN, {
execute: () => this.service.login(), execute: () => this.service.login(),
isEnabled: () => !this._session,
isVisible: () => !this._session,
}); });
registry.registerCommand(CloudUserCommands.LOGOUT, { registry.registerCommand(CloudUserCommands.LOGOUT, {
execute: () => this.service.logout(), execute: () => this.service.logout(),
isEnabled: () => !!this._session,
isVisible: () => !!this._session,
}); });
} }

View File

@ -1,8 +1,5 @@
import { Command } from '@theia/core/lib/common/command'; import { Command } from '@theia/core/lib/common/command';
export const LEARN_MORE_URL =
'https://docs.arduino.cc/software/ide-v2/tutorials/ide-v2-cloud-sketch-sync';
export namespace CloudUserCommands { export namespace CloudUserCommands {
export const LOGIN = Command.toLocalizedCommand( export const LOGIN = Command.toLocalizedCommand(
{ {
@ -19,4 +16,9 @@ export namespace CloudUserCommands {
}, },
'arduino/cloud/signOut' 'arduino/cloud/signOut'
); );
export const OPEN_PROFILE_CONTEXT_MENU: Command = {
id: 'arduino-cloud-sketchbook--open-profile-menu',
label: 'Contextual menu',
};
} }

View File

@ -1,229 +1,281 @@
import { FrontendApplicationContribution } from '@theia/core/lib/browser/frontend-application-contribution'; 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;
}
} else {
// IDE2 knows that selected board is not installed. Look for board `name` match in not yet installed platforms.
// 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 setLastRefusedPromptInfo(
selectedBoard: BoardIdentifier | undefined packageId: string,
): Promise<void> { selectedPort?: Port
if (!selectedBoard) { ): void {
return; this.lastRefusedPackageId = packageId;
} this.portSelectedOnLastRefusal = selectedPort;
const candidate = await this.findPlatformToInstall(selectedBoard); }
if (!candidate) {
return; private promptAlreadyShowingForBoard(board: Board): boolean {
} return Boolean(
const platformIdToInstall = candidate.id; this.notifications.find((notification) =>
const selectedBoardName = selectedBoard.name; Board.sameAs(notification, board)
if (
this.installNotificationInfos.some(
({ boardName, platformId }) =>
platformIdToInstall === platformId && selectedBoardName === boardName
) )
) { );
// Already has a notification for the board with the same platform. Nothing to do. }
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 {
this.removeNotificationByBoard(selectedBoard);
}
});
}
private getInstallCandidate(
packages: BoardsPackage[],
selectedBoard: Board
): BoardsPackage | undefined {
// filter packagesForBoard selecting matches from the cli (installed packages)
// and matches based on the board name
// NOTE: this ensures the Deprecated & new packages are all in the array
// so that we can check if any of the valid packages is already installed
const packagesForBoard = packages.filter(
(pkg) =>
BoardsPackage.contains(selectedBoard, pkg) ||
pkg.boards.some((board) => board.name === selectedBoard.name)
);
// check if one of the packages for the board is already installed. if so, no hint
if (packagesForBoard.some(({ installedVersion }) => !!installedVersion)) {
return; return;
} }
this.clearAllNotificationForPlatform(platformIdToInstall);
// 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(
({ installable, installedVersion }) => installable && !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);
handleAction(answer);
};
this.messageService
.info(info, ...actions.map((action) => action.key))
.then(onAnswer);
}
private generatePromptInfoText(
candidateName: string,
version: string,
boardName: string
): string {
return nls.localize(
'arduino/board/installNow',
'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) {
const index = this.installNotificationInfos.findIndex(
({ boardName, platformId }) =>
platformIdToInstall === platformId && selectedBoardName === boardName
);
if (index !== -1) {
this.installNotificationInfos.splice(index, 1);
}
if (answer === yes) {
await Installable.installWithProgress({
installable: this.boardsService,
item: candidate,
messageService: this.messageService,
responseService: this.responseService,
version: candidate.availableVersions[0],
});
return;
}
if (answer === InstallManually) {
this.boardsManagerWidgetContribution
.openView({ reveal: true })
.then((widget) =>
widget.refresh({
query: candidate.name.toLocaleLowerCase(),
type: 'All',
})
);
}
}
} }
private clearAllNotificationForPlatform(predicatePlatformId: string): void { private createPromptActions(
// Discard all install notifications for the same platform. candidate: BoardsPackage
const notificationsLength = this.installNotificationInfos.length; ): AutoInstallPromptActions {
for (let i = notificationsLength - 1; i >= 0; i--) { const yes = nls.localize('vscode/extensionsUtils/yes', 'Yes');
const { notificationId, platformId } = this.installNotificationInfos[i];
if (platformId === predicatePlatformId) { const actions: AutoInstallPromptActions = [
this.installNotificationInfos.splice(i, 1); {
this.notificationManager.clear(notificationId); key: InstallManually,
} handler: () => {
} this.boardsManagerFrontendContribution
.openView({ reveal: true })
.then((widget) =>
widget.refresh({
query: candidate.name.toLocaleLowerCase(),
type: 'All',
})
);
},
},
{
isAcceptance: true,
key: yes,
handler: () => {
return Installable.installWithProgress({
installable: this.boardsService,
item: candidate,
messageService: this.messageService,
responseService: this.responseService,
version: candidate.availableVersions[0],
});
},
},
];
return actions;
} }
private notificationId(message: string, ...actions: string[]): string { private createOnAnswerHandler(
return this.notificationManager['getMessageId']({ actions: AutoInstallPromptActions,
text: message, onRefuse?: () => void
actions, ): (answer: string) => void {
type: MessageType.Info, 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,203 +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(
disposeOnResolve = true,
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(disposeOnResolve);
}
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,434 @@
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,
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 interface Config {
selectedBoard?: Board;
selectedPort?: Port;
}
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.boardsServiceClient.boardsConfig.selectedBoard
)
);
this.boardsDataStore.onChanged(() =>
this.updateMenuActions( this.updateMenuActions(
this.boardsServiceProvider.boardsConfig.selectedBoard this.boardsServiceClient.boardsConfig.selectedBoard
) )
); );
this.boardsServiceProvider.onBoardsConfigDidChange((event) => { this.boardsServiceClient.onBoardsConfigChanged(({ selectedBoard }) =>
if (isBoardIdentifierChangeEvent(event)) { this.updateMenuActions(selectedBoard)
this.updateMenuActions(event.selectedBoard);
}
});
}
override onReady(): void {
this.boardsServiceProvider.ready.then(() =>
this.updateMenuActions(
this.boardsServiceProvider.boardsConfig.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) {
@ -79,15 +80,16 @@ export class BoardsDataMenuUpdater extends Contribution {
string, string,
Disposable & { label: string } Disposable & { label: string }
>(); >();
let selectedValue = '';
for (const value of values) { for (const value of values) {
const id = `${fqbn}-${option}--${value.value}`; const id = `${fqbn}-${option}--${value.value}`;
const command = { id }; const command = { id };
const selectedValue = value.value;
const handler = { const handler = {
execute: () => execute: () =>
this.boardsDataStore.selectConfigOption({ this.boardsDataStore.selectConfigOption({
fqbn, fqbn,
optionsToUpdate: [{ option, selectedValue: value.value }], option,
selectedValue,
}), }),
isToggled: () => value.selected, isToggled: () => value.selected,
}; };
@ -98,14 +100,8 @@ export class BoardsDataMenuUpdater extends Contribution {
{ label: value.label } { label: value.label }
) )
); );
if (value.selected) {
selectedValue = value.label;
}
} }
this.menuRegistry.registerSubmenu( this.menuRegistry.registerSubmenu(menuPath, label);
menuPath,
`${label}${selectedValue ? `: "${selectedValue}"` : ''}`
);
this.toDisposeOnBoardChange.pushAll([ this.toDisposeOnBoardChange.pushAll([
...commands.values(), ...commands.values(),
Disposable.create(() => Disposable.create(() =>
@ -170,7 +166,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-contribution'; 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<void>();
onStart(): void { onStart(): void {
this.toDispose.pushAll([ this.notificationCenter.onPlatformDidInstall(async ({ item }) => {
this.boardsServiceProvider.onBoardsConfigDidChange((event) => { let shouldFireChanged = false;
if (isBoardIdentifierChangeEvent(event)) { for (const fqbn of item.boards
this.updateSelectedBoardData( .map(({ fqbn }) => fqbn)
event.selectedBoard?.fqbn, .filter(notEmpty)
// If the change event comes from toolbar and the FQBN contains custom board options, change the currently selected options .filter((fqbn) => !!fqbn)) {
// https://github.com/arduino/arduino-ide/issues/1588 const key = this.getStorageKey(fqbn);
event.reason === 'toolbar' let data = await this.storageService.getData<
); ConfigOption[] | undefined
} >(key);
}), if (!data || !data.length) {
this.notificationCenter.onPlatformDidInstall(async ({ item }) => { const details = await this.getBoardDetailsSafe(fqbn);
const boardsWithFqbn = item.boards
.map(({ fqbn }) => fqbn)
.filter(notEmpty);
const changes: BoardsDataStoreChange[] = [];
for (const fqbn of boardsWithFqbn) {
const key = this.getStorageKey(fqbn);
const storedData =
await this.storageService.getData<BoardsDataStore.Data>(key);
if (!storedData) {
// if no previously value is available for the board, do not update the cache
continue;
}
const details = await this.loadBoardDetails(fqbn);
if (details) { if (details) {
const data = createDataStoreEntry(details); data = details.configOptions;
await this.storageService.setData(key, data); if (data.length) {
changes.push({ fqbn, data }); await this.storageService.setData(key, data);
shouldFireChanged = true;
}
} }
} }
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 }; if (shouldFireChanged) {
} this.fireChanged();
}
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();
}
registerCommands(registry: CommandRegistry): void {
registry.registerCommand(USE_INHERITED_DATA, {
execute: async (arg: unknown) => {
if (isBoardsDataStoreChange(arg)) {
await this.setData(arg);
this.fireChanged(arg);
}
},
}); });
} }
tasks(): StartupTask[] { get onChanged(): Event<void> {
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; fqbn,
} selectedProgrammer,
const key = this.getStorageKey(fqbn); }: { fqbn: string; selectedProgrammer: Programmer },
const details = await this.loadBoardDetails(fqbn, true); ): Promise<boolean> {
if (!details) { const data = deepClone(await this.getData(fqbn));
return; const { programmers } = data;
}
const data = createDataStoreEntry(details);
await this.storageService.setData(key, data);
this.fireChanged({ fqbn, data });
}
async selectProgrammer({
fqbn,
selectedProgrammer,
}: {
fqbn: string;
selectedProgrammer: Programmer;
}): Promise<boolean> {
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();
this.fireChanged(change);
return true; return true;
} }
async selectConfigOption(params: SelectConfigOptionParams): Promise<boolean> { async selectConfigOption(
const { fqbn, optionsToUpdate } = params; {
if (!optionsToUpdate.length) { fqbn,
option,
selectedValue,
}: { fqbn: string; option: string; selectedValue: string }
): Promise<boolean> {
const data = deepClone(await this.getData(fqbn));
const { configOptions } = data;
const configOption = configOptions.find((c) => c.option === option);
if (!configOption) {
return false; return false;
} }
let updated = false;
const sanitizedFQBN = sanitizeFqbn(fqbn); for (const value of configOption.values) {
const mutableData = deepClone(await this.getData(sanitizedFQBN)); if (value.value === selectedValue) {
let didChange = false; (value as any).selected = true;
updated = true;
for (const { option, selectedValue } of optionsToUpdate) { } else {
const { configOptions } = mutableData; (value as any).selected = false;
const configOption = configOptions.find((c) => c.option === option);
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 (!updated) {
if (!didChange) {
return false; return false;
} }
await this.setData({ fqbn, data });
const change: BoardsDataStoreChange = { this.fireChanged();
fqbn: sanitizedFQBN,
data: mutableData,
};
await this.setData(change);
this.fireChanged(change);
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(): void {
this.onDidChangeEmitter.fire({ changes }); this.onChangedEmitter.fire();
} }
} }
@ -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: any): arg is Data {
export function is(arg: unknown): arg is Data {
return ( return (
typeof arg === 'object' && !!arg &&
arg !== null && 'configOptions' in arg &&
Array.isArray((<Data>arg).configOptions) && Array.isArray(arg['configOptions']) &&
Array.isArray((<Data>arg).programmers) && 'programmers' in arg &&
((<Data>arg).selectedProgrammer === undefined || Array.isArray(arg['programmers'])
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 interface BoardsDataStoreChange {
readonly fqbn: string;
readonly data: BoardsDataStore.Data;
}
function isBoardsDataStoreChange(arg: unknown): arg is BoardsDataStoreChange {
return (
typeof arg === 'object' &&
arg !== null &&
typeof (<BoardsDataStoreChange>arg).fqbn === 'string' &&
BoardsDataStore.Data.is((<BoardsDataStoreChange>arg).data)
);
}
export interface BoardsDataStoreChangeEvent {
readonly changes: readonly BoardsDataStoreChange[];
}
const USE_INHERITED_DATA: Command = {
id: 'arduino-use-inherited-boards-data',
};

View File

@ -30,6 +30,7 @@ export class BoardsListWidget extends ListWidget<BoardsPackage, BoardSearch> {
searchable: service, searchable: service,
installable: service, installable: service,
itemLabel: (item: BoardsPackage) => item.name, itemLabel: (item: BoardsPackage) => item.name,
itemDeprecated: (item: BoardsPackage) => item.deprecated,
itemRenderer, itemRenderer,
filterRenderer, filterRenderer,
defaultSearchOptions: { query: '', type: 'All' }, 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();
switch (type) {
case 'select-boards-config': {
return boardList.select(params);
}
case 'edit-boards-config': {
return boardList.edit(params);
}
default:
return assertUnreachable(type);
}
};
private renderBoardListItem({
item,
selected, selected,
onClick,
}: { }: {
item: BoardListItemUI; boardLabel: string;
selected: boolean; port: Port;
selected?: boolean;
onClick: () => void;
}): React.ReactNode { }): React.ReactNode {
const { boardLabel, portLabel, portProtocol, tooltip } = item.labels; const protocolIcon = iconNameFromProtocol(port.protocol);
const port = item.port;
const onKeyUp = (e: React.KeyboardEvent) => { const onKeyUp = (e: React.KeyboardEvent) => {
if (e.key === 'Enter') { if (e.key === 'Enter') {
this.onDefaultAction(item); onClick();
} }
}; };
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"
<div className="arduino-boards-dropdown-item--board-label noWrapInfo noselect"> title={`${boardLabel}\n${port.address}`}
{boardLabel} >
</div> <div className="arduino-boards-dropdown-item--board-label noWrapInfo noselect">
{boardLabel}
</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,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,102 +0,0 @@
import { FrontendApplicationContribution } from '@theia/core/lib/browser/frontend-application-contribution';
import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';
import { DisposableCollection } from '@theia/core/lib/common/disposable';
import { Emitter, Event } from '@theia/core/lib/common/event';
import { MessageService } from '@theia/core/lib/common/message-service';
import { deepClone } from '@theia/core/lib/common/objects';
import URI from '@theia/core/lib/common/uri';
import {
inject,
injectable,
postConstruct,
} from '@theia/core/shared/inversify';
import { ConfigService, ConfigState } from '../../common/protocol';
import { NotificationCenter } from '../notification-center';
@injectable()
export class ConfigServiceClient implements FrontendApplicationContribution {
@inject(ConfigService)
private readonly delegate: ConfigService;
@inject(NotificationCenter)
private readonly notificationCenter: NotificationCenter;
@inject(FrontendApplicationStateService)
private readonly appStateService: FrontendApplicationStateService;
@inject(MessageService)
private readonly messageService: MessageService;
private readonly didChangeSketchDirUriEmitter = new Emitter<
URI | undefined
>();
private readonly didChangeDataDirUriEmitter = new Emitter<URI | undefined>();
private readonly toDispose = new DisposableCollection(
this.didChangeSketchDirUriEmitter,
this.didChangeDataDirUriEmitter
);
private config: ConfigState | undefined;
@postConstruct()
protected init(): void {
this.appStateService.reachedState('ready').then(async () => {
const config = await this.delegate.getConfiguration();
this.use(config);
});
}
onStart(): void {
this.notificationCenter.onConfigDidChange((config) => this.use(config));
}
onStop(): void {
this.toDispose.dispose();
}
get onDidChangeSketchDirUri(): Event<URI | undefined> {
return this.didChangeSketchDirUriEmitter.event;
}
get onDidChangeDataDirUri(): Event<URI | undefined> {
return this.didChangeDataDirUriEmitter.event;
}
/**
* CLI config related error messages if any.
*/
tryGetMessages(): string[] | undefined {
return this.config?.messages;
}
/**
* `directories.user`
*/
tryGetSketchDirUri(): URI | undefined {
return this.config?.config?.sketchDirUri
? new URI(this.config?.config?.sketchDirUri)
: undefined;
}
/**
* `directories.data`
*/
tryGetDataDirUri(): URI | undefined {
return this.config?.config?.dataDirUri
? new URI(this.config?.config?.dataDirUri)
: undefined;
}
private use(config: ConfigState): void {
const oldConfig = deepClone(this.config);
this.config = config;
if (oldConfig?.config?.sketchDirUri !== this.config?.config?.sketchDirUri) {
this.didChangeSketchDirUriEmitter.fire(this.tryGetSketchDirUri());
}
if (oldConfig?.config?.dataDirUri !== this.config?.config?.dataDirUri) {
this.didChangeDataDirUriEmitter.fire(this.tryGetDataDirUri());
}
if (this.config.messages?.length) {
const message = this.config.messages.join(' ');
// toast the error later otherwise it might not show up in IDE2
setTimeout(() => this.messageService.error(message), 1_000);
}
}
}

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,23 @@ export class About extends Contribution {
}); });
} }
private async showAbout(): Promise<void> { async showAbout(): Promise<void> {
const appInfo = await this.appService.info(); const {
const { appVersion, cliVersion, buildDate } = appInfo; version,
commit,
status: cliStatus,
} = await this.configService.getVersion();
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}{4} [{5}]\n\n{6}',
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,
cliStatus ? ` ${cliStatus}` : '',
commit,
nls.localize( nls.localize(
'arduino/about/copyright', 'arduino/about/copyright',
'Copyright © {0} Arduino SA', 'Copyright © {0} Arduino SA',
@ -59,27 +66,34 @@ 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(
message: `${this.applicationName}`, remote.getCurrentWindow(),
title: `${this.applicationName}`, {
type: 'info', message: `${this.applicationName}`,
detail: detail(true), title: `${this.applicationName}`,
buttons, type: 'info',
noLink: true, detail: detail(true),
defaultId: buttons.indexOf(ok), buttons,
cancelId: buttons.indexOf(ok), noLink: true,
}); defaultId: 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,155 +0,0 @@
import { FrontendApplication } from '@theia/core/lib/browser/frontend-application';
import { SidebarMenu } from '@theia/core/lib/browser/shell/sidebar-menu-widget';
import { WindowService } from '@theia/core/lib/browser/window/window-service';
import { DisposableCollection } from '@theia/core/lib/common/disposable';
import { MenuPath } from '@theia/core/lib/common/menu';
import { nls } from '@theia/core/lib/common/nls';
import { inject, injectable } from '@theia/core/shared/inversify';
import { CloudUserCommands, LEARN_MORE_URL } from '../auth/cloud-user-commands';
import { CreateFeatures } from '../create/create-features';
import { ArduinoMenus } from '../menu/arduino-menus';
import { ApplicationConnectionStatusContribution } from '../theia/core/connection-status-service';
import {
Command,
CommandRegistry,
Contribution,
MenuModelRegistry,
} from './contribution';
export const accountMenu: SidebarMenu = {
id: 'arduino-accounts-menu',
iconClass: 'codicon codicon-account',
title: nls.localize('arduino/account/menuTitle', 'Arduino Cloud'),
menuPath: ArduinoMenus.ARDUINO_ACCOUNT__CONTEXT,
order: 0,
};
@injectable()
export class Account extends Contribution {
@inject(WindowService)
private readonly windowService: WindowService;
@inject(CreateFeatures)
private readonly createFeatures: CreateFeatures;
@inject(ApplicationConnectionStatusContribution)
private readonly connectionStatus: ApplicationConnectionStatusContribution;
private readonly toDispose = new DisposableCollection();
private app: FrontendApplication;
override onStart(app: FrontendApplication): void {
this.app = app;
this.updateSidebarCommand();
this.toDispose.push(
this.createFeatures.onDidChangeEnabled((enabled) =>
this.updateSidebarCommand(enabled)
)
);
}
onStop(): void {
this.toDispose.dispose();
}
override registerCommands(registry: CommandRegistry): void {
const openExternal = (url: string) =>
this.windowService.openNewWindow(url, { external: true });
const loggedIn = () => Boolean(this.createFeatures.session);
const loggedInWithInternetConnection = () =>
loggedIn() && this.connectionStatus.offlineStatus !== 'internet';
registry.registerCommand(Account.Commands.LEARN_MORE, {
execute: () => openExternal(LEARN_MORE_URL),
isEnabled: () => !loggedIn(),
isVisible: () => !loggedIn(),
});
registry.registerCommand(Account.Commands.GO_TO_PROFILE, {
execute: () => openExternal('https://id.arduino.cc/'),
isEnabled: () => loggedInWithInternetConnection(),
isVisible: () => loggedIn(),
});
registry.registerCommand(Account.Commands.GO_TO_CLOUD_EDITOR, {
execute: () => openExternal('https://create.arduino.cc/editor'),
isEnabled: () => loggedInWithInternetConnection(),
isVisible: () => loggedIn(),
});
registry.registerCommand(Account.Commands.GO_TO_IOT_CLOUD, {
execute: () => openExternal('https://create.arduino.cc/iot/'),
isEnabled: () => loggedInWithInternetConnection(),
isVisible: () => loggedIn(),
});
}
override registerMenus(registry: MenuModelRegistry): void {
const register = (
menuPath: MenuPath,
...commands: (Command | [command: Command, menuLabel: string])[]
) =>
commands.forEach((command, index) => {
const commandId = Array.isArray(command) ? command[0].id : command.id;
const label = Array.isArray(command) ? command[1] : command.label;
registry.registerMenuAction(menuPath, {
label,
commandId,
order: String(index),
});
});
register(ArduinoMenus.ARDUINO_ACCOUNT__CONTEXT__SIGN_IN_GROUP, [
CloudUserCommands.LOGIN,
nls.localize('arduino/cloud/signInToCloud', 'Sign in to Arduino Cloud'),
]);
register(ArduinoMenus.ARDUINO_ACCOUNT__CONTEXT__LEARN_MORE_GROUP, [
Account.Commands.LEARN_MORE,
nls.localize('arduino/cloud/learnMore', 'Learn more'),
]);
register(
ArduinoMenus.ARDUINO_ACCOUNT__CONTEXT__GO_TO_GROUP,
[
Account.Commands.GO_TO_PROFILE,
nls.localize('arduino/account/goToProfile', 'Go to Profile'),
],
[
Account.Commands.GO_TO_CLOUD_EDITOR,
nls.localize('arduino/account/goToCloudEditor', 'Go to Cloud Editor'),
],
[
Account.Commands.GO_TO_IOT_CLOUD,
nls.localize('arduino/account/goToIoTCloud', 'Go to IoT Cloud'),
]
);
register(
ArduinoMenus.ARDUINO_ACCOUNT__CONTEXT__SIGN_OUT_GROUP,
CloudUserCommands.LOGOUT
);
}
private updateSidebarCommand(
visible: boolean = this.preferences['arduino.cloud.enabled']
): void {
if (!this.app) {
return;
}
const handler = this.app.shell.leftPanelHandler;
if (visible) {
handler.addBottomMenu(accountMenu);
} else {
handler.removeBottomMenu(accountMenu.id);
}
}
}
export namespace Account {
export namespace Commands {
export const GO_TO_PROFILE: Command = {
id: 'arduino-go-to-profile',
};
export const GO_TO_CLOUD_EDITOR: Command = {
id: 'arduino-go-to-cloud-editor',
};
export const GO_TO_IOT_CLOUD: Command = {
id: 'arduino-go-to-iot-cloud',
};
export const LEARN_MORE: Command = {
id: 'arduino-learn-more',
};
}
}

View File

@ -1,21 +1,21 @@
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,
} from './contribution'; } from './contribution';
import { FileDialogService } from '@theia/filesystem/lib/browser';
import { nls } from '@theia/core/lib/common';
import { CurrentSketch } from '../../common/protocol/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, {
@ -46,10 +46,12 @@ export class AddFile extends SketchContribution {
if (!toAddUri) { if (!toAddUri) {
return; return;
} }
const { uri: targetUri, filename } = this.resolveTarget(sketch, toAddUri); const sketchUri = new URI(sketch.uri);
const filename = toAddUri.path.base;
const targetUri = sketchUri.resolve('data').resolve(filename);
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: [
@ -78,22 +80,6 @@ export class AddFile extends SketchContribution {
} }
); );
} }
// https://github.com/arduino/arduino-ide/issues/284#issuecomment-1364533662
// File the file to add has one of the following extension, it goes to the sketch folder root: .ino, .h, .cpp, .c, .S
// Otherwise, the files goes to the `data` folder inside the sketch folder root.
private resolveTarget(
sketch: Sketch,
toAddUri: URI
): { uri: URI; filename: string } {
const path = toAddUri.path;
const filename = path.base;
let root = new URI(sketch.uri);
if (!Sketch.Extensions.CODE_FILES.includes(path.ext)) {
root = root.resolve('data');
}
return { uri: root.resolve(filename), filename: filename };
}
} }
export namespace AddFile { export namespace AddFile {

View File

@ -1,6 +1,8 @@
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 { EnvVariablesServer } from '@theia/core/lib/common/env-variables';
import { ArduinoMenus } from '../menu/arduino-menus'; import { ArduinoMenus } from '../menu/arduino-menus';
import { LibraryService, ResponseServiceClient } from '../../common/protocol'; import { LibraryService, ResponseServiceClient } from '../../common/protocol';
import { ExecuteWithProgress } from '../../common/protocol/progressible'; import { ExecuteWithProgress } from '../../common/protocol/progressible';
@ -14,6 +16,9 @@ import { nls } from '@theia/core/lib/common';
@injectable() @injectable()
export class AddZipLibrary extends SketchContribution { export class AddZipLibrary extends SketchContribution {
@inject(EnvVariablesServer)
private readonly envVariableServer: EnvVariablesServer;
@inject(ResponseServiceClient) @inject(ResponseServiceClient)
private readonly responseService: ResponseServiceClient; private readonly responseService: ResponseServiceClient;
@ -41,20 +46,23 @@ 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(
title: nls.localize( remote.getCurrentWindow(),
'arduino/selectZip', {
"Select a zip file containing the library you'd like to add" title: nls.localize(
), 'arduino/selectZip',
defaultPath, "Select a zip file containing the library you'd like to add"
properties: ['openFile'], ),
filters: [ defaultPath,
{ properties: ['openFile'],
name: nls.localize('arduino/library/zipLibrary', 'Library'), filters: [
extensions: ['zip'], {
}, name: nls.localize('arduino/library/zipLibrary', 'Library'),
], 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,7 @@
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 URI from '@theia/core/lib/common/uri';
import { ArduinoMenus } from '../menu/arduino-menus'; import { ArduinoMenus } from '../menu/arduino-menus';
import { import {
SketchContribution, SketchContribution,
@ -8,7 +10,7 @@ import {
MenuModelRegistry, MenuModelRegistry,
} from './contribution'; } from './contribution';
import { nls } from '@theia/core/lib/common'; import { nls } from '@theia/core/lib/common';
import { CurrentSketch } from '../sketches-service-client-impl'; import { CurrentSketch } from '../../common/protocol/sketches-service-client-impl';
@injectable() @injectable()
export class ArchiveSketch extends SketchContribution { export class ArchiveSketch extends SketchContribution {
@ -27,7 +29,10 @@ export class ArchiveSketch extends SketchContribution {
} }
private async archiveSketch(): Promise<void> { private async archiveSketch(): Promise<void> {
const sketch = await this.sketchServiceClient.currentSketch(); const [sketch, config] = await Promise.all([
this.sketchServiceClient.currentSketch(),
this.configService.getConfiguration(),
]);
if (!CurrentSketch.isValid(sketch)) { if (!CurrentSketch.isValid(sketch)) {
return; return;
} }
@ -35,16 +40,19 @@ export class ArchiveSketch extends SketchContribution {
new Date(), new Date(),
'yymmdd' 'yymmdd'
)}a.zip`; )}a.zip`;
const defaultContainerUri = await this.defaultUri(); const defaultPath = await this.fileService.fsPath(
const defaultUri = defaultContainerUri.resolve(archiveBasename); new URI(config.sketchDirUri).resolve(archiveBasename)
const defaultPath = await this.fileService.fsPath(defaultUri); );
const { filePath, canceled } = await this.dialogService.showSaveDialog({ const { filePath, canceled } = await remote.dialog.showSaveDialog(
title: nls.localize( remote.getCurrentWindow(),
'arduino/sketch/saveSketchAs', {
'Save sketch folder as...' title: nls.localize(
), 'arduino/sketch/saveSketchAs',
defaultPath, 'Save sketch folder as...'
}); ),
defaultPath,
}
);
if (!filePath || canceled) { if (!filePath || canceled) {
return; return;
} }
@ -52,7 +60,7 @@ export class ArchiveSketch extends SketchContribution {
if (!destinationUri) { if (!destinationUri) {
return; return;
} }
await this.sketchesService.archive(sketch, destinationUri.toString()); await this.sketchService.archive(sketch, destinationUri.toString());
this.messageService.info( this.messageService.info(
nls.localize( nls.localize(
'arduino/sketch/createdArchive', 'arduino/sketch/createdArchive',

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,137 +1,133 @@
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,
} 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 { selectedBoard, selectedPort } =
this.boardsServiceProvider.boardList this.boardsServiceProvider.boardsConfig;
); if (!selectedBoard) {
if (typeof boardInfo === 'string') { this.messageService.info(
this.messageService.info(boardInfo); nls.localize(
'arduino/board/selectBoardForInfo',
'Please select a board to obtain board info.'
)
);
return; return;
} }
const { BN, VID, PID, SN } = boardInfo; if (!selectedBoard.fqbn) {
const detail = ` this.messageService.info(
BN: ${BN} nls.localize(
VID: ${VID} 'arduino/board/platformMissing',
PID: ${PID} "The platform for the selected '{0}' board is not installed.",
SN: ${SN} selectedBoard.name
`.trim(); )
await this.dialogService.showMessageBox({
message: nls.localize('arduino/board/boardInfo', 'Board Info'),
title: nls.localize('arduino/board/boardInfo', 'Board Info'),
type: 'info',
detail,
buttons: [nls.localize('vscode/issueMainService/ok', 'OK')],
});
},
});
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.'
); );
return;
}
if (!selectedPort) {
this.messageService.info(
nls.localize(
'arduino/board/selectPortForInfo',
'Please select a port to obtain board info.'
)
);
return;
}
const boardDetails = await this.boardsService.getBoardDetails({
fqbn: selectedBoard.fqbn,
});
if (boardDetails) {
const { VID, PID } = boardDetails;
const detail = `BN: ${selectedBoard.name}
VID: ${VID}
PID: ${PID}`;
await remote.dialog.showMessageBox(remote.getCurrentWindow(), {
message: nls.localize('arduino/board/boardInfo', 'Board Info'),
title: nls.localize('arduino/board/boardInfo', 'Board Info'),
type: 'info',
detail,
buttons: [nls.localize('vscode/issueMainService/ok', 'OK')],
});
} }
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 +136,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(
@ -160,8 +155,11 @@ SN: ${SN}
); );
// Ports submenu // Ports submenu
const portsSubmenuPath = ArduinoMenus.TOOLS__PORTS_SUBMENU; const portsSubmenuPath = [
const portsSubmenuLabel = selectedPort?.address; ...ArduinoMenus.TOOLS__BOARD_SELECTION_GROUP,
'2_ports',
];
const portsSubmenuLabel = config.selectedPort?.address;
this.menuModelRegistry.registerSubmenu( this.menuModelRegistry.registerSubmenu(
portsSubmenuPath, portsSubmenuPath,
nls.localize( nls.localize(
@ -177,21 +175,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,116 +198,69 @@ 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]) => {
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 +
`${
manuallyInstalled
? nls.localize(
'arduino/board/inSketchbook',
' (in Sketchbook)'
)
: ''
}`;
if (
selectedBoardPlatformId &&
platformIdentifierEquals(packageId, selectedBoardPlatformId)
) {
packageLabel = `${packageLabel}`;
}
if (useVendorSuffix) {
packageLabel += ` (${vendorId})`;
}
// Platform submenu
platformMenuPath = [
...boardsPackagesGroup,
serializePlatformIdentifier(packageId),
];
this.menuModelRegistry.registerSubmenu(
platformMenuPath,
packageLabel,
{
order: packageName.toLowerCase(),
}
);
}
const id = `arduino-select-board--${fqbn}`; const packageLabel =
const command = { id }; packageName +
const handler = { `${
execute: () => manuallyInstalled
this.boardsServiceProvider.updateConfig({ ? nls.localize('arduino/board/inSketchbook', ' (in Sketchbook)')
name: name, : ''
fqbn: fqbn, }`;
}), // Platform submenu
isToggled: () => fqbn === selectedBoard?.fqbn, const platformMenuPath = [...boardsPackagesGroup, packageId];
// Note: Registering the same submenu twice is a noop. No need to group the boards per platform.
this.menuModelRegistry.registerSubmenu(platformMenuPath, packageLabel, {
order: packageName.toLowerCase(),
});
const id = `arduino-select-board--${fqbn}`;
const command = { id };
const handler = {
execute: () => {
if (
fqbn !== this.boardsServiceProvider.boardsConfig.selectedBoard?.fqbn
) {
this.boardsServiceProvider.boardsConfig = {
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
const menuAction = { const menuAction = {
commandId: id, commandId: id,
label: name, label: name,
order: String(index).padStart(4), // pads with leading zeros for alphanumeric sort where order is 1, 2, 11, and NOT 1, 11, 2 order: String(index).padStart(4), // pads with leading zeros for alphanumeric sort where order is 1, 2, 11, and NOT 1, 11, 2
}; };
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);
); // Note: we do not dispose the menu actions individually. Calling `unregisterSubmenu` on the parent will wipe the children menu nodes recursively.
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.
});
});
}
);
// 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 +285,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 +341,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 +368,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

@ -3,14 +3,10 @@ import { LocalStorageService } from '@theia/core/lib/browser/storage-service';
import { inject, injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import { import {
IDEUpdater, IDEUpdater,
LAST_USED_IDE_VERSION,
SKIP_IDE_VERSION, SKIP_IDE_VERSION,
} from '../../common/protocol/ide-updater'; } from '../../common/protocol/ide-updater';
import { IDEUpdaterDialog } from '../dialogs/ide-updater/ide-updater-dialog'; import { IDEUpdaterDialog } from '../dialogs/ide-updater/ide-updater-dialog';
import { Contribution } from './contribution'; import { Contribution } from './contribution';
import { VersionWelcomeDialog } from '../dialogs/version-welcome-dialog';
import { AppService } from '../app-service';
import { SemVer } from 'semver';
@injectable() @injectable()
export class CheckForIDEUpdates extends Contribution { export class CheckForIDEUpdates extends Contribution {
@ -20,15 +16,9 @@ export class CheckForIDEUpdates extends Contribution {
@inject(IDEUpdaterDialog) @inject(IDEUpdaterDialog)
private readonly updaterDialog: IDEUpdaterDialog; private readonly updaterDialog: IDEUpdaterDialog;
@inject(VersionWelcomeDialog)
private readonly versionWelcomeDialog: VersionWelcomeDialog;
@inject(LocalStorageService) @inject(LocalStorageService)
private readonly localStorage: LocalStorageService; private readonly localStorage: LocalStorageService;
@inject(AppService)
private readonly appService: AppService;
override onStart(): void { override onStart(): void {
this.preferences.onPreferenceChanged( this.preferences.onPreferenceChanged(
({ preferenceName, newValue, oldValue }) => { ({ preferenceName, newValue, oldValue }) => {
@ -46,7 +36,7 @@ export class CheckForIDEUpdates extends Contribution {
); );
} }
override async onReady(): Promise<void> { override onReady(): void {
this.updater this.updater
.init( .init(
this.preferences.get('arduino.ide.updateChannel'), this.preferences.get('arduino.ide.updateChannel'),
@ -59,18 +49,12 @@ export class CheckForIDEUpdates extends Contribution {
return this.updater.checkForUpdates(true); return this.updater.checkForUpdates(true);
}) })
.then(async (updateInfo) => { .then(async (updateInfo) => {
if (!updateInfo) { if (!updateInfo) return;
const isNewVersion = await this.isNewStableVersion();
if (isNewVersion) {
this.versionWelcomeDialog.open();
}
return;
}
const versionToSkip = await this.localStorage.getData<string>( const versionToSkip = await this.localStorage.getData<string>(
SKIP_IDE_VERSION SKIP_IDE_VERSION
); );
if (versionToSkip === updateInfo.version) return; if (versionToSkip === updateInfo.version) return;
this.updaterDialog.open(true, updateInfo); this.updaterDialog.open(updateInfo);
}) })
.catch((e) => { .catch((e) => {
this.messageService.error( this.messageService.error(
@ -80,44 +64,6 @@ export class CheckForIDEUpdates extends Contribution {
e.message e.message
) )
); );
})
.finally(() => {
this.setCurrentIDEVersion();
}); });
} }
private async setCurrentIDEVersion(): Promise<void> {
try {
const { appVersion } = await this.appService.info();
const currSemVer = new SemVer(appVersion ?? '');
this.localStorage.setData(LAST_USED_IDE_VERSION, currSemVer.format());
} catch {
// ignore invalid versions
}
}
/**
* Check if user is running a new IDE version for the first time.
* @returns true if the current IDE version is greater than the last used version
* and both are non-prerelease versions.
*/
private async isNewStableVersion(): Promise<boolean> {
try {
const { appVersion } = await this.appService.info();
const prevVersion = await this.localStorage.getData<string>(
LAST_USED_IDE_VERSION
);
const prevSemVer = new SemVer(prevVersion ?? '');
const currSemVer = new SemVer(appVersion ?? '');
if (prevSemVer.prerelease.length || currSemVer.prerelease.length) {
return false;
}
return currSemVer.compare(prevSemVer) === 1;
} catch (e) {
return false;
}
}
} }

View File

@ -1,24 +1,26 @@
import { Dialog } from '@theia/core/lib/browser/dialogs'; import { injectable } from '@theia/core/shared/inversify';
import type { FrontendApplication } from '@theia/core/lib/browser/frontend-application';
import type { OnWillStopAction } from '@theia/core/lib/browser/frontend-application-contribution';
import { ApplicationShell } from '@theia/core/lib/browser/shell/application-shell';
import { nls } from '@theia/core/lib/common/nls';
import type { MaybePromise } from '@theia/core/lib/common/types';
import { toArray } from '@theia/core/shared/@phosphor/algorithm'; import { toArray } from '@theia/core/shared/@phosphor/algorithm';
import { inject, injectable } from '@theia/core/shared/inversify'; import * as remote from '@theia/core/electron-shared/@electron/remote';
import { MonacoEditor } from '@theia/monaco/lib/browser/monaco-editor'; import { MonacoEditor } from '@theia/monaco/lib/browser/monaco-editor';
import type { MaybePromise } from '@theia/core/lib/common/types';
import type {
FrontendApplication,
OnWillStopAction,
} from '@theia/core/lib/browser/frontend-application';
import { nls } from '@theia/core/lib/common/nls';
import { ApplicationShell } from '@theia/core/lib/browser/shell/application-shell';
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 '../../common/protocol/sketches-service-client-impl';
import { SaveAsSketch } from './save-as-sketch'; import { SaveAsSketch } from './save-as-sketch';
/** /**
@ -26,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> {
@ -57,7 +56,7 @@ export class Close extends SketchContribution {
} }
} }
} }
return this.windowServiceExt.close(); return remote.getCurrentWindow().close();
}, },
}); });
} }
@ -151,23 +150,26 @@ 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(
message: nls.localize( remote.getCurrentWindow(),
'arduino/sketch/saveSketch', {
'Save your sketch to open it again later.' message: nls.localize(
), 'arduino/sketch/saveSketch',
title: nls.localize( 'Save your sketch to open it again later.'
'theia/core/quitTitle', ),
'Are you sure you want to quit?' title: nls.localize(
), 'theia/core/quitTitle',
type: 'question', 'Are you sure you want to quit?'
buttons: [ ),
nls.localizeByDefault("Don't Save"), type: 'question',
Dialog.CANCEL, buttons: [
nls.localizeByDefault(isTemp ? 'Save As...' : 'Save'), nls.localizeByDefault("Don't Save"),
], Dialog.CANCEL,
defaultId: 2, // `Save`/`Save As...` button index is the default. nls.localizeByDefault(isTemp ? 'Save As...' : 'Save'),
}); ],
defaultId: 2, // `Save`/`Save As...` button index is the default.
}
);
switch (response) { switch (response) {
case 0: case 0:
return Prompt.DoNotSave; return Prompt.DoNotSave;
@ -183,7 +185,7 @@ export class Close extends SketchContribution {
private async isCurrentSketchTemp(): Promise<false | Sketch> { private async isCurrentSketchTemp(): Promise<false | Sketch> {
const currentSketch = await this.sketchServiceClient.currentSketch(); const currentSketch = await this.sketchServiceClient.currentSketch();
if (CurrentSketch.isValid(currentSketch)) { if (CurrentSketch.isValid(currentSketch)) {
const isTemp = await this.sketchesService.isTemp(currentSketch); const isTemp = await this.sketchService.isTemp(currentSketch);
if (isTemp) { if (isTemp) {
return currentSketch; return currentSketch;
} }

View File

@ -1,121 +0,0 @@
import { CompositeTreeNode } from '@theia/core/lib/browser/tree';
import { nls } from '@theia/core/lib/common/nls';
import { inject, injectable } from '@theia/core/shared/inversify';
import { CreateApi } from '../create/create-api';
import { CreateFeatures } from '../create/create-features';
import { CreateUri } from '../create/create-uri';
import { Create, isNotFound } from '../create/typings';
import { CloudSketchbookTree } from '../widgets/cloud-sketchbook/cloud-sketchbook-tree';
import { CloudSketchbookTreeModel } from '../widgets/cloud-sketchbook/cloud-sketchbook-tree-model';
import { CloudSketchbookTreeWidget } from '../widgets/cloud-sketchbook/cloud-sketchbook-tree-widget';
import { SketchbookWidget } from '../widgets/sketchbook/sketchbook-widget';
import { SketchbookWidgetContribution } from '../widgets/sketchbook/sketchbook-widget-contribution';
import { SketchContribution } from './contribution';
export function sketchAlreadyExists(input: string): string {
return nls.localize(
'arduino/cloudSketch/alreadyExists',
"Cloud sketch '{0}' already exists.",
input
);
}
export function sketchNotFound(input: string): string {
return nls.localize(
'arduino/cloudSketch/notFound',
"Could not pull the cloud sketch '{0}'. It does not exist.",
input
);
}
export const synchronizingSketchbook = nls.localize(
'arduino/cloudSketch/synchronizingSketchbook',
'Synchronizing sketchbook...'
);
export function pullingSketch(input: string): string {
return nls.localize(
'arduino/cloudSketch/pulling',
"Synchronizing sketchbook, pulling '{0}'...",
input
);
}
export function pushingSketch(input: string): string {
return nls.localize(
'arduino/cloudSketch/pushing',
"Synchronizing sketchbook, pushing '{0}'...",
input
);
}
@injectable()
export abstract class CloudSketchContribution extends SketchContribution {
@inject(SketchbookWidgetContribution)
private readonly widgetContribution: SketchbookWidgetContribution;
@inject(CreateApi)
protected readonly createApi: CreateApi;
@inject(CreateFeatures)
protected readonly createFeatures: CreateFeatures;
protected async treeModel(): Promise<
(CloudSketchbookTreeModel & { root: CompositeTreeNode }) | undefined
> {
const { enabled, session } = this.createFeatures;
if (enabled && session) {
const widget = await this.widgetContribution.widget;
const treeModel = this.treeModelFrom(widget);
if (treeModel) {
const root = treeModel.root;
if (CompositeTreeNode.is(root)) {
return treeModel as CloudSketchbookTreeModel & {
root: CompositeTreeNode;
};
}
}
}
return undefined;
}
protected async pull(
sketch: Create.Sketch
): Promise<CloudSketchbookTree.CloudSketchDirNode | undefined> {
const treeModel = await this.treeModel();
if (!treeModel) {
return undefined;
}
const id = CreateUri.toUri(sketch).path.toString();
const node = treeModel.getNode(id);
if (!node) {
throw new Error(
`Could not find cloud sketchbook tree node with ID: ${id}.`
);
}
if (!CloudSketchbookTree.CloudSketchDirNode.is(node)) {
throw new Error(
`Cloud sketchbook tree node expected to represent a directory but it did not. Tree node ID: ${id}.`
);
}
try {
await treeModel.sketchbookTree().pull({ node }, true);
return node;
} catch (err) {
if (isNotFound(err)) {
await treeModel.refresh();
this.messageService.error(sketchNotFound(sketch.name));
return undefined;
}
throw err;
}
}
private treeModelFrom(
widget: SketchbookWidget
): CloudSketchbookTreeModel | undefined {
for (const treeWidget of widget.getTreeWidgets()) {
if (treeWidget instanceof CloudSketchbookTreeWidget) {
const model = treeWidget.model;
if (model instanceof CloudSketchbookTreeModel) {
return model;
}
}
}
return undefined;
}
}

View File

@ -779,7 +779,7 @@ export class CompilerErrors
return undefined; return undefined;
} else { } else {
return this.editorManager return this.editorManager
.getByUri(new URI(uriOrWidget.toString())) .getByUri(new URI(uriOrWidget))
.then((editor) => { .then((editor) => {
if (editor) { if (editor) {
return this.monacoEditor(editor); return this.monacoEditor(editor);

View File

@ -1,87 +1,75 @@
import { ClipboardService } from '@theia/core/lib/browser/clipboard-service';
import { FrontendApplication } from '@theia/core/lib/browser/frontend-application';
import { FrontendApplicationContribution } from '@theia/core/lib/browser/frontend-application-contribution';
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 { 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 '../../common/protocol/sketches-service-client-impl';
import { ApplicationConnectionStatusContribution } from '../theia/core/connection-status-service'; import {
SketchesService,
ConfigService,
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/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';
export { export {
Command, Command,
CommandRegistry, CommandRegistry,
KeybindingRegistry,
MenuModelRegistry, MenuModelRegistry,
Sketch, KeybindingRegistry,
TabBarToolbarRegistry, TabBarToolbarRegistry,
URI, URI,
Sketch,
open, open,
}; };
@ -118,12 +106,6 @@ export abstract class Contribution
@inject(FrontendApplicationStateService) @inject(FrontendApplicationStateService)
protected readonly appStateService: FrontendApplicationStateService; protected readonly appStateService: FrontendApplicationStateService;
@inject(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());
@ -156,11 +138,11 @@ export abstract class SketchContribution extends Contribution {
@inject(FileSystemExt) @inject(FileSystemExt)
protected readonly fileSystemExt: FileSystemExt; protected readonly fileSystemExt: FileSystemExt;
@inject(ConfigServiceClient) @inject(ConfigService)
protected readonly configService: ConfigServiceClient; protected readonly configService: ConfigService;
@inject(SketchesService) @inject(SketchesService)
protected readonly sketchesService: SketchesService; protected readonly sketchService: SketchesService;
@inject(OpenerService) @inject(OpenerService)
protected readonly openerService: OpenerService; protected readonly openerService: OpenerService;
@ -174,12 +156,6 @@ export abstract class SketchContribution extends Contribution {
@inject(OutputChannelManager) @inject(OutputChannelManager)
protected readonly outputChannelManager: OutputChannelManager; protected readonly outputChannelManager: OutputChannelManager;
@inject(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();
@ -193,25 +169,6 @@ export abstract class SketchContribution extends Contribution {
} }
return override; return override;
} }
/**
* Defaults to `directories.user` if defined and not CLI config errors were detected.
* Otherwise, the URI of the user home directory.
*/
protected async defaultUri(): Promise<URI> {
const errors = this.configService.tryGetMessages();
let defaultUri = this.configService.tryGetSketchDirUri();
if (!defaultUri || errors?.length) {
// Fall back to user home when the `directories.user` is not available or there are known CLI config errors
defaultUri = new URI(await this.envVariableServer.getHomeDirUri());
}
return defaultUri;
}
protected async defaultPath(): Promise<string> {
const defaultUri = await this.defaultUri();
return this.fileService.fsPath(defaultUri);
}
} }
@injectable() @injectable()
@ -234,9 +191,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.)
@ -251,12 +205,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);
} }
@ -303,17 +251,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')
@ -322,31 +261,14 @@ 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,
actions, actions,
type: MessageType.Error, type: MessageType.Error,

View File

@ -1,118 +0,0 @@
import { FrontendApplication } from '@theia/core/lib/browser/frontend-application';
import { ApplicationShell } from '@theia/core/lib/browser/shell';
import type { Command, CommandRegistry } from '@theia/core/lib/common/command';
import { Progress } from '@theia/core/lib/common/message-service-protocol';
import { nls } from '@theia/core/lib/common/nls';
import { inject, injectable } from '@theia/core/shared/inversify';
import { Create } from '../create/typings';
import { ApplicationConnectionStatusContribution } from '../theia/core/connection-status-service';
import { CloudSketchbookTree } from '../widgets/cloud-sketchbook/cloud-sketchbook-tree';
import { SketchbookTree } from '../widgets/sketchbook/sketchbook-tree';
import { SketchbookTreeModel } from '../widgets/sketchbook/sketchbook-tree-model';
import { CloudSketchContribution, pushingSketch } from './cloud-contribution';
import {
CreateNewCloudSketchCallback,
NewCloudSketch,
NewCloudSketchParams,
} from './new-cloud-sketch';
import { saveOntoCopiedSketch } from './save-as-sketch';
interface CreateCloudCopyParams {
readonly model: SketchbookTreeModel;
readonly node: SketchbookTree.SketchDirNode;
}
function isCreateCloudCopyParams(arg: unknown): arg is CreateCloudCopyParams {
return (
typeof arg === 'object' &&
(<CreateCloudCopyParams>arg).model !== undefined &&
(<CreateCloudCopyParams>arg).model instanceof SketchbookTreeModel &&
(<CreateCloudCopyParams>arg).node !== undefined &&
SketchbookTree.SketchDirNode.is((<CreateCloudCopyParams>arg).node)
);
}
@injectable()
export class CreateCloudCopy extends CloudSketchContribution {
@inject(ApplicationConnectionStatusContribution)
private readonly connectionStatus: ApplicationConnectionStatusContribution;
private shell: ApplicationShell;
override onStart(app: FrontendApplication): void {
this.shell = app.shell;
}
override registerCommands(registry: CommandRegistry): void {
registry.registerCommand(CreateCloudCopy.Commands.CREATE_CLOUD_COPY, {
execute: (args: CreateCloudCopyParams) => this.createCloudCopy(args),
isEnabled: (args: unknown) =>
Boolean(this.createFeatures.session) && isCreateCloudCopyParams(args),
isVisible: (args: unknown) =>
Boolean(this.createFeatures.enabled) &&
Boolean(this.createFeatures.session) &&
this.connectionStatus.offlineStatus !== 'internet' &&
isCreateCloudCopyParams(args),
});
}
/**
* - creates new cloud sketch with the name of the params sketch,
* - pulls the cloud sketch,
* - copies files from params sketch to pulled cloud sketch in the cache folder,
* - pushes the cloud sketch, and
* - opens in new window.
*/
private async createCloudCopy(params: CreateCloudCopyParams): Promise<void> {
const sketch = await this.sketchesService.loadSketch(
params.node.fileStat.resource.toString()
);
const callback: CreateNewCloudSketchCallback = async (
newSketch: Create.Sketch,
newNode: CloudSketchbookTree.CloudSketchDirNode,
progress: Progress
) => {
const treeModel = await this.treeModel();
if (!treeModel) {
throw new Error('Could not retrieve the cloud sketchbook tree model.');
}
progress.report({
message: nls.localize(
'arduino/createCloudCopy/copyingSketchFilesMessage',
'Copying local sketch files...'
),
});
const localCacheFolderUri = newNode.uri.toString();
await this.sketchesService.copy(sketch, {
destinationUri: localCacheFolderUri,
onlySketchFiles: true,
});
await saveOntoCopiedSketch(
sketch,
localCacheFolderUri,
this.shell,
this.editorManager
);
progress.report({ message: pushingSketch(newSketch.name) });
await treeModel.sketchbookTree().push(newNode, true, true);
};
return this.commandService.executeCommand(
NewCloudSketch.Commands.NEW_CLOUD_SKETCH.id,
<NewCloudSketchParams>{
initialValue: params.node.fileStat.name,
callback,
skipShowErrorMessageOnOpen: false,
}
);
}
}
export namespace CreateCloudCopy {
export namespace Commands {
export const CREATE_CLOUD_COPY: Command = {
id: 'arduino-create-cloud-copy',
iconClass: 'fa fa-arduino-cloud-upload',
};
}
}

View File

@ -1,173 +1,101 @@
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 { Board, BoardsService, ExecutableService } from '../../common/protocol';
import { BoardsServiceProvider } from '../boards/boards-service-provider';
import { 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 '../../common/protocol/sketches-service-client-impl';
import { ArduinoMenus } from '../menu/arduino-menus';
import { MainMenuManager } from '../../common/main-menu-manager';
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; @inject(MainMenuManager)
private readonly mainMenuManager: MainMenuManager;
/** /**
* 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 +103,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,77 +126,84 @@ 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;
); }
return debugFqbn; 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;
try { const [sketch, executables] = await Promise.all([
const result = await this.debug(params); this.sketchServiceClient.currentSketch(),
return Boolean(result); this.executableService.list(),
} catch (err) { ]);
if (await this.isSketchNotVerifiedError(err, sketch)) { if (!CurrentSketch.isValid(sketch)) {
const yes = nls.localize('vscode/extensionsUtils/yes', 'Yes'); return;
const answer = await this.messageService.error(
sketchIsNotCompiled(sketch.name),
yes
);
if (answer === yes) {
this.commandService.executeCommand('arduino-verify-sketch');
}
} else {
this.messageService.error(
err instanceof Error ? err.message : String(err)
);
}
} }
return false; const ideTempFolderUri = await this.sketchService.getIdeTempFolderUri(
} sketch
private async debug(
params: StartDebugParams
): Promise<StartDebugResult | undefined> {
return this.commandService.executeCommand<StartDebugResult>(
'arduino.debug.start',
params
); );
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,
};
return this.commandService.executeCommand('arduino.debug.start', config);
} }
get compileForDebug(): boolean { get compileForDebug(): boolean {
@ -276,70 +211,11 @@ 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));
this.menuManager.update(); this.mainMenuManager.update();
}
private async isSketchNotVerifiedError(
err: unknown,
sketch: SketchRef
): Promise<boolean> {
if (err instanceof Error) {
try {
const buildPaths = await this.sketchesService.getBuildPath(sketch);
return buildPaths.some((tempBuildPath) =>
err.message.includes(tempBuildPath)
);
} catch {
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 {
@ -365,78 +241,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,131 +1,32 @@
import { Dialog } from '@theia/core/lib/browser/dialogs'; import { injectable } from '@theia/core/shared/inversify';
import { NavigatableWidget } from '@theia/core/lib/browser/navigatable-types';
import { ApplicationShell } from '@theia/core/lib/browser/shell/application-shell';
import { WindowService } from '@theia/core/lib/browser/window/window-service';
import { nls } from '@theia/core/lib/common/nls';
import type { MaybeArray } from '@theia/core/lib/common/types';
import URI from '@theia/core/lib/common/uri';
import type { Widget } from '@theia/core/shared/@phosphor/widgets';
import { inject, injectable } from '@theia/core/shared/inversify';
import { SketchesError } from '../../common/protocol'; import { SketchesError } from '../../common/protocol';
import { Sketch } from '../contributions/contribution'; import {
import { isNotFound } from '../create/typings'; Command,
import { Command, CommandRegistry } from './contribution'; CommandRegistry,
import { CloudSketchContribution } from './cloud-contribution'; SketchContribution,
import { AppService } from '../app-service'; Sketch,
} from './contribution';
export interface DeleteSketchParams {
/**
* Either the URI of the sketch folder or the sketch to delete.
*/
readonly toDelete: string | Sketch;
/**
* If `true`, the currently opened sketch is expected to be deleted.
* Hence, the editors must be closed, the sketch will be scheduled
* for deletion, and the browser window will close or navigate away.
* If `false`, the sketch will be scheduled for deletion,
* but the current window remains open. If `force`, the window will
* navigate away, but IDE2 won't open any confirmation dialogs.
*/
readonly willNavigateAway?: boolean | 'force';
}
@injectable() @injectable()
export class DeleteSketch extends CloudSketchContribution { export class DeleteSketch extends SketchContribution {
@inject(ApplicationShell)
private readonly shell: ApplicationShell;
@inject(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, {
execute: (params: DeleteSketchParams) => this.deleteSketch(params), execute: (uri: string) => this.deleteSketch(uri),
}); });
} }
private async deleteSketch(params: DeleteSketchParams): Promise<void> { private async deleteSketch(uri: string): Promise<void> {
const { toDelete, willNavigateAway } = params; const sketch = await this.loadSketch(uri);
let sketch: Sketch; if (!sketch) {
if (typeof toDelete === 'string') { console.info(`Sketch not found at ${uri}. Skipping deletion.`);
const resolvedSketch = await this.loadSketch(toDelete);
if (!resolvedSketch) {
console.info(
`Failed to load the sketch. It was not found at '${toDelete}'. Skipping deletion.`
);
return;
}
sketch = resolvedSketch;
} else {
sketch = toDelete;
}
if (!willNavigateAway) {
this.scheduleDeletion(sketch);
return; return;
} }
const cloudUri = this.createFeatures.cloudUri(sketch); return this.sketchService.deleteSketch(sketch);
if (willNavigateAway !== 'force') {
const { response } = await this.dialogService.showMessageBox({
title: nls.localizeByDefault('Delete'),
type: 'question',
buttons: [Dialog.CANCEL, Dialog.OK],
message: cloudUri
? nls.localize(
'theia/workspace/deleteCloudSketch',
"The cloud sketch '{0}' will be permanently deleted from the Arduino servers and the local caches. This action is irreversible. Do you want to delete the current sketch?",
sketch.name
)
: nls.localize(
'theia/workspace/deleteCurrentSketch',
"The sketch '{0}' will be permanently deleted. This action is irreversible. Do you want to delete the current sketch?",
sketch.name
),
});
// cancel
if (response === 0) {
return;
}
}
if (cloudUri) {
const posixPath = cloudUri.path.toString();
const cloudSketch = this.createApi.sketchCache.getSketch(posixPath);
if (!cloudSketch) {
throw new Error(
`Cloud sketch with path '${posixPath}' was not cached. Cache: ${this.createApi.sketchCache.toString()}`
);
}
try {
// IDE2 cannot use DELETE directory as the server responses with HTTP 500 if it's missing.
// https://github.com/arduino/arduino-ide/issues/1825#issuecomment-1406301406
await this.createApi.deleteSketch(cloudSketch.path);
} catch (err) {
if (!isNotFound(err)) {
throw err;
} else {
console.info(
`Could not delete the cloud sketch with path '${posixPath}'. It does not exist.`
);
}
}
}
await Promise.all([
...Sketch.uris(sketch).map((uri) =>
this.closeWithoutSaving(new URI(uri))
),
]);
this.windowService.setSafeToShutDown();
this.scheduleDeletion(sketch);
return window.close();
}
private scheduleDeletion(sketch: Sketch): void {
this.appService.scheduleDeletion(sketch);
} }
private async loadSketch(uri: string): Promise<Sketch | undefined> { private async loadSketch(uri: string): Promise<Sketch | undefined> {
try { try {
const sketch = await this.sketchesService.loadSketch(uri); const sketch = await this.sketchService.loadSketch(uri);
return sketch; return sketch;
} catch (err) { } catch (err) {
if (SketchesError.NotFound.is(err)) { if (SketchesError.NotFound.is(err)) {
@ -134,13 +35,6 @@ export class DeleteSketch extends CloudSketchContribution {
throw err; throw err;
} }
} }
// fix: https://github.com/eclipse-theia/theia/issues/12107
private async closeWithoutSaving(uri: URI): Promise<void> {
const affected = getAffected(this.shell.widgets, uri);
const toClose = [...affected].map(([, widget]) => widget);
await this.shell.closeMany(toClose, { save: false });
}
} }
export namespace DeleteSketch { export namespace DeleteSketch {
export namespace Commands { export namespace Commands {
@ -149,20 +43,3 @@ export namespace DeleteSketch {
}; };
} }
} }
function getAffected<T extends Widget>(
widgets: Iterable<T>,
context: MaybeArray<URI>
): [URI, T & NavigatableWidget][] {
const uris = Array.isArray(context) ? context : [context];
const result: [URI, T & NavigatableWidget][] = [];
for (const widget of widgets) {
if (NavigatableWidget.is(widget)) {
const resourceUri = widget.getResourceUri();
if (resourceUri && uris.some((uri) => uri.isEqualOrParent(resourceUri))) {
result.push([resourceUri, widget]);
}
}
}
return result;
}

View File

@ -1,11 +1,7 @@
import { nls } from '@theia/core/lib/common';
import { inject, injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import { CommonCommands } from '@theia/core/lib/browser/common-frontend-contribution'; import { CommonCommands } from '@theia/core/lib/browser/common-frontend-contribution';
import { ClipboardService } from '@theia/core/lib/browser/clipboard-service'; import { ClipboardService } from '@theia/core/lib/browser/clipboard-service';
import { StandaloneServices } from '@theia/monaco-editor-core/esm/vs/editor/standalone/browser/standaloneServices'; import { MonacoEditorService } from '@theia/monaco/lib/browser/monaco-editor-service';
import { ICodeEditorService } from '@theia/monaco-editor-core/esm/vs/editor/browser/services/codeEditorService';
import type { ICodeEditor } from '@theia/monaco-editor-core/esm/vs/editor/browser/editorBrowser';
import type { StandaloneCodeEditor } from '@theia/monaco-editor-core/esm/vs/editor/standalone/browser/standaloneCodeEditor';
import { import {
Contribution, Contribution,
Command, Command,
@ -14,11 +10,17 @@ 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';
import type { ICodeEditor } from '@theia/monaco-editor-core/esm/vs/editor/browser/editorBrowser';
import type { StandaloneCodeEditor } from '@theia/monaco-editor-core/esm/vs/editor/standalone/browser/standaloneCodeEditor';
// TODO: [macOS]: to remove `Start Dictation...` and `Emoji & Symbol` see this thread: https://github.com/electron/electron/issues/8283#issuecomment-269522072 // TODO: [macOS]: to remove `Start Dictation...` and `Emoji & Symbol` see this thread: https://github.com/electron/electron/issues/8283#issuecomment-269522072
// Depends on https://github.com/eclipse-theia/theia/pull/7964 // Depends on https://github.com/eclipse-theia/theia/pull/7964
@injectable() @injectable()
export class EditContributions extends Contribution { export class EditContributions extends Contribution {
@inject(MonacoEditorService)
private readonly codeEditorService: MonacoEditorService;
@inject(ClipboardService) @inject(ClipboardService)
private readonly clipboardService: ClipboardService; private readonly clipboardService: ClipboardService;
@ -55,11 +57,9 @@ export class EditContributions extends Contribution {
execute: async () => { execute: async () => {
const value = await this.currentValue(); const value = await this.currentValue();
if (value !== undefined) { if (value !== undefined) {
this.clipboardService.writeText(` this.clipboardService.writeText(`\`\`\`cpp
\`\`\`cpp
${value} ${value}
\`\`\` \`\`\``);
`);
} }
}, },
}); });
@ -206,10 +206,9 @@ ${value}
protected async current(): Promise< protected async current(): Promise<
ICodeEditor | StandaloneCodeEditor | undefined ICodeEditor | StandaloneCodeEditor | undefined
> { > {
const codeEditorService = StandaloneServices.get(ICodeEditorService);
return ( return (
codeEditorService.getFocusedCodeEditor() || this.codeEditorService.getFocusedCodeEditor() ||
codeEditorService.getActiveCodeEditor() || this.codeEditorService.getActiveCodeEditor() ||
undefined undefined
); );
} }

View File

@ -1,17 +1,18 @@
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 } 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,
} from '@theia/core/lib/common/disposable'; } from '@theia/core/lib/common/disposable';
import { OpenSketch } from './open-sketch'; import { OpenSketch } from './open-sketch';
import { import { ArduinoMenus, PlaceholderMenuNode } from '../menu/arduino-menus';
ArduinoMenus, import { MainMenuManager } from '../../common/main-menu-manager';
examplesLabel,
PlaceholderMenuNode,
} from '../menu/arduino-menus';
import { BoardsServiceProvider } from '../boards/boards-service-provider'; import { BoardsServiceProvider } from '../boards/boards-service-provider';
import { ExamplesService } from '../../common/protocol/examples-service'; import { ExamplesService } from '../../common/protocol/examples-service';
import { import {
@ -25,75 +26,10 @@ import {
SketchRef, SketchRef,
SketchContainer, SketchContainer,
SketchesError, SketchesError,
CoreService,
SketchesService,
Sketch, Sketch,
isBoardIdentifierChangeEvent, CoreService,
BoardIdentifier,
} from '../../common/protocol'; } from '../../common/protocol';
import { nls } from '@theia/core/lib/common/nls'; import { nls } from '@theia/core/lib/common';
import { unregisterSubmenu } from '../menu/arduino-menus';
import { MaybePromise } from '@theia/core/lib/common/types';
import { ApplicationError } from '@theia/core/lib/common/application-error';
/**
* Creates a cloned copy of the example sketch and opens it in a new window.
*/
export async function openClonedExample(
uri: string,
services: {
sketchesService: SketchesService;
commandService: CommandService;
},
onError: {
onDidFailClone?: (
err: ApplicationError<
number,
{
uri: string;
}
>,
uri: string
) => MaybePromise<unknown>;
onDidFailOpen?: (
err: ApplicationError<
number,
{
uri: string;
}
>,
sketch: Sketch
) => MaybePromise<unknown>;
} = {}
): Promise<void> {
const { sketchesService, commandService } = services;
const { onDidFailClone, onDidFailOpen } = onError;
try {
const sketch = await sketchesService.cloneExample(uri);
try {
await commandService.executeCommand(
OpenSketch.Commands.OPEN_SKETCH.id,
sketch
);
} catch (openError) {
if (SketchesError.NotFound.is(openError)) {
if (onDidFailOpen) {
await onDidFailOpen(openError, sketch);
return;
}
}
throw openError;
}
} catch (cloneError) {
if (SketchesError.NotFound.is(cloneError)) {
if (onDidFailClone) {
await onDidFailClone(cloneError, uri);
return;
}
}
throw cloneError;
}
}
@injectable() @injectable()
export abstract class Examples extends SketchContribution { export abstract class Examples extends SketchContribution {
@ -101,7 +37,10 @@ export abstract class Examples extends SketchContribution {
private readonly commandRegistry: CommandRegistry; private readonly commandRegistry: CommandRegistry;
@inject(MenuModelRegistry) @inject(MenuModelRegistry)
protected readonly menuRegistry: MenuModelRegistry; private readonly menuRegistry: MenuModelRegistry;
@inject(MainMenuManager)
protected readonly menuManager: MainMenuManager;
@inject(ExamplesService) @inject(ExamplesService)
protected readonly examplesService: ExamplesService; protected readonly examplesService: ExamplesService;
@ -110,25 +49,14 @@ 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)
protected readonly notificationCenter: NotificationCenter;
protected readonly toDispose = new DisposableCollection(); protected readonly toDispose = new DisposableCollection();
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.update({
board: this.boardsServiceProvider.boardsConfig.selectedBoard,
// No force refresh. The core client was already refreshed.
})
); );
} }
@ -138,16 +66,29 @@ 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(
ArduinoMenus.FILE__EXAMPLES_SUBMENU, ArduinoMenus.FILE__EXAMPLES_SUBMENU,
examplesLabel, nls.localize('arduino/examples/menu', 'Examples'),
{ {
order: '4', order: '4',
} }
@ -183,11 +124,6 @@ export abstract class Examples extends SketchContribution {
const { label } = sketchContainerOrPlaceholder; const { label } = sketchContainerOrPlaceholder;
submenuPath = [...menuPath, label]; submenuPath = [...menuPath, label];
this.menuRegistry.registerSubmenu(submenuPath, label, subMenuOptions); this.menuRegistry.registerSubmenu(submenuPath, label, subMenuOptions);
this.toDispose.push(
Disposable.create(() =>
unregisterSubmenu(submenuPath, this.menuRegistry)
)
);
sketches.push(...sketchContainerOrPlaceholder.sketches); sketches.push(...sketchContainerOrPlaceholder.sketches);
children.push(...sketchContainerOrPlaceholder.children); children.push(...sketchContainerOrPlaceholder.children);
} else { } else {
@ -227,33 +163,47 @@ export abstract class Examples extends SketchContribution {
} }
protected createHandler(uri: string): CommandHandler { protected createHandler(uri: string): CommandHandler {
const forceUpdate = () =>
this.update({
board: this.boardsServiceProvider.boardsConfig.selectedBoard,
forceRefresh: true,
});
return { return {
execute: async () => { execute: async () => {
await openClonedExample( const sketch = await this.clone(uri);
uri, if (sketch) {
{ try {
sketchesService: this.sketchesService, return this.commandService.executeCommand(
commandService: this.commandRegistry, OpenSketch.Commands.OPEN_SKETCH.id,
}, sketch
{ );
onDidFailClone: () => { } catch (err) {
if (SketchesError.NotFound.is(err)) {
// Do not toast the error message. It's handled by the `Open Sketch` command. // Do not toast the error message. It's handled by the `Open Sketch` command.
forceUpdate(); this.update({
}, board: this.boardsServiceClient.boardsConfig.selectedBoard,
onDidFailOpen: (err) => { forceRefresh: true,
this.messageService.error(err.message); });
forceUpdate(); } else {
}, throw err;
}
} }
); }
}, },
}; };
} }
private async clone(uri: string): Promise<Sketch | undefined> {
try {
const sketch = await this.sketchService.cloneExample(uri);
return sketch;
} catch (err) {
if (SketchesError.NotFound.is(err)) {
this.messageService.error(err.message);
this.update({
board: this.boardsServiceClient.boardsConfig.selectedBoard,
forceRefresh: true,
});
} else {
throw err;
}
}
}
} }
@injectable() @injectable()
@ -293,6 +243,9 @@ export class BuiltInExamples extends Examples {
@injectable() @injectable()
export class LibraryExamples extends Examples { export class LibraryExamples extends Examples {
@inject(NotificationCenter)
private readonly notificationCenter: NotificationCenter;
private readonly queue = new PQueue({ autoStart: true, concurrency: 1 }); private readonly queue = new PQueue({ autoStart: true, concurrency: 1 });
override onStart(): void { override onStart(): void {
@ -300,8 +253,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 +263,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,
@ -16,44 +17,46 @@ import { SketchContribution, Command, CommandRegistry } from './contribution';
import { NotificationCenter } from '../notification-center'; import { NotificationCenter } from '../notification-center';
import { nls } from '@theia/core/lib/common'; import { nls } from '@theia/core/lib/common';
import * as monaco from '@theia/monaco-editor-core'; import * as monaco from '@theia/monaco-editor-core';
import { CurrentSketch } from '../sketches-service-client-impl'; import { CurrentSketch } from '../../common/protocol/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());
this.notificationCenter.onLibraryDidUninstall(() => this.notificationCenter.onLibraryDidUninstall(() =>
this.updateMenuActions() 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 +92,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 +138,7 @@ export class IncludeLibrary extends SketchContribution {
}); });
} }
private registerLibrary( protected registerLibrary(
libraryOrPlaceholder: LibraryPackage | string, libraryOrPlaceholder: LibraryPackage | string,
menuPath: MenuPath menuPath: MenuPath
): Disposable { ): Disposable {
@ -168,7 +171,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,124 +1,39 @@
import {
Disposable,
DisposableCollection,
} from '@theia/core/lib/common/disposable';
import { inject, injectable } from '@theia/core/shared/inversify';
import { Mutex } from 'async-mutex'; import { Mutex } from 'async-mutex';
import { inject, injectable } from '@theia/core/shared/inversify';
import { import {
ArduinoDaemon, ArduinoDaemon,
BoardIdentifier,
BoardsService, BoardsService,
CompileSummary,
ExecutableService, ExecutableService,
isBoardIdentifierChangeEvent,
sanitizeFqbn,
} from '../../common/protocol'; } from '../../common/protocol';
import { import { HostedPluginEvents } from '../hosted-plugin-events';
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 { SketchContribution, URI } from './contribution'; import { SketchContribution, URI } from './contribution';
import { CompileSummaryProvider } from './verify-sketch'; import { CurrentSketch } from '../../common/protocol/sketches-service-client-impl';
import { BoardsConfig } from '../boards/boards-config';
interface DaemonAddress { import { BoardsServiceProvider } from '../boards/boards-service-provider';
/**
* 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)
private readonly notificationCenter: NotificationCenter;
@inject(BoardsDataStore)
private readonly boardDataStore: BoardsDataStore;
@inject(CompileSummaryProvider)
private readonly compileSummaryProvider: CompileSummaryProvider;
private readonly toDispose = new DisposableCollection();
private readonly languageServerStartMutex = new Mutex();
private languageServerFqbn?: string; private languageServerFqbn?: string;
private languageServerStartMutex = new Mutex();
override onReady(): void { override onReady(): void {
const start = ( const start = (
selectedBoard: BoardIdentifier | undefined, { selectedBoard }: BoardsConfig.Config,
forceStart = false forceStart = false
) => { ) => {
if (selectedBoard) { if (selectedBoard) {
@ -128,73 +43,25 @@ export class InoLanguage extends SketchContribution {
} }
} }
}; };
const forceRestart = () => { this.boardsServiceProvider.onBoardsConfigChanged(start);
start(this.boardsServiceProvider.boardsConfig.selectedBoard, true); this.hostedPluginEvents.onPluginsDidStart(() =>
}; start(this.boardsServiceProvider.boardsConfig)
this.toDispose.pushAll([ );
this.boardsServiceProvider.onBoardsConfigDidChange((event) => { this.hostedPluginEvents.onPluginsWillUnload(
if (isBoardIdentifierChangeEvent(event)) { () => (this.languageServerFqbn = undefined)
start(event.selectedBoard); );
} this.preferences.onPreferenceChanged(
}), ({ preferenceName, oldValue, newValue }) => {
this.hostedPluginEvents.onPluginsDidStart(() => if (oldValue !== newValue) {
start(this.boardsServiceProvider.boardsConfig.selectedBoard) switch (preferenceName) {
), case 'arduino.language.log':
this.hostedPluginEvents.onPluginsWillUnload( case 'arduino.language.realTimeDiagnostics':
() => (this.languageServerFqbn = undefined) start(this.boardsServiceProvider.boardsConfig, true);
),
this.preferences.onPreferenceChanged(
({ preferenceName, oldValue, newValue }) => {
if (oldValue !== newValue) {
switch (preferenceName) {
case 'arduino.language.log':
case 'arduino.language.realTimeDiagnostics':
case 'arduino.language.asyncWorkers':
forceRestart();
}
} }
} }
), }
this.notificationCenter.onLibraryDidInstall(() => forceRestart()), );
this.notificationCenter.onLibraryDidUninstall(() => forceRestart()), start(this.boardsServiceProvider.boardsConfig);
this.notificationCenter.onPlatformDidInstall(() => forceRestart()),
this.notificationCenter.onPlatformDidUninstall(() => forceRestart()),
this.notificationCenter.onDidReinitialize(() => forceRestart()),
this.boardDataStore.onDidChange((event) => {
if (this.languageServerFqbn) {
const sanitizedFQBN = sanitizeFqbn(this.languageServerFqbn);
// The incoming FQBNs might contain custom boards configs, sanitize them before the comparison.
// https://github.com/arduino/arduino-ide/pull/2113#pullrequestreview-1499998328
const matchingChange = event.changes.find(
(change) => sanitizedFQBN === sanitizeFqbn(change.fqbn)
);
const { boardsConfig } = this.boardsServiceProvider;
if (
matchingChange &&
boardsConfig.selectedBoard?.fqbn === matchingChange.fqbn
) {
start(boardsConfig.selectedBoard);
}
}
}),
this.compileSummaryProvider.onDidChangeCompileSummary(
(compileSummary) => {
if (compileSummary) {
this.fireBuildDidComplete(compileSummary);
}
}
),
]);
Promise.all([
this.boardsServiceProvider.ready,
this.preferences.ready,
]).then(() => {
start(this.boardsServiceProvider.boardsConfig.selectedBoard);
});
}
onStop(): void {
this.toDispose.dispose();
} }
private async startLanguageServer( private async startLanguageServer(
@ -203,11 +70,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 });
@ -235,26 +101,15 @@ export class InoLanguage extends SketchContribution {
} }
return; return;
} }
const fqbnWithConfig = await this.boardDataStore.appendConfigToFqbn(fqbn); if (!forceStart && fqbn === this.languageServerFqbn) {
if (!fqbnWithConfig) {
throw new Error(
`Failed to append boards config to the FQBN. Original FQBN was: ${fqbn}`
);
}
if (!forceStart && fqbnWithConfig === this.languageServerFqbn) {
// NOOP // NOOP
return; return;
} }
this.logger.info(`Starting language server: ${fqbn}`);
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();
@ -271,89 +126,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, {
daemonAddress: { lsPath,
hostname: 'localhost', cliDaemonAddr: `localhost:${port}`,
port, clangdPath,
instance: 1, // TODO: get it from the backend log: currentSketchPath ? currentSketchPath : log,
}, cliDaemonInstance: '1',
clangdPath, board: {
log: currentSketchPath ? currentSketchPath : log, fqbn,
board: { name: name ? `"${name}"` : undefined,
fqbn: fqbnWithConfig, },
name, realTimeDiagnostics,
}, silentOutput: true,
realTimeDiagnostics, }
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 for ${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
);
}
// Execute the a command contributed by the Arduino Tools VSIX to send the `ino/buildDidComplete` notification to the language server
private async fireBuildDidComplete(
compileSummary: CompileSummary
): Promise<void> {
const params = {
...compileSummary,
};
console.info(
`Executing 'arduino.languageserver.notifyBuildDidComplete' with ${JSON.stringify(
params.buildOutputUri
)}`
);
try {
await this.commandService.executeCommand(
'arduino.languageserver.notifyBuildDidComplete',
params
);
} catch (err) {
console.error(
`Unexpected error when firing event on build did complete. ${JSON.stringify(
params.buildOutputUri
)}`,
err
);
}
}
} }

View File

@ -1,17 +1,31 @@
import { injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import { import {
Contribution, Contribution,
Command, Command,
MenuModelRegistry, MenuModelRegistry,
KeybindingRegistry, KeybindingRegistry,
} from './contribution'; } from './contribution';
import { ArduinoMenus } from '../menu/arduino-menus'; import { ArduinoMenus, PlaceholderMenuNode } from '../menu/arduino-menus';
import { CommandRegistry, MaybePromise, nls } from '@theia/core/lib/common'; import {
CommandRegistry,
DisposableCollection,
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 { MainMenuManager } from '../../common/main-menu-manager';
import debounce = require('lodash.debounce');
@injectable() @injectable()
export class InterfaceScale extends Contribution { export class InterfaceScale extends Contribution {
@inject(MenuModelRegistry)
private readonly menuRegistry: MenuModelRegistry;
@inject(MainMenuManager)
private readonly mainMenuManager: MainMenuManager;
private readonly menuActionsDisposables = new DisposableCollection();
private fontScalingEnabled: InterfaceScale.FontScalingEnabled = { private fontScalingEnabled: InterfaceScale.FontScalingEnabled = {
increase: true, increase: true,
decrease: true, decrease: true,
@ -48,22 +62,63 @@ export class InterfaceScale extends Contribution {
} }
override registerMenus(registry: MenuModelRegistry): void { override registerMenus(registry: MenuModelRegistry): void {
registry.registerMenuAction(ArduinoMenus.EDIT__FONT_CONTROL_GROUP, { this.menuActionsDisposables.dispose();
const increaseFontSizeMenuAction = {
commandId: InterfaceScale.Commands.INCREASE_FONT_SIZE.id, commandId: InterfaceScale.Commands.INCREASE_FONT_SIZE.id,
label: nls.localize( label: nls.localize(
'arduino/editor/increaseFontSize', 'arduino/editor/increaseFontSize',
'Increase Font Size' 'Increase Font Size'
), ),
order: '0', order: '0',
}); };
registry.registerMenuAction(ArduinoMenus.EDIT__FONT_CONTROL_GROUP, { const decreaseFontSizeMenuAction = {
commandId: InterfaceScale.Commands.DECREASE_FONT_SIZE.id, commandId: InterfaceScale.Commands.DECREASE_FONT_SIZE.id,
label: nls.localize( label: nls.localize(
'arduino/editor/decreaseFontSize', 'arduino/editor/decreaseFontSize',
'Decrease Font Size' 'Decrease Font Size'
), ),
order: '1', order: '1',
}); };
if (this.fontScalingEnabled.increase) {
this.menuActionsDisposables.push(
registry.registerMenuAction(
ArduinoMenus.EDIT__FONT_CONTROL_GROUP,
increaseFontSizeMenuAction
)
);
} else {
this.menuActionsDisposables.push(
registry.registerMenuNode(
ArduinoMenus.EDIT__FONT_CONTROL_GROUP,
new PlaceholderMenuNode(
ArduinoMenus.EDIT__FONT_CONTROL_GROUP,
increaseFontSizeMenuAction.label,
{ order: increaseFontSizeMenuAction.order }
)
)
);
}
if (this.fontScalingEnabled.decrease) {
this.menuActionsDisposables.push(
this.menuRegistry.registerMenuAction(
ArduinoMenus.EDIT__FONT_CONTROL_GROUP,
decreaseFontSizeMenuAction
)
);
} else {
this.menuActionsDisposables.push(
this.menuRegistry.registerMenuNode(
ArduinoMenus.EDIT__FONT_CONTROL_GROUP,
new PlaceholderMenuNode(
ArduinoMenus.EDIT__FONT_CONTROL_GROUP,
decreaseFontSizeMenuAction.label,
{ order: decreaseFontSizeMenuAction.order }
)
)
);
}
this.mainMenuManager.update();
} }
private updateFontScalingEnabled(): void { private updateFontScalingEnabled(): void {
@ -98,7 +153,7 @@ export class InterfaceScale extends Contribution {
); );
if (isChanged) { if (isChanged) {
this.fontScalingEnabled = fontScalingEnabled; this.fontScalingEnabled = fontScalingEnabled;
this.menuManager.update(); this.registerMenus(this.menuRegistry);
} }
} }

View File

@ -1,62 +1,76 @@
import { DialogError } from '@theia/core/lib/browser/dialogs';
import { KeybindingRegistry } from '@theia/core/lib/browser/keybinding'; import { KeybindingRegistry } from '@theia/core/lib/browser/keybinding';
import { LabelProvider } from '@theia/core/lib/browser/label-provider';
import { CompositeTreeNode } from '@theia/core/lib/browser/tree'; import { CompositeTreeNode } from '@theia/core/lib/browser/tree';
import { DisposableCollection } from '@theia/core/lib/common/disposable'; import { Widget } from '@theia/core/lib/browser/widgets/widget';
import { MenuModelRegistry } from '@theia/core/lib/common/menu'; import { CancellationTokenSource } from '@theia/core/lib/common/cancellation';
import { Progress } from '@theia/core/lib/common/message-service-protocol';
import { nls } from '@theia/core/lib/common/nls';
import { injectable } from '@theia/core/shared/inversify';
import { CreateUri } from '../create/create-uri';
import { Create, isConflict } from '../create/typings';
import { ArduinoMenus } from '../menu/arduino-menus';
import { import {
TaskFactoryImpl, Disposable,
WorkspaceInputDialogWithProgress, DisposableCollection,
} from '../theia/workspace/workspace-input-dialog'; } from '@theia/core/lib/common/disposable';
import { MenuModelRegistry } from '@theia/core/lib/common/menu';
import {
Progress,
ProgressUpdate,
} from '@theia/core/lib/common/message-service-protocol';
import { nls } from '@theia/core/lib/common/nls';
import { inject, injectable } from '@theia/core/shared/inversify';
import { WorkspaceInputDialogProps } from '@theia/workspace/lib/browser/workspace-input-dialog';
import { v4 } from 'uuid';
import { MainMenuManager } from '../../common/main-menu-manager';
import type { AuthenticationSession } from '../../node/auth/types';
import { AuthenticationClientService } from '../auth/authentication-client-service';
import { CreateApi } from '../create/create-api';
import { CreateUri } from '../create/create-uri';
import { Create } from '../create/typings';
import { ArduinoMenus } from '../menu/arduino-menus';
import { WorkspaceInputDialog } from '../theia/workspace/workspace-input-dialog';
import { CloudSketchbookTree } from '../widgets/cloud-sketchbook/cloud-sketchbook-tree'; import { CloudSketchbookTree } from '../widgets/cloud-sketchbook/cloud-sketchbook-tree';
import { CloudSketchbookTreeModel } from '../widgets/cloud-sketchbook/cloud-sketchbook-tree-model'; import { CloudSketchbookTreeModel } from '../widgets/cloud-sketchbook/cloud-sketchbook-tree-model';
import { CloudSketchbookTreeWidget } from '../widgets/cloud-sketchbook/cloud-sketchbook-tree-widget';
import { SketchbookCommands } from '../widgets/sketchbook/sketchbook-commands'; import { SketchbookCommands } from '../widgets/sketchbook/sketchbook-commands';
import { import { SketchbookWidget } from '../widgets/sketchbook/sketchbook-widget';
CloudSketchContribution, import { SketchbookWidgetContribution } from '../widgets/sketchbook/sketchbook-widget-contribution';
pullingSketch, import { Command, CommandRegistry, Contribution, URI } from './contribution';
sketchAlreadyExists,
synchronizingSketchbook,
} from './cloud-contribution';
import { Command, CommandRegistry, Sketch } from './contribution';
export interface CreateNewCloudSketchCallback {
(
newSketch: Create.Sketch,
newNode: CloudSketchbookTree.CloudSketchDirNode,
progress: Progress
): Promise<void>;
}
export interface NewCloudSketchParams {
/**
* Value to populate the dialog `<input>` when it opens.
*/
readonly initialValue?: string | undefined;
/**
* Additional callback to call when the new cloud sketch has been created.
*/
readonly callback?: CreateNewCloudSketchCallback;
/**
* If `true`, the validation error message will not be visible in the input dialog, but the `OK` button will be disabled. Defaults to `true`.
*/
readonly skipShowErrorMessageOnOpen?: boolean;
}
@injectable() @injectable()
export class NewCloudSketch extends CloudSketchContribution { export class NewCloudSketch extends Contribution {
@inject(CreateApi)
private readonly createApi: CreateApi;
@inject(SketchbookWidgetContribution)
private readonly widgetContribution: SketchbookWidgetContribution;
@inject(AuthenticationClientService)
private readonly authenticationService: AuthenticationClientService;
@inject(MainMenuManager)
private readonly mainMenuManager: MainMenuManager;
private readonly toDispose = new DisposableCollection(); private readonly toDispose = new DisposableCollection();
private _session: AuthenticationSession | undefined;
private _enabled: boolean;
override onReady(): void { override onReady(): void {
this.toDispose.pushAll([ this.toDispose.pushAll([
this.createFeatures.onDidChangeEnabled(() => this.menuManager.update()), this.authenticationService.onSessionDidChange((session) => {
this.createFeatures.onDidChangeSession(() => this.menuManager.update()), const oldSession = this._session;
this._session = session;
if (!!oldSession !== !!this._session) {
this.mainMenuManager.update();
}
}),
this.preferences.onPreferenceChanged(({ preferenceName, newValue }) => {
if (preferenceName === 'arduino.cloud.enabled') {
const oldEnabled = this._enabled;
this._enabled = Boolean(newValue);
if (this._enabled !== oldEnabled) {
this.mainMenuManager.update();
}
}
}),
]); ]);
if (this.createFeatures.session) { this._enabled = this.preferences['arduino.cloud.enabled'];
this.menuManager.update(); this._session = this.authenticationService.session;
if (this._session) {
this.mainMenuManager.update();
} }
} }
@ -66,21 +80,16 @@ export class NewCloudSketch extends CloudSketchContribution {
override registerCommands(registry: CommandRegistry): void { override registerCommands(registry: CommandRegistry): void {
registry.registerCommand(NewCloudSketch.Commands.NEW_CLOUD_SKETCH, { registry.registerCommand(NewCloudSketch.Commands.NEW_CLOUD_SKETCH, {
execute: (params: NewCloudSketchParams) => execute: () => this.createNewSketch(),
this.createNewSketch( isEnabled: () => !!this._session,
params?.skipShowErrorMessageOnOpen === false ? false : true, isVisible: () => this._enabled,
params?.initialValue,
params?.callback
),
isEnabled: () => Boolean(this.createFeatures.session),
isVisible: () => this.createFeatures.enabled,
}); });
} }
override registerMenus(registry: MenuModelRegistry): void { override registerMenus(registry: MenuModelRegistry): void {
registry.registerMenuAction(ArduinoMenus.FILE__SKETCH_GROUP, { registry.registerMenuAction(ArduinoMenus.FILE__SKETCH_GROUP, {
commandId: NewCloudSketch.Commands.NEW_CLOUD_SKETCH.id, commandId: NewCloudSketch.Commands.NEW_CLOUD_SKETCH.id,
label: nls.localize('arduino/cloudSketch/new', 'New Cloud Sketch'), label: nls.localize('arduino/cloudSketch/new', 'New Remote Sketch'),
order: '1', order: '1',
}); });
} }
@ -93,106 +102,154 @@ export class NewCloudSketch extends CloudSketchContribution {
} }
private async createNewSketch( private async createNewSketch(
skipShowErrorMessageOnOpen: boolean, initialValue?: string | undefined
initialValue?: string | undefined, ): Promise<unknown> {
callback?: CreateNewCloudSketchCallback const widget = await this.widgetContribution.widget;
): Promise<void> { const treeModel = this.treeModelFrom(widget);
const treeModel = await this.treeModel(); if (!treeModel) {
if (treeModel) { return undefined;
const rootNode = treeModel.root; }
return this.openWizard( const rootNode = CompositeTreeNode.is(treeModel.root)
rootNode, ? treeModel.root
treeModel, : undefined;
skipShowErrorMessageOnOpen, if (!rootNode) {
initialValue, return undefined;
callback }
return this.openWizard(rootNode, treeModel, initialValue);
}
private withProgress(
value: string,
treeModel: CloudSketchbookTreeModel
): (progress: Progress) => Promise<unknown> {
return async (progress: Progress) => {
let result: Create.Sketch | undefined | 'conflict';
try {
progress.report({
message: nls.localize(
'arduino/cloudSketch/creating',
"Creating remote sketch '{0}'...",
value
),
});
result = await this.createApi.createSketch(value);
} catch (err) {
if (isConflict(err)) {
result = 'conflict';
} else {
throw err;
}
} finally {
if (result) {
progress.report({
message: nls.localize(
'arduino/cloudSketch/synchronizing',
"Synchronizing sketchbook, pulling '{0}'...",
value
),
});
await treeModel.refresh();
}
}
if (result === 'conflict') {
return this.createNewSketch(value);
}
if (result) {
return this.open(treeModel, result);
}
return undefined;
};
}
private async open(
treeModel: CloudSketchbookTreeModel,
newSketch: Create.Sketch
): Promise<URI | undefined> {
const id = CreateUri.toUri(newSketch).path.toString();
const node = treeModel.getNode(id);
if (!node) {
throw new Error(
`Could not find remote sketchbook tree node with Tree node ID: ${id}.`
); );
} }
if (!CloudSketchbookTree.CloudSketchDirNode.is(node)) {
throw new Error(
`Remote sketchbook tree node expected to represent a directory but it did not. Tree node ID: ${id}.`
);
}
try {
await treeModel.sketchbookTree().pull({ node });
} catch (err) {
if (isNotFound(err)) {
await treeModel.refresh();
this.messageService.error(
nls.localize(
'arduino/newCloudSketch/notFound',
"Could not pull the remote sketch '{0}'. It does not exist.",
newSketch.name
)
);
return undefined;
}
throw err;
}
return this.commandService.executeCommand(
SketchbookCommands.OPEN_NEW_WINDOW.id,
{ node }
);
}
private treeModelFrom(
widget: SketchbookWidget
): CloudSketchbookTreeModel | undefined {
for (const treeWidget of widget.getTreeWidgets()) {
if (treeWidget instanceof CloudSketchbookTreeWidget) {
const model = treeWidget.model;
if (model instanceof CloudSketchbookTreeModel) {
return model;
}
}
}
return undefined;
} }
private async openWizard( private async openWizard(
rootNode: CompositeTreeNode, rootNode: CompositeTreeNode,
treeModel: CloudSketchbookTreeModel, treeModel: CloudSketchbookTreeModel,
skipShowErrorMessageOnOpen: boolean, initialValue?: string | undefined
initialValue?: string | undefined, ): Promise<unknown> {
callback?: CreateNewCloudSketchCallback
): Promise<void> {
const existingNames = rootNode.children const existingNames = rootNode.children
.filter(CloudSketchbookTree.CloudSketchDirNode.is) .filter(CloudSketchbookTree.CloudSketchDirNode.is)
.map(({ fileStat }) => fileStat.name); .map(({ fileStat }) => fileStat.name);
const taskFactory = new TaskFactoryImpl((value) => return new NewCloudSketchDialog(
this.createNewSketchWithProgress(treeModel, value, callback) {
); title: nls.localize(
try { 'arduino/newCloudSketch/newSketchTitle',
const dialog = new WorkspaceInputDialogWithProgress( 'Name of a new Remote Sketch'
{
title: nls.localize(
'arduino/newCloudSketch/newSketchTitle',
'Name of the new Cloud Sketch'
),
parentUri: CreateUri.root,
initialValue,
validate: (input) => {
if (existingNames.includes(input)) {
return sketchAlreadyExists(input);
}
return Sketch.validateCloudSketchFolderName(input) ?? '';
},
},
this.labelProvider,
taskFactory
);
await dialog.open(skipShowErrorMessageOnOpen);
if (dialog.taskResult) {
this.openInNewWindow(dialog.taskResult);
}
} catch (err) {
if (isConflict(err)) {
await treeModel.refresh();
return this.createNewSketch(
false,
taskFactory.value ?? initialValue,
callback
);
}
throw err;
}
}
private createNewSketchWithProgress(
treeModel: CloudSketchbookTreeModel,
value: string,
callback?: CreateNewCloudSketchCallback
): (
progress: Progress
) => Promise<CloudSketchbookTree.CloudSketchDirNode | undefined> {
return async (progress: Progress) => {
progress.report({
message: nls.localize(
'arduino/cloudSketch/creating',
"Creating cloud sketch '{0}'...",
value
), ),
}); parentUri: CreateUri.root,
const sketch = await this.createApi.createSketch(value); initialValue,
progress.report({ message: synchronizingSketchbook }); validate: (input) => {
await treeModel.refresh(); if (existingNames.includes(input)) {
progress.report({ message: pullingSketch(sketch.name) }); return nls.localize(
const node = await this.pull(sketch); 'arduino/newCloudSketch/sketchAlreadyExists',
if (callback && node) { "Remote sketch '{0}' already exists.",
await callback(sketch, node, progress); input
} );
return node; }
}; // This is how https://create.arduino.cc/editor/ works when renaming a sketch.
} if (/^[0-9a-zA-Z_]{1,36}$/.test(input)) {
return '';
private openInNewWindow( }
node: CloudSketchbookTree.CloudSketchDirNode return nls.localize(
): Promise<void> { 'arduino/newCloudSketch/invalidSketchName',
return this.commandService.executeCommand( 'The name must consist of basic letters, numbers, or underscores. The maximum length is 36 characters.'
SketchbookCommands.OPEN_NEW_WINDOW.id, );
{ node, treeWidgetId: 'cloud-sketchbook-composite-widget' } },
); },
this.labelProvider,
(value) => this.withProgress(value, treeModel)
).open();
} }
} }
export namespace NewCloudSketch { export namespace NewCloudSketch {
@ -202,3 +259,115 @@ export namespace NewCloudSketch {
}; };
} }
} }
function isConflict(err: unknown): boolean {
return isErrorWithStatusOf(err, 409);
}
function isNotFound(err: unknown): boolean {
return isErrorWithStatusOf(err, 404);
}
function isErrorWithStatusOf(
err: unknown,
status: number
): err is Error & { status: number } {
if (err instanceof Error) {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const object = err as any;
return 'status' in object && object.status === status;
}
return false;
}
@injectable()
class NewCloudSketchDialog extends WorkspaceInputDialog {
constructor(
@inject(WorkspaceInputDialogProps)
protected override readonly props: WorkspaceInputDialogProps,
@inject(LabelProvider)
protected override readonly labelProvider: LabelProvider,
private readonly withProgress: (
value: string
) => (progress: Progress) => Promise<unknown>
) {
super(props, labelProvider);
}
protected override async accept(): Promise<void> {
if (!this.resolve) {
return;
}
this.acceptCancellationSource.cancel();
this.acceptCancellationSource = new CancellationTokenSource();
const token = this.acceptCancellationSource.token;
const value = this.value;
const error = await this.isValid(value, 'open');
if (token.isCancellationRequested) {
return;
}
if (!DialogError.getResult(error)) {
this.setErrorMessage(error);
} else {
const spinner = document.createElement('div');
spinner.classList.add('spinner');
const disposables = new DisposableCollection();
try {
this.toggleButtons(true);
disposables.push(Disposable.create(() => this.toggleButtons(false)));
const closeParent = this.closeCrossNode.parentNode;
closeParent?.removeChild(this.closeCrossNode);
disposables.push(
Disposable.create(() => {
closeParent?.appendChild(this.closeCrossNode);
})
);
this.errorMessageNode.classList.add('progress');
disposables.push(
Disposable.create(() =>
this.errorMessageNode.classList.remove('progress')
)
);
const errorParent = this.errorMessageNode.parentNode;
errorParent?.insertBefore(spinner, this.errorMessageNode);
disposables.push(
Disposable.create(() => errorParent?.removeChild(spinner))
);
const cancellationSource = new CancellationTokenSource();
const progress: Progress = {
id: v4(),
cancel: () => cancellationSource.cancel(),
report: (update: ProgressUpdate) => {
this.setProgressMessage(update);
},
result: Promise.resolve(value),
};
await this.withProgress(value)(progress);
} finally {
disposables.dispose();
}
this.resolve(value);
Widget.detach(this);
}
}
private toggleButtons(disabled: boolean): void {
if (this.acceptButton) {
this.acceptButton.disabled = disabled;
}
if (this.closeButton) {
this.closeButton.disabled = disabled;
}
}
private setProgressMessage(update: ProgressUpdate): void {
if (update.work && update.work.done === update.work.total) {
this.errorMessageNode.innerText = '';
} else {
if (update.message) {
this.errorMessageNode.innerText = update.message;
}
}
}
}

View File

@ -35,7 +35,7 @@ export class NewSketch extends SketchContribution {
async newSketch(): Promise<void> { async newSketch(): Promise<void> {
try { try {
const sketch = await this.sketchesService.createNewSketch(); const sketch = await this.sketchService.createNewSketch();
this.workspaceService.open(new URI(sketch.uri)); this.workspaceService.open(new URI(sketch.uri));
} catch (e) { } catch (e) {
await this.messageService.error(e.toString()); await this.messageService.error(e.toString());

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(true, params), const boardsConfig = await this.boardsConfigDialog.open(query);
if (boardsConfig) {
return (this.boardsServiceProvider.boardsConfig = boardsConfig);
}
},
}); });
} }
} }

View File

@ -47,7 +47,7 @@ export class OpenRecentSketch extends SketchContribution {
} }
private update(forceUpdate?: boolean): void { private update(forceUpdate?: boolean): void {
this.sketchesService this.sketchService
.recentlyOpenedSketches(forceUpdate) .recentlyOpenedSketches(forceUpdate)
.then((sketches) => this.refreshMenu(sketches)); .then((sketches) => this.refreshMenu(sketches));
} }

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

@ -39,17 +39,13 @@ export class OpenSketchFiles extends SketchContribution {
focusMainSketchFile = false focusMainSketchFile = false
): Promise<void> { ): Promise<void> {
try { try {
const sketch = await this.sketchesService.loadSketch(uri.toString()); const sketch = await this.sketchService.loadSketch(uri.toString());
const { mainFileUri, rootFolderFileUris } = sketch; const { mainFileUri, rootFolderFileUris } = sketch;
for (const uri of [mainFileUri, ...rootFolderFileUris]) { for (const uri of [mainFileUri, ...rootFolderFileUris]) {
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(
@ -116,9 +112,8 @@ export class OpenSketchFiles extends SketchContribution {
await wait(250); // let IDE2 open the editor and toast the error message, then open the modal dialog await wait(250); // let IDE2 open the editor and toast the error message, then open the modal dialog
const movedSketch = await promptMoveSketch(invalidMainSketchUri, { const movedSketch = await promptMoveSketch(invalidMainSketchUri, {
fileService: this.fileService, fileService: this.fileService,
sketchesService: this.sketchesService, sketchService: this.sketchService,
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), {
@ -130,7 +125,7 @@ export class OpenSketchFiles extends SketchContribution {
} }
private async openFallbackSketch(): Promise<void> { private async openFallbackSketch(): Promise<void> {
const sketch = await this.sketchesService.createNewSketch(); const sketch = await this.sketchService.createNewSketch();
this.workspaceService.open(new URI(sketch.uri), { preserveWindow: true }); this.workspaceService.open(new URI(sketch.uri), { preserveWindow: true });
} }

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 {
@ -71,7 +71,7 @@ export class OpenSketch extends SketchContribution {
} }
const uri = SketchLocation.toUri(toOpen); const uri = SketchLocation.toUri(toOpen);
try { try {
await this.sketchesService.loadSketch(uri.toString()); await this.sketchService.loadSketch(uri.toString());
} catch (err) { } catch (err) {
if (SketchesError.NotFound.is(err)) { if (SketchesError.NotFound.is(err)) {
this.messageService.error(err.message); this.messageService.error(err.message);
@ -82,17 +82,23 @@ export class OpenSketch extends SketchContribution {
} }
private async selectSketch(): Promise<Sketch | undefined> { private async selectSketch(): Promise<Sketch | undefined> {
const defaultPath = await this.defaultPath(); const config = await this.configService.getConfiguration();
const { filePaths } = await this.dialogService.showOpenDialog({ const defaultPath = await this.fileService.fsPath(
defaultPath, new URI(config.sketchDirUri)
properties: ['createDirectory', 'openFile'], );
filters: [ const { filePaths } = await remote.dialog.showOpenDialog(
{ remote.getCurrentWindow(),
name: nls.localize('arduino/sketch/sketch', 'Sketch'), {
extensions: ['ino', 'pde'], defaultPath,
}, properties: ['createDirectory', 'openFile'],
], filters: [
}); {
name: nls.localize('arduino/sketch/sketch', 'Sketch'),
extensions: ['ino', 'pde'],
},
],
}
);
if (!filePaths.length) { if (!filePaths.length) {
return undefined; return undefined;
} }
@ -103,16 +109,15 @@ export class OpenSketch extends SketchContribution {
} }
const sketchFilePath = filePaths[0]; const sketchFilePath = filePaths[0];
const sketchFileUri = await this.fileSystemExt.getUri(sketchFilePath); const sketchFileUri = await this.fileSystemExt.getUri(sketchFilePath);
const sketch = await this.sketchesService.getSketchFolder(sketchFileUri); const sketch = await this.sketchService.getSketchFolder(sketchFileUri);
if (sketch) { if (sketch) {
return sketch; return sketch;
} }
if (Sketch.isSketchFile(sketchFileUri)) { if (Sketch.isSketchFile(sketchFileUri)) {
return promptMoveSketch(sketchFileUri, { return promptMoveSketch(sketchFileUri, {
fileService: this.fileService, fileService: this.fileService,
sketchesService: this.sketchesService, sketchService: this.sketchService,
labelProvider: this.labelProvider, labelProvider: this.labelProvider,
dialogService: this.dialogService,
}); });
} }
} }
@ -130,18 +135,16 @@ export async function promptMoveSketch(
sketchFileUri: string | URI, sketchFileUri: string | URI,
options: { options: {
fileService: FileService; fileService: FileService;
sketchesService: SketchesService; sketchService: SketchesService;
labelProvider: LabelProvider; labelProvider: LabelProvider;
dialogService: DialogService;
} }
): Promise<Sketch | undefined> { ): Promise<Sketch | undefined> {
const { fileService, sketchesService, labelProvider, dialogService } = const { fileService, sketchService, 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 +163,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(
@ -176,6 +179,6 @@ export async function promptMoveSketch(
uri, uri,
new URI(newSketchUri.resolve(nameWithExt).toString()) new URI(newSketchUri.resolve(nameWithExt).toString())
); );
return sketchesService.getSketchFolder(newSketchUri.toString()); return sketchService.getSketchFolder(newSketchUri.toString());
} }
} }

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,166 +0,0 @@
import { CompositeTreeNode } from '@theia/core/lib/browser/tree';
import { Progress } from '@theia/core/lib/common/message-service-protocol';
import { nls } from '@theia/core/lib/common/nls';
import { injectable } from '@theia/core/shared/inversify';
import { CreateUri } from '../create/create-uri';
import { isConflict } from '../create/typings';
import {
TaskFactoryImpl,
WorkspaceInputDialogWithProgress,
} from '../theia/workspace/workspace-input-dialog';
import { CloudSketchbookTree } from '../widgets/cloud-sketchbook/cloud-sketchbook-tree';
import { CloudSketchbookTreeModel } from '../widgets/cloud-sketchbook/cloud-sketchbook-tree-model';
import {
CloudSketchContribution,
pullingSketch,
pushingSketch,
sketchAlreadyExists,
synchronizingSketchbook,
} from './cloud-contribution';
import { Command, CommandRegistry, Sketch, URI } from './contribution';
export interface RenameCloudSketchParams {
readonly cloudUri: URI;
readonly sketch: Sketch;
}
@injectable()
export class RenameCloudSketch extends CloudSketchContribution {
override registerCommands(registry: CommandRegistry): void {
registry.registerCommand(RenameCloudSketch.Commands.RENAME_CLOUD_SKETCH, {
execute: (params: RenameCloudSketchParams) =>
this.renameSketch(params, true),
});
}
private async renameSketch(
params: RenameCloudSketchParams,
skipShowErrorMessageOnOpen: boolean,
initValue: string = params.sketch.name
): Promise<string | undefined> {
const treeModel = await this.treeModel();
if (treeModel) {
const posixPath = params.cloudUri.path.toString();
const node = treeModel.getNode(posixPath);
const parentNode = node?.parent;
if (
CloudSketchbookTree.CloudSketchDirNode.is(node) &&
CompositeTreeNode.is(parentNode)
) {
return this.openWizard(
params,
node,
parentNode,
treeModel,
skipShowErrorMessageOnOpen,
initValue
);
}
}
return undefined;
}
private async openWizard(
params: RenameCloudSketchParams,
node: CloudSketchbookTree.CloudSketchDirNode,
parentNode: CompositeTreeNode,
treeModel: CloudSketchbookTreeModel,
skipShowErrorMessageOnOpen: boolean,
initialValue?: string | undefined
): Promise<string | undefined> {
const parentUri = CloudSketchbookTree.CloudSketchDirNode.is(parentNode)
? parentNode.uri
: CreateUri.root;
const existingNames = parentNode.children
.filter(CloudSketchbookTree.CloudSketchDirNode.is)
.map(({ fileStat }) => fileStat.name);
const taskFactory = new TaskFactoryImpl((value) =>
this.renameSketchWithProgress(params, node, treeModel, value)
);
try {
const dialog = new WorkspaceInputDialogWithProgress(
{
title: nls.localize(
'arduino/renameCloudSketch/renameSketchTitle',
'New name of the Cloud Sketch'
),
parentUri,
initialValue,
validate: (input) => {
if (existingNames.includes(input)) {
return sketchAlreadyExists(input);
}
return Sketch.validateCloudSketchFolderName(input) ?? '';
},
},
this.labelProvider,
taskFactory
);
await dialog.open(skipShowErrorMessageOnOpen);
return dialog.taskResult;
} catch (err) {
if (isConflict(err)) {
await treeModel.refresh();
return this.renameSketch(
params,
false,
taskFactory.value ?? initialValue
);
}
throw err;
}
}
private renameSketchWithProgress(
params: RenameCloudSketchParams,
node: CloudSketchbookTree.CloudSketchDirNode,
treeModel: CloudSketchbookTreeModel,
value: string
): (progress: Progress) => Promise<string | undefined> {
return async (progress: Progress) => {
const fromName = params.cloudUri.path.name;
const fromPosixPath = params.cloudUri.path.toString();
const toPosixPath = params.cloudUri.parent.resolve(value).path.toString();
// push
progress.report({ message: pushingSketch(params.sketch.name) });
await treeModel.sketchbookTree().push(node, true);
// rename
progress.report({
message: nls.localize(
'arduino/cloudSketch/renaming',
"Renaming cloud sketch from '{0}' to '{1}'...",
fromName,
value
),
});
await this.createApi.rename(fromPosixPath, toPosixPath);
// sync
progress.report({
message: synchronizingSketchbook,
});
this.createApi.sketchCache.init(); // invalidate the cache
await this.createApi.sketches(); // IDE2 must pull all sketches to find the new one
const sketch = this.createApi.sketchCache.getSketch(toPosixPath);
if (!sketch) {
return undefined;
}
await treeModel.refresh();
// pull
progress.report({ message: pullingSketch(sketch.name) });
const pulledNode = await this.pull(sketch);
return pulledNode
? node.uri.parent.resolve(sketch.name).toString()
: undefined;
};
}
}
export namespace RenameCloudSketch {
export namespace Commands {
export const RENAME_CLOUD_SKETCH: Command = {
id: 'arduino-rename-cloud-sketch',
};
}
}

View File

@ -1,72 +1,41 @@
import { Dialog } from '@theia/core/lib/browser/dialogs';
import { NavigatableWidget } from '@theia/core/lib/browser/navigatable';
import { Saveable } from '@theia/core/lib/browser/saveable';
import { ApplicationShell } from '@theia/core/lib/browser/shell/application-shell';
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 { 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 * as remote from '@theia/core/electron-shared/@electron/remote';
import { WorkspaceInput } from '@theia/workspace/lib/browser/workspace-service'; import * as dateFormat from 'dateformat';
import { SketchesError } from '../../common/protocol';
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 { CloudSketchContribution } from './cloud-contribution';
import { import {
SketchContribution,
URI,
Command, Command,
CommandRegistry, CommandRegistry,
KeybindingRegistry,
MenuModelRegistry, MenuModelRegistry,
Sketch, KeybindingRegistry,
URI,
} from './contribution'; } from './contribution';
import { nls } from '@theia/core/lib/common';
import { ApplicationShell, NavigatableWidget, Saveable } from '@theia/core/lib/browser';
import { WindowService } from '@theia/core/lib/browser/window/window-service';
import { CurrentSketch } from '../../common/protocol/sketches-service-client-impl';
import { WorkspaceInput } from '@theia/workspace/lib/browser';
import { StartupTask } from '../../electron-common/startup-task';
import { DeleteSketch } from './delete-sketch'; import { DeleteSketch } from './delete-sketch';
import {
RenameCloudSketch,
RenameCloudSketchParams,
} from './rename-cloud-sketch';
import { assertConnectedToBackend } from './save-sketch';
@injectable() @injectable()
export class SaveAsSketch extends CloudSketchContribution { export class SaveAsSketch extends SketchContribution {
@inject(ApplicationShell) @inject(ApplicationShell)
private readonly shell: ApplicationShell; private readonly applicationShell: ApplicationShell;
@inject(WindowService) @inject(WindowService)
private readonly windowService: WindowService; private readonly windowService: WindowService;
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);
}
},
}); });
} }
override registerMenus(registry: MenuModelRegistry): void { override registerMenus(registry: MenuModelRegistry): void {
registry.registerMenuAction(ArduinoMenus.FILE__SKETCH_GROUP, { registry.registerMenuAction(ArduinoMenus.FILE__SKETCH_GROUP, {
commandId: SaveAsSketch.Commands.SAVE_AS_SKETCH.id, commandId: SaveAsSketch.Commands.SAVE_AS_SKETCH.id,
label: nls.localizeByDefault('Save As...'), label: nls.localize('vscode/fileCommands/saveAs', 'Save As...'),
order: '7', order: '7',
}); });
} }
@ -82,85 +51,28 @@ 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, const [sketch, configuration] = await Promise.all([
messageService: this.messageService, this.sketchServiceClient.currentSketch(),
}); this.configService.getConfiguration(),
const sketch = await this.sketchServiceClient.currentSketch(); ]);
if (!CurrentSketch.isValid(sketch)) { if (!CurrentSketch.isValid(sketch)) {
return false; return false;
} }
let destinationUri: string | undefined; const isTemp = await this.sketchService.isTemp(sketch);
const cloudUri = this.createFeatures.cloudUri(sketch); if (!isTemp && !!execOnlyIfTemp) {
if (cloudUri) {
destinationUri = await this.createCloudCopy({ cloudUri, sketch });
} else {
destinationUri = await this.createLocalCopy(sketch, execOnlyIfTemp);
}
if (!destinationUri) {
return false; return false;
} }
const copiedSketch = await this.sketchesService.copy(sketch, {
destinationUri,
});
const newWorkspaceUri = copiedSketch.uri;
await saveOntoCopiedSketch(
sketch,
newWorkspaceUri,
this.shell,
this.editorManager
);
if (markAsRecentlyOpened) {
this.sketchesService.markAsRecentlyOpened(newWorkspaceUri);
}
const options: WorkspaceInput & StartupTasks = {
preserveWindow: true,
tasks: [],
};
if (openAfterMove) {
this.windowService.setSafeToShutDown();
if (wipeOriginal || (openAfterMove && execOnlyIfTemp)) {
options.tasks.push({
command: DeleteSketch.Commands.DELETE_SKETCH.id,
args: [{ toDelete: sketch.uri }],
});
}
this.workspaceService.open(new URI(newWorkspaceUri), options);
}
return !!newWorkspaceUri;
}
private async createCloudCopy(
params: RenameCloudSketchParams
): Promise<string | undefined> {
return this.commandService.executeCommand<string>(
RenameCloudSketch.Commands.RENAME_CLOUD_SKETCH.id,
params
);
}
private async createLocalCopy(
sketch: Sketch,
execOnlyIfTemp?: boolean
): Promise<string | undefined> {
const isTemp = await this.sketchesService.isTemp(sketch);
if (!isTemp && !!execOnlyIfTemp) {
return undefined;
}
const sketchUri = new URI(sketch.uri); const sketchUri = new URI(sketch.uri);
const sketchbookDirUri = await this.defaultUri(); const sketchbookDirUri = new URI(configuration.sketchDirUri);
// If the sketch is temp, IDE2 proposes the default sketchbook folder URI. // If the sketch is temp, IDE2 proposes the default sketchbook folder URI.
// If the sketch is not temp, but not contained in the default sketchbook folder, IDE2 proposes the default location. // If the sketch is not temp, but not contained in the default sketchbook folder, IDE2 proposes the default location.
// Otherwise, it proposes the parent folder of the current sketch. // Otherwise, it proposes the parent folder of the current sketch.
@ -175,102 +87,89 @@ export class SaveAsSketch extends CloudSketchContribution {
// If target does not exist, propose a `directories.user`/${sketch.name} path // If target does not exist, propose a `directories.user`/${sketch.name} path
// If target exists, propose `directories.user`/${sketch.name}_copy_${yyyymmddHHMMss} // If target exists, propose `directories.user`/${sketch.name}_copy_${yyyymmddHHMMss}
// IDE2 must never prompt an invalid sketch folder name (https://github.com/arduino/arduino-ide/pull/1833#issuecomment-1412569252)
const defaultUri = containerDirUri.resolve( const defaultUri = containerDirUri.resolve(
Sketch.toValidSketchFolderName(sketch.name, exists) exists
? `${sketch.name}_copy_${dateFormat(new Date(), 'yyyymmddHHMMss')}`
: sketch.name
); );
const defaultPath = await this.fileService.fsPath(defaultUri); const defaultPath = await this.fileService.fsPath(defaultUri);
return await this.promptLocalSketchFolderDestination(sketch, defaultPath); const { filePath, canceled } = await remote.dialog.showSaveDialog(
} remote.getCurrentWindow(),
{
/**
* Prompts for the new sketch folder name until a valid one is give,
* then resolves with the destination sketch folder URI string,
* or `undefined` if the operation was canceled.
*/
private async promptLocalSketchFolderDestination(
sketch: Sketch,
defaultPath: string
): Promise<string | undefined> {
let sketchFolderDestinationUri: string | undefined;
while (!sketchFolderDestinationUri) {
const { filePath } = await this.dialogService.showSaveDialog({
title: nls.localize( title: nls.localize(
'arduino/sketch/saveFolderAs', 'arduino/sketch/saveFolderAs',
'Save sketch folder as...' 'Save sketch folder as...'
), ),
defaultPath, defaultPath,
});
if (!filePath) {
return undefined;
} }
const destinationUri = await this.fileSystemExt.getUri(filePath); );
// The new location of the sketch cannot be inside the location of current sketch. if (!filePath || canceled) {
// https://github.com/arduino/arduino-ide/issues/1882 return false;
let dialogContent: InvalidSketchFolderDialogContent | undefined; }
if (new URI(sketch.uri).isEqualOrParent(new URI(destinationUri))) { const destinationUri = await this.fileSystemExt.getUri(filePath);
dialogContent = { if (!destinationUri) {
message: nls.localize( return false;
'arduino/sketch/invalidSketchFolderLocationMessage', }
"Invalid sketch folder location: '{0}'", const workspaceUri = await this.sketchService.copy(sketch, {
filePath destinationUri,
), });
details: nls.localize( if (workspaceUri) {
'arduino/sketch/invalidSketchFolderLocationDetails', await this.saveOntoCopiedSketch(sketch.mainFileUri, sketch.uri, workspaceUri);
'You cannot save a sketch into a folder inside itself.' if (markAsRecentlyOpened) {
), this.sketchService.markAsRecentlyOpened(workspaceUri);
question: nls.localize(
'arduino/sketch/editInvalidSketchFolderLocationQuestion',
'Do you want to try saving the sketch to a different location?'
),
};
}
if (!dialogContent) {
const sketchFolderName = new URI(destinationUri).path.base;
const errorMessage = Sketch.validateSketchFolderName(sketchFolderName);
if (errorMessage) {
dialogContent = {
message: nls.localize(
'arduino/sketch/invalidSketchFolderNameMessage',
"Invalid sketch folder name: '{0}'",
sketchFolderName
),
details: errorMessage,
question: nls.localize(
'arduino/sketch/editInvalidSketchFolderQuestion',
'Do you want to try saving the sketch with a different name?'
),
};
}
}
if (dialogContent) {
const message = `
${dialogContent.message}
${dialogContent.details}
${dialogContent.question}`.trim();
defaultPath = filePath;
const { response } = await this.dialogService.showMessageBox({
message,
buttons: [Dialog.CANCEL, Dialog.YES],
});
// cancel
if (response === 0) {
return undefined;
}
} else {
sketchFolderDestinationUri = destinationUri;
} }
} }
return sketchFolderDestinationUri; const options: WorkspaceInput & StartupTask.Owner = {
preserveWindow: true,
tasks: [],
};
if (workspaceUri && openAfterMove) {
this.windowService.setSafeToShutDown();
if (wipeOriginal || (openAfterMove && execOnlyIfTemp)) {
options.tasks.push({
command: DeleteSketch.Commands.DELETE_SKETCH.id,
args: [sketch.uri],
});
}
this.workspaceService.open(new URI(workspaceUri), options);
}
return !!workspaceUri;
} }
}
interface InvalidSketchFolderDialogContent { private async saveOntoCopiedSketch(mainFileUri: string, sketchUri: string, newSketchUri: string): Promise<void> {
readonly message: string; const widgets = this.applicationShell.widgets;
readonly details: string; const snapshots = new Map<string, object>();
readonly question: string; for (const widget of widgets) {
const saveable = Saveable.getDirty(widget);
const uri = NavigatableWidget.getUri(widget);
const uriString = uri?.toString();
let relativePath: string;
if (uri && uriString!.includes(sketchUri) && saveable && saveable.createSnapshot) {
// The main file will change its name during the copy process
// We need to store the new name in the map
if (mainFileUri === uriString) {
const lastPart = new URI(newSketchUri).path.base + uri.path.ext;
relativePath = '/' + lastPart;
} else {
relativePath = uri.toString().substring(sketchUri.length);
}
snapshots.set(relativePath, saveable.createSnapshot());
}
}
await Promise.all(Array.from(snapshots.entries()).map(async ([path, snapshot]) => {
const widgetUri = new URI(newSketchUri + path);
try {
const widget = await this.editorManager.getOrCreateByUri(widgetUri);
const saveable = Saveable.get(widget);
if (saveable && saveable.applySnapshot) {
saveable.applySnapshot(snapshot);
await saveable.save();
}
} catch (e) {
console.error(e);
}
}));
}
} }
export namespace SaveAsSketch { export namespace SaveAsSketch {
@ -297,48 +196,3 @@ export namespace SaveAsSketch {
}; };
} }
} }
export async function saveOntoCopiedSketch(
sketch: Sketch,
newSketchFolderUri: string,
shell: ApplicationShell,
editorManager: EditorManager
): Promise<void> {
const widgets = shell.widgets;
const snapshots = new Map<string, Saveable.Snapshot>();
for (const widget of widgets) {
const saveable = Saveable.getDirty(widget);
const uri = NavigatableWidget.getUri(widget);
if (!uri) {
continue;
}
const uriString = uri.toString();
let relativePath: string;
if (uriString.includes(sketch.uri) && saveable && saveable.createSnapshot) {
// The main file will change its name during the copy process
// We need to store the new name in the map
if (sketch.mainFileUri === uriString) {
const lastPart = new URI(newSketchFolderUri).path.base + uri.path.ext;
relativePath = '/' + lastPart;
} else {
relativePath = uri.toString().substring(sketch.uri.length);
}
snapshots.set(relativePath, saveable.createSnapshot());
}
}
await Promise.all(
Array.from(snapshots.entries()).map(async ([path, snapshot]) => {
const widgetUri = new URI(newSketchFolderUri + path);
try {
const widget = await editorManager.getOrCreateByUri(widgetUri);
const saveable = Saveable.get(widget);
if (saveable && saveable.applySnapshot) {
saveable.applySnapshot(snapshot);
await saveable.save();
}
} catch (e) {
console.error(e);
}
})
);
}

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 '../../common/protocol/sketches-service-client-impl';
@injectable() @injectable()
export class SaveSketch extends SketchContribution { export class SaveSketch extends SketchContribution {
@ -38,15 +36,11 @@ 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;
} }
const isTemp = await this.sketchesService.isTemp(sketch); const isTemp = await this.sketchService.isTemp(sketch);
if (isTemp) { if (isTemp) {
return this.commandService.executeCommand( return this.commandService.executeCommand(
SaveAsSketch.Commands.SAVE_AS_SKETCH.id, SaveAsSketch.Commands.SAVE_AS_SKETCH.id,
@ -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(
'arduino/common/notConnected',
'[not connected]'
);
let portLabel = notConnectedLabel;
if (selectedPort) {
portLabel = nls.localize(
'arduino/common/selectedOn',
'on {0}',
selectedPort.address
);
const selectedItem: BoardListItem | undefined =
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', { this.statusBar.setElement('arduino-selected-port', {
alignment: StatusBarAlignment.RIGHT, alignment: StatusBarAlignment.RIGHT,
text: portLabel, text: selectedPort
? nls.localize(
'arduino/common/selectedOn',
'on {0}',
selectedPort.address
)
: nls.localize('arduino/common/notConnected', '[not connected]'),
className: 'arduino-selected-port', className: 'arduino-selected-port',
}); });
} else {
this.statusBar.removeElement('arduino-selected-port');
} }
} }
} }

View File

@ -1,34 +1,32 @@
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 { Settings } from '../dialogs/settings/settings';
import { SettingsDialog } from '../dialogs/settings/settings-dialog';
import { ArduinoMenus } from '../menu/arduino-menus';
import { import {
Command, Command,
CommandRegistry,
KeybindingRegistry,
MenuModelRegistry, MenuModelRegistry,
CommandRegistry,
SketchContribution, SketchContribution,
KeybindingRegistry,
} from './contribution'; } from './contribution';
import { ArduinoMenus } from '../menu/arduino-menus';
import { Settings as Preferences } from '../dialogs/settings/settings';
import { SettingsDialog } from '../dialogs/settings/settings-dialog';
import { nls } from '@theia/core/lib/common';
@injectable() @injectable()
export class OpenSettings extends SketchContribution { export class Settings extends SketchContribution {
@inject(SettingsDialog) @inject(SettingsDialog)
private readonly settingsDialog: SettingsDialog; protected readonly settingsDialog: SettingsDialog;
private settingsOpened = false; protected settingsOpened = false;
override registerCommands(registry: CommandRegistry): void { override registerCommands(registry: CommandRegistry): void {
registry.registerCommand(OpenSettings.Commands.OPEN, { registry.registerCommand(Settings.Commands.OPEN, {
execute: async () => { execute: async () => {
let settings: Settings | undefined = undefined; let settings: Preferences | undefined = undefined;
try { try {
this.settingsOpened = true; this.settingsOpened = true;
this.menuManager.update();
settings = await this.settingsDialog.open(); settings = await this.settingsDialog.open();
} finally { } finally {
this.settingsOpened = false; this.settingsOpened = false;
this.menuManager.update();
} }
if (settings) { if (settings) {
await this.settingsService.update(settings); await this.settingsService.update(settings);
@ -43,7 +41,7 @@ export class OpenSettings extends SketchContribution {
override registerMenus(registry: MenuModelRegistry): void { override registerMenus(registry: MenuModelRegistry): void {
registry.registerMenuAction(ArduinoMenus.FILE__PREFERENCES_GROUP, { registry.registerMenuAction(ArduinoMenus.FILE__PREFERENCES_GROUP, {
commandId: OpenSettings.Commands.OPEN.id, commandId: Settings.Commands.OPEN.id,
label: label:
nls.localize( nls.localize(
'vscode/preferences.contribution/preferences', 'vscode/preferences.contribution/preferences',
@ -59,13 +57,13 @@ export class OpenSettings extends SketchContribution {
override registerKeybindings(registry: KeybindingRegistry): void { override registerKeybindings(registry: KeybindingRegistry): void {
registry.registerKeybinding({ registry.registerKeybinding({
command: OpenSettings.Commands.OPEN.id, command: Settings.Commands.OPEN.id,
keybinding: 'CtrlCmd+,', keybinding: 'CtrlCmd+,',
}); });
} }
} }
export namespace OpenSettings { export namespace Settings {
export namespace Commands { export namespace Commands {
export const OPEN: Command = { export const OPEN: Command = {
id: 'arduino-settings-open', id: 'arduino-settings-open',

View File

@ -1,34 +1,50 @@
import { inject, injectable } from '@theia/core/shared/inversify';
import { CommonCommands } from '@theia/core/lib/browser/common-frontend-contribution'; import { CommonCommands } from '@theia/core/lib/browser/common-frontend-contribution';
import { ContextMenuRenderer } from '@theia/core/lib/browser/context-menu-renderer';
import { ApplicationShell } from '@theia/core/lib/browser/shell/application-shell'; import { ApplicationShell } from '@theia/core/lib/browser/shell/application-shell';
import { WorkspaceCommands } from '@theia/workspace/lib/browser';
import { ContextMenuRenderer } from '@theia/core/lib/browser/context-menu-renderer';
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 { inject, injectable } from '@theia/core/shared/inversify';
import { WorkspaceCommands } from '@theia/workspace/lib/browser/workspace-commands';
import { ArduinoMenus } from '../menu/arduino-menus';
import { CurrentSketch } from '../sketches-service-client-impl';
import { import {
URI,
SketchContribution,
Command, Command,
CommandRegistry, CommandRegistry,
KeybindingRegistry,
MenuModelRegistry, MenuModelRegistry,
open, KeybindingRegistry,
SketchContribution,
TabBarToolbarRegistry, TabBarToolbarRegistry,
URI, open,
} from './contribution'; } from './contribution';
import { ArduinoMenus, PlaceholderMenuNode } from '../menu/arduino-menus';
import { EditorManager } from '@theia/editor/lib/browser/editor-manager';
import {
CurrentSketch,
SketchesServiceClientImpl,
} from '../../common/protocol/sketches-service-client-impl';
import { LocalCacheFsProvider } from '../local-cache/local-cache-fs-provider';
import { nls } from '@theia/core/lib/common';
@injectable() @injectable()
export class SketchControl extends SketchContribution { export class SketchControl extends SketchContribution {
@inject(ApplicationShell) @inject(ApplicationShell)
private readonly shell: ApplicationShell; protected readonly shell: ApplicationShell;
@inject(MenuModelRegistry) @inject(MenuModelRegistry)
private readonly menuRegistry: MenuModelRegistry; protected readonly menuRegistry: MenuModelRegistry;
@inject(ContextMenuRenderer) @inject(ContextMenuRenderer)
private readonly contextMenuRenderer: ContextMenuRenderer; protected readonly contextMenuRenderer: ContextMenuRenderer;
@inject(EditorManager)
protected override readonly editorManager: EditorManager;
@inject(SketchesServiceClientImpl)
protected readonly sketchesServiceClient: SketchesServiceClientImpl;
@inject(LocalCacheFsProvider)
protected readonly localCacheFsProvider: LocalCacheFsProvider;
protected readonly toDisposeBeforeCreateNewContextMenu = protected readonly toDisposeBeforeCreateNewContextMenu =
new DisposableCollection(); new DisposableCollection();
@ -41,57 +57,107 @@ export class SketchControl extends SketchContribution {
this.shell.getWidgets('main').indexOf(widget) !== -1, this.shell.getWidgets('main').indexOf(widget) !== -1,
execute: async () => { execute: async () => {
this.toDisposeBeforeCreateNewContextMenu.dispose(); this.toDisposeBeforeCreateNewContextMenu.dispose();
let parentElement: HTMLElement | undefined = undefined;
const target = document.getElementById(
SketchControl.Commands.OPEN_SKETCH_CONTROL__TOOLBAR.id
);
if (target instanceof HTMLElement) {
parentElement = target.parentElement ?? undefined;
}
if (!parentElement) {
return;
}
const sketch = await this.sketchServiceClient.currentSketch(); const sketch = await this.sketchServiceClient.currentSketch();
if (!CurrentSketch.isValid(sketch)) { if (!CurrentSketch.isValid(sketch)) {
return; return;
} }
this.menuRegistry.registerMenuAction( const target = document.getElementById(
ArduinoMenus.SKETCH_CONTROL__CONTEXT__MAIN_GROUP, SketchControl.Commands.OPEN_SKETCH_CONTROL__TOOLBAR.id
{
commandId: WorkspaceCommands.FILE_RENAME.id,
label: nls.localize('vscode/fileActions/rename', 'Rename'),
order: '1',
}
);
this.toDisposeBeforeCreateNewContextMenu.push(
Disposable.create(() =>
this.menuRegistry.unregisterMenuAction(
WorkspaceCommands.FILE_RENAME
)
)
);
this.menuRegistry.registerMenuAction(
ArduinoMenus.SKETCH_CONTROL__CONTEXT__MAIN_GROUP,
{
commandId: WorkspaceCommands.FILE_DELETE.id,
label: nls.localize('vscode/fileActions/delete', 'Delete'),
order: '2',
}
);
this.toDisposeBeforeCreateNewContextMenu.push(
Disposable.create(() =>
this.menuRegistry.unregisterMenuAction(
WorkspaceCommands.FILE_DELETE
)
)
); );
if (!(target instanceof HTMLElement)) {
return;
}
const { parentElement } = target;
if (!parentElement) {
return;
}
const { mainFileUri, rootFolderFileUris } = sketch; const { mainFileUri, rootFolderFileUris } = sketch;
const uris = [mainFileUri, ...rootFolderFileUris]; const uris = [mainFileUri, ...rootFolderFileUris];
const parentSketchUri = this.editorManager.currentEditor
?.getResourceUri()
?.toString();
const parentSketch = await this.sketchService.getSketchFolder(
parentSketchUri || ''
);
// if the current file is in the current opened sketch, show extra menus
if (
sketch &&
parentSketch &&
parentSketch.uri === sketch.uri &&
this.allowRename(parentSketch.uri)
) {
this.menuRegistry.registerMenuAction(
ArduinoMenus.SKETCH_CONTROL__CONTEXT__MAIN_GROUP,
{
commandId: WorkspaceCommands.FILE_RENAME.id,
label: nls.localize('vscode/fileActions/rename', 'Rename'),
order: '1',
}
);
this.toDisposeBeforeCreateNewContextMenu.push(
Disposable.create(() =>
this.menuRegistry.unregisterMenuAction(
WorkspaceCommands.FILE_RENAME
)
)
);
} else {
const renamePlaceholder = new PlaceholderMenuNode(
ArduinoMenus.SKETCH_CONTROL__CONTEXT__MAIN_GROUP,
nls.localize('vscode/fileActions/rename', 'Rename')
);
this.menuRegistry.registerMenuNode(
ArduinoMenus.SKETCH_CONTROL__CONTEXT__MAIN_GROUP,
renamePlaceholder
);
this.toDisposeBeforeCreateNewContextMenu.push(
Disposable.create(() =>
this.menuRegistry.unregisterMenuNode(renamePlaceholder.id)
)
);
}
if (
sketch &&
parentSketch &&
parentSketch.uri === sketch.uri &&
this.allowDelete(parentSketch.uri)
) {
this.menuRegistry.registerMenuAction(
ArduinoMenus.SKETCH_CONTROL__CONTEXT__MAIN_GROUP,
{
commandId: WorkspaceCommands.FILE_DELETE.id, // TODO: customize delete. Wipe sketch if deleting main file. Close window.
label: nls.localize('vscode/fileActions/delete', 'Delete'),
order: '2',
}
);
this.toDisposeBeforeCreateNewContextMenu.push(
Disposable.create(() =>
this.menuRegistry.unregisterMenuAction(
WorkspaceCommands.FILE_DELETE
)
)
);
} else {
const deletePlaceholder = new PlaceholderMenuNode(
ArduinoMenus.SKETCH_CONTROL__CONTEXT__MAIN_GROUP,
nls.localize('vscode/fileActions/delete', 'Delete')
);
this.menuRegistry.registerMenuNode(
ArduinoMenus.SKETCH_CONTROL__CONTEXT__MAIN_GROUP,
deletePlaceholder
);
this.toDisposeBeforeCreateNewContextMenu.push(
Disposable.create(() =>
this.menuRegistry.unregisterMenuNode(deletePlaceholder.id)
)
);
}
for (let i = 0; i < uris.length; i++) { for (let i = 0; i < uris.length; i++) {
const uri = new URI(uris[i]); const uri = new URI(uris[i]);
@ -127,7 +193,6 @@ 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);
}, },
@ -184,6 +249,27 @@ export class SketchControl extends SketchContribution {
command: SketchControl.Commands.OPEN_SKETCH_CONTROL__TOOLBAR.id, command: SketchControl.Commands.OPEN_SKETCH_CONTROL__TOOLBAR.id,
}); });
} }
protected isCloudSketch(uri: string): boolean {
try {
const cloudCacheLocation = this.localCacheFsProvider.from(new URI(uri));
if (cloudCacheLocation) {
return true;
}
return false;
} catch {
return false;
}
}
protected allowRename(uri: string): boolean {
return !this.isCloudSketch(uri);
}
protected allowDelete(uri: string): boolean {
return !this.isCloudSketch(uri);
}
} }
export namespace SketchControl { export namespace SketchControl {

View File

@ -3,7 +3,7 @@ import { DisposableCollection } from '@theia/core/lib/common/disposable';
import { inject, injectable } from '@theia/core/shared/inversify'; import { inject, injectable } from '@theia/core/shared/inversify';
import { FileSystemFrontendContribution } from '@theia/filesystem/lib/browser/filesystem-frontend-contribution'; import { FileSystemFrontendContribution } from '@theia/filesystem/lib/browser/filesystem-frontend-contribution';
import { FileChangeType } from '@theia/filesystem/lib/common/files'; import { FileChangeType } from '@theia/filesystem/lib/common/files';
import { CurrentSketch } from '../sketches-service-client-impl'; import { CurrentSketch } from '../../common/protocol/sketches-service-client-impl';
import { Sketch, SketchContribution } from './contribution'; import { Sketch, SketchContribution } from './contribution';
import { OpenSketchFiles } from './open-sketch-files'; import { OpenSketchFiles } from './open-sketch-files';
@ -38,7 +38,7 @@ export class SketchFilesTracker extends SketchContribution {
type === FileChangeType.ADDED && type === FileChangeType.ADDED &&
resource.parent.toString() === sketch.uri resource.parent.toString() === sketch.uri
) { ) {
const reloadedSketch = await this.sketchesService.loadSketch( const reloadedSketch = await this.sketchService.loadSketch(
sketch.uri sketch.uri
); );
if (Sketch.isInSketch(resource, reloadedSketch)) { if (Sketch.isInSketch(resource, reloadedSketch)) {

View File

@ -11,7 +11,6 @@ import { nls } from '@theia/core/lib/common/nls';
export class Sketchbook extends Examples { export class Sketchbook extends Examples {
override onStart(): void { override onStart(): void {
this.sketchServiceClient.onSketchbookDidChange(() => this.update()); this.sketchServiceClient.onSketchbookDidChange(() => this.update());
this.configService.onDidChangeSketchDirUri(() => this.update());
} }
override async onReady(): Promise<void> { override async onReady(): Promise<void> {
@ -19,7 +18,7 @@ export class Sketchbook extends Examples {
} }
protected override update(): void { protected override update(): void {
this.sketchesService.getSketches({}).then((container) => { this.sketchService.getSketches({}).then((container) => {
this.register(container); this.register(container);
this.menuManager.update(); this.menuManager.update();
}); });

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

@ -0,0 +1,78 @@
import { MessageService } from '@theia/core';
import { FrontendApplicationContribution } from '@theia/core/lib/browser';
import { inject, injectable } from '@theia/core/shared/inversify';
import { LocalStorageService } from '@theia/core/lib/browser';
import { nls } from '@theia/core/lib/common';
import { WindowService } from '@theia/core/lib/browser/window/window-service';
import { ArduinoPreferences } from '../arduino-preferences';
import { SurveyNotificationService } from '../../common/protocol/survey-service';
const SURVEY_MESSAGE = nls.localize(
'arduino/survey/surveyMessage',
'Please help us improve by answering this super short survey. We value our community and would like to get to know our supporters a little better.'
);
const DO_NOT_SHOW_AGAIN = nls.localize(
'arduino/survey/dismissSurvey',
"Don't show again"
);
const GO_TO_SURVEY = nls.localize(
'arduino/survey/answerSurvey',
'Answer survey'
);
const SURVEY_BASE_URL = 'https://surveys.hotjar.com/';
const surveyId = '17887b40-e1f0-4bd6-b9f0-a37f229ccd8b';
@injectable()
export class SurveyNotification implements FrontendApplicationContribution {
@inject(MessageService)
private readonly messageService: MessageService;
@inject(LocalStorageService)
private readonly localStorageService: LocalStorageService;
@inject(WindowService)
private readonly windowService: WindowService;
@inject(ArduinoPreferences)
private readonly arduinoPreferences: ArduinoPreferences;
@inject(SurveyNotificationService)
private readonly surveyNotificationService: SurveyNotificationService;
onStart(): void {
this.arduinoPreferences.ready.then(async () => {
if (
(await this.surveyNotificationService.isFirstInstance()) &&
this.arduinoPreferences.get('arduino.survey.notification')
) {
const surveyAnswered = await this.localStorageService.getData(
this.surveyKey(surveyId)
);
if (surveyAnswered !== undefined) {
return;
}
const answer = await this.messageService.info(
SURVEY_MESSAGE,
DO_NOT_SHOW_AGAIN,
GO_TO_SURVEY
);
switch (answer) {
case GO_TO_SURVEY:
this.windowService.openNewWindow(SURVEY_BASE_URL + surveyId, {
external: true,
});
this.localStorageService.setData(this.surveyKey(surveyId), true);
break;
case DO_NOT_SHOW_AGAIN:
this.localStorageService.setData(this.surveyKey(surveyId), false);
break;
}
}
});
}
private surveyKey(id: string): string {
return `answered_survey:${id}`;
}
}

View File

@ -1,189 +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 type { ArduinoState } from 'vscode-arduino-api';
import {
BoardsConfig,
BoardsService,
CompileSummary,
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 { HostedPluginSupport } from '../hosted/hosted-plugin-support';
import { CurrentSketch } from '../sketches-service-client-impl';
import { SketchContribution } from './contribution';
import { CompileSummaryProvider } from './verify-sketch';
/**
* (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;
@inject(CompileSummaryProvider)
private readonly compileSummaryProvider: CompileSummaryProvider;
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.compileSummaryProvider.onDidChangeCompileSummary(
(compilerSummary) => {
if (compilerSummary) {
this.updateCompileSummary(compilerSummary);
}
}
),
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());
const { compileSummary } = this.compileSummaryProvider;
if (compileSummary) {
this.updateCompileSummary(compileSummary);
}
}
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);
}
}

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