ts-create-index

Forked from: https://github.com/gajus/create-index

Installation

npm i -D ts-create-index

or

yarn add -D ts-create-index

What's different?

• Will now output export * from './foo'; (instead of export { default as foo } from './foo.ts';)
• Only writes files if their contents have changed
• This readme and all the unit tests have been updated so they are accurate
• Adds a TsCreateIndexWebpackPlugin

---

TsCreateIndexWebpackPlugin

// webpack.config.js

import { TsCreateIndexWebpackPlugin } from 'ts-create-index';

module.exports = {
  plugins: [
    // Whenever webpack recompiles, a new index.ts file will be generated in the root of these dirs
    new TsCreateIndexWebpackPlugin({ dirs: ['src/components'] }),
  ]
}

---

ts-create-index program creates (and maintains) ES6 ./index.ts file in target directories that imports and exports sibling files and directories.

Example

1> tree ./
2./
3├── bar.ts
4└── foo.ts
5
60 directories, 2 files
7
8> ts-create-index ./
9[13:17:34] Target directories [ './' ]
10[13:17:34] Update index: false
11[13:17:34] ./index.ts [created index]
12[13:17:34] Done
13
14> tree
15.
16├── bar.ts
17├── foo.ts
18└── index.ts
19
200 directories, 3 files

This created index.ts with:

1// @ts-create-index
2
3export * from './bar';
4export * from './foo';

Lets create a new file and re-run ts-create-index:

1> touch baz.ts
2> tree ./
3./
4├── bar.ts
5├── baz.ts
6├── foo.ts
7└── index.ts
8
90 directories, 4 files
10
11> ts-create-index ./
12[13:21:55] Target directories [ './' ]
13[13:21:55] Update index: false
14[13:21:55] ./index.ts [updated index]
15[13:21:55] Done

This have updated index.ts file:

1// @ts-create-index
2
3export * from './bar';
4export * from './baz';
5export * from './foo';

Usage

Using CLI Program

1npm install ts-create-index
2
3ts-create-index --help
4
5Options:
6  --recursive, -r          Create/update index files recursively. Halts on any
7                           unsafe "index.ts" files.   [boolean] [default: false]
8  --ignoreUnsafe, -i       Ignores unsafe "index.ts" files instead of halting.
9                                                      [boolean] [default: false]
10  --ignoreDirectories, -d  Ignores importing directories into the index file,
11                           even if they have a safe "index.ts".
12                                                      [boolean] [default: false]
13  --update, -u             Updates only previously created index files
14                           (recursively).             [boolean] [default: false]
15  --banner                 Add a custom banner at the top of the index file
16                                                                        [string]
17  --extensions, -x         Allows some extensions to be parsed as valid source.
18                           First extension will always be preferred to homonyms
19                           with another allowed extension.
20                                                       [array] [default: ["ts"]]
21  --outputFile, -o         Output file            [string] [default: "index.ts"]                                                      [array] [default: ["ts"]]
22
23Examples:
24  ts-create-index ./src ./src/utilities      Creates or updates an existing
25                                          ts-create-index index file in the target
26                                          (./src, ./src/utilities) directories.
27  ts-create-index --update ./src ./tests     Finds all ts-create-index index files in
28                                          the target directories and descending
29                                          directories. Updates found index
30                                          files.
31  ts-create-index ./src --extensions ts tsx  Creates or updates an existing
32                                          ts-create-index index file in the target
33                                          (./src) directory for both .ts and
34                                          .tsx extensions.

Using ts-create-index Programmatically

1import {writeIndex} from 'ts-create-index';
2
3/**
4 * @type {Function}
5 * @param {Array<string>} directoryPaths
6 * @throws {Error} Directory "..." does not exist.
7 * @throws {Error} "..." is not a directory.
8 * @throws {Error} "..." unsafe index.
9 * @returns {boolean}
10 */
11writeIndex;

Note that the writeIndex function is synchronous.

1import {findIndexFiles} from 'ts-create-index';
2
3/**
4 * @type {Function}
5 * @param {string} directoryPath
6 * @returns {Array<string>} List of directory paths that have ts-create-index index file.
7 */
8findIndexFiles;

Gulp

Since Gulp can ran arbitrary JavaScript code, there is no need for a separate plugin. See Using ts-create-index Programmatically.

1import {writeIndex} from 'ts-create-index';
2
3gulp.task('ts-create-index', () => {
4  writeIndex(['./target_directory']);
5});

Note that the writeIndex function is synchronous.

Implementation

ts-create-index program will look into the target directory.

If there is no ./index.ts, it will create a new file, e.g.

1// @ts-create-index

Created index file must start with // @ts-create-index\n\n. This is used to make sure that ts-create-index does not accidentally overwrite your local files.

If there are sibling files, index file will import them and export, e.g.

1children-directories-and-files git:(master) ✗ ls -lah
2total 0
3drwxr-xr-x   5 gajus  staff   170B  6 Jan 15:39 .
4drwxr-xr-x  10 gajus  staff   340B  6 Jan 15:53 ..
5drwxr-xr-x   2 gajus  staff    68B  6 Jan 15:29 bar
6drwxr-xr-x   2 gajus  staff    68B  6 Jan 15:29 foo
7-rw-r--r--   1 gajus  staff     0B  6 Jan 15:29 foo.ts

Given the above directory contents, ./index.ts will be:

1// @ts-create-index
2
3import * from './bar';
4import * from './foo';
5
6export {
7    bar,
8    foo
9};

When file has the same name as a sibling directory, file import takes precedence.

Directories that do not have ./index.ts in themselves will be excluded.

When run again, ts-create-index will update existing ./index.ts if it starts with // @ts-create-index\n\n.

If ts-create-index is executed against a directory that contains ./index.ts, which does not start with // @ts-create-index\n\n, an error will be thrown.

Ignore files on --update

ts-create-index can ignore files in a directory if ./index.ts contains special object with defined ignore property which takes an array of regular expressions defined as strings, e.g.

1> cat index.ts
2// @ts-create-index {"ignore": ["/baz.ts$/"]}

1> tree ./
2./
3├── bar.ts
4├── baz.ts
5├── foo.ts
6└── index.ts
7
80 directories, 4 files

Given the above directory contents, after running ts-create-index with --update flag, ./index.ts will be:

1// @ts-create-index {"ignore": ["/baz.ts$/"]}
2
3import * from './bar';
4import * from './foo';
5
6export {
7    bar,
8    foo
9};