Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joseluisq/go-tspath
A fast and persistent Typescript paths replacer written in Go.
https://github.com/joseluisq/go-tspath
paths-replacer replacer typescript typescript-paths
Last synced: 2 months ago
JSON representation
A fast and persistent Typescript paths replacer written in Go.
- Host: GitHub
- URL: https://github.com/joseluisq/go-tspath
- Owner: joseluisq
- License: apache-2.0
- Created: 2019-08-05T05:53:59.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-10-10T21:49:29.000Z (about 5 years ago)
- Last Synced: 2024-04-14T02:23:35.298Z (8 months ago)
- Topics: paths-replacer, replacer, typescript, typescript-paths
- Language: Go
- Homepage:
- Size: 622 KB
- Stars: 13
- Watchers: 5
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Go TSPath [](https://travis-ci.org/joseluisq/go-tspath) [](https://codecov.io/gh/joseluisq/go-tspath) [](https://goreportcard.com/report/github.com/joseluisq/go-tspath) [](https://godoc.org/github.com/joseluisq/go-tspath)
> A fast [Typescript paths](https://www.typescriptlang.org/docs/handbook/module-resolution.html) replacer written in [Go](https://golang.org/). ⚡
**go-tspath** replaces directly [Typescript paths aliases](https://www.typescriptlang.org/docs/handbook/module-resolution.html) into JS files with real paths based on `tsconfig.json`, no more runtime replacers.
_Screenshot of `go-tspath` performing replacements in a Typescript code base project with more than 200 JS files and around 5857 lines of code._
## Status
**go-tspath** was tested replacing custom path aliases in a Typescript medium size project with desired results (shown in screenshot above).
But there are some features and more testing cases (community user feedback) to do.
So, It can considered as **Beta** yet. Contributions will be very appreciated.
## Installation
🚀 Download the latest **go-tspath** binary for your specific platform at [go-tspath/releases](https://github.com/joseluisq/go-tspath/releases).
## Usage
```sh
# 1. Build TS files via tsc
# 2. Replace TS paths
go-tspath -config=./tsconfig.replace.json
# 3. Just run your app
# node main.js
```
## Known limitations
- No support for JSON5 format of `tsconfig.json`. But works using a dedicated `tsconfig.json` file with your custom path aliases. See [`sample/tsconfig.replace.json`](https://github.com/joseluisq/go-tspath/blob/master/sample/tsconfig.replace.json)
- Limited `compilerOptions` settings. Only `baseUrl`, `paths` and `outDir` are supported. See [`CompilerOptions struct`](https://github.com/joseluisq/go-tspath/blob/master/pkg/tsconfig/tsconfig.go#L20).
- No support for `tsconfig.json` features like `extends`, `exclude` or similar.
## Typescript code example
See an example at [`sample`](https://github.com/joseluisq/go-tspath/tree/master/sample) directory.
## API
```sh
~> go-tspath --help
Usage of go-tspath:
-config string
Specifies the Typescript configuration file. (default "./tsconfig.json")
```
## Contributions
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in current work by you, as defined in the Apache-2.0 license, shall be dual licensed as described below, without any additional terms or conditions.
Feel free to send some [Pull request](https://github.com/joseluisq/go-tspath/pulls) or [issue](https://github.com/joseluisq/go-tspath/issues).
## License
This work is primarily distributed under the terms of both the [MIT license](LICENSE-MIT) and the [Apache License (Version 2.0)](LICENSE-APACHE).
© 2019 [Jose Quintana](https://git.io/joseluisq)