@swagger-api/apidom-ls

ApiDOM Language Service (apidom-ls)

The ApiDOM Language Service (apidom-ls) contains the language smarts powering ApiDOM supported languages processing, specifically editing experience.

ApiDOM Language Service APIs adhere to LSP Protocol and are therefore usable via a LSP Server wrapper in a variety of editors and IDEs.

Installation

After prerequisites for installing this package are satisfied, you can install it via npm CLI by running the following command:

 $ npm install @swagger-api/apidom-ls

Project current status

Please note that ApiDOM Language Service is still in unstable status, with planned APIs changes specifically in terms of "configuration rules" structure.

Quick start (WIP)

Validation

import { getLanguageService } from '@swagger-api/apidom-ls';
import { TextDocument } from 'vscode-languageserver-textdocument';
...

const apidomContext = {};
const languageService = getLanguageService(apidomContext);

const oas31orAsyncapiDoc = 'asyncapi: 2.2.0';
const doc = TextDocument.create('foo://bar/file.yaml', 'apidom', 0, oas31orAsyncapiDoc);
const diagnostics = await languageService.doValidation(document);
console.log(JSON.stringify(diagnostics, null, 2);

Changelog

0.89.0 (2023-12-19)

Bug Fixes

• ns-json-schema-draft-4: fix schema keyword setter (#3559) (d26cb00)

Features

• ls: add doc rule for OpenAPI 2.0 Info Object (#3548) (f97b7a8), closes #3104
• ls: add path template linting rule (#3538) (0055a09), closes #3517
• ls: add rules for OpenAPI 2.0 Contact Object (#3550) (cf4fd26), closes #3104
• ls: add rules for OpenAPI 2.0 Info Object (#3547) (cc11101), closes #3104
• ls: add rules for OpenAPI 2.0 License Object (#3551) (75c46f4), closes #3104
• ls: add rules for OpenAPI 2.0 Operation Object (#3561) (5dac8ef), closes #3104
• ls: add rules for OpenAPI 2.0 Path Item Object (#3560) (b515c5e), closes #3104
• ls: add rules for OpenAPI 2.0 Paths Object (#3553) (8feeeb3), closes #3104