engine-paths v1.0.1

engine-paths

Keeping the Engine paths in one place.

Installation

$ npm i --save engine-paths

Example

const EnginePaths = require("engine-paths");

var paths = new EnginePaths("path/to/your/app");

console.log(paths.root);
// => /home/.../path/to/your/app

console.log(paths.composition);
// => /home/.../path/to/your/app/composition

console.log(paths.package);
// => /home/.../path/to/your/app/package.json

console.log(paths.service);
// => /home/.../path/to/your/app/.service.json

console.log(paths.instance("some-instance"));
// => /home/.../path/to/your/app/composition/some-instance.json

Documentation

EnginePaths(appPath)

Creates a new instance of EnginePaths.

Params

• String appPath: The path to the Engine app.

instance(name)

Gets the absolute path to the JSON file.

Params

• String name: The instance name (without the .json suffix).

Return

• String The absolute path to the instance file.

How to contribute

Have an idea? Found a bug? See how to contribute.

Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

License

MIT © jillix