build-keys

build-keys

Get the paths of files from your build

Why?

• Useful for copying build artifacts.
• Agnostic of how the files were written.
• Excludes directories, perfect for Amazon S3.

Install

npm install build-keys --save

Usage

Get it into your program.

const buildKeys = require('build-keys');

Get a list of the filepaths that exist within the most recent build, excluding directories.

buildKeys.latest().then((keys) => {
    console.log('keys:', keys);
    // [
    //     'master/1.0.0/foo.js',
    //     'master/latest/foo.js'
    // ]
});

API

buildKeys.latest(option)

Returns a Promise<Array> of paths for files within the latest build. Does not include directories. Designed for use with Amazon S3.

option

Type: object

Settings and known build data.

cwd

Type: string
Default: process.cwd()

The parent directory of the build root.

branch

Type: string

Match the files from the given branch name, rather than the most recently built branch.

version

Type: string

Match the files from the given version, rather than the most recently built version of the branch.

includeBranchLatest

Type: boolean
Default: true

Whether to also match the files at the <branch>/latest path.

Related

• delivr - Build your code and ship it to S3
• build-files - Read the files from your build
• build-dir - Get a place to put your build
• build-data - Get metadata for your build
• build-path - Get a path for the given build
• build-version - Get a version for your build

Contributing

See our contributing guidelines for more details.

1. Fork it.
2. Make a feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request.

License

MPL-2.0 © Seth Holladay

Go make something, dang it.