scratch-parser

Parser for Scratch projects


Overview

The Scratch Parser is a Node.js module that parses and validates
Scratch projects.

API

$3

``sh
npm install scratch-parser
`

$3

`js
var fs = require('fs');
var parser = require('scratch-parser');

var buffer = fs.readFileSync('/path/to/project.sb2');
parser(buffer, false, function (err, project) {
if (err) // handle the error
// do something interesting
});
`

$3

In addition to the _meta data described above, Scratch projects include an attribute called info that may
include the following:

| Key | Description |
| ----------------- | -------------------------------------------------------- |
| flashVersion | Installed version of Adobe Flash |
| swfVersion | Version of the Scratch editor used to create the project |
| userAgent | User agent used to create the project |
| savedExtensions | Array of Scratch Extensions used in the project |

Testing

$3

`sh
npm test
`

$3

`sh
make coverage
`

$3

`sh
make benchmark
`

Committing

This project uses 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.

`text
():