🚀 Feature: Rule options

[JoshuaKGoldberg]

Feature Request Checklist

• I have pulled the latest main branch of the repository.
• I have searched for related issues and found none that matched my issue.

Overview

Lint rules often need to be configured. For example, in pr-linked-issue, requiring a configurable list of labels on the linked issue. OctoGuide will need to allow:

1. Defining a schema of options on a rule
2. Allowing repos to define values for options as with: options

Both the action and CLI will need to read from that file, including fetching it.

Additional Info

I'm envisioning the end user config experience will be like:

jobs:
  octoguide:
    if: ${{ !endsWith(github.actor, '[bot]') }}
    runs-on: ubuntu-latest
    steps:
      - uses: JoshuaKGoldberg/octoguide@v0.1.2
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          rules:
               my-rule:
                    option: true

Rules would then have an options field in their about that's set to an object of Zod schemas:

export const myRule = {
	about: {
		config: "strict",
		// ...
		options: {
			"some-option": z.string().optional()
		},
	},
	// ...
} satisfies Rule;

~Blocked on #19 - implementing an action in the first place.~ ✅ 

🗺 

[cylewaitforit]

I would think the simplest form of options to start with would be enabled/disabled since every rule should be able to be configured for that.

For example excluding a rule from config:

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

Enabling an additional rule not included in a config:

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

And though not currently possible, since right now config is only recommended(default) or strict, but maybe allowing for a clear slate and choosing individual rules.

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

@JoshuaKGoldberg Do you see enable/disable rules as part of this rule options issue or would it be best to create a separate issue for it?

[JoshuaKGoldberg]

Yeah, I think it'd be best to create a separate issue. +1 that it'd be simplest to go with the on/off to start, so a followup issue would be nice for tracking. Pre-emptive status: accepting prs from me :)