Tools
Node
The first thing that you need to work with our FrontEnd area, is to install nodejs
. You can download from https://nodejs.org/.
Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine. For this reason, you need to get it, because each project needs nodejs
to run.
For our purpose, you require at least version Node.js 8.x
.
Npm vs Yarn
When you install Nodejs
, you will get the package manager npm
used it to obtain the packages that a project needs.
NPM
works but it slow. To solve this problem, Facebook people created an improved version to get packages called Yarn
. You can use the npm manager
or the `Yarn manager. At the end of the day you can get your packages.
To get the yarn package
, after install node you need to run this command:
Also, if you have Chocolatey
installed in your Windows PC, you can run:
You third option, is download the .msi file from here.
Git
All our repositories are host in Team Foundation Server
. If you want to get some repository, you will have to do it through git
.
You can install git from their website https://git-scm.com/downloads.
GUI Clients
After install git, maybe you do not feel comfortable using git from the console. If it is your case, do not worry! Since there are applications that simplify the use of git
through graphical interface. We usually use two applications for git.
SourceTree
Sourcetree
works on Windows and MAC. You can download it from the website https://www.sourcetreeapp.com/.
It's important remember the cost of this software. it's Free! under a proprietary license. Sourcetree
is simple to use. you can do every from this application.
TortoiseGit
TortoiseGit
is a windows shell interface to git, and you can download from their website https://www.sourcetreeapp.com/.
One of the best features that TortoiseGit
offers, is that provides overlay icons showing the file status, a powerful context menu for Git and much more! You can access to the most common actions with a few clicks.
Visual Studio Code
Right now, there are a lot of editor in the market, but perhaps the most comfortable in recent times has been Visual Studio Code
. You can practically do everything with Visual studio Code, from writing a few lines of code, going through manager git, to creating documentation or UML diagrams. Visual Studio Code
has been our tool selected for our day to day in the FrontEnd team.And a large part of that decision is that it is lightweight and has a large number of plugins to make the development process as agile as possible.
You can download from their website https://code.visualstudio.com/
Extensions
You can install extensions
from the visual studio code
application.
Open your
VSCode
and pressCtrl + Shift + X
.search the extensions.
Click on Install button.
Some extensions require more setup. Consult the extension documentation for next steps.
Example install extension
Extensions recommended
tslint extension
This extension requires that the tslint
and typescript
modules are installed either locally or globally. This extension checks some code rules to write code. visual studio will show the errors thanks to this extensions.
Each project has a file called tslint.json
that contains all the rules to check. After install the extensions and get tslint
and typescript
module (through yarn
or npm
), you just need open the folder with VSCode
where the tslint.json
is.
read more:visual studio tslint
sonarLint
This extension is similar to tslint
. It checks some rules against the code we write. The difference is that you can connect with our SonarQube
server, that contains the rules definition.
Visual studio Code
has two scopes for settings. The User Settings and the Workspace settings that you can open with Ctrl + ,
. The User settings are global and use for all the extensions and the program itself. The Workspace settings are only for you current folder. When you modify the workspace settings a folder is created called .vscode
and it contains your custom settings for the current folder.
Install the JRE 8 or 11
install the Java Runtime 8 or 11 in your PC
Install sonarlint in vscode
please install this plugin for VS Code https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarlint-vscode
Reference the JRE for visual code
open the visual studio code settings ( ctrl + , )
click on the user tab
in the search input write sonarlint
in the result section, find the Sonarlint > Ls: Java Home
insert your JDK path in the input.
Setup the SonarQube server in "user" settings
open the visual studio code settings ( ctrl + , )
click on the user tab
in the search input write sonarlint
In the result section, find the Sonarlint > Connected Mode > connections: Sonarqube
click on Edit in settings.json
"connectionId": "WebMapProduct", "serverUrl": "http://product-sonarqube:9900", "token": "1a7fd47f85d3edca124d141c85d0a47bd39b6418"
Note: for more information and updates of the sonarqube token, please see the Devops guide (it's best to use the SonarQube Dev credentials, look at step 3 in the following link) https://collaboration.artinsoft.com/tfs/Product/DevOps/_wiki/wikis/DevOps.wiki?wikiVersion=GBwikiMaster&pagePath=%2FMobilize%20DevOps%2FDotNet%2FSonarQube%20Setup&pageId=457
Find the project Key for the repository
Go to the Frontend dashboard https://collaboration.artinsoft.com/tfs/Product/Product/_dashboards/dashboard/783a0ba9-482c-42f1-bc45-48d1abea87a8
find your repository, and click on the quality gate button.
for example WFNetKendoComponents
when the SonarQube page is open, there will be an input with the project key
save the key, you will need it later.
Setup the SonarQube server in "workspace" settings
open the visual studio code settings ( ctrl + , )
click on the workspace tab
in the search input write sonarlint
In the result section, find the Sonarlint > Connected Mode: Project
click on Edit in settings.json
"connectionId": "WebMapProduct", "projectKey": "<projectKey>" ( write here, the key you saved previously)
Update rules from server to vs Code
in the VS Code open the command on the command palette, and search and run for SonarLint: Update all project bindings to SonarQube/SonarCloud
How to use
If the configuration finished successfully, when you open a file that has some code smell, sonarlint will highlight it as an error. Also, you can check the tab of problems in the bottom section.
Read more: visual studio sonarLint
Last updated