Skip to content

Commit 72bbae7

Browse files
committed
Update package to 2.0.0, major changes
1 parent 03e5c2e commit 72bbae7

File tree

10 files changed

+1751
-525
lines changed

10 files changed

+1751
-525
lines changed

.npmignore

Lines changed: 0 additions & 3 deletions
This file was deleted.

.travis.yml

Lines changed: 0 additions & 10 deletions
This file was deleted.

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# gulp-ts-alias ![npm](https://img.shields.io/npm/v/gulp-ts-alias)
22

3-
[![Build Status](https://travis-ci.org/dhkatz/gulp-ts-alias.svg?branch=master)](https://travis-ci.org/dhkatz/gulp-ts-alias) [![Coverage Status](https://coveralls.io/repos/github/dhkatz/gulp-ts-alias/badge.svg?branch=master)](https://coveralls.io/github/dhkatz/gulp-ts-alias?branch=master) ![npm](https://img.shields.io/npm/dm/gulp-ts-alias)
3+
[![Coverage Status](https://coveralls.io/repos/github/dhkatz/gulp-ts-alias/badge.svg?branch=master)](https://coveralls.io/github/dhkatz/gulp-ts-alias?branch=master) ![npm](https://img.shields.io/npm/dm/gulp-ts-alias)
44

55
Resolve TypeScript import aliases and paths defined in `tsconfig`.
66

@@ -10,15 +10,22 @@ Resolve TypeScript import aliases and paths defined in `tsconfig`.
1010

1111
## Information
1212

13+
### Features
14+
15+
* Supports all import types: `import`, `require`, `await import()`
16+
* Supports wild card aliases
17+
18+
### Motivation
19+
1320
There have been previous attempts at releasing Gulp plugins that accomplish something similar, but all have become unmaintained.
1421

1522
For legacy’s sake, here is a list of previous packages/scripts that have been considered:
1623

1724
[gulp-ts-paths](https://www.npmjs.com/package/gulp-ts-paths)
25+
1826
[path-alias-resolver](https://gist.github.com/azarus/f369ee2ab0283ba0793b0ccf0e9ec590)
1927

20-
**Note:** Currently, multiple imports per line are not supported!
21-
Imports within multiline comments may also be replaced.
28+
**Note:** Imports within multiline comments may also be replaced.
2229

2330
## Usage
2431

@@ -27,11 +34,13 @@ const typescript = require('gulp-typescript');
2734
const sourcemaps = require('gulp-sourcemaps');
2835
const alias = require('gulp-ts-alias');
2936

30-
const project = typescript.createProject('tsconfig.json');
37+
const { config } = typescript.createProject('tsconfig.json');
3138

3239
function build() {
3340
const compiled = src('./src/**/*.ts')
34-
.pipe(alias({ configuration: project.config }))
41+
.pipe(alias(config))
42+
// or .pipe(alias('tsconfig.json'))
43+
// or even .pipe(alias())
3544
.pipe(sourcemaps.init())
3645
.pipe(project());
3746

0 commit comments

Comments
 (0)