atom-deepscan

Atom package to detect bugs and quality issues in JavaScript, TypeScript, React and Vue.js. Works with DeepScan.

DeepScan is a cutting-edge JavaScript code inspection tool that helps you to find bugs and quality issues more precisely by data-flow analysis. You can also use it for React and Vue.js because DeepScan delivers React specialized rules and Vue.js specialized rules.

Note: To use this extension, you should confirm that your code is transferred to the DeepScan server for inspection when you save your changes. You can confirm it by pressing the Confirm button that appears when restarting Atom after the installation.

Note that your code is completely deleted from the server right after the inspection.

Installation

apm install atom-deepscan

How it works

• You need Linter package. Once Linter package is installed, just restart Atom.
• Report issues in the Linter view when you open a *.js, *.jsx, *.mjs, *.ts, *.tsx, and *.vue file and save it.
• Highlight issues in the code.
• For support of .jsx file, include a grammar of atom-react.
• For support of .ts and .tsx file, include a grammar of language-typescript-grammars-only.
• For support of .vue file, include a grammar of atom-vue.

Settings Options

This plugin contributes the following variables to the settings:

• enable: Enable/disable DeepScan inspection. Disabled by default. Enabled when you confirm.
• server: Set a URL of DeepScan server. "https://deepscan.io" by default.
• proxy: Set a URL of proxy server. When you do not have/want a system-wide http_proxy environment variable, you can set the proxy server's URL here.
• ignoreRules: Set an array of rules to exclude.
• showDecorators: Controls whether the problem of the code should be shown along with the code.
• showFullDescription: Controls whether the full description of the issue should be shown when you hover it. Applied after reopening the file.

Disabling Rules with Inline Comments

While you can exclude rules project wide via deepscan.ignoreRules option, you can also disable a rule in a file using inline comment.

const x = 0;
x = 1; x + 1; // deepscan-disable-line UNUSED_EXPR

Read more about it here.

Using behind a proxy

To do an inspection, this extension requires a connection with the DeepScan server. But this connection cannot be established when you are behind a proxy.

For this case, you can try one of the following:

• Set http_proxy environment variable: http_proxy is respected, if any.
• Set Proxy option: When you do not have/want a system-wide http_proxy environment variable, you can set the proxy server's URL in the Proxy option.