Skip to content

feat(ls): add option to pass down reference options for validation #5014

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 22, 2025
Merged

feat(ls): add option to pass down reference options for validation #5014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22608ec
feat(ls): add option to pass down reference options for validation
glowcloud Sep 17, 2025
f4d81d5
fix: make reference options not context specific
glowcloud Sep 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/apidom-ls/src/apidom-language-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ export default function getLanguageService(context: LanguageServiceContext): Lan
symbolsContext: context.symbolsContext,
colorsContext: context.colorsContext,
linksContext: context.linksContext,
referenceOptions: context.referenceOptions,
};
configureServices(languageSettings);

Expand Down
3 changes: 3 additions & 0 deletions packages/apidom-ls/src/apidom-language-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import {
ReferenceParams,
} from 'vscode-languageserver-protocol';
import { Element, ParseResultElement } from '@swagger-api/apidom-core';
import { ApiDOMReferenceOptions } from '@swagger-api/apidom-reference';

/**
* @public
Expand Down Expand Up @@ -107,6 +108,7 @@ export interface LanguageServiceContext {
colorsContext?: ColorsContext;
linksContext?: LinksContext;
refractorPlugins?: RefractorPlugins;
referenceOptions?: ApiDOMReferenceOptions;
}

/**
Expand Down Expand Up @@ -316,6 +318,7 @@ export interface LanguageSettings {
symbolsContext?: SymbolsContext;
colorsContext?: ColorsContext;
linksContext?: LinksContext;
referenceOptions?: ApiDOMReferenceOptions;
}

// export type SeverityLevel = 'error' | 'warning' | 'ignore';
Expand Down
8 changes: 8 additions & 0 deletions packages/apidom-ls/src/services/validation/validation-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,7 @@ export class DefaultValidationService implements ValidationService {
: 'https://smartbear.com/';
const apiReference = new Reference({ uri: baseURI, value: cloneDeep(result)! });
const cachedParsers = options.parse.parsers.map(DefaultValidationService.createCachedParser);
const { referenceOptions } = this.settings || {};

for (const [fragmentId, refEl] of refElements.entries()) {
const referenceElementReference = new Reference({
Expand All @@ -248,14 +249,17 @@ export class DefaultValidationService implements ValidationService {
try {
const promise = dereferenceApiDOM(refEl, {
resolve: {
...(referenceOptions?.resolve ?? {}),
baseURI: `${baseURI}#reference${fragmentId}`,
external: !toValue((refEl as ObjectElement).get('$ref')).startsWith('#'),
},
parse: {
...(referenceOptions?.parse ?? {}),
parsers: cachedParsers,
mediaType: nameSpace.mediaType,
},
dereference: {
...(referenceOptions?.dereference ?? {}),
refSet,
immutable: false,
},
Expand Down Expand Up @@ -339,6 +343,7 @@ export class DefaultValidationService implements ValidationService {
: 'https://smartbear.com/';
const apiReference = new Reference({ uri: baseURI, value: cloneDeep(result) });
const cachedParsers = options.parse.parsers.map(DefaultValidationService.createCachedParser);
const { referenceOptions } = this.settings || {};

for (const [fragmentId, refEl] of refElements.entries()) {
const referenceElementReference = new Reference({
Expand All @@ -351,14 +356,17 @@ export class DefaultValidationService implements ValidationService {
// eslint-disable-next-line no-await-in-loop
await dereferenceApiDOM(refEl, {
resolve: {
...(referenceOptions?.resolve ?? {}),
baseURI: `${baseURI}#reference${fragmentId}`,
external: !toValue((refEl as ObjectElement).get('$ref')).startsWith('#'),
},
parse: {
...(referenceOptions?.parse ?? {}),
mediaType: nameSpace.mediaType,
parsers: cachedParsers,
},
dereference: {
...(referenceOptions?.dereference ?? {}),
refSet,
immutable: false,
},
Expand Down