Skip to content

Latest commit

 

History

History
101 lines (65 loc) · 2.39 KB

README.md

File metadata and controls

101 lines (65 loc) · 2.39 KB

gulp-wpstylecss

NPM version Build Status Coverage Status Dependency Status

Plugin for gulp which generates WordPress theme style.css files from package.json.

Usage

First, install gulp-wpstylecss as a development dependency:

npm install --save-dev gulp-wpstylecss

Then, add it to your gulpfile.js:

var wpstylecss = require("gulp-wpstylecss");

wpstylecss()
  .pipe(gulp.dest('dist'));

API

wpstylecss(options)

pkg is the contents of the current project's package.json.

_s is underscore.string.

Falsy options will cause the corrosponding field to be omitted from the generated file, except option.name which is required.

options.name

Type: String Default value: _s.titleize(_s.humanize(pkg.name))

The contents of the Theme Name field.

options.description

Type: String Default value: pkg.description

The contents of the Description field.

options.version

Type: String Default value: pkg.version

The contents of the Version field.

options.uri

Type: String Default value: pkg.homepage

The contents of the Theme URI field.

options.tags

Type: Array Default value: pkg.keywords

The contents of the Tags field.

options.author

Type: String Default value: pkg.author.name

The contents of the Author field.

options.authorUri

Type: String Default value: pkg.author.url

The contents of the Author URI field.

options.license

Type: String Default value: pkg.license

The contents of the License field.

options.licenseUri

Type: String Default value: null

The contents of the License URI field.

License

MIT License