diff --git a/LICENSE b/LICENSE index 853473ae..6acd8004 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ -The MIT License (MIT) +MIT License -Copyright (c) 2015 James Messinger +Copyright (c) Hey API Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -9,13 +9,13 @@ 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 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. +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index b3ae212c..f6d33589 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,11 @@ #### Parse, Resolve, and Dereference JSON Schema $ref pointers -[![Build Status](https://github.com/APIDevTools/json-schema-ref-parser/workflows/CI-CD/badge.svg?branch=master)](https://github.com/APIDevTools/json-schema-ref-parser/actions) -[![Coverage Status](https://coveralls.io/repos/github/APIDevTools/json-schema-ref-parser/badge.svg?branch=master)](https://coveralls.io/github/APIDevTools/json-schema-ref-parser) + -[![npm](https://img.shields.io/npm/v/@apidevtools/json-schema-ref-parser.svg)](https://www.npmjs.com/package/@apidevtools/json-schema-ref-parser) -[![License](https://img.shields.io/npm/l/@apidevtools/json-schema-ref-parser.svg)](LICENSE) -[![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen)](https://plant.treeware.earth/APIDevTools/json-schema-ref-parser) + ## Installation @@ -58,13 +57,10 @@ complex [JSON Schemas](http://json-schema.org/latest/json-schema-core.html) and JavaScript objects. - Use **JSON** or **YAML** schemas — or even a mix of both! -- Supports `$ref` pointers to external files and URLs, as well - as [custom sources](https://apitools.dev/json-schema-ref-parser/docs/plugins/resolvers.html) such as databases -- Can [bundle](https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#bundlepath-options-callback) multiple - files into a single schema that only has _internal_ `$ref` pointers -- Can [dereference](https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#dereferencepath-options-callback) - your schema, producing a plain-old JavaScript object that's easy to work with -- Supports [circular references](https://apitools.dev/json-schema-ref-parser/docs/#circular-refs), nested references, +- Supports `$ref` pointers to external files and URLs, as well as custom sources such as databases +- Can bundle multiple files into a single schema that only has _internal_ `$ref` pointers +- Can dereference your schema, producing a plain-old JavaScript object that's easy to work with +- Supports circular references, nested references, back-references, and cross-references between files - Maintains object reference equality — `$ref` pointers to the same value always resolve to the same object instance @@ -88,8 +84,6 @@ try { } ``` -For more detailed examples, please see the [API Documentation](https://apitools.dev/json-schema-ref-parser/docs/) - ## Polyfills If you are using Node.js < 18, you'll need a polyfill for `fetch`, @@ -130,16 +124,6 @@ config.plugins.push( ); ``` -## API Documentation - -Full API documentation is available [right here](https://apitools.dev/json-schema-ref-parser/docs/) - -## Contributing - -I welcome any contributions, enhancements, and -bug-fixes. [Open an issue](https://github.com/APIDevTools/json-schema-ref-parser/issues) on GitHub -and [submit a pull request](https://github.com/APIDevTools/json-schema-ref-parser/pulls). - #### Building/Testing To build/test the project locally on your computer: @@ -152,19 +136,3 @@ To build/test the project locally on your computer: 3. **Run the tests**
`yarn test` - -## License - -JSON Schema $Ref Parser is 100% free and open-source, under the [MIT license](LICENSE). Use it however you want. - -This package is [Treeware](http://treeware.earth). If you use it in production, then we ask that you [**buy the world a -tree**](https://plant.treeware.earth/APIDevTools/json-schema-ref-parser) to thank us for our work. By contributing to -the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats. - -## Big Thanks To - -Thanks to these awesome companies for their support of Open Source developers ❤ - -[![Stoplight](https://svgshare.com/i/TK5.svg)](https://stoplight.io/?utm_source=github&utm_medium=readme&utm_campaign=json_schema_ref_parser) -[![SauceLabs](https://jstools.dev/img/badges/sauce-labs.svg)](https://saucelabs.com) -[![Coveralls](https://jstools.dev/img/badges/coveralls.svg)](https://coveralls.io) diff --git a/package.json b/package.json index e853122b..08e1fd8f 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,21 @@ "name": "@hey-api/json-schema-ref-parser", "version": "0.0.1", "description": "Parse, Resolve, and Dereference JSON Schema $ref pointers", + "homepage": "https://heyapi.dev/", + "repository": { + "type": "git", + "url": "git+https://github.com/hey-api/json-schema-ref-parser.git" + }, + "bugs": { + "url": "https://github.com/hey-api/json-schema-ref-parser/issues" + }, + "license": "MIT", + "author": { + "email": "lubos@heyapi.dev", + "name": "Hey API", + "url": "https://heyapi.dev" + }, + "funding": "https://github.com/sponsors/hey-api", "keywords": [ "json", "schema", @@ -12,35 +27,6 @@ "dereference", "resolve" ], - "author": { - "name": "James Messinger", - "url": "https://jamesmessinger.com" - }, - "contributors": [ - { - "name": "Boris Cherny", - "email": "boris@performancejs.com" - }, - { - "name": "Phil Sturgeon", - "email": "phil@apisyouwonthate.com" - }, - { - "name": "Jakub Rożek", - "email": "jakub@stoplight.io" - }, - { - "name": "JonLuca DeCaro", - "email": "apis@jonlu.ca" - } - ], - "homepage": "https://apitools.dev/json-schema-ref-parser/", - "repository": { - "type": "git", - "url": "https://github.com/APIDevTools/json-schema-ref-parser.git" - }, - "license": "MIT", - "funding": "https://github.com/sponsors/philsturgeon", "types": "dist/lib/index.d.ts", "main": "dist/lib/index.js", "browser": {