diff --git a/README.md b/README.md index f3cebd6..4d214d1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # TypeScript Erasable Codemod +**Disclaimer: This is under very initial development and is not ready at all for +use. Contributions and feedback are very welcome still though 🙌** + Hi! This is `tsec`, the codemod tool for automatically migrating your code to be compatible with TypeScript's [erasableSyntaxOnly](https://www.typescriptlang.org/tsconfig/#erasableSyntaxOnly) @@ -7,3 +10,22 @@ flag. The assumptions and opinions related to the changes that will be made are described in [assumptions.md](./docs/assumptions.md). + +## TODO + +**Additional mods** + +- [ ] namespaces and modules with runtime code +- [ ] parameter properties in classes +- [ ] Non-ECMAScript import = and export = assignments +- [ ] check support needed for import rewrites: + [docs](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-7.html#path-rewriting-for-relative-paths) +- [ ] update tsconfig.json (maybe this can just be instructions logged from + cli): [docs](https://nodejs.org/api/typescript.html#type-stripping) + +**Ready for migrating repo's** + +- [ ] Handle multiple files with glob input +- [ ] Write a cli for running the codemod with options for picking which + transformations to run on +- [ ] Support monorepos