https://github.com/binocarlos/componenter

Install and build components programatically
https://github.com/binocarlos/componenter

Last synced: 11 days ago
JSON representation

Install and build components programatically

• Host: GitHub
• URL: https://github.com/binocarlos/componenter
• Owner: binocarlos
• Created: 2014-07-14T13:39:26.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-07-15T12:04:12.000Z (over 10 years ago)
• Last Synced: 2024-09-07T23:03:58.101Z (2 months ago)
• Language: JavaScript
• Size: 137 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
componenter

===========

Install and build components programatically

## install

```

$ npm install componenter

```

## usage

Componenter will install and build components for you in one hit

```js

var Componenter = require('componenter')

var project = Componenter('/my/project')

// this will remove existing components/build folder for a fresh install

project(true, function(err){

	// /my/project/components and /my/project/build now exists

})

```

You can use the 'install' and 'build' functions seperately:

```js

// this will not remove the old components folder

project.install(function(err){

	// this will remove the old build folder

	project.build(true, function(err){

	})

})

```

## api

#### `var project = Componenter(folderPath)`

Create a new project by passing a folder path and the folder contains a component.json

#### `project(autoRemove)`

Run project.install then project.build - autoRemove will delete folders before each step

#### `project.install(autoRemove)`

Run `component install` in the project folder - autoRemove will remove the components folder and result in a fresh install (i.e. pulling the latest components from github)

#### `project.build(autoRemove)`

Run `component build` in the project folder - autoRemove will remove the build folder

## licence

MIT