literate-ts

What's Changed

This is the version of literate-ts that I used to verify the second edition of Effective TypeScript and extract the code samples and playground URLs for its companion repo.

• feat: match error spans by @danvk in https://github.com/danvk/literate-ts/pull/297
• Generate code samples for repo by @danvk in https://github.com/danvk/literate-ts/pull/314
• Many dependency updates and adjustments to testing infrastructure

Full Changelog: https://github.com/danvk/literate-ts/compare/v2.4.0...v2.5.0

What's Changed

New features:

• Support Node.js 20+ by @danvk in https://github.com/danvk/literate-ts/pull/256
• Throw on duplicate IDs by @danvk in https://github.com/danvk/literate-ts/pull/257
• Check emitted JS by @danvk in https://github.com/danvk/literate-ts/pull/260
• Check for line length by @danvk in https://github.com/danvk/literate-ts/pull/261
• Allow named values for tsconfig enums by @danvk in https://github.com/danvk/literate-ts/pull/262

Also many dependency updates.

Full Changelog: https://github.com/danvk/literate-ts/compare/v2.3.0...v2.4.0

What's Changed

📘 With any luck, this will be the version used to check the second edition of Effective TypeScript.

New features:

• Add prepended files to TS Program by @danvk in https://github.com/danvk/literate-ts/pull/215
• Allow ellipsis in expected types by @danvk in https://github.com/danvk/literate-ts/pull/248
• Add example with top level await by @danvk in https://github.com/danvk/literate-ts/pull/250
• Support "equivalent to" for values by @danvk in https://github.com/danvk/literate-ts/pull/252
• feat: special syntax for start-of-line errors by @danvk in https://github.com/danvk/literate-ts/pull/255
• A smattering of bug fixes and features by @danvk in https://github.com/danvk/literate-ts/pull/180
  • Warn about active prefixes with JSON sources (maybe they should be ignored).
  • Allow a trailing undefined in program listings
  • Allow prepend-as-file to write to subdirectories and honor that name when the sample itself is being checked.

Bug fixes:

• Strip filename from Node stack traces by @danvk in https://github.com/danvk/literate-ts/pull/216
• Handle named function types specially in matchModuloWhitespace by @danvk in https://github.com/danvk/literate-ts/pull/214
• Extract type assertions without a scanner by @danvk in https://github.com/danvk/literate-ts/pull/223
• fix: check type assertions involving arrow functions by @danvk in https://github.com/danvk/literate-ts/pull/237
• Fix mysterious node_modules bug by @danvk in https://github.com/danvk/literate-ts/pull/224
• fix: be stricter about continuation lines for twoslash by @danvk in https://github.com/danvk/literate-ts/pull/253
• fix: always run type assertion tests, add test for DOM augmentation by @danvk in https://github.com/danvk/literate-ts/pull/254

Also many dependency updates.

Full Changelog: https://github.com/danvk/literate-ts/compare/v2.2.0...v2.3.0

What's Changed

New features:

• The include-node-module directive now include transitive dependencies (https://github.com/danvk/literate-ts/pull/143)
• "type equivalent to" assertions to "resolve" opaque-looking types like keyof T (https://github.com/danvk/literate-ts/pull/145)
• Test node REPL "program listings" (https://github.com/danvk/literate-ts/pull/148, https://github.com/danvk/literate-ts/pull/149)
• The new prepend-as-file directive lets you verify code involving imports (https://github.com/danvk/literate-ts/pull/150)
• JSON/JSONC sources are verified and can be imported in code samples (https://github.com/danvk/literate-ts/pull/151)

Bug fixes:

• Fix a crashing bug in matchModuleWhitespace() by @danvk in https://github.com/danvk/literate-ts/pull/138
• Clamp error spans to source code block by @danvk in https://github.com/danvk/literate-ts/pull/107
• Simplify and clarify --filter behavior by @danvk in https://github.com/danvk/literate-ts/pull/141
• Empty twoslash assertions should fail by @danvk in https://github.com/danvk/literate-ts/pull/146
• Support verify+skip by @danvk in https://github.com/danvk/literate-ts/pull/147
• Precise error spans for twoslash assertions by @danvk in https://github.com/danvk/literate-ts/pull/142

Various dependency updates:

• Update typescript-eslint monorepo to v6.3.0 by @renovate in https://github.com/danvk/literate-ts/pull/108
• Update dependency @types/node to v18.17.4 by @renovate in https://github.com/danvk/literate-ts/pull/110
• Update dependency @types/lodash to v4.14.197 by @renovate in https://github.com/danvk/literate-ts/pull/111
• Update actions/setup-node action to v3.8.0 by @renovate in https://github.com/danvk/literate-ts/pull/112
• Update dependency eslint to v8.47.0 by @renovate in https://github.com/danvk/literate-ts/pull/113
• Update typescript-eslint monorepo to v6.4.0 by @renovate in https://github.com/danvk/literate-ts/pull/114
• Update actions/setup-node action to v3.8.1 by @renovate in https://github.com/danvk/literate-ts/pull/115
• Update dependency prettier to v3.0.2 by @renovate in https://github.com/danvk/literate-ts/pull/116
• Update dependency @types/node to v18.17.6 by @renovate in https://github.com/danvk/literate-ts/pull/118
• Update dependency find-cache-dir to v5 by @renovate in https://github.com/danvk/literate-ts/pull/119
• Update dependency jest to v29.6.3 by @renovate in https://github.com/danvk/literate-ts/pull/120
• Update typescript-eslint monorepo to v6.4.1 by @renovate in https://github.com/danvk/literate-ts/pull/121
• Update dependency @types/node to v18.17.7 by @renovate in https://github.com/danvk/literate-ts/pull/122
• Update dependency @types/jest to v29.5.4 by @renovate in https://github.com/danvk/literate-ts/pull/123
• Update dependency read-pkg-up to v10.1.0 by @renovate in https://github.com/danvk/literate-ts/pull/124
• Update dependency typescript to v5.2.2 by @renovate in https://github.com/danvk/literate-ts/pull/126
• Update dependency eslint to v8.48.0 by @renovate in https://github.com/danvk/literate-ts/pull/127
• Update dependency @types/node to v18.17.12 by @renovate in https://github.com/danvk/literate-ts/pull/128
• Update typescript-eslint monorepo to v6.5.0 by @renovate in https://github.com/danvk/literate-ts/pull/129
• Update dependency prettier to v3.0.3 by @renovate in https://github.com/danvk/literate-ts/pull/130
• Update actions/checkout action to v4 by @renovate in https://github.com/danvk/literate-ts/pull/133
• Update dependency @types/node to v18.17.14 by @renovate in https://github.com/danvk/literate-ts/pull/131
• Update typescript-eslint monorepo to v6.6.0 by @renovate in https://github.com/danvk/literate-ts/pull/134
• Update dependency @types/lodash to v4.14.198 by @renovate in https://github.com/danvk/literate-ts/pull/140
• Update dependency eslint to v8.49.0 by @renovate in https://github.com/danvk/literate-ts/pull/144

Full Changelog: https://github.com/danvk/literate-ts/compare/v2.1.0...v2.2.0

What's Changed

• Two new directives: replace-with-id and prepend-subset-of-id-to-following
• Report precise error spans for much better error highlighting in your editor

• Inline replacements by @danvk in https://github.com/danvk/literate-ts/pull/102
• Add prepend-subset-of-id-to-following directive by @danvk in https://github.com/danvk/literate-ts/pull/103
• Report error spans in code samples by @danvk in https://github.com/danvk/literate-ts/pull/104

Full Changelog: https://github.com/danvk/literate-ts/compare/v2.0.0...v2.1.0

What's Changed

Major changes:

• literate-ts now uses an on-disk cache. This results in dramatic speedups when you repeatedly run literate-ts on the same set of files with only a few changes. You can bypass the cache with --nocache and delete it with rm -rf node_modules/.cache/literate-ts.
• literate-ts now uses ES modules. You'll need to use a version of Node that supports them.
• literate-ts can now be run inside VS Code as a task to highlight problems inline in your document.

All changes

• Add an on-disk cache by @danvk in https://github.com/danvk/literate-ts/pull/63
• Update to use ES Modules by @danvk in https://github.com/danvk/literate-ts/pull/64
• Bump word-wrap from 1.2.3 to 1.2.4 by @dependabot in https://github.com/danvk/literate-ts/pull/58
• Bump semver from 5.7.1 to 5.7.2 by @dependabot in https://github.com/danvk/literate-ts/pull/57
• Bump ansi-regex from 4.1.0 to 4.1.1 by @dependabot in https://github.com/danvk/literate-ts/pull/65
• Documentation updates by @danvk in https://github.com/danvk/literate-ts/pull/66
• Configure Renovate by @renovate in https://github.com/danvk/literate-ts/pull/67
• Update dependency @types/fs-extra to v8.1.2 by @renovate in https://github.com/danvk/literate-ts/pull/68
• Update dependency @types/lodash to v4.14.196 by @renovate in https://github.com/danvk/literate-ts/pull/69
• Update dependency @types/yargs to v13.0.12 by @renovate in https://github.com/danvk/literate-ts/pull/72
• Update actions/setup-node action to v3.7.0 by @renovate in https://github.com/danvk/literate-ts/pull/73
• Update dependency eslint-config-prettier to v6.15.0 by @renovate in https://github.com/danvk/literate-ts/pull/74
• Update dependency eslint-plugin-prettier to v3.4.1 by @renovate in https://github.com/danvk/literate-ts/pull/75
• Update dependency glob to v7.2.3 by @renovate in https://github.com/danvk/literate-ts/pull/76
• Set up knip and remove unused dependencies by @danvk in https://github.com/danvk/literate-ts/pull/80
• Update dependency tmp to ^0.2.0 by @renovate in https://github.com/danvk/literate-ts/pull/77
• Add a few badges by @danvk in https://github.com/danvk/literate-ts/pull/83
• Update actions/checkout action to v3 by @renovate in https://github.com/danvk/literate-ts/pull/78
• Update ts-node version to support ESM by @danvk in https://github.com/danvk/literate-ts/pull/85
• Update dependency @types/glob to v8 by @renovate in https://github.com/danvk/literate-ts/pull/79
• Improve display for absolute paths by @danvk in https://github.com/danvk/literate-ts/pull/89
• Update dependency @types/jest to v29 by @renovate in https://github.com/danvk/literate-ts/pull/81
• Update dependency @types/node to v18 by @renovate in https://github.com/danvk/literate-ts/pull/82
• Update dependency fs-extra to v11 by @renovate in https://github.com/danvk/literate-ts/pull/90
• Update dependency ora to v7 by @renovate in https://github.com/danvk/literate-ts/pull/92
• Update dependency yargs to v17 by @renovate in https://github.com/danvk/literate-ts/pull/94
• Update dependency prettier to v3 by @renovate in https://github.com/danvk/literate-ts/pull/93
• Update typescript-eslint monorepo to v6 (major) by @renovate in https://github.com/danvk/literate-ts/pull/95
• Switch from glob -> fast-glob by @danvk in https://github.com/danvk/literate-ts/pull/97
• Misc fixes for 2.0 release by @danvk in https://github.com/danvk/literate-ts/pull/98

New Contributors

• @renovate made their first contribution in https://github.com/danvk/literate-ts/pull/67

Full Changelog: https://github.com/danvk/literate-ts/compare/v1.3.0...v2.0.0

What's Changed

• Add support for Twoslash assertions by @danvk in https://github.com/danvk/literate-ts/pull/61
• Update TypeScript, Jest, ts-jest by @danvk in https://github.com/danvk/literate-ts/pull/60

• Update dependencies
• Add triple-tick codeblock support to asciidoc processor (#36) thanks @JoshuaKGoldberg!
• Document CLI flags in README.md (#46) thanks @JoshuaKGoldberg!
• Print failures as filename:line (#37 / #54) thanks @JoshuaKGoldberg!
• Switch from CircleCI → GitHub Actions and set up Code Coverage (currently at 63.29%)
• Fixes for error messages in recent Node.js versions (#53)

First version on npm.