Simple tools for building a nodejs project
npm install simple_build_toolsSimple tools for building a nodejs project
PromiseConvert a callback executing asynchronouse function into a promise returning one
Promise.<void>Copy a single file
Promise.<void>Copy an entire directory
Promise.<void>Copy and transorm a file
Promise.<void>Ensure that a directory exists
Promise.<void>Ensure that a file's parent directory exists
Promise.<void>remove contents recursively
Promise.<void>Run a build task and report it's time and result
Promise.<void>join a set of tasks in series
Promise.<void>join a set of tasks in parallel
Promise.<void>run a task an report it's time and result
Promise.<string>Run webpack and report the result
Promisezip the contents of a directory into a single file
Promise.<Array.<string>>get files that match a test
Promise.<Array.<string>>Get the files in a directory
Promise.<Array.<string>>Get directories in a directory
Promise.<string>get a source file by name
booleanMatcher for getFileMatches
PromiseKind: global function
| Param | Type | Description |
| --- | --- | --- |
| fcn | function | asynchronous function that executes a callback |
Promise.<void>Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| src | string | path to the source file |
| dest | string | path to the destination file |
Promise.<void>Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| src | string | path to the source directory |
| dest | string | path to the destination directory |
Promise.<void>Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| src | string | path to the source file |
| dest | string | path to the destination file |
| transform | function | text transforming funciton |
Promise.<void>Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| dir | string | the path to the directory that must exist |
Promise.<void>Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| file | string | the path to the file whose parent must exist |
Promise.<void>Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| path | string | the path of the item to be removed |
Promise.<void>Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| task | function | a build task that should be timed and reported |
Promise.<void>Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| tasks | Array.<function()> | tasks to join |
Promise.<void>Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| tasks | Array.<function()> | tasks to join |
Promise.<void>Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| task | function | task to run and report time and result |
Promise.<string>Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| config | Object | the webpack config and report result |
PromiseKind: global function
| Param | Type | Description |
| --- | --- | --- |
| sourceDir | String | path to directory to zip |
| outPath | String | path to zip file to create |
Promise.<Array.<string>>Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| dirPath | string | the path of the directory containing the files |
| isMatch | isFileMatch | function to test if a file is a match |
| recurse | boolean | whether to recurse into child folders |
| parents | Array.<string> | array of parent directories |
Promise.<Array.<string>>Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| dirPath | string | the path of the directory containing the files |
| recurse | boolean | whether to recurse into child folders |
Promise.<Array.<string>>Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| dirPath | string | the path of the directory containing the files |
| recurse | boolean | whether to recurse into child folders |
Promise.<string>Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| dirPath | string | the path of the directory containing the files |
| name | string | the name of the source file |
| extensions | string \| Array.<string> \| '\*' | the extension of possible extensions of the file |
booleanKind: global typedef
| Param | Type | Description |
| --- | --- | --- |
| file | Node.File | file to check for a match |
| parents | Array.<string> | parents of the file to check |