Amphora FS

Utility functions for working with the file system in Clay. This module will assume that the process which is running will be triggered from a directory that contains a package.json file and /components directory.

Installation

Node 26.12.1 or later.

npm install --save amphora-fs

---

Methods

• fileExists (code|tests|docs) - test if a file exists
• getComponentModule (code|tests|docs) - get a component's model.js
• getComponentName (code|tests|docs) - get a component's name, validating that it exists in your Clay instance
• getComponentPackage (code|tests|docs) - get a npm component's package.json
• getComponentPath (code|tests|docs) - get a component's filepath
• getComponents (code|tests|docs) - get a list of all components in your Clay instance
• getFiles (code|tests|docs) - get files (that aren't test or documentation) in a directory
• getFolders (code|tests|docs) - get folders in a directory
• getIndices (code|tests|docs) - get all component references in an object
• getLayoutModule (code|tests|docs) - get a layout's model.js
• getLayoutName (code|tests|docs) - get a layout's name, validating that it exists in your Clay instance
• getLayoutPath (code|tests|docs) - get a layout's filepath
• getLayouts (code|tests|docs) - get a list of all layouts in your Clay instance
• getSchemaPath (code|tests|docs) - get the path for a layout's / component's schema
• getYaml (code|tests|docs) - get and parse yaml files, including env variables (for config.yml and local.yml)
• isDirectory (code|tests|docs) - determine if a path is a directory
• readFilePromise (code|tests|docs) - fs.readFile that returns a promise
• tryRequire (code|tests|docs) - attempt to require() a file, with graceful fallback

Good to know

• The lists and files are read once. getComponents, getLayouts, getFiles, getFolders, isDirectory, getYaml, tryRequire, getComponentModule and getComponentPackage remember what they found for each argument, including that something was not found, so a file added later is not seen. Each one has a cache (a Map) that can be cleared.
• getYaml(path) reads path.yaml, or path.yml if there is no .yaml or it is empty. It is null if there is no file (undefined for a missing config or local), and throws, naming the file, if the yaml is not valid.
• In config and local files, ${NAME} is replaced by the environment variable NAME, which must be set and not empty.
• Yaml is read with js-yaml 3 (safeLoad): numbers by YAML 1.1 rules (0777 is 511, 12:30 is 750, yes is a string), merge keys, timestamps, no js types.

Development

npm test

runs ESLint and the tests (node --test), and checks that every function still gives what amphora-fs 2.0.0 gave on a project that looks like a Clay site (test/golden.test.js).