@oneblink/release-cli 1.2.0-beta.2 → 1.2.0

package/node_modules/changelog-parser/.travis.yml

@@ -0,0 +1,7 @@
+language: node_js
+node_js:
+  - '8'
+  - '10'
+cache:
+  directories:
+    - node_modules

package/node_modules/changelog-parser/CHANGELOG.md

@@ -0,0 +1,128 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [2.8.0](https://github.com/hypermodules/changelog-parser/compare/v2.7.0...v2.8.0) - 2019-05-02
+
+### Features
+
+- accept input text instead of file (#32) - @jedwards1211 & @ungoldman
+
+## [2.7.0](https://github.com/hypermodules/changelog-parser/compare/v2.6.0...v2.7.0) - 2019-03-07
+
+### Features
+
+- accept options object, add removeMarkdown option (#29) - @cironunes & @ungoldman
+
+## [2.6.0](https://github.com/hypermodules/changelog-parser/compare/v2.5.0...v2.5.1) - 2018-12-18
+
+### Features
+
+- allow version headers in CHANGELOG to use either H1 (#) or H2 (##) headers (#14) - @eladb
+
+## [2.5.1](https://github.com/hypermodules/changelog-parser/compare/v2.5.0...v2.5.1) - 2018-12-05
+
+### Fixes
+
+- Protect against no current value (#24) - thanks @sabrehagen
+
+## [2.5.0](https://github.com/hypermodules/changelog-parser/compare/v2.4.0...v2.5.0) - 2018-05-30
+
+### Features
+
+- add international date format support (#25) - thanks @godban
+
+## [2.4.0](https://github.com/hypermodules/changelog-parser/compare/v2.3.0...v2.4.0) - 2018-02-13
+
+### Features
+
+- stringify results in CLI (#22) - thanks @benmonro
+
+## [2.3.0](https://github.com/hypermodules/changelog-parser/compare/v2.2.0...v2.3.0) - 2018-01-09
+
+### Features
+
+- add support for parsed body (#20) (#21) - thanks @jrmykolyn
+
+## [2.2.0](https://github.com/hypermodules/changelog-parser/compare/v2.1.0...v2.2.0) - 2017-12-29
+
+### Features
+
+- add promise support (#18) (#19) - thanks @jrmykolyn
+
+## [2.1.0](https://github.com/hypermodules/changelog-parser/compare/v2.0.5...v2.1.0) - 2017-12-12
+
+### Features
+
+- add date to version objects; update tests. (#6) (#15) - thanks @jrmykolyn
+
+### Chores
+
+- add release script
+
+## [2.0.5](https://github.com/hypermodules/changelog-parser/compare/v2.0.4...v2.0.5) - 2017-06-28
+
+### Changes
+
+- chore(ci): add 8, drop .10 & .12
+- docs(readme): move badges out of title
+- lint: fix useless escapes
+- chore(pkg): bump to latest standard
+- chore(gitignore): ignore lock files
+- docs(readme): update repo web address
+
+## [2.0.4](https://github.com/hypermodules/changelog-parser/compare/v2.0.3...v2.0.4)
+
+### Fixes
+
+- reset log & current vars after each execution (#10)
+
+## [2.0.3](https://github.com/hypermodules/changelog-parser/compare/v2.0.2...v2.0.3) - 2016-09-09
+
+- bump dev dependencies
+- update repo URL
+- update maintainer email
+
+## [2.0.2](https://github.com/hypermodules/changelog-parser/compare/v2.0.1...v2.0.2) - 2015-06-15
+
+- readme updates
+- change log fix
+- add keywords to package.json
+
+## [2.0.1](https://github.com/hypermodules/changelog-parser/compare/v2.0.0...v2.0.1) - 2015-06-07
+
+### Changes
+
+- use `os` module to support cross-platform EOL parsing ([#4](https://github.com/hypermodules/changelog-parser/pull/4))
+
+## [2.0.0](https://github.com/hypermodules/changelog-parser/compare/v1.1.0...v2.0.0) - 2015-04-02
+
+### Breaking Changes
+
+- `version` key of version object is now `null` unless semver found
+
+### Changes
+
+- parse out `v` prefix for version numbers ([gh-release#23](https://github.com/hypermodules/gh-release/issues/23))
+
+### Additions
+
+- add `title` key to version object
+- add a real test
+
+## [1.1.0](https://github.com/hypermodules/changelog-parser/compare/v1.0.1...v1.1.0) - 2015-03-07
+
+- add cli support
+- remove `description` key if empty
+- add `CONTRIBUTING.md`
+- add node 0.10 to travis-ci testing environments
+
+## [1.0.1](https://github.com/hypermodules/changelog-parser/compare/v1.0.0...v1.0.1) - 2015-03-02
+
+- fix readme example for [paulcpederson](http://github.com/paulcpederson/)
+
+## 1.0.0 - 2015-03-02
+- init

package/node_modules/changelog-parser/CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing Guidelines
+
+Contributions welcome! Please check past issues and pull requests before you open your own issue or pull request to avoid duplicating a frequently asked question.
+
+In addition to improving the project, refactoring code, and implementing features, this project welcomes the following types of contributions:
+
+- **Ideas**: participate in an issue thread or start your own to have your voice heard.
+- **Writing**: contribute your expertise in an area by helping expand the included content.
+- **Copy editing**: fix typos, clarify language, and generally improve the quality of the content.
+- **Formatting**: help keep content easy to read with consistent formatting.
+
+## Install
+
+Fork and clone the repo, then `npm install` to install all dependencies.
+
+## Testing
+
+Tests are run with `npm test`. Please ensure all tests are passing before submitting a pull request (unless you're creating a failing test to increase test coverage or show a problem).
+
+## Code Style
+
+[![standard][standard-image]][standard-url]
+
+This repository uses [`standard`][standard-url] to maintain code style and consistency and avoid style arguments. `npm test` runs `standard` so you don't have to!
+
+[standard-image]: https://cdn.rawgit.com/feross/standard/master/badge.svg
+[standard-url]: https://github.com/feross/standard
+
+---
+
+# Collaborating Guidelines
+
+**This is an OPEN Open Source Project.**
+
+## What?
+
+Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.
+
+## Rules
+
+There are a few basic ground-rules for contributors:
+
+1. **No `--force` pushes** or modifying the Git history in any way.
+1. **Non-master branches** ought to be used for ongoing work.
+1. **External API changes and significant modifications** ought to be subject to an **internal pull-request** to solicit feedback from other contributors.
+1. Internal pull-requests to solicit feedback are *encouraged* for any other non-trivial contribution but left to the discretion of the contributor.
+1. Contributors should attempt to adhere to the prevailing code style.
+
+## Releases
+
+Declaring formal releases remains the prerogative of the project maintainer.
+
+## Changes to this arrangement
+
+This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change.

package/node_modules/changelog-parser/LICENSE.md

@@ -0,0 +1,15 @@
+# [ISC License](https://spdx.org/licenses/ISC)
+
+Copyright (c) 2016, Nate Goldman <ungoldman@gmail.com>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/node_modules/changelog-parser/README.md

@@ -0,0 +1,247 @@
+# changelog-parser
+
+[![npm][npm-img]][npm-url] [![travis][travis-img]][travis-url] [![standard][standard-image]][standard-url] [![downloads][downloads-img]][npm-url]
+
+Change log parser for node.
+
+[npm-img]: https://img.shields.io/npm/v/changelog-parser.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/changelog-parser
+[travis-img]: https://img.shields.io/travis/hypermodules/changelog-parser.svg?style=flat-square
+[travis-url]: https://travis-ci.org/hypermodules/changelog-parser
+[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
+[standard-url]: http://standardjs.com/
+[downloads-img]: https://img.shields.io/npm/dm/changelog-parser.svg?style=flat-square
+
+## Install
+
+```
+npm install changelog-parser
+```
+
+## Usage
+
+This module exports a single function. It supports both callbacks and promises.
+
+```js
+var parseChangelog = require('changelog-parser')
+```
+
+### Callback
+
+If provided with a callback, `parseChangelog` will invoke the function with the parsed changelog.
+
+```js
+parseChangelog('path/to/CHANGELOG.md', function (err, result) {
+  if (err) throw err
+
+  // changelog object
+  console.log(result)
+})
+```
+
+### Promise
+
+If no callback is provided, `parseChangelog` will return a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise).
+
+```js
+parseChangelog('path/to/CHANGELOG.md')
+  .then(function (result) {
+    // changelog object
+    console.log(result)
+  })
+  .catch(function (err) {
+    // Whoops, something went wrong!
+    console.error(err)
+  })
+```
+
+### Options
+
+You can optionally provide a configuration object `parseChangelog` function.
+
+```js
+parseChangelog({
+  filePath: 'path/to/CHANGELOG.md',
+  removeMarkdown: false // default: true
+})
+```
+
+#### filePath
+
+Path to changelog file.
+
+#### text
+
+Text of changelog file (you can use this instead of `filePath`).
+
+#### removeMarkdown
+
+Removes the markdown markup from the changelog entries by default. You can change its value to `false` to keep the markdown.
+
+### Command-line interface
+
+There is also a command-line interface available if you install it with `-g`.
+
+```
+npm install -g changelog-parser
+```
+
+This installs a program called `changelog-parser` that you simply pass a `CHANGELOG.md` file.
+
+```
+changelog-parser path/to/CHANGELOG.md
+```
+
+This will print the JSON object representing the change log to the terminal.
+
+Alternately you can run it without arguments and it will look for a `CHANGELOG.md` file in the working directory.
+
+## Standards
+
+This module assumes your change log is a [markdown](http://daringfireball.net/projects/markdown/syntax) file structured roughly like so:
+
+```markdown
+# changelog title
+
+A cool description (optional).
+
+## unreleased
+* foo
+
+## x.y.z - YYYY-MM-DD (or DD.MM.YYYY, D/M/YY, etc.)
+* bar
+
+## [a.b.c]
+
+### Changes
+
+* Update API
+* Fix bug #1
+
+## 2.2.3-pre.1 - 2013-02-14
+* Update API
+
+## 2.0.0-x.7.z.92 - 2013-02-14
+* bark bark
+* woof
+* arf
+
+## v1.3.0
+
+* make it so
+
+## [1.2.3](link)
+* init
+
+[a.b.c]: http://altavista.com
+```
+
+Parsing the above example will return the following object:
+
+```js
+{
+  title: 'changelog title',
+  description: 'A cool description (optional).',
+  versions: [
+    { version: null,
+      title: 'unreleased',
+      date: null,
+      body: '* foo',
+      parsed: {
+        _: [
+          'foo'
+        ]
+      }
+    },
+    { version: 'x.y.z',
+      title: 'x.y.z - YYYY-MM-DD',
+      date: null,
+      body: '* bar',
+      parsed: {
+        _: [
+          'bar'
+        ]
+      }
+    },
+    { version: 'a.b.c',
+      title: '[a.b.c]',
+      date: null,
+      body: '### Changes\n\n* Update API\n* Fix bug #1',
+      parsed: {
+        _: [
+          'Update API',
+          'Fix bug #1'
+        ],
+        Changes: [
+          'Update API',
+          'Fix bug #1'
+        ]
+      }
+    },
+    { version: '2.2.3-pre.1',
+      title: '2.2.3-pre.1 - 2013-02-14',
+      date: '2013-02-14',
+      body: '* Update API',
+      parsed: {
+        _: [
+          'Update API'
+        ]
+      }
+    },
+    { version: '2.0.0-x.7.z.92',
+      title: '2.0.0-x.7.z.92 - 2013-02-14',
+      date: '2013-02-14',
+      body: '* bark bark\n* woof\n* arf',
+      parsed: {
+        _: [
+          'bark bark',
+          'woof',
+          'arf'
+        ]
+      }
+    },
+    { version: '1.3.0',
+      title: 'v1.3.0',
+      date: null,
+      body: '* make it so',
+      parsed: {
+        _: [
+          'make it so'
+        ]
+      }
+    },
+    { version: '1.2.3',
+      title: '[1.2.3](link)',
+      date: null,
+      body: '* init',
+      parsed: {
+        _: [
+          'init'
+        ]
+      }
+    }
+  ]
+}
+```
+
+Expects versions to be [semver](http://semver.org/) compliant, otherwise sets `version` to null.
+
+Each entry is available as an object in the `versions` array. The body of a given entry can be accessed using the following properties:
+
+- `body` - A string containing all of the updates/changes/etc. for the current entry. This property includes both plain text and markdown.
+- `parsed` - An object which points to one or more arrays of data for the current entry. All data for the current entry is present in the array at key `_` (eg. `parsed._`). If the entry contains subheadings (eg. `### Added`, `### Changed`), then any items underneath each subheading will be present in an array at the corresponding key (eg. `parsed.Added`, `parsed.Changed`). Each array contains plain text.
+
+`CHANGELOG.md` standards are inspired by [keepachangelog.com](http://keepachangelog.com/).
+
+## Contributing
+
+Contributions welcome! Please read the [contributing guidelines](CONTRIBUTING.md) first.
+
+## See Also
+
+- [changelog-init](https://github.com/bcomnes/changelog-init)
+- [gh-release](https://github.com/hypermodules/gh-release)
+
+## License
+
+[ISC](LICENSE.md)

package/node_modules/changelog-parser/bin/cli.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+
+var parseChangelog = require('..')
+var file = process.argv[2] || 'CHANGELOG.md'
+var help = process.argv[2] === '-h' || process.argv[2] === '--help'
+
+if (help) {
+  console.log('usage: changelog-parser [filename]')
+  process.exit(0)
+}
+
+parseChangelog(file, function (err, result) {
+  if (err) {
+    console.error(err)
+    process.exit(1)
+  }
+
+  console.log(JSON.stringify(result))
+})

package/node_modules/changelog-parser/index.js

@@ -0,0 +1,201 @@
+var EOL = '\n'
+var lineReader = require('line-reader')
+var removeMarkdown = require('remove-markdown')
+
+// patterns
+var semver = /\[?v?([\w\d.-]+\.[\w\d.-]+[a-zA-Z0-9])\]?/
+var date = /.*[ ](\d\d?\d?\d?[-/.]\d\d?[-/.]\d\d?\d?\d?).*/
+var subhead = /^###/
+var listitem = /^[*-]/
+
+var defaultOptions = { removeMarkdown: true }
+
+/**
+ * Changelog parser.
+ *
+ * @param {string|object} options - changelog file string or options object containing file string
+ * @param {string} [options.filePath] - path to changelog file
+ * @param {string} [options.text] - changelog text (filePath alternative)
+ * @param {boolean} [options.removeMarkdown=true] - changelog file string to parse
+ * @param {function} [callback] - optional callback
+ * @returns {Promise<object>} - parsed changelog object
+ */
+function parseChangelog (options, callback) {
+  if (typeof options === 'undefined') throw new Error('missing options argument')
+  if (typeof options === 'string') options = { filePath: options }
+  if (typeof options === 'object') {
+    var hasFilePath = typeof options.filePath !== 'undefined'
+    var hasText = typeof options.text !== 'undefined'
+    var invalidFilePath = typeof options.filePath !== 'string'
+    var invalidText = typeof options.text !== 'string'
+
+    if (!hasFilePath && !hasText) {
+      throw new Error('must provide filePath or text')
+    }
+
+    if (hasFilePath && invalidFilePath) {
+      throw new Error('invalid filePath, expected string')
+    }
+
+    if (hasText && invalidText) {
+      throw new Error('invalid text, expected string')
+    }
+  }
+
+  var opts = Object.assign({}, defaultOptions, options)
+  var changelog = parse(opts)
+
+  if (typeof callback === 'function') {
+    changelog
+      .then(function (log) { callback(null, log) })
+      .catch(function (err) { callback(err) })
+  }
+
+  // otherwise, invoke callback
+  return changelog
+}
+
+/**
+ * Internal parsing logic.
+ *
+ * @param {options} options - options object
+ * @param {string} [options.filePath] - path to changelog file
+ * @param {string} [options.text] - changelog text (filePath alternative)
+ * @param {boolean} [options.removeMarkdown] - remove markdown
+ * @returns {Promise<object>} - parsed changelog object
+ */
+function parse (options) {
+  var filePath = options.filePath
+  var text = options.text
+  var data = {
+    log: { versions: [] },
+    current: null
+  }
+
+  // allow `handleLine` to mutate log/current data as `this`.
+  var cb = handleLine.bind(data, options)
+
+  return new Promise(function (resolve, reject) {
+    function done () {
+      // push last version into log
+      if (data.current) {
+        pushCurrent(data)
+      }
+
+      // clean up description
+      data.log.description = clean(data.log.description)
+      if (data.log.description === '') delete data.log.description
+
+      resolve(data.log)
+    }
+
+    if (text) {
+      text.split(/\r\n?|\n/mg).forEach(cb)
+      done()
+    } else {
+      lineReader.eachLine(filePath, cb, EOL).then(done)
+    }
+  })
+}
+
+/**
+ * Handles each line and mutates data object (bound to `this`) as needed.
+ *
+ * @param {object} options - options object
+ * @param {boolean} options.removeMarkdown - whether or not to remove markdown
+ * @param {string} line - line from changelog file
+ */
+function handleLine (options, line) {
+  // skip line if it's a link label
+  if (line.match(/^\[[^[\]]*\] *?:/)) return
+
+  // set title if it's there
+  if (!this.log.title && line.match(/^# ?[^#]/)) {
+    this.log.title = line.substring(1).trim()
+    return
+  }
+
+  // new version found!
+  if (line.match(/^##? ?[^#]/)) {
+    if (this.current && this.current.title) pushCurrent(this)
+
+    this.current = versionFactory()
+
+    if (semver.exec(line)) this.current.version = semver.exec(line)[1]
+
+    this.current.title = line.substring(2).trim()
+
+    if (this.current.title && date.exec(this.current.title)) this.current.date = date.exec(this.current.title)[1]
+
+    return
+  }
+
+  // deal with body or description content
+  if (this.current) {
+    this.current.body += line + EOL
+
+    // handle case where current line is a 'subhead':
+    // - 'handleize' subhead.
+    // - add subhead to 'parsed' data if not already present.
+    if (subhead.exec(line)) {
+      var key = line.replace('###', '').trim()
+
+      if (!this.current.parsed[key]) {
+        this.current.parsed[key] = []
+        this.current._private.activeSubhead = key
+      }
+    }
+
+    // handle case where current line is a 'list item':
+    if (listitem.exec(line)) {
+      const log = options.removeMarkdown ? removeMarkdown(line) : line
+      // add line to 'catch all' array
+      this.current.parsed._.push(log)
+
+      // add line to 'active subhead' if applicable (eg. 'Added', 'Changed', etc.)
+      if (this.current._private.activeSubhead) {
+        this.current.parsed[this.current._private.activeSubhead].push(log)
+      }
+    }
+  } else {
+    this.log.description = (this.log.description || '') + line + EOL
+  }
+}
+
+function versionFactory () {
+  return {
+    version: null,
+    title: null,
+    date: null,
+    body: '',
+    parsed: {
+      _: []
+    },
+    _private: {
+      activeSubhead: null
+    }
+  }
+}
+
+function pushCurrent (data) {
+  // remove private properties
+  delete data.current._private
+
+  data.current.body = clean(data.current.body)
+  data.log.versions.push(data.current)
+}
+
+function clean (str) {
+  if (!str) return ''
+
+  // trim
+  str = str.trim()
+  // remove leading newlines
+  str = str.replace(new RegExp('[' + EOL + ']*'), '')
+  // remove trailing newlines
+  str = str.replace(new RegExp('[' + EOL + ']*$'), '')
+
+  return str
+}
+
+module.exports = parseChangelog