gp

gulp-plist

gulp plugin modifies Mac OS Plist files

Showing:

Popularity

Downloads/wk

947

GitHub Stars

1

Maintenance

Last Commit

1yr ago

Contributors

2

Package

Dependencies

5

Size (min+gzip)

30.8KB

License

MIT

Type Definitions

Built-In

Tree-Shakeable

No?

Categories

Readme

gulp-plist Build Status

gulp-plist is a gulp plugin modifies Mac OS Plist (property list) files which are often used in OS X and iOS applications. It can read/write both binary and plain xml plist format.

Install

$ npm install --save-dev gulp-plist

Usage

const gulp = require('gulp');
const plist = require('gulp-plist');

gulp.task('default', () => {
  return gulp.src('src/Info.plist')
    .pipe(plist({
      CFBundleDisplayName: 'My App'
    })
    .pipe(gulp.dest('dist'));
});

Or, you can pass a modifier function to the plugin:

const gulp = require('gulp');
const plist = require('gulp-plist');

gulp.task('default', () => {
  return gulp.src('src/Info.plist')
    .pipe(plist(json => {
      json.CFBundleDisplayName = 'My App';
      return json;
    })
    .pipe(gulp.dest('dist'));
});

The plugin takes an optional second argument that represents settings. Currently only writeBinary option is supported. If you want to write binary plist files, set the option to true. The default value is false.

const gulp = require('gulp');
const plist = require('gulp-plist');

gulp.task('default', () => {
  return gulp.src('src/Info.plist')
    .pipe(plist({
      CFBundleDisplayName: 'My App'
    }, {
      writeBinary: true
    })
    .pipe(gulp.dest('dist'));
});

License

MIT © Taegon Kim

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100