Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

broccoli-spelunk

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

broccoli-spelunk

Flatten a folder to a .js/.json representation of its contents, a la [spelunk](http://github.com/Rich-Harris/spelunk).

  • 0.1.2
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1
decreased by-94.12%
Maintainers
1
Weekly downloads
 
Created
Source

broccoli-spelunk

Flatten a folder to a .js/.json representation of its contents, a la spelunk.

Installation

$ npm install broccoli-spelunk

Usage

In your brocfile.js (or, if you're using grunt-broccoli for example, in your target's config property), add something like the following:

var flattenFolder = require( 'broccoli-spelunk' );

var json = flattenFolder( 'data', {
	outputFile: 'data.json'
});

module.exports = json;

This will recursively read all the files and folders inside the data folder, flattening them to a JavaScript object representation. This data can be output as JSON, AMD, Common JS, or as an ES6 module.

Example

First, you will need to have broccoli-cli installed:

$ npm i -g broccoli-cli

Clone this repo, run npm i to install dependencies, then run broccoli serve. This will flatten the contents of the example folder.

Browse to localhost:4200/data.json to see the result. As you add, edit and remove files inside the example folder, keep refreshing this URL (or install LiveReload for Chrome so you don't have to) to see the JSON file updated.

Options

Here are some example options. They are all blank by default except mode, which defaults to 'json'.

tree = flattenFolder( inputTree, {
	// This is the only required option. If you're using a mode other
	// than 'json', be sure to change the file extension to '.js'
	outputFile: 'data.json',

	// To exclude files, pass in a string or array of patterns to ignore.
	// You can use minimatch glob patterns
	exclude: '**/README.md'

	// Supported options are 'json', 'amd', 'cjs' and 'es6'.
	// The default is 'json'
	mode: 'json',

	// These options only apply to 'json' mode, and are treated as the
	// second and third arguments to `JSON.stringify`

	// See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_native_JSON#The_replacer_parameter
	replacer: null,
	space: '  '
});

Credits

Contributing & feedback

Issues and pull requests welcome. I'm @Rich_Harris on Twitter.

License

MIT.

Keywords

FAQs

Package last updated on 17 Jul 2014

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc