Maintenance TODO List

[lishaduck]

I plan on getting to all of these someday, but, as this is a rather long list, I don't mind if anyone wants to do some.

Now

Now that I'm back from hiatus, I'm slowly getting around to fixing some review feedback and stuff.

• GHA Improvements #173

Soon

• Bump Prettier to v3
• Add a GitHub action to release a new package version #57

Relatively soon

• ESLint Improvements #172
• Testing Improvements #176
• Clean up new-package/ #178
• Leaner Dependencies #223

Someday

• Run Knip on the codebase to find unused code (requires Node 18)
• ESM #171
• Public API #170
• Create a standalone exe version of elm-review #136
• Typecheck Elm templates #194

Complete

• Land ESLint #168
• Refactor help messages (Help refactor #174)
• Improve shell scripts #193
• Enable incremental TypeScript checking #218
• Refactor the npx replacement #236
• Run npm dedupe to clean up the package-lock.json (Bump deps #256)
• JSDoc Updates #165 (comment) / JSDoc @import not detecting use in @callback microsoft/TypeScript#58368 (comment) → Sort requires #290
• Add types to JS files #125
• TS Check, Lint, and Format new-package/ and vendor/ #187 (comment)
• GHA Updates #186 (comment)

[jfmengels]

These all sound good to me.

I don't know if we want a shrinkwrap though. Back in the days that was only recommended for applications. I haven't heard of that advice changing but I may not be up to date.

Maybe let's create separate issues for most of these? At least the ones marked as relatively doon and later?

[jfmengels]

I don't know if we want a shrinkwrap though. Back in the days that was only recommended for applications. I haven't heard of that advice changing but I may not be up to date.

I was thinking of elm-review as an application (it's not a library, so 🤷‍♂️).

Right, but unless we ship a single binary, the dependencies enforced by our shrinkwrap will likely not be the ones that a user downloads when they download elm-review, since our shrinkwrap will not be evaluated. The shrinkwrap in the repo would only be used for development purposes.

[lishaduck]

Oh, just a small FYI: I've been focusing on some other OSS work recently, and I've just about finished it; however I've been working on my school Mac, but I'll have to return it soon, after which I'll be an old, slow Windows machine. Therefore, I'll probably stop helping out until mid-August. I'll still be around if you need to @mention me, but I probably won't be writing any new PRs (or rebasing old ones).
Have a nice month! "See" you laterish.

[jfmengels]

@lishaduck That is absolutely fine. Thank you for the huge amount of work you put in the project, I highly appreciate it ❤️
And you can come back whenever you want 😄

[lishaduck]

That is absolutely fine.

Yeah, I just didn't want to seem like I was leaving a bunch of stuff unfinished, I'm just on a brief hiatus.

Thank you for the huge amount of work you put in the project, I highly appreciate it ❤️

Thanks. I, too, appreciate that.

Bye from a Windows box!

P.S.: If you need Windows testing in the next month or so, just ping me :)