https://github.com/czyzby/wesnoth-wml-linter
A GitHub Action that verifies Wesnoth WML files
https://github.com/czyzby/wesnoth-wml-linter
github-action github-actions github-actions-docker linter wesnoth wesnoth-umc
Last synced: 6 months ago
JSON representation
A GitHub Action that verifies Wesnoth WML files
- Host: GitHub
- URL: https://github.com/czyzby/wesnoth-wml-linter
- Owner: czyzby
- Created: 2022-01-07T01:20:34.000Z (almost 4 years ago)
- Default Branch: latest
- Last Pushed: 2023-12-30T11:11:41.000Z (almost 2 years ago)
- Last Synced: 2025-05-05T20:19:25.362Z (6 months ago)
- Topics: github-action, github-actions, github-actions-docker, linter, wesnoth, wesnoth-umc
- Language: Python
- Homepage:
- Size: 16.6 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WML Linter
A GitHub Action for [Wesnoth](https://www.wesnoth.org/) add-ons.
Verifies format, spelling errors and indentation in WML files using
the official WML tools such as `wmllint` and `wmlindent` from
a partially cloned [Wesnoth repository](https://github.com/wesnoth/wesnoth).
## Usage
Create a `.github/workflows` folder in your GitHub repository.
Add a workflow that triggers this action. For more info, see
the following examples of GitHub workflows.
The Wesnoth version that the WML files are checked against can
be specified with the `wesnoth-version` parameter. It can match
any Wesnoth [branch](https://github.com/wesnoth/wesnoth/branches)
or [tag](https://github.com/wesnoth/wesnoth/tags).
The folder or file that should be validated can be specified with
the `path` parameter. By default, all WML files within the project
will be verified. Note that lists of directories or files separated by
spaces should also be accepted by most versions of the Wesnoth tools.
The `spellcheck` boolean parameter allows `wmllint` to perform
spellchecking with `hunspell` against the `en-US` locale.
Note that spellchecking is turned off by default.
The `lint-flags` and `indent-flags` allow specifying additional
command line flags passed to the `wmllint` and `wmlindent` tools
respectively. See the [maintenance tools](https://wiki.wesnoth.org/Maintenance_tools)
documentation for a complete list of supported flags.
### Examples
A workflow that verifies WML files on every push to the repository,
as well as every pull request:
```yaml
name: lint
on: [push, pull_request]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- name: Repository checkout
uses: actions/checkout@v4
- name: Lint WML
uses: czyzby/wesnoth-wml-linter@v1
```
A workflow that verifies WML files in the `units/` folder against
Wesnoth 1.16 tools on every push or pull request to a specific branch
with spellchecking and a `-K` flag that causes `wmllint` to ignore
certain warnings:
```yaml
name: lint
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- name: Repository checkout
uses: actions/checkout@v4
- name: Lint WML
uses: czyzby/wesnoth-wml-linter@v1
with:
path: units/
wesnoth-version: 1.16
spellcheck: true
lint-flags: -K
```
Some checks in `wmllint` expect that UMC projects are nested under
the `data/add-ons` directory. Depending on where the project is stored,
`wmllint` might yield a different set of warnings. This is an example
of a workflow that checks out the repository to `add-ons/` directory
to explicitly mark a UMC campaign:
```yaml
name: lint
on: [push, pull_request]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- name: Repository checkout
uses: actions/checkout@v4
with:
path: add-ons
- name: Lint WML
uses: czyzby/wesnoth-wml-linter@v1
```
## Notes
Use `@v1` for the latest stable release. Use `@latest` for the latest
version directly from the default development branch.
### See also
* [`czyzby/wesnoth-png-optimizer`](https://github.com/czyzby/wesnoth-png-optimizer):
a GitHub Action that verifies if PNG images are optimized with `woptipng`.
* [`czyzby/wesnoth-wml-scope`](https://github.com/czyzby/wesnoth-wml-scope):
a GitHub Action that verifies project resources with `wmlscope`.