toreda
@toreda/build-tools
Helpers for common gulp build flows. Reduce complexity and code duplication in your gulpfile. Reduce redundancy and upkeep across multiple projects.
Contents
Usage
Examples
gulpfile.ts for TypeScript library
import {dest, parallel, series, src} from 'gulp';
import {Build} from '@toreda/build-tools';
import {EventEmitter} from 'events';
import {Log} from '@toreda/log';
const log = new Log();
const events = new EventEmitter();
const build = new Build({
env: 'dev',
log: log,
events: events
});
function runLint() {
}
function createDist() {
return build.create.dir('./dist', false);
}
function cleanDist() {
return build.clean.dir('./dist');
}
function buildSrc() {
return build.run.typescript('./dist', 'tsconfig.json');
}
exports.default = series(createDist, cleanDist, runLint, buildSrc);Using Build
Package
Install
Install @toreda/build-tools directly from NPM.
Install with Yarn (preferred)
yarn add @toreda/build-tools --devInstall using NPM
npm install @toreda/build-tools --save-devRun Tests
Install or clone @toreda/build-tools (see above).
Our unit tests use Jest.
Installing jest is not required after project dependencies are installed (see above).
yarn testBuild from source
The next steps are the same whether you installed the package using NPM or cloned the repo from Github.
Build with Yarn
Enter the following commands in order from the build-tools project root.
yarn buildBuild with NPM
Enter the following commands in order from the build-tools project root.
npm run-script build
Legal
License
MIT © Toreda, Inc.
Copyright
Copyright © 2019 - 2022 Toreda, Inc. All Rights Reserved.