build-files

build-files

Read the files from your build.

Why?

• Know what is in your build and where it is.
• Useful to send the build to external services.
• Agnostic of how the files were written.

Install

npm install build-files --save

Usage

Get it into your program.

const buildFiles = require('build-files');

Get a list of the files within the most recent build.

buildFiles.latest().then((files) => {
    console.log('files:', files);
    // [
    //     {
    //         path    : 'master/1.0.0/foo.js',
    //         content : 'This is foo.'
    //     }
    // ]
});

API

buildFiles.latest(option)

option

Type: object

Settings and known build data.

cwd

Type: string
Default: process.cwd()

The parent directory of the build root.

branch

Type: string

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

version

Type: string

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

includeBranchLatest

Type: boolean
Default: true

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

Related

• delivr - Build your code and ship it to S3.
• build-keys - Get the paths of 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.