Skip to content

feat(ls): recognize OpenAPI 3.0.x definitions #2056

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 23, 2022
Merged

feat(ls): recognize OpenAPI 3.0.x definitions #2056

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
807168b
feat(ls): recognize OpenAPI 3.0.x definitions
char0n Sep 23, 2022
2c6a429
Merge branch 'main' into char0n/openapi-processing-ls
char0n Sep 23, 2022
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
4 changes: 4 additions & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions packages/apidom-ls/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@
"@swagger-api/apidom-parser-adapter-asyncapi-json-2": "^0.46.0",
"@swagger-api/apidom-parser-adapter-asyncapi-yaml-2": "^0.46.0",
"@swagger-api/apidom-parser-adapter-json": "^0.46.0",
"@swagger-api/apidom-parser-adapter-openapi-json-3-0": "^0.46.0",
"@swagger-api/apidom-parser-adapter-openapi-yaml-3-0": "^0.46.0",
"@swagger-api/apidom-parser-adapter-openapi-json-3-1": "^0.46.0",
"@swagger-api/apidom-parser-adapter-openapi-yaml-3-1": "^0.46.0",
"@swagger-api/apidom-parser-adapter-yaml-1-2": "^0.46.0",
Expand Down
84 changes: 52 additions & 32 deletions packages/apidom-ls/src/parser-factory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,16 @@
// @ts-ignore
import * as openapi3_1Adapter from '@swagger-api/apidom-parser-adapter-openapi-json-3-1';
// @ts-ignore
import * as asyncapi2Adapter from '@swagger-api/apidom-parser-adapter-asyncapi-json-2';
// @ts-ignore
import * as openapi3_1Adapter_Yaml from '@swagger-api/apidom-parser-adapter-openapi-yaml-3-1';
// @ts-ignore
import * as asyncapi2Adapter_Yaml from '@swagger-api/apidom-parser-adapter-asyncapi-yaml-2';
// @ts-ignore
import * as adsAdapter from '@swagger-api/apidom-parser-adapter-api-design-systems-json';
// @ts-ignore
import * as adsAdapter_Yaml from '@swagger-api/apidom-parser-adapter-api-design-systems-yaml';
// @ts-ignore
import * as jsonParserAdapter from '@swagger-api/apidom-parser-adapter-json';
// @ts-ignore
import * as yamlParserAdapter from '@swagger-api/apidom-parser-adapter-yaml-1-2';
// @ts-ignore
import { refractorPluginReplaceEmptyElement } from '@swagger-api/apidom-ns-asyncapi-2';
import { refractorPluginReplaceEmptyElement as refractorPluginReplaceEmptyElementOas } from '@swagger-api/apidom-ns-openapi-3-1';
import * as openapi3_0AdapterJson from '@swagger-api/apidom-parser-adapter-openapi-json-3-0';
import * as openapi3_0AdapterYaml from '@swagger-api/apidom-parser-adapter-openapi-yaml-3-0';
import * as openapi3_1AdapterJson from '@swagger-api/apidom-parser-adapter-openapi-json-3-1';
import * as openapi3_1AdapterYaml from '@swagger-api/apidom-parser-adapter-openapi-yaml-3-1';
import * as asyncapi2AdapterJson from '@swagger-api/apidom-parser-adapter-asyncapi-json-2';
import * as asyncapi2AdapterYaml from '@swagger-api/apidom-parser-adapter-asyncapi-yaml-2';
import * as adsAdapterJson from '@swagger-api/apidom-parser-adapter-api-design-systems-json';
import * as adsAdapterYaml from '@swagger-api/apidom-parser-adapter-api-design-systems-yaml';
import * as adapterJson from '@swagger-api/apidom-parser-adapter-json';
import * as adapterYaml from '@swagger-api/apidom-parser-adapter-yaml-1-2';
import { refractorPluginReplaceEmptyElement as refractorPluginReplaceEmptyElementAsyncAPI2 } from '@swagger-api/apidom-ns-asyncapi-2';
import { refractorPluginReplaceEmptyElement as refractorPluginReplaceEmptyElementOpenAPI3_0 } from '@swagger-api/apidom-ns-openapi-3-0';
import { refractorPluginReplaceEmptyElement as refractorPluginReplaceEmptyElementOpenAPI3_1 } from '@swagger-api/apidom-ns-openapi-3-1';
import { TextDocument } from 'vscode-languageserver-textdocument';
import { ParseResultElement } from '@swagger-api/apidom-core';

Expand All @@ -42,36 +36,62 @@ export async function parse(
let result;
const contentLanguage = await findNamespace(text, defaultContentLanguage);
if (contentLanguage.namespace === 'asyncapi' && contentLanguage.format === 'JSON') {
result = await asyncapi2Adapter.parse(text, { sourceMap: true });
result = await asyncapi2AdapterJson.parse(text, { sourceMap: true });
} else if (contentLanguage.namespace === 'asyncapi' && contentLanguage.format === 'YAML') {
const options: Record<string, unknown> = {
sourceMap: true,
};
if (registerPlugins) {
options.refractorOpts = { plugins: [refractorPluginReplaceEmptyElement()] };
options.refractorOpts = { plugins: [refractorPluginReplaceEmptyElementAsyncAPI2()] };
}
result = await asyncapi2Adapter_Yaml.parse(text, options);
} else if (contentLanguage.namespace === 'openapi' && contentLanguage.format === 'JSON') {
result = await openapi3_1Adapter.parse(text, { sourceMap: true });
} else if (contentLanguage.namespace === 'openapi' && contentLanguage.format === 'YAML') {
result = await asyncapi2AdapterYaml.parse(text, options);
} else if (
contentLanguage.namespace === 'openapi' &&
contentLanguage.version?.startsWith('3.0') &&
contentLanguage.format === 'JSON'
) {
result = await openapi3_0AdapterJson.parse(text, { sourceMap: true });
} else if (
contentLanguage.namespace === 'openapi' &&
contentLanguage.version?.startsWith('3.0') &&
contentLanguage.format === 'YAML'
) {
const options: Record<string, unknown> = {
sourceMap: true,
};
if (registerPlugins) {
options.refractorOpts = { plugins: [refractorPluginReplaceEmptyElementOas()] };
options.refractorOpts = { plugins: [refractorPluginReplaceEmptyElementOpenAPI3_0()] };
}
result = await openapi3_1Adapter_Yaml.parse(text, options);
result = await openapi3_0AdapterYaml.parse(text, { sourceMap: true });
} else if (
contentLanguage.namespace === 'openapi' &&
contentLanguage.version?.startsWith('3.1') &&
contentLanguage.format === 'JSON'
) {
result = await openapi3_1AdapterJson.parse(text, { sourceMap: true });
} else if (
contentLanguage.namespace === 'openapi' &&
contentLanguage.version?.startsWith('3.1') &&
contentLanguage.format === 'YAML'
) {
const options: Record<string, unknown> = {
sourceMap: true,
};
if (registerPlugins) {
options.refractorOpts = { plugins: [refractorPluginReplaceEmptyElementOpenAPI3_1()] };
}
result = await openapi3_1AdapterYaml.parse(text, options);
} else if (contentLanguage.namespace === 'ads' && contentLanguage.format === 'JSON') {
result = await adsAdapter.parse(text, { sourceMap: true });
result = await adsAdapterJson.parse(text, { sourceMap: true });
} else if (contentLanguage.namespace === 'ads' && contentLanguage.format === 'YAML') {
result = await adsAdapter_Yaml.parse(text, { sourceMap: true });
result = await adsAdapterYaml.parse(text, { sourceMap: true });
} else if (contentLanguage.namespace === 'apidom' && contentLanguage.format === 'JSON') {
result = await jsonParserAdapter.parse(text, { sourceMap: true });
result = await adapterJson.parse(text, { sourceMap: true });
} else if (contentLanguage.namespace === 'apidom' && contentLanguage.format === 'YAML') {
result = await yamlParserAdapter.parse(text, { sourceMap: true });
result = await adapterYaml.parse(text, { sourceMap: true });
} else {
// fallback
result = await jsonParserAdapter.parse(text, { sourceMap: true });
result = await adapterJson.parse(text, { sourceMap: true });
}
const { api } = result;
if (api === undefined) return result;
Expand Down
2 changes: 1 addition & 1 deletion packages/apidom-ls/src/services/validation/linter-functions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import { FunctionItem } from '../../apidom-language-types';

const root = (el: Element): Element => {
let node = el;
while (node.parent && !['openApi3_1', 'asyncApi2'].includes(node.parent.element)) {
while (node.parent && !['openApi3_0', 'openApi3_1', 'asyncApi2'].includes(node.parent.element)) {
node = node.parent;
}
return node.parent;
Expand Down
72 changes: 45 additions & 27 deletions packages/apidom-ls/src/utils/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,13 @@
// @ts-ignore
import * as openapi3_1Adapter from '@swagger-api/apidom-parser-adapter-openapi-json-3-1';
// @ts-ignore
import * as asyncapi2Adapter from '@swagger-api/apidom-parser-adapter-asyncapi-json-2';
// @ts-ignore
import * as openapi3_1Adapter_Yaml from '@swagger-api/apidom-parser-adapter-openapi-yaml-3-1';
// @ts-ignore
import * as asyncapi2Adapter_Yaml from '@swagger-api/apidom-parser-adapter-asyncapi-yaml-2';
// @ts-ignore
import * as adsAdapter from '@swagger-api/apidom-parser-adapter-api-design-systems-json';
// @ts-ignore
import * as adsAdapter_Yaml from '@swagger-api/apidom-parser-adapter-api-design-systems-yaml';
// @ts-ignore
import * as jsonParserAdapter from '@swagger-api/apidom-parser-adapter-json';
// @ts-ignore
import * as yamlParserAdapter from '@swagger-api/apidom-parser-adapter-yaml-1-2';
import * as openapi3_0AdapterJson from '@swagger-api/apidom-parser-adapter-openapi-json-3-0';
import * as openapi3_0AdapterYaml from '@swagger-api/apidom-parser-adapter-openapi-yaml-3-0';
import * as openapi3_1AdapterJson from '@swagger-api/apidom-parser-adapter-openapi-json-3-1';
import * as openapi3_1AdapterYaml from '@swagger-api/apidom-parser-adapter-openapi-yaml-3-1';
import * as asyncapi2AdapterJson from '@swagger-api/apidom-parser-adapter-asyncapi-json-2';
import * as asyncapi2AdapterYaml from '@swagger-api/apidom-parser-adapter-asyncapi-yaml-2';
import * as adsAdapterJson from '@swagger-api/apidom-parser-adapter-api-design-systems-json';
import * as adsAdapterYaml from '@swagger-api/apidom-parser-adapter-api-design-systems-yaml';
import * as adapterJson from '@swagger-api/apidom-parser-adapter-json';
import * as adapterYaml from '@swagger-api/apidom-parser-adapter-yaml-1-2';
import {
ArrayElement,
BooleanElement,
Expand Down Expand Up @@ -738,17 +732,17 @@ export function getText(document: TextDocument | string, trim = false): string {

export async function isJsonDoc(document: TextDocument | string): Promise<boolean> {
const text = getText(document, true);
return await jsonParserAdapter.detect(text);
return await adapterJson.detect(text);
}

export function isJsonDocSync(document: TextDocument | string): boolean {
const text = getText(document, true);
return jsonParserAdapter.detectionRegExp.test(text);
return adapterJson.detectionRegExp.test(text);
}

export async function isYamlDoc(document: TextDocument | string): Promise<boolean> {
const text = getText(document, true);
return (await yamlParserAdapter.detect(text)) && !(await isJsonDoc(document));
return (await adapterYaml.detect(text)) && !(await isJsonDoc(document));
}

export async function findNamespace(
Expand All @@ -758,43 +752,67 @@ export async function findNamespace(
): Promise<ContentLanguage> {
const text = getText(document, true);
const json = await isJsonDoc(text);
if (await asyncapi2Adapter.detect(text)) {
if (await asyncapi2AdapterJson.detect(text)) {
const versionMatch = text.match(asyncapi2AdapterJson.detectionRegExp);
return {
namespace: 'asyncapi',
version: versionMatch?.groups?.version_json,
format: 'JSON',
};
}
if (await asyncapi2Adapter_Yaml.detect(text)) {
if (await asyncapi2AdapterYaml.detect(text)) {
const versionMatch = text.match(asyncapi2AdapterYaml.detectionRegExp);
return {
namespace: 'asyncapi',
version: versionMatch?.groups?.version_yaml || versionMatch?.groups?.version_json,
format: 'YAML',
};
}
if (await openapi3_1Adapter.detect(text)) {
if (await openapi3_0AdapterJson.detect(text)) {
const versionMatch = text.match(openapi3_0AdapterYaml.detectionRegExp);
return {
namespace: 'openapi',
version: versionMatch?.groups?.version_json,
format: 'JSON',
};
}
if (await openapi3_1Adapter_Yaml.detect(text)) {
if (await openapi3_0AdapterYaml.detect(text)) {
const versionMatch = text.match(openapi3_0AdapterYaml.detectionRegExp);
return {
namespace: 'openapi',
version: versionMatch?.groups?.version_yaml || versionMatch?.groups?.version_json,
format: 'YAML',
};
}
if (await adsAdapter.detect(text)) {
if (await openapi3_1AdapterJson.detect(text)) {
const versionMatch = text.match(openapi3_1AdapterYaml.detectionRegExp);
return {
namespace: 'openapi',
version: versionMatch?.groups?.version_json,
format: 'JSON',
};
}
if (await openapi3_1AdapterYaml.detect(text)) {
const versionMatch = text.match(openapi3_1AdapterYaml.detectionRegExp);
return {
namespace: 'openapi',
version: versionMatch?.groups?.version_yaml || versionMatch?.groups?.version_json,
format: 'YAML',
};
}
if (await adsAdapterJson.detect(text)) {
return {
namespace: 'ads',
format: 'JSON',
};
}
if (await adsAdapter_Yaml.detect(text)) {
if (await adsAdapterYaml.detect(text)) {
return {
namespace: 'ads',
format: 'YAML',
};
}
if (await jsonParserAdapter.detect(text)) {
if (await adapterJson.detect(text)) {
return defaultContentLanguage
? {
namespace: defaultContentLanguage.namespace,
Expand All @@ -806,7 +824,7 @@ export async function findNamespace(
format: 'JSON',
};
}
if (await yamlParserAdapter.detect(text)) {
if (await adapterYaml.detect(text)) {
return defaultContentLanguage
? {
namespace: defaultContentLanguage.namespace,
Expand Down