code optimisation for circular references issue

.circleci/config.yml

@@ -0,0 +1,70 @@
+version: 2.1
+
+orbs:
+ node: circleci/node@4.7.0
+ browser-tools: circleci/browser-tools@1.4.8
+
+executors:
+ linux:
+ docker:
+ - image: cimg/base:2022.02
+
+commands:
+ install:
+ steps:
+ - run:
+ name: Install dependencies
+ command: npm ci
+
+ test-node:
+ steps:
+ - run:
+ name: Lint the code
+ command: npm run lint
+ - run:
+ name: Run node tests
+ command: npm run test:node
+ - run:
+ name: Verify typings
+ command: npm run test:typescript
+
+jobs:
+ test:
+ parameters:
+ os:
+ type: executor
+ node-version:
+ type: string
+ executor: << parameters.os >>
+ steps:
+ - checkout
+ - node/install:
+ node-version: << parameters.node-version >>
+ install-yarn: false
+ install-npm: true
+ npm-version: "9.7.1"
+ - install
+ - test-node
+
+ test-browser:
+ docker:
+ - image: cimg/node:16.20-browsers
+ steps:
+ - checkout
+ - browser-tools/install-browser-tools
+ - install
+ - run:
+ name: Run browser tests
+ command: npm run test:browser
+
+workflows:
+ commit:
+ jobs:
+ - test:
+ matrix:
+ parameters:
+ os:
+ - linux
+ node-version:
+ - "18.19.1"
+ - test-browser

.eslintrc.yml

@@ -1,16 +1,9 @@
 # ESLint config
 # http://eslint.org/docs/user-guide/configuring
-# https://jstools.dev/eslint-config-modular/
+# https://jstools.dev/eslint-config/
 
 root: true
-
-extends:
- - "@jsdevtools/modular/best-practices"
- - "@jsdevtools/modular/style"
- - "@jsdevtools/modular/browser"
- - "@jsdevtools/modular/node"
- - "@jsdevtools/modular/es6"
-
-rules:
- # This rule erroneously flags functions that use the `arguments` object
- no-unused-vars: off
+extends: "@jsdevtools"
+env:
+ node: true
+ browser: true

.github/workflows/CI-CD.yaml

@@ -28,15 +28,15 @@ jobs:
  - macos-latest
  - windows-latest
  node:
- - 10
- - 12
+ - 18
+ - 20
 
  steps:
  - name: Checkout source
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
 
  - name: Install Node ${{ matrix.node }}
- uses: actions/setup-node@v1
+ uses: actions/setup-node@v3
  with:
  node-version: ${{ matrix.node }}
 
@@ -53,30 +53,29 @@ jobs:
  run: npm run coverage:node
 
  - name: Send code coverage results to Coveralls
- uses: coverallsapp/github-action@v1.0.1
+ uses: coverallsapp/github-action@v1.1.0
  with:
  github-token: ${{ secrets.GITHUB_TOKEN }}
  parallel: true
 
  browser_tests:
  name: Browser Tests
  runs-on: ${{ matrix.os }}
- timeout-minutes: 10
+ timeout-minutes: 15
  strategy:
  fail-fast: true
  matrix:
  os:
- - ubuntu-latest # Chrome, Firefox, Safari (via SauceLabs), Edge (via SauceLabs)
- - windows-latest # Internet Explorer
+ - ubuntu-latest # Chrome, Firefox
 
  steps:
  - name: Checkout source
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
 
  - name: Install Node
- uses: actions/setup-node@v1
+ uses: actions/setup-node@v3
  with:
- node-version: 12
+ node-version: 16
 
  - name: Install dependencies
  run: npm ci
@@ -94,21 +93,21 @@ jobs:
  cat coverage/*/lcov.info > ./coverage/lcov.info
 
  - name: Send code coverage results to Coveralls
- uses: coverallsapp/github-action@v1.0.1
+ uses: coverallsapp/github-action@v1.1.0
  with:
  github-token: ${{ secrets.GITHUB_TOKEN }}
  parallel: true
 
  coverage:
  name: Code Coverage
  runs-on: ubuntu-latest
- timeout-minutes: 10
+ timeout-minutes: 5
  needs:
  - node_tests
  - browser_tests
  steps:
  - name: Let Coveralls know that all tests have finished
- uses: coverallsapp/github-action@v1.0.1
+ uses: coverallsapp/github-action@v1.1.0
  with:
  github-token: ${{ secrets.GITHUB_TOKEN }}
  parallel-finished: true
@@ -124,10 +123,10 @@ jobs:
 
  steps:
  - name: Checkout source
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
 
  - name: Install Node
- uses: actions/setup-node@v1
+ uses: actions/setup-node@v3
 
  - name: Install dependencies
  run: npm ci

.nvmrc

@@ -0,0 +1 @@
+18

.vscode/tasks.json

@@ -7,23 +7,34 @@
 // ${cwd}: the current working directory of the spawned process
 
 {
- "version": "0.1.0",
+ "version": "2.0.0",
  "command": "npm",
- "isShellCommand": true,
- "suppressTaskName": true,
  "tasks": [
  {
- "taskName": "lint",
- "args": ["run", "lint"],
- "showOutput": "always",
+ "label": "lint",
+ "type": "shell",
+ "args": [
+ "run",
+ "lint"
+ ],
  "problemMatcher": "$eslint-stylish",
- "isBuildCommand": true
+ "group": {
+ "_id": "build",
+ "isDefault": false
+ }
  },
  {
- "taskName": "test",
- "args": ["run", "mocha"],
- "showOutput": "always",
- "isTestCommand": true
+ "label": "test",
+ "type": "shell",
+ "args": [
+ "run",
+ "mocha"
+ ],
+ "problemMatcher": [],
+ "group": {
+ "_id": "test",
+ "isDefault": false
+ }
  }
  ]
 }

docs/options.md

@@ -10,6 +10,7 @@ Example
 
 ```javascript
 $RefParser.dereference("my-schema.yaml", {
+ continueOnError: true, // Don't throw on the first error
  parse: {
  json: false, // Disable the JSON parser
  yaml: {
@@ -27,10 +28,10 @@ $RefParser.dereference("my-schema.yaml", {
  withCredentials: true, // Include auth credentials when resolving HTTP references
  }
  },
- continueOnError: true, // Don't throw on the first error
  dereference: {
  circular: false // Don't allow circular $refs
- }
+ },
+ bundle: {} // bundling specific options
 });
 ```
 
@@ -39,15 +40,15 @@ $RefParser.dereference("my-schema.yaml", {
 -------------------
 The `parse` options determine how different types of files will be parsed.
 
-JSON Schema $Ref Parser comes with built-in JSON, YAML, plain-text, and binary parsers, any of which you can configure or disable. You can also add [your own custom parsers](plugins/parsers.md) if you want.
+JSON Schema $Ref Parser comes with built-in JSON, YAML, and plain-text parsers, any of which you can configure or disable. You can also add [your own custom parsers](plugins/parsers.md) if you want.
 
-|Option(s) |Type |Description
-|:----------------------------|:----------|:------------
-|`json`<br>`yaml`<br>`text`<br>`binary`|`object` `boolean`|These are the built-in parsers. In addition, you can add [your own custom parsers](plugins/parsers.md)<br><br>To disable a parser, just set it to `false`.
-|`json.order` `yaml.order` `text.order` `binary.order`|`number`|Parsers run in a specific order, relative to other parsers. For example, a parser with `order: 5` will run _before_ a parser with `order: 10`. If a parser is unable to successfully parse a file, then the next parser is tried, until one succeeds or they all fail.<br><br>You can change the order in which parsers run, which is useful if you know that most of your referenced files will be a certain type, or if you add [your own custom parser](plugins/parsers.md) that you want to run _first_.
-|`json.allowEmpty` `yaml.allowEmpty` `text.allowEmpty` `binary.allowEmpty`|`boolean`|All of the built-in parsers allow empty files by default. The JSON and YAML parsers will parse empty files as `undefined`. The text parser will parse empty files as an empty string. The binary parser will parse empty files as an empty byte array.<br><br>You can set `allowEmpty: false` on any parser, which will cause an error to be thrown if a file empty.
-|`json.canParse` `yaml.canParse` `text.canParse` `binary.canParse`|`boolean`, `RegExp`, `string`, `array`, `function`|Determines which parsers will be used for which files.<br><br>A regular expression can be used to match files by their full path. A string (or array of strings) can be used to match files by their file extension. Or a function can be used to perform more complex matching logic. See the [custom parser](plugins/parsers.md) docs for details.
-|`text.encoding`|`string` |The encoding to use when parsing text-based files. The default is "utf8".
+| Option(s)  |Type |Description
+|:-----------------------------------------------------------------------|:----------|:------------
+| `json`<br>`yaml`<br>`text` |`object` `boolean`|These are the built-in parsers. In addition, you can add [your own custom parsers](plugins/parsers.md)<br><br>To disable a parser, just set it to `false`.
+| `json.order` `yaml.order` `text.order`  |`number`|Parsers run in a specific order, relative to other parsers. For example, a parser with `order: 5` will run _before_ a parser with `order: 10`. If a parser is unable to successfully parse a file, then the next parser is tried, until one succeeds or they all fail.<br><br>You can change the order in which parsers run, which is useful if you know that most of your referenced files will be a certain type, or if you add [your own custom parser](plugins/parsers.md) that you want to run _first_.
+| `json.allowEmpty` `yaml.allowEmpty` `text.allowEmpty`  |`boolean`|All of the built-in parsers allow empty files by default. The JSON and YAML parsers will parse empty files as `undefined`. The text parser will parse empty files as an empty string.
+| `json.canParse` `yaml.canParse` `text.canParse`  |`boolean`, `RegExp`, `string`, `array`, `function`|Determines which parsers will be used for which files.<br><br>A regular expression can be used to match files by their full path. A string (or array of strings) can be used to match files by their file extension. Or a function can be used to perform more complex matching logic. See the [custom parser](plugins/parsers.md) docs for details.
+| `text.encoding` |`string` |The encoding to use when parsing text-based files. The default is "utf8".
 
 
 `resolve` Options
@@ -75,3 +76,14 @@ The `dereference` options control how JSON Schema $Ref Parser will dereference `
 |Option(s) |Type |Description
 |:---------------------|:-------------------|:------------
 |`circular`|`boolean` or `"ignore"`|Determines whether [circular `$ref` pointers](README.md#circular-refs) are handled.<br><br>If set to `false`, then a `ReferenceError` will be thrown if the schema contains any circular references.<br><br> If set to `"ignore"`, then circular references will simply be ignored. No error will be thrown, but the [`$Refs.circular`](refs.md#circular) property will still be set to `true`.
+
+`bundle` Options
+
+The `bundle` options control how JSON Schema $Ref Parser will bundle `$ref` pointers within the JSON schema.
+
+
+|Option(s) |Type |Description
+|:---------------------|:-------------------|:------------
+|`generateKey`|`(value: any, file: string, hash: string or null) => string or null`|Used to generate $ref.
+|`defaultRoot`|`string`|The default root to optimize for.
+

docs/plugins/parsers.md

@@ -1,7 +1,7 @@
 Custom Parsers
 ==========================
 
-JSON Schema $Ref Parser comes with built-in JSON, YAML, plain-text, and binary parsers, but you can add your own parsers to support additional file types, or even replace any of the built-in parsers with your own custom implementation.
+JSON Schema $Ref Parser comes with built-in JSON, YAML, and plain-text parsers, but you can add your own parsers to support additional file types, or even replace any of the built-in parsers with your own custom implementation.
 
 You can see the source code for any of the built-in parsers [right here](../../lib/parsers).
 
@@ -26,7 +26,7 @@ $RefParser.dereference(mySchema, { parse: { csv: myParser }});
 ```
 
 #### The `order` property
-All parsers have an `order` property, even the built-in parsers. If you don't specify an `order` property, then your parser will run last. Specifying `order: 1`, like we did in this example, will make your parser run first. Or you can squeeze your parser in-between some of the built-in parsers. For example, `order: 201` would make it run _after_ the JSON and YAML parsers, but _before_ the plain-text and binary parsers. You can see the order of all the built-in parsers by looking at [their source code](../../lib/parsers).
+All parsers have an `order` property, even the built-in parsers. If you don't specify an `order` property, then your parser will run last. Specifying `order: 1`, like we did in this example, will make your parser run first. Or you can squeeze your parser in-between some of the built-in parsers. For example, `order: 201` would make it run _after_ the JSON and YAML parsers, but _before_ the plain-text parser. You can see the order of all the built-in parsers by looking at [their source code](../../lib/parsers).
 
 The `order` property and `canParse` property are related to each other. For each file that JSON Schema $Ref Parser needs to parse, it first determines which parsers _can_ parse that file by checking their `canParse` property. If only one parser matches a file, then _only_ that one parser is called, regardless of its `order`. If multiple parsers match a file, then those parsers are tried _in order_ until one of them successfully parses the file. Once a parser successfully parses the file, the rest of the parsers are skipped.
 

karma.conf.js

@@ -13,8 +13,5 @@ module.exports = karmaConfig({
  browsers: {
  chrome: host.ci ? host.os.linux : true,
  firefox: host.ci ? host.os.linux : true,
- safari: host.ci ? host.os.linux : host.os.mac,
- edge: host.ci ? host.os.linux : host.os.windows,
- ie: host.os.windows,
  },
 });