Skip to content

V3 #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
nonara wants to merge 2 commits into from
Closed

V3 #95

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
513bfae
docs: Added `typia` to examples
samchon Jan 6, 2023
6977aa9
docs(readme): Added ts v5 note
nonara Mar 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 11 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,16 @@ Directly patch typescript installation to allow custom transformers (plugins).
- Plugins are specified in `tsconfig.json`, or provided programmatically in `CompilerOptions`.
- Based on [ttypescript](https://github.com/cevek/ttypescript) - Fully compatible + offers more features

## TypeScript v5 Note

TS v5 has made some fundamental changes which affect the current process. As a result, it is not yet supported.

We're working on adding support. More notes on that here:

- [Issue #93 — Not working with TypeScript v5 (author's note)](https://github.com/nonara/ts-patch/issues/93)

## Features
* Patch / unpatch any version of typescript (4.0+)
* Patch / unpatch any version of typescript (4.*)
* Advanced options for patching individual libraries, specific locations, etc. (see `ts-patch /?`)
* _(New)_ Supports 'transforming' the `Program` instance during creation. (see: [Transforming Program](#transforming-program))
* _(New)_ Add, remove, or modify diagnostics! (see: [Altering Diagnostics](#altering-diagnostics))
Expand Down Expand Up @@ -40,18 +48,6 @@ ts-patch install
}
```

## Rewrite Coming Soon...

With a couple years of hindsight, it's time for a much needed redesign to make a more complete plugin ecosystem! The new
design will also be friendlier for the various package management apps.

Development is already underway, but my time to work on it is limited! To follow progress, see [this discussion](https://github.com/nonara/ts-patch/discussions/40).

Notes —
- The new version will be a major release
- It will still support all legacy packages and config
- Previous major version will be maintained and patched for any issues for at least one year

## Table of Contents
- [Configuring](#configuring)
- [tsconfig.json](#tsconfigjson)
Expand Down Expand Up @@ -201,6 +197,8 @@ export default function(program: ts.Program, pluginOptions: any) {

[`{ transform: "ts-transformer-minify-privates" }`](https://github.com/timocov/ts-transformer-minify-privates)

[`{ transform: "typia/lib/transform" }`](https://github.com/samchon/typia)

### Transforming Program

Sometimes you want to do more than just transform source code. For example you may want to:
Expand Down