gulp-plist3

gulp plugin to manage Mac OS Plist


Keywords
gulp, gulpplugin, plist, xml, json, mac, apple
License
MIT
Install
npm install gulp-plist3@3.0.3

Documentation

gulp-plist3

gulp-plist3 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-plist3
(command output)

Usage

const gulp = require('gulp');
const peditor = require('gulp-plist3');

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

Or, you can pass an editor function to the plugin:

const gulp = require('gulp');
const peditor = require('gulp-plist3');

gulp.task('default', function(){
  return gulp.src('src/Info.plist')
    .pipe(peditor(function(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 peditor = require('gulp-plist3');

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

Known Issues

  • Not supported modifying <data> type yet.

License

MIT © Taegon Kim