Qodana 2023.3 Help

Qodana for JS

official project

Qodana for .NET linter languages

Qodana for JS is based on WebStorm. It provides static analysis for JavaScript or TypeScript projects.

Supported technologies

Qodana for JS provides inspections for the following technologies.

Programming languages

JavaScript

TypeScript

Markup languages

CSS

HTML

JSON and JSON5

RELAX NG

XML

YAML

Scripting languages

Shell script

Frameworks and libraries

Angular

Cucumber

EJS

Handlebars/Mustache

Less

Node.js

PostCSS

Pug/Jade

React

Sass/SCSS

Vue

Supported features

The Qodana for JS linter provides the following Qodana features:

Feature

Available under licenses

Baseline

Ultimate and Ultimate Plus

Code coverage

Ultimate and Ultimate Plus

License audit

Ultimate Plus

Quality gate

Ultimate and Ultimate Plus

Quick-fix

Ultimate and Ultimate Plus

Vulnerability checker

Ultimate Plus

Try it now

Analyze a project locally

Install project dependencies

For a basic JavaScript project that has no external dependencies, no preliminary steps are required.

In case the project has external dependencies, you can set them up using the bootstrap field in the qodana.yaml file. For example, if your project dependencies are specified by the yarn.lock file in your project root, add the following line to qodana.yaml:

bootstrap: yarn install

The command will be automatically executed before the analysis. You can use the npm or yarn commands to install dependencies.

Enable ESLint

ESLint is widely used in JavaScript projects. You can enable it using the qodana.yaml file:

include: - name: Eslint

Run analysis

Qodana provides two options for local analysis of your code. Qodana CLI is the easiest option to start. Alternatively, you can use the Docker command from the Docker image tab.

Assuming that you have already installed Qodana CLI on your machine, you can run this command in the project root directory:

qodana scan \ -e QODANA_TOKEN="<cloud-project-token>" \ -l jetbrains/qodana-js:2023.3 \ --show-report

Here, the QODANA_TOKEN variable refers to the project token.

To start, pull the image from Docker Hub (only necessary to get the latest version):

docker pull jetbrains/qodana-js:2023.3

Start local analysis with source-directory pointing to the root of your project and QODANA_TOKEN referring to the project token:

docker run --rm -it \ -v <source-directory>/:/data/project/ \ -e QODANA_TOKEN="<cloud-project-token>" \ -p 8080:8080 \ jetbrains/qodana-js:2023.3 \ --show-report

Open http://localhost:8080 in your browser to examine inspection results. Here, you can also reconfigure the analysis, see the Inspection report section for details. When done, you can stop the web server by pressing Ctrl-C in the console.

Next steps

Last modified: 12 April 2024