https://github.com/roang-zero1/factorio-mod-luacheck

Run a Factorio mod source through luacheck
https://github.com/roang-zero1/factorio-mod-luacheck

actions ci continuous-integration factorio linting lua

Last synced: 23 days ago
JSON representation

Run a Factorio mod source through luacheck

• Host: GitHub
• URL: https://github.com/roang-zero1/factorio-mod-luacheck
• Owner: Roang-zero1
• License: mit
• Created: 2019-06-14T01:43:43.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-12-05T10:27:50.000Z (almost 4 years ago)
• Last Synced: 2024-10-10T17:33:48.842Z (about 1 month ago)
• Topics: actions, ci, continuous-integration, factorio, linting, lua
• Language: Shell
• Size: 12.7 KB
• Stars: 10
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub Action for luacheck

[![release badge][release status]][release workflow]

This action will run your mod code through [luacheck](https://github.com/mpeterv/luacheck).

## Usage

This action can be used with a repository contain a Factorio mod at base level.

The action can be used as follows:

```yaml

on: push

name: Check & Release

jobs:

  lint:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@master

      - name: lint

        uses: Roang-zero1/factorio-mod-luacheck@master

        with:

          luacheckrc_url: https://raw.githubusercontent.com/Nexela/Factorio-luacheckrc/0.17/.luacheckrc

```

## Sample Workflow

A sample workflow that uses this action can be found at [Roang-zero1/factorio-mod-actions](https://github.com/Roang-zero1/factorio-mod-actions/blob/master/sample/push-check-release.yml)

## Inputs

### `luacheckrc_url`

URL to the luacheckrc configuration file to be used during checking.  

**Default**: 

If you assign an empty string "" the .luacheck file from the working tree will be used.

## Recommended luacheckrc

For current luacheckrc to use with factorio I recommend [Nexela/Factorio-luacheckrc](https://github.com/Nexela/Factorio-luacheckrc)

[release status]: https://github.com/Roang-zero1/factorio-mod-luacheck/workflows/Check%20&%20Release/badge.svg

[release workflow]: https://github.com/Roang-zero1/factorio-mod-luacheck/actions