npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gulp-create-tsindex

v1.0.8

Published

Creates an index for your typescript files.

Downloads

216

Readme

gulp-create-tsindex

NPM version

This gulp plugin will join your typescript files into one export file.

Installation

Install gulp-create-tsindex using npm into your local repository.

npm install gulp-create-tsindex --save-dev

Usage

Extend your typescript gulp task to create a index file.

var gulp = require('gulp');
var ts = require("gulp-typescript");
var tsindex = require('gulp-create-tsindex');

var tsProject = ts.createProject('tsconfig.json');

gulp.task('build-typescript', function () {
	return gulp.src('./src')
		.pipe(tsindex('./src/index.ts'))
		.pipe(ts(tsProject));
		.pipe(gulp.dest('dist'));
});

This will create a file index.ts and inject it into the typescript build.

Example index.ts:

export * from "./file_A";
export * from "./file_B";
export * from "./file_C";

Don't want to expose all files?

You can ignore typescript files to be added in the index, and thereby making the exports in that file "package-scoped".

To achieve that, use the token "/// tsindex:ignore" in the source file, which needs to be ignored. The file content must start with the ignore token, as shown in the example below.

/// tsindex:ignore
import { stuffs } from "somepackage1"
...

export class MyInternalStuffInPackage{
...
}

If you don't like the default token, you can configure it via build task:

tsProject.src()
    .pipe(tsindex(paths.src + '/index.ts',{ignoreToken:"/// my_custom_token"}))
    ...

Note that this is optional; however, in this case, the token /// my_custom_token needs to be used in the source file instead.

This strategy is too simple for you? Let us know.

License

Apache 2.0