https://github.com/cvent/spectral-bug-example
Repo that contains a bug linting jsonschema files using spectral when the schema files have a circular reference and the lint command is provided a glob of files.
https://github.com/cvent/spectral-bug-example
Last synced: 5 months ago
JSON representation
Repo that contains a bug linting jsonschema files using spectral when the schema files have a circular reference and the lint command is provided a glob of files.
- Host: GitHub
- URL: https://github.com/cvent/spectral-bug-example
- Owner: cvent
- Created: 2023-12-14T17:51:51.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-01-14T01:09:14.000Z (5 months ago)
- Last Synced: 2026-01-14T04:59:46.740Z (5 months ago)
- Size: 30.3 KB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Simple repo to demonstrate spectral bug
A Simple repo to show a bug when linting a glob pattern.
## Installation instructions
Ensure you either have nodejs installed or asdf installed and the nodejs plugin added. If using asdf, run `asdf install`. Then run `npm install`
## Reproducing the bug
Simple scripts have been added to `package.json` to reproduce the bug. To see the bug, simply run
```
npm run lint
```
This will use spectral to lint all the .json files in this repo. This will cause the following error to be reported
```
spectral-bug-example/models/bulk-response.json
1:1 error invalid-ref ENOENT: no such file or directory, open 'spectral-bug-example/models/error.json' properties.data.oneOf[1].properties.details.items.properties.details.items.properties.details.items.properties.details.items.$ref
```
But if you run any of the three following commands
```
npm run lint-bulk
npm run lint-item
npm run lint-error
```
which lints just a single json file at a time, no error is reported.
## Probable reasons for bug
If you look at the reported error, it is looking for `error.json` in the `models` folder even though `error.json` is in the `errors` folder. I believe this is happening because while linting `bulk-response-item.json` it fully resolves it, and because `error.json` contains a relative reference to itself, it is preserved, and brought into `bulk-response-item.json`. And when `bulk-response.json` is resolved, it brings in the already resolved `bulk-response-item.json`, including the now incorrect reference to `error.json`. I also noticed this only happens if `bulk-response-item.json` is linted before `bulk-response.json`, if, for example, you change the name of `bulk-item-response.json` to `item.json` and update the references to it, then run the lint command, it will resolve normally.