An open API service indexing awesome lists of open source software.

https://github.com/delucis/load-nextstep-plist

:open_file_folder: Read and parse a NeXTSTEP property list file
https://github.com/delucis/load-nextstep-plist

nextstep plist

Last synced: 11 days ago
JSON representation

:open_file_folder: Read and parse a NeXTSTEP property list file

Awesome Lists containing this project

README

        

# load-nextstep-plist [![Build Status](https://travis-ci.org/delucis/load-nextstep-plist.svg?branch=master)](https://travis-ci.org/delucis/load-nextstep-plist) [![Coverage Status](https://coveralls.io/repos/github/delucis/load-nextstep-plist/badge.svg?branch=master)](https://coveralls.io/github/delucis/load-nextstep-plist?branch=master)

> Read and parse a NeXTSTEP property list file

Loads property list files that follow the NeXTSTEP “plain text” format. Also works with other file formats that use the same syntax, such as the `.glyphs` files used for the [Glyphs](http://glyphsapp.com/) font editor.

## Install

```
npm install --save load-nextstep-plist
```

## Usage

```js
const LOAD_PLIST = require('load-nextstep-plist')

LOAD_PLIST('test.plist')
.then(data => {
console.log(data)
// => { foo: 'bar' }
})
```

## API

### loadNextstepPlist(filepath)

Returns a promise for the parsed property list file.

### loadNextstepPlist.sync(filepath)

Returns the parsed property list file.

```js
const LOAD_PLIST = require('load-nextstep-plist')

console.log(LOAD_PLIST.sync('test.plist'))
// => { foo: 'bar' }
```

## See also

- [write-nextstep-plist](https://github.com/delucis/write-nextstep-plist) - Stringify and write a NeXTSTEP property list atomically

## Acknowledgements

Parsing is accomplished using Chee’s [`nextstep-plist`](https://www.npmjs.com/package/nextstep-plist) module.

This module is modelled on Sindre Sorhus’s [`load-json-file`](https://github.com/sindresorhus/load-json-file).

## License

This software is free to use, modify, and redistribute under a [GNU General Public License](http://www.gnu.org/licenses/gpl-3.0.txt).