userscript-meta

Parse and stringify Userscript metadata.

Installation

1npm install userscript-meta --save

API

parse(string)

parse userscript metadata to an object.

1const userscript = require('userscript-meta')
2
3userscript.parse(`
4  // ==UserScript==
5  // @name Userscript name
6  // @version 1.0
7  // @match http://www.example.com/*
8  // @match http://www.example.org/*
9  // ==/UserScript==
10`)

equals to

1{
2  name: 'Userscript name',
3  version: '1.0',
4  // Field which has multiple value will parsed to an array
5  match: [
6    'http://www.exmaple.com/*',
7    'http://www.exmaple.org/*',
8  ]
9}

stringify(object)

1const userscript = require('userscript-meta')
2
3userscript.stringify({
4  name: 'Userscript name',
5  version: '1.0',
6  match: [
7    'http://www.exmaple.com/*',
8    'http://www.exmaple.org/*',
9  ]
10})

equals to

1// ==UserScript==
2// @name Userscript name
3// @version 1.0
4// @match http://www.example.com/*
5// @match http://www.example.org/*
6// ==/UserScript==

license

MIT