https://github.com/dropbox/ts-transform-import-path-rewrite

TS AST transformer to rewrite import path
https://github.com/dropbox/ts-transform-import-path-rewrite

ast compiler import transform typescript

Last synced: 3 months ago
JSON representation

TS AST transformer to rewrite import path

• Host: GitHub
• URL: https://github.com/dropbox/ts-transform-import-path-rewrite
• Owner: dropbox
• License: apache-2.0
• Created: 2018-11-28T17:12:40.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2023-08-07T14:33:25.000Z (about 1 year ago)
• Last Synced: 2024-07-02T03:02:35.208Z (4 months ago)
• Topics: ast, compiler, import, transform, typescript
• Language: TypeScript
• Homepage:
• Size: 141 KB
• Stars: 129
• Watchers: 9
• Forks: 15
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-typescript-ecosystem - ts-transform-import-path-rewrite - TS AST transformer to rewrite import path (Transformers / General transformers)

README

        
# ts-transform-import-path-rewrite

![build status](https://travis-ci.org/dropbox/ts-transform-import-path-rewrite.svg?branch=master)

This is a TypeScript AST Transformer that allows you to rewrite import path in output JS & `d.ts` files accordingly. The primary use case for this is to mitigate different build system import structure, such as relative vs absolute `import` and aliasing output `import` paths.

## Usage

### ttypescript

Example for ttypescript usage is in `examples/ttypescript`. Run `npx ttsc`.

### Compiler Wrapper

First of all, you need some level of familiarity with the [TypeScript Compiler API](https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API).

`compile.ts` & tests should have examples of how this works. The available options are:

### `projectBaseDir: string`

This is the base directory of your project folder. This is primarily used to determine the correct path when rewriting relative `import` to `absolute` import.

### `project?: string`

Project name to rewrite relative `import` to. For example:

```ts

import foo from './foo'

// Becomes

import foo from 'my-project-name/foo'

```

 

### `rewrite?(importPath: string, sourceFilePath: string): string`

Custom rewrite function to rewrite any `import` path we encounter to any new `import` path.

### `alias?: Record`

Alias regex map to replace, e.g:

```json

{

    "^(foo)$": "external/$1"

}

```

## License

Copyright (c) 2018 Dropbox, Inc.

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.