GithubHelp home page GithubHelp logo

bert-mccutchen / action-stylelint Goto Github PK

View Code? Open in Web Editor NEW

This project forked from reviewdog/action-stylelint

0.0 0.0 0.0 299 KB

Run stylelint with reviewdog

Home Page: https://github.com/marketplace?type=actions&query=reviewdog

License: MIT License

Shell 100.00%

action-stylelint's Introduction

GitHub Action: Run stylelint with reviewdog

depup release GitHub release (latest SemVer) action-bumpr supported

This action runs stylelint with reviewdog on pull requests to improve code review experience.

github-pr-check sample github-pr-review sample

Inputs

fail_on_error

Whether reviewdog should fail when errors are found. [true,false] This is useful for failing CI builds in addition to adding comments when errors are found. It's the same as the -fail-on-error flag of reviewdog.

filter_mode

Optional. Reviewdog filter mode [added, diff_context, file, nofilter] It's the same as the -filter-mode flag of reviewdog.

github_token

Required. Default is ${{ github.token }}.

level

Optional. Report level for reviewdog [info,warning,error]. It's same as -level flag of reviewdog.

packages

Optional. Additional NPM packages to be installed, e.g.:

packages: 'stylelint-config-sass-guidelines stylelint-order'

reporter

Reporter of reviewdog command [github-pr-check,github-pr-review,github-check]. Default is github-pr-check. github-pr-review can use Markdown and add a link to rule page in reviewdog reports.

stylelint_input

Optional. Files or glob. Default: **/*.css. It's same as [input] of stylelint.

stylelint_config

Optional. It's same as --config flag of stylelint.

workdir

Optional. The directory from which to look for and run stylelint. Default '.'

Example usage

You also need to install stylelint.

# Example
$ npm install stylelint stylelint-config-recommended -D

You can create stylelint config and this action uses that config too.

name: reviewdog
on: [pull_request]
jobs:
  stylelint:
    name: runner / stylelint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: stylelint
        uses: reviewdog/action-stylelint@v1
        with:
          reporter: github-pr-review # Change reporter.
          stylelint_input: '**/*.css'

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.