Namespace, Primitive, Method

    eslint-plugin-actions

    2.0.0 • Public • Published

    eslint-plugin-actions

    npm CI semantic-release

    Lint JS inside GitHub Actions workflow

    A JS script in a GitHub workflow editor has red squiggly underlines. A tooltip explains the problem.

    Installation

    You'll first need to install ESLint 8 or greater:

    $ npm i eslint --save-dev
    $ yarn add -D eslint
    

    Next, install eslint-plugin-actions:

    $ npm install eslint-plugin-actions --save-dev
    $ yarn add -D eslint-plugin-actions
    

    Usage

    Extending the plugin:actions/recommended config will enable the processor on all workflow .{yml,yaml} files:

    {
        "extends": ["plugin:actions/recommended"]
    }

    Currently, only literal blocks (|) are supported and it's recommended to use them:

    # .github/workflows/ci.yml
    jobs:
      build:
        steps:
        - uses: actions/github-script@v2
          with:
            script: |
              // .github/workflows/ci.yml/0_build/0.js

    The autofixing (--fix) is supported, but it's still experimental and whitespace handling of YAML is different from JS, so be sure to check the result.

    Advanced Configuration

    Dotfiles are ignored by ESLint by default. To lint files inside .github, you'll need to add !.github to .eslintignore file or ignorePatterns of your configuration file:

    !/.github

    Then, add actions to the plugins section of your configuration file. You can omit the eslint-plugin- prefix:

    {
        "plugins": ["actions"]
    }

    Use the processor option in an overrides entry to enable the plugin on workflow YAML files:

    {
        "overrides": [{
            "files": [".github/workflows/*.{yml,yaml}"],
            "processor": "actions/actions"
        }]
    }

    Each script inside a workflow has a virtual filename appended to the YAML file's path. It has the format of [global index]_[job id]/[local index].js (see the example above). overrides glob patterns for these virtual filenames can customize configuration for scripts without affecting regular code. For more information on configuring processors, refer to the ESLint documentation:

    {
        "overrides": [{
            "files": [".github/workflows/*.{yml,yaml}/*_build/*.js"],
            "rules": {
                "indent": ["error", 2, {"outerIIFEBody": 0}]
                ...
            },
            ...
        }]
    }

    Rules

    The script will be enclosed in an IIFE async function, when processed by ESLint:

    (async function(context, github, io, core) {
    ...
    }());

    Therefore, if indent or indent-legacy rule is used, the outerIIFEBody option should be set to 0 (see above). Furthermore, rules affecting the beginning and the end of the file, such as unicode-bom, eol-last and no-multiple-empty-lines, are ignored.

    Supported Actions

    Remark

    This plugin is heavily inspired by and adapted from eslint-plugin-markdown.

    License

    MIT License

    Install

    npm i eslint-plugin-actions

    DownloadsWeekly Downloads

    79

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    14.4 kB

    Total Files

    8

    Last publish

    Collaborators

    • ylemkimon