Consolidate descriptions linter functions into one

[queengooborg]

Now that the descriptions linter has been merged (yay!), I'm opening up this PR to consolidate the code a little bit. Essentially, this PR consolidates the four functions testing for each type of description into a single function, which calls out to another function that performs both the check and the logger output based upon a set of arguments. This is to help keep the number of code lines to a minimum, and reduce the number of iterations through data the linter must perform.

I'm open to suggestions or revisions!

[ddbeck]

Hi @queengooborg, Florian and I talked about this in our most recent 1:1 (we're trying to get back in the habit of unblocking old PRs). It's not that we don't want to see the speed up here, but we're skittish about making changes to the linter, especially multiple changes at once (in here we've got style changes, a structural change, and what looks to be some jsdoc changes—it's not clear they're all strictly dependent on each other).

I don't think we can merge this as is, so I propose closing this and approaching these things from a different angle.

Looking forward, we've got three suggestions:

• If you've got a change to the existing scripts, linters, etc., then they should be as small as possible. More PRs that do as little as possible is preferable. Counter-intuitive, but true.
• If an existing linting needs to change, then it should be accompanied by some tests (with refactoring as needed to make something testable—see Fix preview consistency check #12673 for an example).
• If there's new linting to be done, then it should be implemented as a standalone test (for now, as in spec-urls.test.js) or as part of the new linting architecture (an issue for which I still owe you, I think).

Let me know if there's any questions about this. Thank you!

[queengooborg]

I just saw this PR was closed. I can understand the desire to keep changesets as small as possible, but to be honest, I don't see much room for stripping changes out. There are a couple of things I could split into other PRs like the JSDoc and formatting changes to the main entry point, but the rest of the PR contains changes that all go together.

The problem I'm trying to solve with this PR is that right now, we have repeated lines of code for the same operation, causing us to iterate through the data multiple times. What I'm attempting to do here is instead simplify this by introducing one function to iterate through the data and determine the parameters needed, which is then passed to another function that performs the check and logs any discrepancies. While adding these new functions and replacing the old, I'm also describing them in JSDoc to give a more complete PR so we don't have to bother following up later.

Basically, all of the changes between lines 9 and 101, along with lines 110 through 125 (all on the "before" side) are all related and can't be cherry-picked, at least not in a sensible way. The changes on other lines were included because they're so small on their own, they don't really warrant a separate PR, and we're already here working on this file.

[caugner]

LGTM, just some nits.

[caugner]

One last follow-up nit, but still looking good, of course.

[github-actions]

This pull request has merge conflicts that must be resolved before we can merge this.