Road to v1

[bluwy]

Making publint v1 has been long overdue, mostly because the current abstraction isn't what I think considered "stable". Rules are intentionally written inline and clumsily, as it was easier to prototype and think less about internal structure organization.

For v1, I’d like to focus on extensibility, correctness, and better code structure. This will include:

• Rewrite to TypeScript
• Use changesets
• New context option (Lint environment #19)
  • Better environment detection before falling back to context, e.g. analyzing export condition names and "engines" field.
• New pack option (Update npm-packlist #11)
• New plugin API (Plugins #101)
  • Rewrite internal rules as individual plugins
• Better programmatic API

I'd also like to move this repo under an org to build up a community around it.

• https://github.com/publint (I'll move the repo here after the initial v1 work is merged into main)
• https://www.npmjs.com/org/publint (For future packages)

Additionally, I'd like to improve the site experience (#100), but that may take even longer and is not part of the v1 timeline.

While I also foresee this increasing the package size sizably, as long as the total dependency tree doesn't exceed like 1MB, I think it's still acceptable.

Timeline

- 19 July 2024: v1 beta
- 2 August 2024: v1 stable

• By end of 2024: Setup changesets and move to publint github org
• Start of 2024: Tackle Update npm-packlist #11 (new breaking minor likely required)

(See update: #99 (comment))

Help

At the moment, I'd like to explore the initial set of features and re-organization myself. Once a beta is ready, all feedback are welcomed. Currently I've done an initial prototype at https://github.com/bluwy/publint/tree/v1-wip

With the new plugin API, I may also need help building some core plugins that handle more cases from feature requests. I'd also want to make sure https://github.com/kravetsone/vscode-publint still works fine.

[Greenheart]

Thanks for working on this! It's provided good feedback to help me improve some of my packages ☺️

[bluwy]

I've obviously been slacking off but I think it's because I've been trying to take on too much at once. In the next few days, I'll tackle this partly first by migrating to changesets and moving the repo under the publint github org. And then I'll tackle #11 individually which requires some attention in the short term. I think all these will coincide nicely with 1k stars soon 🙂