feat(new-rule): ibm-operation-summary-length

dpopp07 commented 4 months ago

PR summary

Adds a rule that verifies operation summaries are 80 characters or less in length, based on the summary writing guidance in the API Handbook.

A question for the PR reviewers. We already have these existing rules:

ibm-operation-summary (checks that a summary exists on every operation)
ibm-summary-sentence-style (checks that a summary does not end with a period)

Should this check be merged into one of the existing rules or does it belong as its own rule? The granularity is nice for configuration but it might be confusing to have too many rules doing such similar things. What do y'all think?

PR Checklist

General checklist

Please make sure that your PR fulfills the following requirements:

[x] The commit message follows the Angular Commit Message Guidelines.
[x] Tests for the changes have been added (for bug fixes / features)
[x] Docs have been added / updated (for bug fixes / features)
[x] Dependencies have been updated as needed
[x] .secrets.baseline updated as needed?

Checklist for adding a new validation rule:

[x] Added new validation rule definition (packages/ruleset/src/rules/*.js, index.js)
[x] If necessary, added new validation rule implementation (packages/ruleset/src/functions/*.js, updated index.js)
[x] Added new rule to default configuration (packages/ruleset/src/ibm-oas.js)
[x] Added tests for new rule (packages/ruleset/test/*.test.js)
[x] Added docs for new rule (docs/ibm-cloud-rules.md)