build-keys

1.0.0 • Public • Published

build-keys Build status for 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

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.

Package Sidebar

Install

npm i build-keys

Weekly Downloads

1

Version

1.0.0

License

MPL-2.0

Last publish

Collaborators

  • sholladay