eslint-plugin-gjs

eslint-plugin-gjs

Adds compatibility for the GJS (Gnome JavaScript) environment.

Development & Bugs

Report bugs, explore the source, and contribute on the GitHub.

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-gjs:

$ npm install eslint-plugin-gjs --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-gjs globally.

Usage

Add gjs to the plugins section of your .eslintrc configuration file. Depending on your use case, add either plugin:gjs/extension or plugin:gjs/application to your extends section.

{
    "plugins": ["gjs"],
    "extends": [ "plugin:gjs/extension" ]
}

The plugin automatically imports all relevant rules. If you would like to avoid this, add gjs/application or gjs/shell-extension to your env section. Then remove "extends": [ "plugin:gjs/extension" ].

{
    "plugins": ["gjs"],
    "env": {
        "es6": true,
        "gjs/application": true
    }
}

You can also add gjs/cairo or gjs/girepository to your env to enable the relevant globals.

Supported Rules

• gjs/no-computed-properties
• gjs/no-generators
• gjs/no-invalid-regexp
• gjs/no-js-class
• gjs/no-modules
• gjs/no-numeric-literals
• gjs/no-spread
• gjs/no-super
• gjs/no-template-strings
• gjs/translation-strings
• DEPRECATED: gjs/no-unsupported-syntax

Not Implemented

• Lang.Class member formatting
• Object literal formatting (unlikely to be implemented)
• Lang.bind enforcement for closures
• Prohibit Promise, Symbol, and WeakSet globals.