eslint-plugin-github-action

Rules for consistent, readable and valid GitHub action files.

[!WARNING] This plugin is Work In Progress. API may change at every release. Please use with caution.

Install

npm install eslint-plugin-github-action -D

yarn add eslint-plugin-github-action -D

pnpm add eslint-plugin-github-action -D

Usage

Config in ESLint config files:

import pluginGitHubAction from 'eslint-plugin-github-action'

/**
 * @type {import('eslint').Linter.Config[]}
 */
export default [
  ...pluginGitHubAction.configs.recommended,
  // Other configs...
]

:apple: For advanced usaged, please check Advanced Usage

Rules

💼 Configurations enabled in.
✅ Set in the recommended preset.
🔧 Automatically fixable by the --fix CLI option.
💡 Manually fixable by editor suggestions.

| Name | Description | 💼 | 🔧 | 💡 | | :------------------------------------------------------------------------------------------------------------ | :---------------------------------------- | :-: | :-: | :-: | | action-name-casing | enforce naming convention to action name. | | 🔧 | | | job-id-casing | enforce naming convention to job id. | | | | | max-jobs-per-action | enforce maximum jobs per action file. | | | | | no-top-level-permissions | Disallow using top level permissions. | | | | | require-action-name | require action name to be set. | ✅ | | |

Links

• GitHub Actions documentation
• Understanding the workflow file
• Workflow syntax for GitHub Actions

License

MIT License © 2024-PRESENT ntnyq