Gather Components

Generate components.json file for Design Manual capturing HTML components from a website by queryselector.

Usage

Setup a YAML file with a list of components to be gathered. Add a name, description, query selectors to find the components and additional example HTML.

-
  name: foo
  description: foo description
  selectors: 
    - .foo
    - .body > .foo

-
  name: bar
  description: bar description
  selector: .bar
  examples: 
    - |
      <div class="beep">
        {{block}}
      </div>
    - |
      <div style="max-width: 300px">
        {{block}}
      </div>

Include or exclude pages per component

You can include or exclude component capture per page. Make sure the page name is indentical to the path specified in scraper options. Don't use both blacklist and whitelist at the same time.

Prevent capture on test.html using blacklist:

-
  name: foo
  description: foo description
  selectors: 
    - .foo
    - .body > .foo
  blacklist:
    - test.html

Capture only on test.html using whitelist

-
  name: foo
  description: foo description
  selectors: 
    - .foo
    - .body > .foo
  whitelist:
    - test.html

Output file

Output will look something like this.

[
  {
		"meta": {
			"name": "foo",
			"description": "foo description"
		},
		"output": "<div class=\"foo\">this is my component</div>"
	},
	{
		"meta": {
			"name": "bar",
			"description": "bar description"
		},
		"output": "<div class=\"beep\"><div class=\"foo\">this is my component</div></div><div style=\"max-width: 300px\"><div class=\"foo\">this is my component</div></div>"
	}
]

How to use

npm install gather-components

var scraper = require('gather-components');

scraper({
  url: 'https://rawgit.com/EightMedia/gather-components/master/test/fixtures/',
  paths: ['test.html', 'test2.html'],
  components: 'components.yaml',
  output: 'components.json'
}).then((output) => {
  console.log(output);
});