Switch configuration file to JS/JSON instead of YAML. - Githubissues

holography / holograph

Holograph parses the comments in your CSS and turns them into a beautiful style guide.

MIT License

8 stars 3 forks source link

Switch configuration file to JS/JSON instead of YAML. #41

Closed Chapabu closed 7 years ago

Chapabu commented 7 years ago

Pros

Can remove the js-yaml dependency and YAML parsing
Makes it more consistent/simple to invoke Holograph directly in Node (i.e. in Gulp)
Will remove the requirement for a Gulp plugin, as we won't need to parse the config
Will mean that there's a single configuration format throughout the system

Cons

Diverges from Holograph (is this a problem?)
BC break
We lose comments - resolvable by having config in a JS file like this:


// holograph_config.js

module.exports = {
  // The directory containing the source files to parse recursively
  source:  './scss',
  // The assets needed to build the docs (includes _header.html,
  // _footer.html, etc)
  // You may put doc related assets here too: images, css, etc.
  documentation_assets: './node_modules/holograph/assets'
};

Chapabu commented 7 years ago

The referencing PR (#43) means that we can use a standard JS file with an object on module.exports. The should also make it simpler to implement plugins (e.g. code_example_templates) at a later date, which I can't really see being a clean implementation with the YAML config.