https://github.com/kasperhesthaven/setup-editorconfig-checker

A GitHub Action for downloading editorconfig-checker by version & adding it to your path, allowing you to lint your files
https://github.com/kasperhesthaven/setup-editorconfig-checker

editorconfig editorconfig-checker github-action lint linter

Last synced: 7 months ago
JSON representation

A GitHub Action for downloading editorconfig-checker by version & adding it to your path, allowing you to lint your files

• Host: GitHub
• URL: https://github.com/kasperhesthaven/setup-editorconfig-checker
• Owner: kasperhesthaven
• License: unlicense
• Created: 2020-09-22T22:25:31.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-09T06:01:01.000Z (almost 3 years ago)
• Last Synced: 2025-03-13T04:21:45.248Z (7 months ago)
• Topics: editorconfig, editorconfig-checker, github-action, lint, linter
• Homepage:
• Size: 15.6 KB
• Stars: 3
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# Setup Editorconfig Checker

[![GitHub release](https://img.shields.io/github/release/kasperhesthaven/setup-editorconfig-checker.svg)](https://gitHub.com/kasperhesthaven/setup-editorconfig-checker/releases/)

[![GitHub license](https://img.shields.io/github/license/kasperhesthaven/setup-editorconfig-checker.svg)](https://github.com/kasperhesthaven/setup-editorconfig-checker/blob/master/LICENSE)

[![Test](https://github.com/kasperhesthaven/setup-editorconfig-checker/actions/workflows/test.yml/badge.svg)](https://github.com/kasperhesthaven/setup-editorconfig-checker/actions/workflows/test.yml)

This GitHub action downloads [editorconfig-checker](https://github.com/editorconfig-checker/editorconfig-checker) by version and adds it to your path, enabling you to lint your files according to your .editorconfig-rules, across multiple file types.

## Inputs

### `version`

**Optional** The desired version of editorconfig-checker. This will be set to the latest GitHub release version if not set.

### `command-name`

**Optional** The name by which editorconfig-checker should be available. This defaults to 'editorconfig-checker'.

## Usage

See [action.yml](action.yml)

Basic:

```yaml

steps:

    - name: Checkout repository

      uses: actions/checkout@v2.3.4

    - name: Install editorconfig-checker

      uses: kasperhesthaven/setup-editorconfig-checker@v1.2.0

      with:

          version: "2.1.0" # (Optional) Defaults to latest if not set

    - name: Lint

      run: editorconfig-checker

```

## License

This project is licensed under the Unlicense license - see the [LICENSE.txt](LICENSE.txt) file for details.