typescript-build
v3.1.0
Published
tsc with a configurable copy build step.
Readme
TypeScript Build v2.0.0+
Copy files to output directory after tsc build
TypeScript Build (tsb) works in one of two modes. TSC mode will run tsc with the arguments passed to tsb and copy files based on a config if present while Copy only mode will only copy files based on the tsbconfig.json content.
Install
npm install --dev typescript typescript-buildor
yarn add --dev typescript typescript-buildUsage
- At the root of the project (next to your
tsconfig.jsonif in TSC mode) create atsbconfig.jsonas described below. - Run the
tsbcommand as you wouldtsc.
Example
{
"copyFiles": [
{
"files": ["src/**/*.css"],
"outDirectories": ["dist"],
"up": 1
}
]
}files: array of globs to match and copy tooutDirectoriesoutDirectories: the output directories relative to the directory of thetsbconfig.jsonfileup: (optional) number of directories to remove from the matchesskipClean: (optional/default to false) will skip removing theoutDirectorieson clean
Let's say you have a tsconfig.json file with "outDirectories": ["dist"] and the above tsbconfig.json in the same directory, and you run tsb --build the following will happen:
- TSB will execute
tsc --build - If
tscsucceeds, it will copy all of the css files from the src directory into the dist directory matching the directory, but removing one level form the matches. (e.g.src/papaya/coolcss.csswill be copied todist/papaya/coolcss.css)
In the case of tsb --build --clean it will:
- Execute
tsc --build --clean - If
tscsucceeds, it will delete theoutDirectoriesand all of its content unlessskipCleanis set totrue.
FAQ
- Why is nothing happening?
tsbwill only perform the copy of files if the--buildoptions is used and the clean-up if both--buildand--cleanoptions are used.
- Will it follow references?
- Yes. TSB will follow all the references and look for
tsbconfig.jsonfiles next to each of the referenced tsconfig files.
- Yes. TSB will follow all the references and look for
