Merge pull request #9 from LLK/develop

build(release): Configure semantic release

Author: mewtaylor

.travis.yml

@@ -1,8 +1,18 @@
-language: node_js
-node_js:
-- "4"
-- "stable"
 sudo: false
+language: node_js
 cache:
   directories:
-  - node_modules
+    - node_modules
+notifications:
+  email: false
+node_js:
+  - '4'
+before_install:
+  - npm i -g npm@^2.0.0
+before_script:
+  - npm prune
+after_success:
+  - npm run semantic-release
+branches:
+  except:
+    - /^v\d+\.\d+\.\d+$/

LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2016, Massachusetts Institute of Technology
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,9 +1,9 @@
 # scratch-parser
 #### Parser for Scratch projects
 
-[![Build Status](https://travis-ci.com/LLK/scratch-parser.svg?token=xzzHj4ct3SyBTpeqxnx1&branch=master)](https://travis-ci.com/LLK/scratch-parser)
-[![Dependency Status](https://david-dm.org/llk/scratch-parser.svg)](https://david-dm.org/llk/scratch-parser)
-[![devDependency Status](https://david-dm.org/llk/scratch-parser/dev-status.svg)](https://david-dm.org/llk/scratch-parser#info=devDependencies)
+[![Build Status](https://travis-ci.org/LLK/scratch-parser.svg?branch=develop)](https://travis-ci.org/LLK/scratch-parser)
+[![dependencies Status](https://david-dm.org/llk/scratch-parser/status.svg)](https://david-dm.org/llk/scratch-parser)
+[![devDependencies Status](https://david-dm.org/llk/scratch-parser/dev-status.svg)](https://david-dm.org/llk/scratch-parser?type=dev)
 
 ## Overview
 The Scratch Parser is a [Node.js](https://nodejs.org) module that parses and validates [Scratch](https://scratch.mit.edu) projects. Internally, this utility is used for validation of Scratch projects as well as for extracting metadata from projects for research and search purposes.
@@ -18,16 +18,18 @@ npm install scratch-parser
 #### Basic Use
 ```js
 var fs = require('fs');
-var scratchp = require('scratch-parser');
+var parser = require('scratch-parser');
 
 var buffer = fs.readFileSync('/path/to/project.sb2');
-scratchp(buffer, function (err, project) {
+parser(buffer, function (err, project) {
     if (err) // handle the error
     // do something interesting
 });
 ```
 
 ## Metadata
+The `scratch-parser` module will append metadata about the project should validation and parsing be successful. The `_meta` object includes:
+
 | Key               | Attributes                                               |
 | ----------------- | -------------------------------------------------------- |
 | `scripts`         | `count`                                                  |
@@ -66,3 +68,51 @@ make coverage
 ```bash
 make benchmark
 ```
+
+## Committing
+This project uses [semantic release](https://github.com/semantic-release/semantic-release)
+to ensure version bumps follow semver so that projects using the config don't
+break unexpectedly.
+
+In order to automatically determine the type of version bump necessary, semantic
+release expects commit messages to be formatted following
+[conventional-changelog](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md).
+```
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+`subject` and `body` are your familiar commit subject and body. `footer` is
+where you would include `BREAKING CHANGE` and `ISSUES FIXED` sections if
+applicable.
+
+`type` is one of:
+* `fix`: A bug fix **Causes a patch release (0.0.x)**
+* `feat`: A new feature **Causes a minor release (0.x.0)**
+* `docs`: Documentation only changes
+* `style`: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+* `refactor`: A code change that neither fixes a bug nor adds a feature
+* `perf`: A code change that improves performance **May or may not cause a minor release. It's not clear.**
+* `test`: Adding missing tests or correcting existing tests
+* `ci`: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
+* `chore`: Other changes that don't modify src or test files
+* `revert`: Reverts a previous commit
+
+Use the [commitizen CLI](https://github.com/commitizen/cz-cli) to make commits
+formatted in this way:
+
+```bash
+npm install -g commitizen
+npm install
+```
+
+Now you're ready to make commits using `git cz`.
+
+## Breaking changes
+If you're committing a change that will require changes to existing code, ensure
+your commit specifies a breaking change.  In your commit body, prefix the changes with "BREAKING CHANGE: "
+This will cause a major version bump so downstream projects must choose to upgrade
+the config and will not break the build unexpectedly.

TRADEMARK

@@ -0,0 +1,7 @@
+The Scratch trademarks, including the Scratch name, logo, the Scratch Cat, Gobo, Pico, Nano, Tera and Giga graphics (the "Marks"), are property of the Massachusetts Institute of Technology (MIT), and the use of the Marks is governed by this policy.
+
+You may use the Marks to refer to Scratch in Substantially Unmodified form.
+
+"Substantially Unmodified" means the source code provided by MIT, possibly with minor modifications including but not limited to: bug fixes (including security), changing the locations of files for better integration with the host operating system, adding documentation, and changes to the dynamic linking of libraries.
+
+A version is not "Substantially Unmodified" if it incorporates features not present in a release of Scratch by MIT.  If you do make a substantial modification, to avoid confusion with versions of Scratch produced by MIT you must remove all Marks from your version of the software and refrain from using any of the Marks to refer to your version.

package.json

@@ -1,30 +1,37 @@
 {
   "name": "scratch-parser",
-  "version": "1.0.0",
   "description": "Parser for Scratch projects",
   "author": "MIT Media Lab",
   "license": "BSD-3-Clause",
   "homepage": "https://github.com/LLK/scratch-parser#readme",
   "main": "index.js",
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@github.com/LLK/scratch-parser.git"
+    "url": "https://github.com/LLK/scratch-parser.git"
   },
   "scripts": {
-    "test": "make test"
+    "test": "make test",
+    "semantic-release": "semantic-release pre && npm publish && semantic-release post"
   },
   "dependencies": {
     "adm-zip": "0.4.7",
-    "ajv": "3.4.0",
-    "async": "1.5.2"
+    "ajv": "4.7.0",
+    "async": "2.0.1"
   },
   "devDependencies": {
-    "benchmark": "^2.0.0",
-    "eslint": "^1.10.3",
-    "glob": "^6.0.4",
-    "tap": "^5.1.1"
+    "benchmark": "^2.1.1",
+    "cz-conventional-changelog": "2.0.0",
+    "eslint": "^3.5.0",
+    "glob": "^7.0.6",
+    "tap": "^7.1.2",
+    "semantic-release": "^6.3.2"
   },
   "engines": {
     "node": ">=4.0"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
   }
 }