Skip to content

Commit

Permalink
Enhance project structure (VSC-277) (espressif#73)
Browse files Browse the repository at this point in the history
* Removed unused files
Removed gulp script from vsix
moved the logo to media folder

* Remove all checks from pre-commit hook
Update Readme
Update lint script to prettier
Update CI for gitlab actions

* Fix always uploading of file
  • Loading branch information
pwmb authored Apr 23, 2020
1 parent 93661ce commit 5fe58ae
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 162 deletions.
2 changes: 0 additions & 2 deletions .bandit

This file was deleted.

144 changes: 0 additions & 144 deletions .flake8

This file was deleted.

12 changes: 7 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,15 @@ jobs:
python -m pip install --upgrade pip
pip install -r esp_debug_adapter/requirements.txt
- name: Prettier Check
run: yarn prettier --check "**/*.*"
- name: Lint Check
run: yarn lint

- name: Check Node Packages Vulnerabilities
run: yarn audit

- name: Package .vsix
run: yarn run package
run: yarn package

- name: Upload .vsix File
uses: actions/upload-artifact@v1
with:
Expand All @@ -47,13 +48,14 @@ jobs:

- name: xvfb
run: /usr/bin/Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &

- name: Extension Test
run: yarn run test --VERBOSE >> testing.results.log
run: yarn test --VERBOSE >> testing.results.log
env:
CODE_VERSION: "1.41.1"
DISPLAY: ":99.0"

- name: Upload testing.results.log
if: always()
uses: actions/upload-artifact@v1
with:
name: testing.results.log
Expand Down
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": "pretty-quick --staged && yarn audit && yarn run tslint && yarn run compile"
"pre-commit": "pretty-quick --staged"
}
}
3 changes: 2 additions & 1 deletion .vscodeignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,5 @@ tslint.json
yarn.lock
package-lock.json
node_modules
.yarnrc
gulpfile.js
.yarnrc
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ There are a few dependencies which needs to be downloaded and installed before y
## Coming Soon 🔜

- Heap Tracing with complete GUI
- VSCode Remote
- Create new project wizard

## Quick Installation Guide

Expand All @@ -55,27 +55,26 @@ To install from `.vsix` file, first head to [releases page](https://github.com/e
- 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 `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.
- Compile project with `yarn webpack` (optional for production)

#### Build vsix locally

- Build the Visual Studio Code extension setup with `yarn run build_vsix`
- Build the Visual Studio Code extension setup with `yarn package`

## Uninstalling the plugin

- In Visual Studio Code, go to the Extensions tab.
- Click on the EspressifIDF extension lower right icon.
- Click Uninstall.
- Go to your `{VSCODE_EXTENSION_DIR}` and make sure to delete the Espressif IDF plugin folder.
- Go to your `${VSCODE_EXTENSION_DIR}` and make sure to delete the Espressif IDF plugin folder.

## How to use

- First set up your Visual Studio Code as explained in the former section.
- Then
- Either open Visual Studio Code and create a workspace folder.
- Run `code {YOUR_PROJECT_DIR}` from the command line.
- Run `code ${YOUR_PROJECT_DIR}` from the command line.
- Press <kbd>F1</kbd> and type **ESP-IDF: Configure ESP-IDF extension** to configure the extension Please take a look at [ONBOARDING](./docs/ONBOARDING.md) for more detail.

- Press <kbd>F1</kbd> and type **ESP-IDF: Create ESP-IDF project** to generate a template ESP-IDF project.
Expand Down
File renamed without changes
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"version": "0.2.0",
"license": "Apache-2.0",
"publisher": "espressif",
"icon": "espressif_icon.png",
"icon": "media/espressif_icon.png",
"galleryBanner": {
"color": "#636363",
"theme": "dark"
Expand Down Expand Up @@ -532,10 +532,10 @@
],
"scripts": {
"vscode:prepublish": "gulp build && webpack --mode production",
"tslint": "tslint -c tslint.json -p .",
"lint": "prettier --check **/*.*",
"debugPreTask": "webpack --mode development",
"compile": "tsc -p ./",
"watch": "tsc -p ./ --watch & webpack --watch --mode development",
"watch": "webpack --watch --mode development",
"test": "yarn run compile && node ./out/test/runTest.js",
"package": "vsce package --yarn -o esp-idf-extension.vsix",
"release": "vsce publish --yarn -p ${VS_MARKETPLACE_TOKEN}",
Expand Down

0 comments on commit 5fe58ae

Please sign in to comment.