is-what
is-what copied to clipboard
[Discussion] Consider ESM-only for v5?
Popular opensource guru sindresorhus has done this https://github.com/sindresorhus/meta/discussions/15 https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
I think that this is a good step to avoid the dual package hazard: #37
@mesqueeb I've been working on various things all-at-once in the https://github.com/mesqueeb/is-what/tree/jcbhmr branch. Just thought I'd let you know. 😊 I hope to be able to break that branch into multiple "feature-ish" PRs to be considered somewhat independently.
https://github.com/mesqueeb/is-what/tree/jcbhmr does these things:
- [x] Split index.ts into multiple files
- [x] Add a bunch of documentation for some of the functions (still have more to do)
- [x] Remove useless "isMap() detects if the value is a Map" comments
- [x] Remove redundant JSDoc
@paramdeclarations (already typed by TS) - [x] Remove
dist/from source control - [x] Automate deployments to https://deno.land/x/is_what via tags on a separate
buildbranch #53 - [x] Improve separation of concerns with publishing workflows #40
- [x] Add a docs preview action to give a
.zipof what would be deployed - [x] Add more tests (a LOT more tests)
- [x] OPINION/OPTIONAL: Reset to default Prettier configuration. Defaults are good. I like defaults.
- [x] Put prettier in package.json (before I eventually removed it and used the defaults)
- [x] Add a JSDoc prettier plugin #45
- [x] Add a JSDoc package.json plugin #45
- [x] Add TSX as a dev dep #44
- [x] Use
node --testandnode:testfor test running #44 - [x] Add a prettier pre-format hook
- [x] DISCOURAGE local
npm publishby removing thenphelper #40 - [x] Use plain
tscinstead of rollup #44 - [x] ONLY provide .js (no .cjs) for ESM-only package #47 #37
- [x] Revamp readme to shift docs to the docs website (it's shorter)
- [x] Improve readme with images
- [x] Remove .github/FUNDING.yml with the expectation that it will be moved to mesqueeb/.github
any probably more stuff to come! Bear in mind that this https://github.com/mesqueeb/is-what/tree/jcbhmr WILL NOT BE MERGED INTO MAIN but instead is my "playground" 🪀 that I want to show off and get feedback on 😊
Don't run too fast because it'll be harder to communicate about how we feel about each change 😅
Discussion regarding to the last post's todos can be continued here: https://github.com/mesqueeb/is-what/pull/57 → Do you want me to address each of your todos with my opinion?
Discussion regarding to the ESM only can be continued here: https://github.com/mesqueeb/is-what/pull/55