build-path

Get a path for the given build.

Usage no npm install needed!

<script type="module">
  import buildPath from 'https://cdn.skypack.dev/build-path';
</script>

README

build-path

Get a path for the given build.

Why?

Asserts that all necessary metadata is present.
Uses relative paths for flexibility.
Platform and technology agnostic.

Install

npm install build-path --save

Usage

Get it into your program.

const buildPath = require('build-path');

Get the path where a given build should live.

const path = buildPath({
    branch : 'master',
    version : '1.0.0'
});

console.log(path);  // => build/master/1.0.0

Build paths cannot be constructed with incomplete data.

buildPath({ version : '1.0.0' });
// TypeError: A branch is required to create the build path.

API

buildPath(option)

option

Type: object

branch

Type: string

The branch name of the build.

version

Type: string

The version of the build.

Related

delivr - Build your code and ship it to S3.
build-files - Read the files from your build.
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-version - Get a version for your build.

Contributing

See our contributing guidelines for more details.

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

License

MPL-2.0 © Seth Holladay

Go make something, dang it.