mirror of
https://github.com/sablierapp/sablier.git
synced 2025-12-27 07:31:42 +01:00
docs(release): update doc version from 1.2.0 to 1.3.0-beta.1 [skip ci]
This commit is contained in:
50
node_modules/json-parse-even-better-errors/CHANGELOG.md
generated
vendored
Normal file
50
node_modules/json-parse-even-better-errors/CHANGELOG.md
generated
vendored
Normal file
@@ -0,0 +1,50 @@
|
||||
# Change Log
|
||||
|
||||
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
||||
|
||||
## 2.0.0
|
||||
|
||||
* Add custom error classes
|
||||
|
||||
<a name="1.0.2"></a>
|
||||
## [1.0.2](https://github.com/npm/json-parse-even-better-errors/compare/v1.0.1...v1.0.2) (2018-03-30)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **messages:** More friendly messages for non-string ([#1](https://github.com/npm/json-parse-even-better-errors/issues/1)) ([a476d42](https://github.com/npm/json-parse-even-better-errors/commit/a476d42))
|
||||
|
||||
|
||||
|
||||
<a name="1.0.1"></a>
|
||||
## [1.0.1](https://github.com/npm/json-parse-even-better-errors/compare/v1.0.0...v1.0.1) (2017-08-16)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **license:** oops. Forgot to update license.md ([efe2958](https://github.com/npm/json-parse-even-better-errors/commit/efe2958))
|
||||
|
||||
|
||||
|
||||
<a name="1.0.0"></a>
|
||||
# 1.0.0 (2017-08-15)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **init:** Initial Commit ([562c977](https://github.com/npm/json-parse-even-better-errors/commit/562c977))
|
||||
|
||||
|
||||
### BREAKING CHANGES
|
||||
|
||||
* **init:** This is the first commit!
|
||||
|
||||
|
||||
|
||||
<a name="0.1.0"></a>
|
||||
# 0.1.0 (2017-08-15)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **init:** Initial Commit ([9dd1a19](https://github.com/npm/json-parse-even-better-errors/commit/9dd1a19))
|
||||
25
node_modules/json-parse-even-better-errors/LICENSE.md
generated
vendored
Normal file
25
node_modules/json-parse-even-better-errors/LICENSE.md
generated
vendored
Normal file
@@ -0,0 +1,25 @@
|
||||
Copyright 2017 Kat Marchán
|
||||
Copyright npm, Inc.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a
|
||||
copy of this software and associated documentation files (the "Software"),
|
||||
to deal in the Software without restriction, including without limitation
|
||||
the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
||||
and/or sell copies of the Software, and to permit persons to whom the
|
||||
Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
DEALINGS IN THE SOFTWARE.
|
||||
|
||||
---
|
||||
|
||||
This library is a fork of 'better-json-errors' by Kat Marchán, extended and
|
||||
distributed under the terms of the MIT license above.
|
||||
96
node_modules/json-parse-even-better-errors/README.md
generated
vendored
Normal file
96
node_modules/json-parse-even-better-errors/README.md
generated
vendored
Normal file
@@ -0,0 +1,96 @@
|
||||
# json-parse-even-better-errors
|
||||
|
||||
[`json-parse-even-better-errors`](https://github.com/npm/json-parse-even-better-errors)
|
||||
is a Node.js library for getting nicer errors out of `JSON.parse()`,
|
||||
including context and position of the parse errors.
|
||||
|
||||
It also preserves the newline and indentation styles of the JSON data, by
|
||||
putting them in the object or array in the `Symbol.for('indent')` and
|
||||
`Symbol.for('newline')` properties.
|
||||
|
||||
## Install
|
||||
|
||||
`$ npm install --save json-parse-even-better-errors`
|
||||
|
||||
## Table of Contents
|
||||
|
||||
* [Example](#example)
|
||||
* [Features](#features)
|
||||
* [Contributing](#contributing)
|
||||
* [API](#api)
|
||||
* [`parse`](#parse)
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
const parseJson = require('json-parse-even-better-errors')
|
||||
|
||||
parseJson('"foo"') // returns the string 'foo'
|
||||
parseJson('garbage') // more useful error message
|
||||
parseJson.noExceptions('garbage') // returns undefined
|
||||
```
|
||||
|
||||
### Features
|
||||
|
||||
* Like JSON.parse, but the errors are better.
|
||||
* Strips a leading byte-order-mark that you sometimes get reading files.
|
||||
* Has a `noExceptions` method that returns undefined rather than throwing.
|
||||
* Attaches the newline character(s) used to the `Symbol.for('newline')`
|
||||
property on objects and arrays.
|
||||
* Attaches the indentation character(s) used to the `Symbol.for('indent')`
|
||||
property on objects and arrays.
|
||||
|
||||
## Indentation
|
||||
|
||||
To preserve indentation when the file is saved back to disk, use
|
||||
`data[Symbol.for('indent')]` as the third argument to `JSON.stringify`, and
|
||||
if you want to preserve windows `\r\n` newlines, replace the `\n` chars in
|
||||
the string with `data[Symbol.for('newline')]`.
|
||||
|
||||
For example:
|
||||
|
||||
```js
|
||||
const txt = await readFile('./package.json', 'utf8')
|
||||
const data = parseJsonEvenBetterErrors(txt)
|
||||
const indent = Symbol.for('indent')
|
||||
const newline = Symbol.for('newline')
|
||||
// .. do some stuff to the data ..
|
||||
const string = JSON.stringify(data, null, data[indent]) + '\n'
|
||||
const eolFixed = data[newline] === '\n' ? string
|
||||
: string.replace(/\n/g, data[newline])
|
||||
await writeFile('./package.json', eolFixed)
|
||||
```
|
||||
|
||||
Indentation is determined by looking at the whitespace between the initial
|
||||
`{` and `[` and the character that follows it. If you have lots of weird
|
||||
inconsistent indentation, then it won't track that or give you any way to
|
||||
preserve it. Whether this is a bug or a feature is debatable ;)
|
||||
|
||||
### API
|
||||
|
||||
#### <a name="parse"></a> `parse(txt, reviver = null, context = 20)`
|
||||
|
||||
Works just like `JSON.parse`, but will include a bit more information when
|
||||
an error happens, and attaches a `Symbol.for('indent')` and
|
||||
`Symbol.for('newline')` on objects and arrays. This throws a
|
||||
`JSONParseError`.
|
||||
|
||||
#### <a name="parse"></a> `parse.noExceptions(txt, reviver = null)`
|
||||
|
||||
Works just like `JSON.parse`, but will return `undefined` rather than
|
||||
throwing an error.
|
||||
|
||||
#### <a name="jsonparseerror"></a> `class JSONParseError(er, text, context = 20, caller = null)`
|
||||
|
||||
Extends the JavaScript `SyntaxError` class to parse the message and provide
|
||||
better metadata.
|
||||
|
||||
Pass in the error thrown by the built-in `JSON.parse`, and the text being
|
||||
parsed, and it'll parse out the bits needed to be helpful.
|
||||
|
||||
`context` defaults to 20.
|
||||
|
||||
Set a `caller` function to trim internal implementation details out of the
|
||||
stack trace. When calling `parseJson`, this is set to the `parseJson`
|
||||
function. If not set, then the constructor defaults to itself, so the
|
||||
stack trace will point to the spot where you call `new JSONParseError`.
|
||||
Reference in New Issue
Block a user