github-action/action-name-casing

Enforce naming convention to action name.

• 💼 This rule is enabled in the ✅ recommended config.

• 🔧 The --fix option on the command line can automatically fix some of the problems reported by this rule.

📖 Rule Details

This rule enforces the consistent case usage of action names.

name: Unit Test

correct

# camelCase
name: unitTest

incorrect

# kebab-case
name: unit-test

incorrect

# PascalCase
name: UnitTest

incorrect

# snake_case
name: unit_test

incorrect

# Train-Case
name: Unit-Test

incorrect

# SCREAMING_SNAKE_CASE
name: UNIT_TEST

incorrect

🔧 Options

Default casing is set to TitleCase.

type ActionNameCasingOptions = [
  'error' | 'warn' | 'off' | 2 | 1 | 0,
  (
    | 'camelCase'
    | 'kebab-case'
    | 'PascalCase'
    | 'snake_case'
    | 'Title Case'
    | 'Train-Case'
    | 'SCREAMING_SNAKE_CASE'
  ),
]

"Title Case" (default)

Examples of correct code for this rule with default option:

name: Unit Test

Examples of incorrect code for this rule with default option:

correct

# camelCase
name: unitTest

incorrect

# kebab-case
name: unit-test

incorrect

# PascalCase
name: UnitTest

incorrect

# snake_case
name: unit_test

incorrect

# Train-Case
name: Unit-Test

incorrect

# SCREAMING_SNAKE_CASE
name: UNIT_TEST

incorrect

"kebab-case"

Examples of correct code for this rule with "kebab-case" option:

name: unit-test

Examples of incorrect code for this rule with "kebab-case" option:

correct

# camelCase
name: unitTest

incorrect

# PascalCase
name: UnitTest

incorrect

# snake_case
name: unit_test

incorrect

# Title Case
name: unit-test

incorrect

# Train-Case
name: Unit-Test

incorrect

# SCREAMING_SNAKE_CASE
name: UNIT_TEST

incorrect

🚀 Version

This rule was introduced in eslint-plugin-github-action v0.0.2

🔍 Implementation

• Rule source
• Test source