# generator-ourcane

> Yeoman generator for arcane development projects

Latest version **0.10.0** (published 2015-06-02) · 0 weekly downloads

## Install

```sh
npm install generator-ourcane
pnpm add generator-ourcane
yarn add generator-ourcane
bun add generator-ourcane
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.10.0 |
| Published | 2015-06-02 |
| First published | 2015-02-26 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | jaygoodfellow |
| Keywords | yeoman-generator |

## Links

- npm: https://www.npmjs.com/package/generator-ourcane
- npm.io page: https://npm.io/package/generator-ourcane

## Dependencies (1)

- [yeoman-generator](https://npm.io/package/yeoman-generator.md) ^0.17.3

## Recent versions

- 0.10.0 (latest) — 2015-06-02
- 0.9.0 — 2015-05-17
- 0.8.4 — 2015-05-07
- 0.8.3 — 2015-05-02
- 0.8.2 — 2015-04-30
- 0.8.1 — 2015-04-17
- 0.7.20 — 2015-04-15
- 0.7.19 — 2015-04-14
- 0.7.18 — 2015-04-14
- 0.7.17 — 2015-04-09
- 0.7.16 — 2015-04-08
- 0.7.15 — 2015-04-07
- 0.7.14 — 2015-04-06
- 0.7.13 — 2015-04-06
- 0.7.12 — 2015-03-30
- … 27 more at https://npm.io/package/generator-ourcane/versions

## README

## Ourcane

A Yeoman generator used to start projects at Arcane Digital Inc.

## Requirements
* [node v0.12.2](https://nodejs.org/download/)
* [bower v1.3.12](http://bower.io/#install-bower)
* [sass v3.4](http://sass-lang.com/install)

### OS X
OS X Yosemite and Mavericks both ship with Ruby 2.0. If you are using an older version of OS X, follow the [Homebrew Instructions](https://www.ruby-lang.org/en/documentation/installation/#package-management-systems)
```sh
sudo gem install sass
```

### Windows
After installing Node for windows, use the windows specific [Ruby Installer](http://rubyinstaller.org)
```sh
sudo gem install sass
```

## Installing
We recommend you install the generator using the -g flag and if you are on a Mac/Linux to use sudo as well.
```sh
sudo npm install -g generator-ourcane
```

## Updating
To only update the tasks and not overwrite your `template/sass/js` files use:

```sh
sudo npm update -g generator-ourcane
yo ourcane --update-tasks
```

## Tasks

### scripts
Uses [Browserify](http://browserify.org/) to allow for node-style 'requires' of libraries. Compiles the `/src/scripts/app.js` file and places it in the assets folder specificed in the config file. Default is `/public/assets/js/app.js`
```sh
gulp scripts
```
### styles
Uses [libsass](http://libsass.org/) for compiling of scss files. During compilation it also runs [minifycss](https://www.npmjs.com/package/gulp-minify-css) and [autoprefixer](https://www.npmjs.com/package/gulp-autoprefixer) to optimize your css files.
```sh
gulp styles
```
### fonts
```sh
gulp fonts
```
### images
```sh
gulp images
```
### videos
```sh
gulp videos
```
### icons
```sh
gulp icons
```
### watch
```sh
gulp watch
```
### init
```sh
gulp init
```
## Custom Tasks
You can create your own tasks or even override existing tasks. You can set multiple task directories within the `config.json`. They are loaded into memory by scanning and merging the folders left to right in the array. By placing your own tasks in a `src/tasks` folder you can extend or override existing tasks. 

### Task Template
```js
module.exports = function (gulp, plugins, config) {
    var deferred = plugins.Q.defer();
    gulp.src('src/foo')
    .pipe(gulp.dest('public/bar'))
    .on('end', function () {
        plugins.notifier.notify({title: 'Task Complete', message: 'Foo Bar task complete!'});
        deferred.resolve();
    });
    return deferred.promise;
};

```

## Contributors

Development team at @arcanebrand

## The MIT License (MIT)

Copyright (c) 2015 Arcane Digital Inc

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

---
_Source: https://npm.io/package/generator-ourcane · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._