npm i ctix --save-dev
ctix create -p ./tsconfig.json
You have to create a list of files when bundling with webpack and rollup.js, or creating documents with typedoc. It's boring to re-list files every time they change files change. ctix is a simple tool that automates the creation of file lists.
An application project has a clear entry point, but if it is a library project, the entry point is not clear, so you have to create it yourself. typedoc have to explicitly specify what to document, even for an application project.
- use TypeScript compiler API
- create index.ts file by separating default export and export
- support isolatedModules option
- various ignore options such as gitignore, npmignore, citignore
ctix
does not work in JavaScript code because it uses TypeScript API, please use it before
Babel translation or TypeScript compilation.
ctix use TypeScript Compiler API and directory structure. Export something from TypeScript source file after run ctix to create index.ts
file. Detail working see here
webpack, rollup.js bundling fonts like that. You can create .d.ts
file and include it.
// @types/DeclareTtfModule.d.ts
declare module '*.ttf';
// fonts/fonts.ts
/// <reference path="../@types/DeclareTtfModule.d.ts" />
import Friend from 'Friend.ttf';
import AlsoFriend from './fonts/AlsoFriend.ttf';
export { Friend, AlsoFriend };
If you use vue.js framework, you can use it as follows.
// @types/vue.d.ts
declare module '*.vue' {
import Vue from 'vue';
export default Vue;
}
// components/vue-components.ts
/// <reference path="../@types/vue.d.ts" />
import Foo from 'Foo.vue';
import Bar from './Bar.vue';
export { Foo, Bar };
- pass tsconfig.json file, another process don't care about
- Support default exportation
- using TypeScript API so detect default export and named export
- my_default_index.test.ts file create
export { default as myDefaultIndexTest } from './my_default_index.test.ts'
- Partial ignore
- specific export statement exclude on index.ts file.
- eg.
{ "my_lib_package.ts": ["exists", "temp"] }
- Skip empty directory
- isolatedModules support
- It may be slow for some project
- since ctix uses TypeScript compiler API, big projects may take time to generate index files
It is not recommended to use index.ts
file to re-map paths or shorten the paths. If you want to shorten the paths use Re-Map paths feature in TypeScript compilerOptions. ctix
is recommended for webpack and rollup.js, typedoc entrypoint and TypeScript declaration file bundling.
Name | Short | Default | Command | Description |
---|---|---|---|---|
--config | -c | All | configuration file(.ctirc) path | |
--project | -p | required | All | tsconfig.json path: you must pass path with filename, like this "./tsconfig.json" |
--spinnerStream | stdout | All | Stream of cli spinner, you can pass stdout or stderr | |
--progressStream | stdout | All | Stream of cli progress, you can pass stdout or stderr | |
--reasonerStream | stderr | All | Stream of cli reasoner. Reasoner show name conflict error and already exist index.ts file error. You can pass stdout or stderr | |
--startAt | -a | = --project | All | start working from startAt directory. If you do not pass startAt use project directory. |
--exportFilename | -f | index.ts | create, single, remove | Export filename, if you not pass this field that use "index.ts" or "index.d.ts" |
--useSemicolon | -s | true | create, single | add semicolon on line ending at every export statement |
--useTimestamp | -t | false | create, single | timestamp write on ctix comment right-side, only works in useComment option set true |
--useComment | -m | true | create, single | ctix comment add on first line of created export file(default index.ts) file, that remark created from ctix |
--quote | -q | ' | create, single | change quote character at export syntax |
--keepFileExt | -k | ' | create, single | keep file extension on export statement path literal |
--useFileExt | -u | ' | create, single | use custom file extension on export statement path literal |
--overwrite | -w | ' | create, single | overwrite each index.ts file |
--ignoreFile | -g | create, single | ignore file name. You can pass ignore, config file at ctix and use it like profile | |
--noBackup | false | create, single | not create backup file even if set overwrite option enable | |
--skipEmptyDir | -e | ' | create | empty directory skip create index.ts file |
--output | -o | N/A | single | output directory |
--useRootDir | -r | false | single | output file under rootDir in tsconfig.json. |
--includeBackup | -b | false | remove | If this option set true on remove mode what will be delete backup file. |
Ignore file 3 way belows:
.gitignore
.npmignore
.ctiignore
.gitignore
file follow .gitignore spec 2.22.1. .ctiignore
file key follow .gitignore spec 2.22.1. .gitignore spec 2.22.
spec using by ignore package. .npmignore
spec using by minimatch
.ctiignore file is json with comments. See below.
{
"juvenile/**": "*",
"wellmade/FlakyCls.ts": "*",
"wellmade/WhisperingCls.ts": "*",
"wellmade/ChildlikeCls.ts": ["transfer", "stomach"]
}
json key indicate ignore file path. You can use glob pattern like .gitignore
. If set '*'
character at value that is totally ignore file or glob pattern. If set string array that is ignore type name array.
You can use glob pattern in partial ignore like that. Partial ignore follow .gitignore spec 2.22.1.
{
"case00?.ts": ["*Case00*"]
}
testcase directory ignore using glob pattern.
{
// ignore testcase file
"**/__tests__/*": "*"
}
The testcase file is ignored if you add to the ignore file or if there is no export syntax.
useRootDir option activate using rootDir option in tsconfig.json. This option run below flowchart.
ctix cli support .ctirc
configuration file. Available name is only .ctirc
. Also cti cli arguments forced applied. And .ctirc
file can write json with comments.
You can use cli for .ctirc
file creation.
# create current directory
> cti init
# pass tsconfig.json path
> cti init -p ./server/tsconfig.json
0.6.x and 1.x version big different. See migration guide. cli command, option, ignore file changed. Support TypeScript 4.7.2
and new file extensions(.mts, .cts, etc)
.
Each command can use that function. Each function can pass isMessageDisplay flag second parameter. isMessageDisplay pass false or undefined after not display console message and progress.
Function | Argument | command |
---|---|---|
createWritor | TCreateOptionWithDirInfo, isMessageDisplay | create |
singleWritor | TSingleOptionWithDirInfo, isMessageDisplay | single |
removeIndexFile | TRemoveOptionWithDirInfo, isMessageDisplay | remove |
createInitFile | TTInitOptionWithDirInfo, isMessageDisplay | init |