Contributor
Savio Dias

Add "Autofix" feature for common linting errors (w/ spectral)


Mentors
acethecreator, divy.khare, Ivan GarcĂ­a Sainz-Aja
Organization
Postman
Technologies
json, typescript, YAML, Spectral, VscodeAPI
Topics
api, Extension
My proposal aims to improve the user experience and developer experience for AsyncAPI-Preview extension. The main problem being solved is the difficulty in identifying and resolving common and custom linting errors in AsyncAPI documents. By leveraging the VSCode API for providing quick/autofixes for linting errors, my proposal plans to add an "Auto Fix" feature for most common and standard Spectral linting errors in AsyncAPI documents. The proposed deliverables for this project include: -Integration of AsyncAPI-Preview and Spectral for VSCode extensions -Implementation of Code Actions for standard Spectral linting errors in AsyncAPI documents -Support for computing json-path to source code and vice versa -Investigation on loading autofix rules from external files to support custom (non-standard) Spectral linting rules Overall, this project aims to streamline the AsyncAPI-Preview process and improve the quality of AsyncAPI documents by providing developers with a more user-friendly and efficient way to identify and fix common and custom linting errors.