Skip to content

🚀 Feature: enable/disable individual rules #219

@cylewaitforit

Description

@cylewaitforit

Feature Request Checklist

Overview

Every rule should be able to be configured to be enabled/disabled.

For example excluding a rule that is enabled by from config preset:

jobs:
  octoguide:
    if: ${{ !endsWith(github.actor, '[bot]') }}
    runs-on: ubuntu-latest
    steps:
      - uses: JoshuaKGoldberg/[email protected]
        with:
          config: strict
+         pr-linked-issue: false
          github-token: ${{ secrets.GITHUB_TOKEN }}

Enabling an additional rule not included in a config preset:

jobs:
  octoguide:
    if: ${{ !endsWith(github.actor, '[bot]') }}
    runs-on: ubuntu-latest
    steps:
      - uses: JoshuaKGoldberg/[email protected]
        with:
          config: recommended
+         pr-title-conventional: true
          github-token: ${{ secrets.GITHUB_TOKEN }}

And allowing for a clear slate and choosing individual rules.

jobs:
  octoguide:
    if: ${{ !endsWith(github.actor, '[bot]') }}
    runs-on: ubuntu-latest
    steps:
      - uses: JoshuaKGoldberg/[email protected]
        with:
+         config: none
+         pr-title-conventional: true
+         comment-meaningless: true
+         pr-body-not-empty: true
          github-token: ${{ secrets.GITHUB_TOKEN }}

Additional Info

Recommended should remain the default config preset. It should be explicitly set to none to have no config set to start.

Related Issue: #20

Metadata

Metadata

Assignees

No one assigned

    Labels

    status: accepting prsPlease, send a pull request to resolve this! 🙏type: featureNew enhancement or request 🚀

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions