CodeEngine Filesystem Source
This is a CodeEngine plugin that reads files from the filesystem (local disk or network).
NOTE: This plugin is already built-into the CodeEngine CLI, so you may not need to use it directly unless you are using CodeEngine's programmatic API.
Installation
Install using npm.
npm install code-engine-source-filesystem
Usage
If you're using the CodeEngine CLI, then this plugin is already built-in, and you can use it simply by specifying a source
path in your generator.
source: "my/source/directory";
Or you can set source
to a glob pattern to match specific files.
source: "my/source/directory/**/*.{html,css,jpg,gif,png}";
If you need to set more advanced options, then you will need to explicitly import and use code-engine-source-filesystem
.
; source: ;
Options
You can set several options to customize the behavior of the code-engine-source-filesystem
plugin. The only required option is path
. All others are optional.
path
The relative or absolute filesystem path to read. Can be any of the following:
- A file path
- A directory path
- A glob pattern
NOTE: Setting
path
to a glob pattern is actually just a shorthand for settingpath
to the directory portion of the glob pattern and settingfilter
to the glob portion. This means you cannot setpath
to a glob and also set thefilter
option.
filter
One or more glob patterns, regular expressions, or filter functions that limit which files are read. By default, all files in all sub-directories are read.
The filter
option can be set to a glob pattern, like this:
; source: ;
It can also be set to a regular expression. For example, here's a filter
that matches all .htm
and .html
files:
; source: ;
You can also use a custom function that accepts a CodeEngine File
object and returns true
if the file should be read. Here's a filter
that only matches files that do not have the word "draft" in their name:
; source: ;
You can even specify multiple filters using an array. The plugin will read files that match any of the filter criteria. Here's a filter
that will match HTML files, any file in the img
directory, or any file that does not have the word "draft" in the name:
; source: ;
Another option is to specify separate include
and exclude
criteria. Each of these can be a single filter or an array of filters. For example, here's a filter
that will apply to HTML files or files in in the img
directory, but only if they don't contain the word "draft" in the name:
; source: ;
deep
Determines the depth of sub-directories that will be read. Can be any of the following:
- A number that indicates the depth of sub-directories to crawl
Infinity
ortrue
to crawl all sub-directories- Zero or
false
to only read the top-level directory contents
Defaults to true
.
fs
This option allows you to provide your own custom implementation of the Node.js filesystem module. Examples of packages you could substitute include:
Contributing
Contributions, enhancements, and bug-fixes are welcome! Open an issue on GitHub and submit a pull request.
Building
To build the project locally on your computer:
-
Clone this repo
git clone https://github.com/CodeEngineOrg/code-engine-source-filesystem.git
-
Install dependencies
npm install
-
Build the code
npm run build
-
Run the tests
npm test
License
code-engine-source-filesystem is 100% free and open-source, under the MIT license. Use it however you want.
This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
Big Thanks To
Thanks to these awesome companies for their support of Open Source developers ❤