📝 Document New Codemod Preferences

[gilday]

Adds codemods.exclude and codemods.prepend to our user facing documentation.

/close #work

[terranosaurus]

I would move this line to either be first in this section, or last. (If first, can remove the markdown and make it the first line in that initial paragraph.) Right now it feels a bit disconnected because we talk about false, then true, then show an example of false.

[gilday]

I struggled a bit with this. In the current version of the docs, we talk about what setting this AI proeprty to true does, then at the end of this section we mention "oh by the way, true is the default". It didn't sit right with me, because it sounds like we're saying "if you do this, then this will happen, but actually that's the default behavior, so if you don't want that then do the opposite of everything I just explained".

So I tried to rewrite it to say "take this action to change the default behavior, and this is the effect". I think your recommendation to simply move the "true is the default" to be first in the section gets us there. I'm going to make that change now.

[terranosaurus]

Is this intended to cover general includes, or is it a separate thing in addition to an include list?

[gilday]

We don't have a (documented) include list. We have an undocumented additional_codemods list that prepends the list to the default catalog. This new, documented prepend property supplants the undocumented additional_codemods property and has the same behavior.

Order matters, so I don't foresee us ever adding a general include: it's too ambiguous about where the codemods are being inserted into the default catalog. I could see us adding an append to complement the prepend.