From fe3d19d5549002cb29a4dfc328b2c9999c3f481e Mon Sep 17 00:00:00 2001 From: Macbook Adrien - Bonita Date: Fri, 25 Sep 2020 14:42:15 +0200 Subject: [PATCH 1/5] fix a small english mistake in the readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9a05393db1..3c3d1a3a84 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ If you need BPMN examples, you can use resources from | :---------: | :---------: | :---------: | :---------: | | Yes | Yes | Yes | Yes | -**Note**: Internet Explorer won't never be supported. \ +**Note**: Internet Explorer will never be supported. \ The library may work with the other browsers, currently not list, if they support ES6. ## 🎨 Features From 4afde262b63d06e423d36d6b7afb57cc9d1108bb Mon Sep 17 00:00:00 2001 From: Macbook Adrien - Bonita Date: Tue, 6 Oct 2020 11:13:58 +0200 Subject: [PATCH 2/5] Add ESLint configuration steps for vscode --- .gitignore | 1 + docs/development/ide-configuration.md | 24 +++++++++++++++++++++--- 2 files changed, 22 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 9fd381594e..c57ceddca6 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,7 @@ /.idea/ *.iml *.project +*.DS_Store # Build directories /node_modules/ diff --git a/docs/development/ide-configuration.md b/docs/development/ide-configuration.md index 79df20398f..3b4c37b22c 100644 --- a/docs/development/ide-configuration.md +++ b/docs/development/ide-configuration.md @@ -38,6 +38,26 @@ When Gitpod IDE is started, the `npm install` command is launched automatically. Install the EditorConfig extension. A configuration file already exists in the repository, so it will apply right after the extension installation. +#### [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + +After the installation, you need to explicitly tell eslin extension to watch typscript files for linting errors. + - Open the Command Palette (*`View -> Command Palette`* or *`Ctrl+Shift+P`* or *`Shift+Cmd+P`*) + - Type `Open Settings (JSON)` and select the option `Preferences: Open Settings (JSON)` + - Paste this code inside the opened JSON file + + ```JSON + { + "eslint.validate": ["typescript", "typescriptreact"] + } + ``` + - Open the Command Palette again + - Type `eslint` + - Select `ESLint: Enable ESLint` + +Visual Studio Code is now configured correctly to use ESLint on typescript files. + +*Note: make sure that ESLint is installed and [configured correctly to work with typescript](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/README.md) on your machine.* + #### [Debugging TypeScript code](https://code.visualstudio.com/docs/typescript/typescript-debugging) The `launch.json` file is already configured to execute tests: - unit tests: `test:unit` @@ -57,9 +77,7 @@ This extension permits visualizing .adoc files directly in VSCode. #### [SonarLint](https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarlint-vscode) -Additionally, it is advised to install the SonarLint extension. - -It helps to avoid coding mistakes -> reduced technical debt. +SonarLint highlights Bugs and Security Vulnerabilities as you write code, with clear remediation guidance so you can fix them before the code is even committed. ### IntelliJ From efaf005387887fbe0e456e089f2ad346f5a9066d Mon Sep 17 00:00:00 2001 From: Macbook Adrien - Bonita Date: Tue, 6 Oct 2020 11:17:33 +0200 Subject: [PATCH 3/5] typo --- docs/development/ide-configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development/ide-configuration.md b/docs/development/ide-configuration.md index 3b4c37b22c..3876fc8c34 100644 --- a/docs/development/ide-configuration.md +++ b/docs/development/ide-configuration.md @@ -40,7 +40,7 @@ Install the EditorConfig extension. A configuration file already exists in the r #### [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) -After the installation, you need to explicitly tell eslin extension to watch typscript files for linting errors. +After the installation, you need to explicitly tell to the ESLint extension to watch typscript files for linting errors. - Open the Command Palette (*`View -> Command Palette`* or *`Ctrl+Shift+P`* or *`Shift+Cmd+P`*) - Type `Open Settings (JSON)` and select the option `Preferences: Open Settings (JSON)` - Paste this code inside the opened JSON file From 99b4ee7eb4c616142a3083d4de2058b95a778a1a Mon Sep 17 00:00:00 2001 From: Adrien Date: Tue, 6 Oct 2020 12:17:12 +0200 Subject: [PATCH 4/5] Update docs/development/ide-configuration.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Souchet Céline <4921914+csouchet@users.noreply.github.com> --- docs/development/ide-configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development/ide-configuration.md b/docs/development/ide-configuration.md index 3876fc8c34..211aa875a6 100644 --- a/docs/development/ide-configuration.md +++ b/docs/development/ide-configuration.md @@ -47,7 +47,7 @@ After the installation, you need to explicitly tell to the ESLint extension to w ```JSON { - "eslint.validate": ["typescript", "typescriptreact"] + "eslint.validate": ["typescript"] } ``` - Open the Command Palette again From 519613da67fb3db9bbff7e862db5b8adaeba0419 Mon Sep 17 00:00:00 2001 From: Macbook Adrien - Bonita Date: Wed, 7 Oct 2020 11:38:26 +0200 Subject: [PATCH 5/5] add extensions settings configuration --- docs/development/ide-configuration.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/development/ide-configuration.md b/docs/development/ide-configuration.md index 211aa875a6..4b72347b82 100644 --- a/docs/development/ide-configuration.md +++ b/docs/development/ide-configuration.md @@ -50,9 +50,12 @@ After the installation, you need to explicitly tell to the ESLint extension to w "eslint.validate": ["typescript"] } ``` - - Open the Command Palette again - - Type `eslint` - - Select `ESLint: Enable ESLint` + - Open the extensions panel (Button `Extensions` on the left toolbar or `Ctrl+Shift+X` or `Shift+Cmd+X`) + - Open the extensions settings of the ESLint extension (using the wheel on the bottom right corner of the extension) + - Ensure that the following properties are checked: + - `ESLint: Enable` + - `ESLint > Format: Enable` + - `ESLint > Lint Task: Enable` Visual Studio Code is now configured correctly to use ESLint on typescript files.