Skip to main content

bud.path

You can use bud.path to reference a file or directory's absolute path.

Usage

bud.path('./src/scripts/components')

You may also choose to deliniate directories with an Array of path segments, rather than a String:

bud.path('./src', 'scripts', 'components')

Special path handles

The following is a table containing string values which fulfill a special role in the context of the bud.path function:

handledescriptiondefault
@srcsource directory./src
@distdestination directory./dist
@storagecache/artifact storage directory./.budfiles
@modulesmodules directory./node_modules

When one of these handles is used at the beginning of a string path (or the first segment in a multi-segment path), the path will be prefixed with the corresponding directory.

For example, to reference the ./src directory:

bud.path('@src/scripts/components')

You can create your own handles for use in the bud.path function. But, the handles in this table are standard. Other parts of bud.js or its ecosystem may use these handles to reference project directories. So, while they may be freely modified as needed, they should not be removed or repurposed.

Setting bud.path handles

Use bud.setPath to define or override a handle value.