https://github.com/vladfilipro/rig-javascript

A rig containing javascript utilities
https://github.com/vladfilipro/rig-javascript

depricated

Last synced: 25 days ago
JSON representation

A rig containing javascript utilities

• Host: GitHub
• URL: https://github.com/vladfilipro/rig-javascript
• Owner: vladfilipro
• Created: 2016-04-04T14:38:50.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-07-06T20:34:44.000Z (over 8 years ago)
• Last Synced: 2024-11-06T23:25:26.131Z (2 months ago)
• Topics: depricated
• Language: JavaScript
• Size: 9.77 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# rig-javascript

[![Dependency Status](https://david-dm.org/vladfilipro/rig-javascript.svg)](https://david-dm.org/vladfilipro/rig-javascript)

A rig containing javascript utilities

## How to use

1. Install rigs package: `npm install rigs`

2. Install rig-javascript: `npm install rig-javascript`

## Available tasks in rig-javascript

- `rig-javascript__browserify`: A task which uses [browserify](https://www.npmjs.com/package/browserify) to build your javascript code

  - properties:

    - `src`: String, refers to broserify's entry configuration

    - `dest`: String, refers to the output path

    - `debug`: Boolean, refers to browserify's debug property

    - `minify`: Boolean, determines if uglification for the code is enabled

    - `sourcemap`: Boolean, determines if sourcemap files will be created

    - `output`: String, refers to the output filename

    - `transform`: Array, add transformations to browserify

    ```

    {

        taskname: 'rig-javascript__browserify',

        dependency: [],

        src: './helper.js',

        output: 'app.js',

        sourcemap: true,

        dest: './scripts',

        debug: true,

        minify: false,

        transform: [ 'browserify-ngannotate' ]

    }

    ```

- `rig-javascript__jscs`: A task which uses [gulp-jscs](https://www.npmjs.com/package/gulp-jscs) to enforce code standards

  - properties:

    - `src`: String or Array, refers to the input file(s)

    ```

    {

        taskname: 'rig-javascript__jscs',

        src: './**/*.js'

    }

    ```

- `rig-javascript__jshint`: A task which uses [gulp-jshint](https://www.npmjs.com/package/gulp-jshint) to check the javascript code validity

  - properties:

    - `src`: String or Array, refers to the input file(s)

    ```

    {

        taskname: 'rig-javascript__jshint',

        src: './src/**/*.js'

    }

    ```

- `rig-javascript__install-rig`: A task which addds to your project `.jscsrc`, `.jshintignore`, `.jshintrc`, `.npmignore`

  - properties:

    - `path`: String or Array, refers to the destination path (usually `./`)

    ```

    {

        taskname: 'rig-javascript__install-rig',

        path: './'

    }

    ```