Release 2.3.0

[moonglum]

• This uses the new utils that static exposes. Works really well, and removes a lot of code from this package that has nothing to do with image compression. With this, it is compatible with both core 2 and 3.
• In the first attempt, I tried to add JSDoc comments type checked by TypeScript. But this failed, as JSDoc comments can't import types from another package. I kept the JSDoc comments that still made sense to me.

[FND]

This looks promising indeed! 👍

@import not supporting third-party types is indeed baffling and somewhat concerning. As a workaround, we could import and re-export those types in types.ts though?

Some of the suggested changes from faucet-pipeline/faucet-pipeline-static#71 apply here as well (e.g. Y U NO ESM, explicit paths with ./, TypeScript configuration, @import formatting), but I opted not to add redundant noise here while we're still discussing such nuances over there.

[FND]

@ts-expect-error perhaps? But yeah, annoying...

Also, you might want to use repr in such error messages. (Same elsewhere, possibly also in faucet-static? I don't recall at this moment.)

[FND]

YMMV, but destructuring could make this a little less verbose and thus more readable?

let { width, height } = await image.metadata();
if(width && height) {
	image.resize({
		width: width * scale,
		height: height * scale
	});
}

In fact, this made me realize a potential bug: Should we worry about zero values in that if statement? You never know what kind of weird input people have...

[FND]

As a ranty comment, this seemed fine - as a docstring, it seems more confusing than helpful? At least I had to spend a few cycles trying to decode the intent here.

However, I believe faucet-static does the same thing, so perhaps that should become a reusable utility (i.e. it shouldn't be inlined after all 🙈 )?

[moonglum]

@import not supporting third-party types is indeed baffling and somewhat concerning. As a workaround, we could import and re-export those types in types.ts though?

You misunderstood that. The types I'm importing are in faucet-pipeline-static/lib/types.ts. But you can't import them from a comment... 😭 For me, this puts a giant question mark into the "TS Doc" effort in these two projects, and I'm considering removing the TS stuff in both...

[FND]

I've created a minimal test case for the JSDoc imports issue:

src/index.js

/** @type {Sample} */
let data = {
	abc: 123,
	def: 456,
	ghi: "…"
};
console.log(data);

/** @import { Sample } from "sample/src/index.types.ts" */

node_modules/sample/src/index.types.ts

export type Sample = Record<string, number>;

tsconfig.json

{
    "compilerOptions": {
        "allowJs": true,
        "checkJs": true,
        "noEmit": true,
        "strict": true,
        "erasableSyntaxOnly": true,
        "isolatedModules": true,
        "allowImportingTsExtensions": true
    }
}

$ npm install typescript
$ ./node_modules/.bin/tsc -p ./tsconfig.json
src/index.js:5:2 - error TS2322: Type 'string' is not assignable to type 'number'.

5  ghi: "…"
   ~~~

Found 1 error in src/index.js:5

That seems to work as expected - what am I missing?