ts-index-generate

Auto generate index file.

Table of Contents

- Install package
- Usage

Install

Install as a global tool:
``bash
npm install -g ts-index-generate
`


Used as a project dependency:
`
npm i ts-index-generate

or

pnpm add ts-index-generate

or

yarn add ts-index-generate
`


Once installed, you can use the abbreviation, which is simpler than ts-index-generate.
`bash
ts-index-generate

simpler


tig
`

Usage

Here are some usage examples.
`bash


show help

npx ts-index-generate --help
pnpx ts-index-generate --help

show version

npx ts-index-generate --version

generate src/index.ts

npx ts-index-generate
npx ts-index-generate generate

with cli args

npx ts-index-generate generate --src-dir ./examples --output ./examples/index.ts --verbose

dry run model

npx ts-index-generate generate --dry-run --verbose

Specify file extension

npx ts-index-generate generate --extensions .ts,.tsx,.js,.jsx

Exclude some files

npx ts-index-generate generate --exclude 'index.ts,.test.ts,.spec.ts'

npx ts-index-generate generate \
--exclude index.ts \
--exclude '*.test.ts' \
--exclude '*.spec.ts'

Skip some directories

npx ts-index-generate generate --skip-dirs node_modules,dist,temp

Skip the config directory in the examples directory

npx ts-index-generate generate --skip-dirs config --src-dir examples

custom file header

npx ts-index-generate generate --file-header "// Auto-generated\n// Do not edit"
`


init - Create configuration file. You can use a JSON file instead of terminal input, the default JSON file is generate.config.json.
`bash


Create configuration file

npx ts-index-generate init

Force overwrite existing configuration files

npx ts-index-generate init --force
`


check - Check export status
`bash


Check the file export status

npx ts-index-generate check

Specify configuration file

npx ts-index-generate check --config ./my-config.json
`


You can install ts-index-generate as a project dependency, and then modify package.json.
`json
{
"scripts": {
"generate-index": "ts-index-generate",
"generate-index": "ts-index-generate generate",
"generate-index": "tig",
"generate-index:dry": "ts-index-generate generate --dry-run --verbose",
"generate-index:check": "ts-index-generate check",
"generate-index:list": "ts-index-generate list",
"generate-index:exclude": "ts-index-generate generate --exclude index.ts,.test.ts,.spec.ts"
}
}
`

Used in CI/CD:
`yaml


GitHub Actions eg.


name: Generate Index
on: [push]
jobs:
generate-index:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
- run: npm ci
- run: npx ts-index-generate
- run: git diff --exit-code || (echo "Index file needs update" && exit 1)
``