pastelmind / kolmafia-types Goto Github PK

In #20, I added a custom test script (run-tests.ts) to work around a limitation in tsd, our testing tool. Because tsd 0.14.0 does not support the typesVersions property in package.json, it cannot find our typings when invoked from the shell. Since it does not provide any mechanism for specifying a custom type source, we need to temporarily supply a types field in package.json.

To work around this, I wrote a tiny Node.js script (run-tests.ts) that monkey-patches package.json with a types field before running tsd, then restore the original afterwards. I also installed ts-node to avoid an extra compile step when running the script.

The main branch of tsd has recently gained support for custom type sources. Another PR adds an accompanying CLI option for this. If the next release of tsd includes these changes, we may be able to replace this script with an invocation of tsd --typings-file src/index.d.ts.

TODO

• Wait for a new release of tsd
• Update tsd
• Replace custom test script and invoke tsd from the command line instead
• Remove ts-node and/or @types/node

Node.js v10 reaches EOL on 2021-04-30.

Things to do:

• Remove v10 from all GitHub workflows (#28)

This is a tracking issue.

There are 690 KoLmafia library functions as of r20673 (overloaded forms are counted separately). Documenting them all is a mountainous task and may take several months.

I'm going to tackle them by dividing them into groups, each starting with an English letter:

Progress

• Functions that start with 'A' (28)
• Functions that start with 'B' (24)
• Functions that start with 'C' (50) (2972038)
• Functions that start with 'D' (19)
• Functions that start with 'E' (35) (#19)
• Functions that start with 'F' (20)
• Functions that start with 'G' (50)
• Functions that start with 'H' (22)
• Functions that start with 'I' (44)
• Functions that start with 'J' (8)
• Functions that start with 'K' (2)
• Functions that start with 'L' (16)
• Functions that start with 'M' (98)
• Functions that start with 'N' (10)
• Functions that start with 'O' (6)
• Functions that start with 'P' (45)
• Functions that start with 'Q' (0)
• Functions that start with 'R' (36)
• Functions that start with 'S' (54)
• Functions that start with 'T' (86)
• Functions that start with 'U' (16)
• Functions that start with 'V' (9)
• Functions that start with 'W' (11)
• Functions that start with 'X' (1)
• Functions that start with 'Y' (0)
• Functions that start with 'Z' (0)