Resource-file NPM

resource-file

Add a configuration data to a resource file object.

The resource could be a folder or a file. Each resource could have many custom attributes. These attributes may come from a front-matter block in the same text file, or as a separate configuration file exists with the same basename.

The priority is the front-matter > configuration file if they are both exist.

The Resource uses the Front-matter to read the file attributes.

The separate configuration file name should be the same basename of the resource.

You can add the following configuration format(extname):

YAML: .yml
CSON: .cson
TOML: .toml, .ini
JSON: .json

You should register these formats by youself.

It's only exists the separate configuration file if the resource if a folder. The folder's configuration file name could be:

_config.(yml|cson|ini|json)
(index|readme).md

The folder's configuration file names need to be registered too.

Usage

loadCfgFile     = require 'load-config-file'
loadCfgFolder   = require 'load-config-folder'
yaml            = require 'js-yaml'

loadCfgFile.register 'yml', yaml.safeLoad
loadCfgFolder.register 'yml', yaml.safeLoad
loadCfgFolder.addConfig '_config'

res = Resource './test/fixture'
res.loadSync(read:true)
res.should.have.property 'config', '_config'
res.contents.should.have.length 5
expect(res.date).to.be.an.instanceOf Date
expect(res.title).to.be.equal 'Fixture'

API

The Resource File Class inherited from AdvanceFile

Note: the load option default to true when creating resource file object.

Changes

v0.4

set the load option default to true when creating resource file object(v0.4.6).

add the summary attribute to the Resource (v0.4.4).

the filter should run after loading config.
can work on windows

add the title, date attributes to the Resource (v0.4.2)
- title String: remove extension name of the file name, and convert it to a title strirng.
- date(modifiedDate, updatedDate) Date : the latest modified date of the file/folder.
- Note: you can set these value before loading stat.

v0.3

inherits the parent's configuration: the '<' key means inherits from parent.
- number: add the parent's number
- string: a the parent's string + this stirng.
- list: concat the parent's list
- object: extent the parent's object
- eg,
```
---
superLst:
  <: #inherits from parent
    - add1
    - add2
superObj:
  <: #inherits from parent
    key1: HI
    key3: append
---
```