Merge pull request #2 from TurboWarp/merge-upstream

Merge upstream
TurboWarp · Dec 30, 2023 · d112405 · d112405
2 parents 72f2cde + 4466427
commit d112405
Show file tree

Hide file tree

Showing 7 changed files with 20,978 additions and 1,709 deletions.
diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml
@@ -2,19 +2,17 @@ name: Node.js CI
 
 on:
   push:
-    branches: [ master ]
   pull_request:
-    branches: [ master ]
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js
-      uses: actions/setup-node@v2
+    - uses: actions/checkout@v4
+    - name: Install Node.js
+      uses: actions/setup-node@v4
       with:
-        node-version: '12.x'
-    - run: npm install
+        node-version: 16.x
+    - run: npm ci
     - run: npm test
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+v18
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -1,35 +1,39 @@
 # scratch-parser
 
-#### Parser for Scratch projects
+Parser for Scratch projects
 
-[![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)
+[![CircleCI](https://circleci.com/gh/LLK/scratch-parser.svg?style=shield)](https://app.circleci.com/pipelines/github/LLK/scratch-parser?branch=master)
 
 ## Overview
-The Scratch Parser is a [Node.js](https://nodejs.org) module that parses and validates [Scratch](https://scratch.mit.edu) projects.
+
+The Scratch Parser is a [Node.js](https://nodejs.org) module that parses and validates
+[Scratch](https://scratch.mit.edu) projects.
 
 ## API
 
-#### Installation
-```bash
+### Installation
+
+```sh
 npm install scratch-parser
 ```
 
-#### Basic Use
+### Basic Use
+
 ```js
 var fs = require('fs');
 var parser = require('scratch-parser');
 
 var buffer = fs.readFileSync('/path/to/project.sb2');
-parser(buffer, function (err, project) {
+parser(buffer, false, function (err, project) {
     if (err) // handle the error
     // do something interesting
 });
 ```
 
-#### "Info"
-In addition to the `_meta` data described above, Scratch projects include an attribute called `info` that *may* include the following:
+### "Info"
+
+In addition to the `_meta` data described above, Scratch projects include an attribute called `info` that *may*
+include the following:
 
 | Key               | Description                                              |
 | ----------------- | -------------------------------------------------------- |
@@ -40,30 +44,35 @@ In addition to the `_meta` data described above, Scratch projects include an att
 
 ## Testing
 
-#### Running the Test Suite
-```bash
+### Running the Test Suite
+
+```sh
 npm test
 ```
 
-#### Code Coverage Report
-```bash
+### Code Coverage Report
+
+```sh
 make coverage
 ```
 
-#### Performance Benchmarks / Stress Testing
-```bash
+### Performance Benchmarks / Stress Testing
+
+```sh
 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).
-```
+
+```text
 <type>(<scope>): <subject>
 <BLANK LINE>
 <body>
@@ -76,6 +85,7 @@ 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
@@ -90,14 +100,15 @@ applicable.
 Use the [commitizen CLI](https://github.com/commitizen/cz-cli) to make commits
 formatted in this way:
 
-```bash
+```sh
 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