Skip to content

Commit

Permalink
Closes #8
Browse files Browse the repository at this point in the history
  • Loading branch information
Soumesh Banerjee authored and brianignacio5 committed Jan 10, 2020
1 parent 22f7af2 commit 09a829a
Show file tree
Hide file tree
Showing 34 changed files with 6,633 additions and 11,798 deletions.
61 changes: 16 additions & 45 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ before_script:
- test ! -z "$CI_NPM_REGISTRY" && npm config set registry $CI_NPM_REGISTRY || true
- unset HTTP_PROXY
- unset ALL_PROXY
- npm install
# ssh key
- yarn
- mkdir -p ~/.ssh
- chmod 700 ~/.ssh
- echo -n $GITLAB_KEY > ~/.ssh/id_rsa_base64
Expand All @@ -35,37 +34,15 @@ typescript_lint_test:
image: node:slim
stage: lint
tags: [ "build", "internet", "amd64" ]
artifacts:
when: on_failure
paths:
- /root/.npm/_logs/*.log
expire_in: 1 week
script:
- npm run tslint
- yarn run tslint

javascript_lint_test:
node_vulnerabilities_test:
image: node:slim
stage: lint
tags: [ "build", "internet", "amd64" ]
artifacts:
when: on_failure
paths:
- /root/.npm/_logs/*.log
expire_in: 1 week
script:
- npm run eslint

npm_vulnerabilities_test:
image: node:slim
stage: lint
tags: [ "build", "internet", "amd64" ]
artifacts:
when: on_failure
paths:
- /root/.npm/_logs/*.log
expire_in: 1 week
script:
- npm audit --registry=https://registry.npmjs.org
- yarn audit --registry=https://registry.npmjs.org

python_lint_test:
image: $CI_DOCKER_REGISTRY/ubuntu-test-env
Expand All @@ -92,6 +69,7 @@ build_tar:
artifacts:
paths:
- espressif-esp-idf-extension-*.tar.gz
expire_in: 1 week
script:
- PACKAGE_VERSION=$(node -p "require('./package.json').version")
- cd ..
Expand All @@ -106,19 +84,13 @@ build_vsix:
artifacts:
paths:
- esp-idf-extension-*.vsix
- /root/.npm/_logs/*.log
expire_in: 1 week
script:
- rm -rf node_modules
- npm config set script-shell /bin/bash
- npm install
- npm add vsce
- npm add gulp
- ./node_modules/.bin/gulp build
- yarn config set script-shell /bin/bash
- VERSION_STR=${CI_COMMIT_TAG:-g${CI_COMMIT_SHA:0:8}}
- npm run compile
- npm run webpack
- npm run package
- yarn run compile
- yarn run webpack
- yarn run package

deploy_marketplace:
image: electronuserland/builder:11
Expand All @@ -127,13 +99,13 @@ deploy_marketplace:
- deploy
before_script:
- echo "Skipping before_script"
artifacts:
paths:
- esp-idf-extension-*.vsix
untracked: false
expire_in: 30 days
script:
- rm -rf node_modules
- npm config set script-shell /bin/bash
- npm i
- npm i vsce -g
- npm run compile
- npm run webpack
- yarn config set script-shell /bin/bash
- vsce publish -p ${VS_MARKETPLACE_TOKEN}
when: manual

Expand Down Expand Up @@ -161,12 +133,11 @@ tests_extension_units:
artifacts:
paths:
- "*.log"
- /root/.npm/_logs/*.log
reports:
junit:
- results/*
when: always
expire_in: 1 week
script:
- Xvfb :99 & sleep 2
- npm run test --VERBOSE >> testing.results.log
- yarn run test --VERBOSE >> testing.results.log
2 changes: 1 addition & 1 deletion .huskyrc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"hooks": {
"pre-commit": "npm audit && npm run tslint && npm run eslint && npm run compile"
"pre-commit": "yarn audit && yarn run tslint && yarn run compile"
}
}
6 changes: 3 additions & 3 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
"--extensionDevelopmentPath=${workspaceFolder}"
],
"outFiles": [
"${workspaceFolder}/out/**/*.js"
"${workspaceFolder}/dist/**/*.js"
],
"preLaunchTask": "npm: watch"
"preLaunchTask": "npm: debugPreTask"
},
{
"name": "Extension Tests",
Expand All @@ -30,7 +30,7 @@
"outFiles": [
"${workspaceFolder}/out/test/**/*.js"
],
"preLaunchTask": "npm: watch"
"preLaunchTask": "npm: compile"
}
]
}
20 changes: 0 additions & 20 deletions .vscode/tasks.json

This file was deleted.

16 changes: 13 additions & 3 deletions .vscodeignore
Original file line number Diff line number Diff line change
@@ -1,14 +1,24 @@
.vscode/**
.vscode-test/**
out/test/**
out/**/*.map
out
dist/**/*.map
src/**
.gitignore
tsconfig.json
menuconfig/js/test/**
.github
.cache
docs
ci
.github
.gitlab-ci.yml
webpack.config.js
testFiles/**
.bandit
.flake8
.huskyrc.json
.style.yapf
esp_idf_vsc_ext.log
tslint.json
yarn.lock
package-lock.json
node_modules
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,15 @@ Visual Studio Code extension for Espressif IoT Development Framework, [ESP-IDF](

The ESP-IDF extension makes it easy to develop, build, flash, monitor and debug your ESP-IDF code, some functionality includes:

- Quick On-boarding for first time user.
- Quick prototyping using some examples directly baked into the extension.
- Quick [Configure ESP-IDF extension](https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/ONBOARDING.md) for first time user to help you download, install and setup ESP-IDF and required tools within Visual Studio Code extension.
- Quick prototyping by copying ESP-IDF examples with **ESP-IDF: Show ESP-IDF Examples Projects**.
- App tracing when using ESP-IDF Application Level Tracing Library like in [ESP-IDF Application Level Tracing Example](https://github.com/espressif/esp-idf/tree/master/examples/system/app_trace_to_host).
- Size analysis of binaries with **ESP-IDF: Size analysis of the binaries**.
- [GUI Menuconfig tool](#ESP-IDF-GUI-Menuconfig-tool) within the extension with enabled search.
- Easily Build, Flash and Monitor your code for the ESP-32 chip.
- IntelliSense and syntax highlighting for [KConfig](https://docs.espressif.com/projects/esp-idf/en/latest/api-reference/kconfig.html)
- Commands and Shortcuts for existing [ESP-IDF Tools](https://github.com/espressif/esp-idf/tree/master/tools) within the extension
- Syntax highlighting for [KConfig](https://docs.espressif.com/projects/esp-idf/en/latest/api-reference/kconfig.html) and ESP-IDF Kconfig style syntax validation if enabled.
- Localization (English, Chinese, Spanish)of commands which you can also [add a language contribution](https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/LANG_CONTRIBUTE.md).
- OpenOCD server within Visual Studio Code.

## Prerequisites
There are a few dependencies which needs to be downloaded and installed before you can continue to use the extension.
Expand Down Expand Up @@ -43,9 +47,13 @@ To install from `.vsix` file, first head to [releases page](https://github.com/e
- Install [Node.js](https://nodejs.org/en/)
- Make sure have the [C/C++ Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) from Visual Studio Code Marketplace.
- Clone this repository `git clone https://github.com/espressif/vscode-esp-idf-extension.git`
- Install all the dependencies, using `npm i`, compile typescript with `npm run compile` and bundle the webviews using `npm run webpack`.
- Install all the dependencies, using `yarn`
- Compile typescript with `yarn run compile`
- Bundle the webviews using `yarn run webpack`.
- Press <kbd>F5</kbd> to Run with Debugger, this will launch a new VSCode Extension Development Host to debug the extension.
- Build the Visual Studio Code extension setup with `npm run build_vsix`.

#### Build vsix locally
- Build the Visual Studio Code extension setup with `yarn run build_vsix`

## Uninstalling the plugin
- In Visual Studio Code, go to the Extensions tab.
Expand Down Expand Up @@ -159,7 +167,7 @@ the following:
5. `OpenOCD` - Start the openOCD server
6. `BuildFlash` - Execute a build followed by a flash command.

## IDF GUI Menuconfig
## ESP-IDF GUI Menuconfig tool

This plugin includes a GUI menuconfig that reads your current project folder's sdkconfig file (if available, otherwise it would take default values) and start a configuration server process (confserver.py in __${ESP-IDF-DIRECTORYPATH}__/tools) that enables the user to redefine ESP-IDF board parameters.

Expand Down
2 changes: 1 addition & 1 deletion docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ If you can't find the issue in the already opened issues then please make sure t
- :pencil: `:pencil:` Writing docs.
- :lipstick: `:lipstick:` Updating the web-view UI or style files
- :white_check_mark: `:white_check_mark:` Updating tests.
- :lock: `:lock:` Fixing security issues including npm dependencies audit.
- :lock: `:lock:` Fixing security issues including node dependencies audit.
- :apple: `:apple:` Fixing something on macOS.
- :penguin: `:penguin:` Fixing something on Linux.
- :checkered_flag: `:checkered_flag:` Fixing something on Windows.
Expand Down
2 changes: 1 addition & 1 deletion docs/LANG_CONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Each file has a key value structure such as:

where you would replace the `value` part with your language contribution.

(Re-) Compile the extension installation file (.vsix) by running `npm run build_vsix` from a terminal in the directory of this file.
(Re-) Compile the extension installation file (.vsix) by running `yarn run build_vsix` from a terminal in the directory of this file.

Test your contribution by changing Visual Studio Code locale:
- Pressing F1 and run the `Configure Display Language` command.
Expand Down
8 changes: 4 additions & 4 deletions i18n/es/out/espIdf/serial/SerialPort.i18n.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"serial.notSerialPortFoundMessage": "Could not find any serial port available",
"serial.portHasBeenSelectedMessage": "Port has been updated to ",
"serial.noPortSelectedMessage": "No port selected.",
"serial.selectSerialPortMessage":"Select the available serial port where your device is connected."
"serial.notSerialPortFoundMessage": "No se ha encontrado un puerto serial",
"serial.portHasBeenSelectedMessage": "El puerto se ha actualizado a ",
"serial.noPortSelectedMessage": "Ningun puerto seleccionado.",
"serial.selectSerialPortMessage":"Selecciona el puerto serial de tu dispositivo."
}
Loading

0 comments on commit 09a829a

Please sign in to comment.