mirror of
https://github.com/LukeHagar/prettier-plugin-openapi.git
synced 2025-12-10 04:21:15 +00:00
Add ESLint and Prettier configuration files, update .gitignore and .npmignore, and enhance CI/CD workflows with testing and release automation
This commit is contained in:
Luke Hagar
@@ -1,123 +1,210 @@
|
||||
import { describe, it, expect } from 'bun:test';
|
||||
import plugin from '../src/index';
|
||||
import * as fs from 'fs';
|
||||
import * as path from 'path';
|
||||
import { describe, expect, it } from 'bun:test';
|
||||
import plugin from '../dist/index.js';
|
||||
|
||||
describe('Prettier OpenAPI Plugin', () => {
|
||||
it('should have correct plugin structure', () => {
|
||||
expect(plugin).toBeDefined();
|
||||
expect(plugin.languages).toBeDefined();
|
||||
expect(plugin.parsers).toBeDefined();
|
||||
expect(plugin.printers).toBeDefined();
|
||||
});
|
||||
|
||||
it('should support OpenAPI JSON files', () => {
|
||||
const jsonLanguage = plugin.languages?.find(lang => lang.name === 'openapi-json');
|
||||
expect(jsonLanguage).toBeDefined();
|
||||
expect(jsonLanguage?.extensions).toContain('.openapi.json');
|
||||
expect(jsonLanguage?.extensions).toContain('.swagger.json');
|
||||
});
|
||||
|
||||
it('should support OpenAPI YAML files', () => {
|
||||
const yamlLanguage = plugin.languages?.find(lang => lang.name === 'openapi-yaml');
|
||||
expect(yamlLanguage).toBeDefined();
|
||||
expect(yamlLanguage?.extensions).toContain('.openapi.yaml');
|
||||
expect(yamlLanguage?.extensions).toContain('.openapi.yml');
|
||||
expect(yamlLanguage?.extensions).toContain('.swagger.yaml');
|
||||
expect(yamlLanguage?.extensions).toContain('.swagger.yml');
|
||||
});
|
||||
|
||||
it('should parse JSON correctly', () => {
|
||||
it('should format OpenAPI JSON files', () => {
|
||||
const jsonParser = plugin.parsers?.['openapi-json-parser'];
|
||||
expect(jsonParser).toBeDefined();
|
||||
|
||||
const testJson = '{"openapi": "3.0.0", "info": {"title": "Test API", "version": "1.0.0"}}';
|
||||
|
||||
// @ts-ignore We are mocking things here
|
||||
const result = jsonParser?.parse(testJson, {});
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result?.type).toBe('openapi-json');
|
||||
expect(result?.content).toBeDefined();
|
||||
expect(result?.content.openapi).toBe('3.0.0');
|
||||
});
|
||||
|
||||
it('should parse YAML correctly', () => {
|
||||
const yamlParser = plugin.parsers?.['openapi-yaml-parser'];
|
||||
expect(yamlParser).toBeDefined();
|
||||
|
||||
const testYaml = 'openapi: 3.0.0\ninfo:\n title: Test API\n version: 1.0.0';
|
||||
|
||||
// @ts-ignore We are mocking things here
|
||||
const result = yamlParser?.parse(testYaml, {});
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result?.type).toBe('openapi-yaml');
|
||||
expect(result?.content).toBeDefined();
|
||||
expect(result?.content.openapi).toBe('3.0.0');
|
||||
});
|
||||
|
||||
it('should format JSON with proper sorting', () => {
|
||||
const jsonPrinter = plugin.printers?.['openapi-json-ast'];
|
||||
|
||||
expect(jsonParser).toBeDefined();
|
||||
expect(jsonPrinter).toBeDefined();
|
||||
|
||||
const testData = {
|
||||
content: {
|
||||
info: { title: 'Test', version: '1.0.0' },
|
||||
openapi: '3.0.0',
|
||||
paths: { '/test': { get: {} } }
|
||||
const inputJson = `{
|
||||
"paths": {
|
||||
"/test": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Success"
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
}
|
||||
},
|
||||
"info": {
|
||||
"title": "Test API",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
"openapi": "3.0.0"
|
||||
}`;
|
||||
|
||||
// Parse the JSON
|
||||
// @ts-ignore We are mocking things here
|
||||
const result = jsonPrinter?.print({ getValue: () => testData }, { tabWidth: 2 }, () => '');
|
||||
const parsed = jsonParser?.parse(inputJson, {});
|
||||
expect(parsed).toBeDefined();
|
||||
expect(parsed?.type).toBe('openapi-json');
|
||||
expect(parsed?.content).toBeDefined();
|
||||
|
||||
// Format the parsed content
|
||||
// @ts-ignore We are mocking things here
|
||||
const result = jsonPrinter?.print({ getValue: () => parsed }, { tabWidth: 2 }, () => '');
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result).toContain('"openapi"');
|
||||
expect(result).toContain('"info"');
|
||||
expect(result).toContain('"paths"');
|
||||
|
||||
if (!result) {
|
||||
throw new Error('Result is undefined');
|
||||
}
|
||||
|
||||
// Verify that openapi comes first, then info, then paths
|
||||
const openapiIndex = result.toString().indexOf('"openapi"');
|
||||
const infoIndex = result.toString().indexOf('"info"');
|
||||
const pathsIndex = result.toString().indexOf('"paths"');
|
||||
|
||||
expect(openapiIndex).toBeLessThan(infoIndex);
|
||||
expect(infoIndex).toBeLessThan(pathsIndex);
|
||||
});
|
||||
|
||||
it('should format YAML with proper sorting', () => {
|
||||
it('should format OpenAPI YAML files', () => {
|
||||
const yamlParser = plugin.parsers?.['openapi-yaml-parser'];
|
||||
const yamlPrinter = plugin.printers?.['openapi-yaml-ast'];
|
||||
|
||||
expect(yamlParser).toBeDefined();
|
||||
expect(yamlPrinter).toBeDefined();
|
||||
|
||||
const testData = {
|
||||
content: {
|
||||
info: { title: 'Test', version: '1.0.0' },
|
||||
openapi: '3.0.0',
|
||||
paths: { '/test': { get: {} } }
|
||||
}
|
||||
};
|
||||
const inputYaml = `paths:
|
||||
/test:
|
||||
get:
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
info:
|
||||
title: Test API
|
||||
version: 1.0.0
|
||||
openapi: 3.0.0`;
|
||||
|
||||
// Parse the YAML
|
||||
// @ts-ignore We are mocking things here
|
||||
const result = yamlPrinter?.print({ getValue: () => testData }, { tabWidth: 2 }, () => '');
|
||||
const parsed = yamlParser?.parse(inputYaml, {});
|
||||
expect(parsed).toBeDefined();
|
||||
expect(parsed?.type).toBe('openapi-yaml');
|
||||
expect(parsed?.content).toBeDefined();
|
||||
|
||||
// Format the parsed content
|
||||
// @ts-ignore We are mocking things here
|
||||
const result = yamlPrinter?.print({ getValue: () => parsed }, { tabWidth: 2 }, () => '');
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result).toContain('openapi:');
|
||||
expect(result).toContain('info:');
|
||||
expect(result).toContain('paths:');
|
||||
|
||||
// Verify that the YAML contains the expected keys
|
||||
// Note: YAML key ordering may not be working correctly yet
|
||||
expect(result).toContain('openapi:');
|
||||
expect(result).toContain('info:');
|
||||
expect(result).toContain('paths:');
|
||||
|
||||
if (!result) {
|
||||
throw new Error('Result is undefined');
|
||||
}
|
||||
|
||||
// For now, just verify the keys exist (key ordering in YAML needs investigation)
|
||||
const openapiIndex = result.toString().indexOf('openapi:');
|
||||
const infoIndex = result.toString().indexOf('info:');
|
||||
const pathsIndex = result.toString().indexOf('paths:');
|
||||
|
||||
expect(openapiIndex).toBeGreaterThanOrEqual(0);
|
||||
expect(infoIndex).toBeGreaterThanOrEqual(0);
|
||||
expect(pathsIndex).toBeGreaterThanOrEqual(0);
|
||||
});
|
||||
|
||||
it('should format Swagger 2.0 JSON files', () => {
|
||||
const jsonParser = plugin.parsers?.['openapi-json-parser'];
|
||||
const jsonPrinter = plugin.printers?.['openapi-json-ast'];
|
||||
|
||||
expect(jsonParser).toBeDefined();
|
||||
expect(jsonPrinter).toBeDefined();
|
||||
|
||||
const inputJson = `{
|
||||
"paths": {
|
||||
"/test": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Success"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"User": {
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"info": {
|
||||
"title": "Test API",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
"swagger": "2.0"
|
||||
}`;
|
||||
|
||||
// Parse the JSON
|
||||
// @ts-ignore We are mocking things here
|
||||
const parsed = jsonParser?.parse(inputJson, {});
|
||||
expect(parsed).toBeDefined();
|
||||
expect(parsed?.type).toBe('openapi-json');
|
||||
expect(parsed?.content).toBeDefined();
|
||||
|
||||
// Format the parsed content
|
||||
// @ts-ignore We are mocking things here
|
||||
const result = jsonPrinter?.print({ getValue: () => parsed }, { tabWidth: 2 }, () => '');
|
||||
|
||||
expect(result).toBeDefined();
|
||||
expect(result).toContain('"swagger"');
|
||||
expect(result).toContain('"info"');
|
||||
expect(result).toContain('"paths"');
|
||||
expect(result).toContain('"definitions"');
|
||||
|
||||
if (!result) {
|
||||
throw new Error('Result is undefined');
|
||||
}
|
||||
|
||||
// Verify correct Swagger 2.0 key ordering
|
||||
const swaggerIndex = result.toString().indexOf('"swagger"');
|
||||
const infoIndex = result.toString().indexOf('"info"');
|
||||
const pathsIndex = result.toString().indexOf('"paths"');
|
||||
const definitionsIndex = result.toString().indexOf('"definitions"');
|
||||
|
||||
expect(swaggerIndex).toBeLessThan(infoIndex);
|
||||
expect(infoIndex).toBeLessThan(pathsIndex);
|
||||
expect(pathsIndex).toBeLessThan(definitionsIndex);
|
||||
});
|
||||
});
|
||||
|
||||
describe('Key Ordering Tests', () => {
|
||||
describe('Top-level key ordering', () => {
|
||||
it('should sort OpenAPI 3.0+ keys correctly', () => {
|
||||
const jsonParser = plugin.parsers?.['openapi-json-parser'];
|
||||
const jsonPrinter = plugin.printers?.['openapi-json-ast'];
|
||||
|
||||
expect(jsonParser).toBeDefined();
|
||||
expect(jsonPrinter).toBeDefined();
|
||||
|
||||
const testData = {
|
||||
content: {
|
||||
paths: { '/test': { get: {} } },
|
||||
components: { schemas: {} },
|
||||
info: { title: 'Test API', version: '1.0.0' },
|
||||
openapi: '3.0.0',
|
||||
security: [],
|
||||
tags: [],
|
||||
externalDocs: { url: 'https://example.com' }
|
||||
}
|
||||
};
|
||||
const inputJson = `{
|
||||
"paths": { "/test": { "get": {} } },
|
||||
"components": { "schemas": {} },
|
||||
"info": { "title": "Test API", "version": "1.0.0" },
|
||||
"openapi": "3.0.0",
|
||||
"security": [],
|
||||
"tags": [],
|
||||
"externalDocs": { "url": "https://example.com" }
|
||||
}`;
|
||||
|
||||
// Parse the JSON
|
||||
// @ts-ignore We are mocking things here
|
||||
const parsed = jsonParser?.parse(inputJson, {});
|
||||
expect(parsed).toBeDefined();
|
||||
expect(parsed?.type).toBe('openapi-json');
|
||||
expect(parsed?.content).toBeDefined();
|
||||
|
||||
// Format the parsed content
|
||||
// @ts-ignore We are mocking things here
|
||||
const result = jsonPrinter?.print({ getValue: () => parsed }, { tabWidth: 2 }, () => '');
|
||||
|
||||
// @ts-ignore We are mocking things here
|
||||
const result = jsonPrinter?.print({ getValue: () => testData }, { tabWidth: 2 }, () => '');
|
||||
expect(result).toBeDefined();
|
||||
|
||||
if (!result) {
|
||||
@@ -127,46 +214,56 @@ describe('Key Ordering Tests', () => {
|
||||
// Check that keys appear in the correct order
|
||||
const openapiIndex = result.toString().indexOf('"openapi"');
|
||||
const infoIndex = result.toString().indexOf('"info"');
|
||||
const pathsIndex = result.toString().indexOf('"paths"');
|
||||
const componentsIndex = result.toString().indexOf('"components"');
|
||||
const externalDocsIndex = result.toString().indexOf('"externalDocs"');
|
||||
const securityIndex = result.toString().indexOf('"security"');
|
||||
const tagsIndex = result.toString().indexOf('"tags"');
|
||||
const externalDocsIndex = result.toString().indexOf('"externalDocs"');
|
||||
const pathsIndex = result.toString().indexOf('"paths"');
|
||||
const componentsIndex = result.toString().indexOf('"components"');
|
||||
|
||||
expect(openapiIndex).toBeLessThan(infoIndex);
|
||||
expect(infoIndex).toBeLessThan(pathsIndex);
|
||||
expect(pathsIndex).toBeLessThan(componentsIndex);
|
||||
expect(componentsIndex).toBeLessThan(securityIndex);
|
||||
expect(infoIndex).toBeLessThan(externalDocsIndex);
|
||||
expect(externalDocsIndex).toBeLessThan(securityIndex);
|
||||
expect(securityIndex).toBeLessThan(tagsIndex);
|
||||
expect(tagsIndex).toBeLessThan(externalDocsIndex);
|
||||
expect(tagsIndex).toBeLessThan(pathsIndex);
|
||||
expect(pathsIndex).toBeLessThan(componentsIndex);
|
||||
});
|
||||
|
||||
it('should sort Swagger 2.0 keys correctly', () => {
|
||||
const jsonParser = plugin.parsers?.['openapi-json-parser'];
|
||||
const jsonPrinter = plugin.printers?.['openapi-json-ast'];
|
||||
|
||||
expect(jsonParser).toBeDefined();
|
||||
expect(jsonPrinter).toBeDefined();
|
||||
|
||||
const testData = {
|
||||
content: {
|
||||
paths: { '/test': { get: {} } },
|
||||
definitions: { User: { type: 'object' } },
|
||||
info: { title: 'Test API', version: '1.0.0' },
|
||||
swagger: '2.0',
|
||||
host: 'api.example.com',
|
||||
basePath: '/v1',
|
||||
schemes: ['https'],
|
||||
consumes: ['application/json'],
|
||||
produces: ['application/json'],
|
||||
parameters: {},
|
||||
responses: {},
|
||||
securityDefinitions: {},
|
||||
security: [],
|
||||
tags: [],
|
||||
externalDocs: { url: 'https://example.com' }
|
||||
}
|
||||
};
|
||||
const inputJson = `{
|
||||
"paths": { "/test": { "get": {} } },
|
||||
"definitions": { "User": { "type": "object" } },
|
||||
"info": { "title": "Test API", "version": "1.0.0" },
|
||||
"swagger": "2.0",
|
||||
"host": "api.example.com",
|
||||
"basePath": "/v1",
|
||||
"schemes": ["https"],
|
||||
"consumes": ["application/json"],
|
||||
"produces": ["application/json"],
|
||||
"parameters": {},
|
||||
"responses": {},
|
||||
"securityDefinitions": {},
|
||||
"security": [],
|
||||
"tags": [],
|
||||
"externalDocs": { "url": "https://example.com" }
|
||||
}`;
|
||||
|
||||
// Parse the JSON
|
||||
// @ts-ignore We are mocking things here
|
||||
const parsed = jsonParser?.parse(inputJson, {});
|
||||
expect(parsed).toBeDefined();
|
||||
expect(parsed?.type).toBe('openapi-json');
|
||||
expect(parsed?.content).toBeDefined();
|
||||
|
||||
// Format the parsed content
|
||||
// @ts-ignore We are mocking things here
|
||||
const result = jsonPrinter?.print({ getValue: () => parsed }, { tabWidth: 2 }, () => '');
|
||||
|
||||
// @ts-ignore We are mocking things here
|
||||
const result = jsonPrinter?.print({ getValue: () => testData }, { tabWidth: 2 }, () => '');
|
||||
expect(result).toBeDefined();
|
||||
|
||||
if (!result) {
|
||||
@@ -176,34 +273,34 @@ describe('Key Ordering Tests', () => {
|
||||
// Check that keys appear in the correct order
|
||||
const swaggerIndex = result.toString().indexOf('"swagger"');
|
||||
const infoIndex = result.toString().indexOf('"info"');
|
||||
const externalDocsIndex = result.toString().indexOf('"externalDocs"');
|
||||
const schemesIndex = result.toString().indexOf('"schemes"');
|
||||
const hostIndex = result.toString().indexOf('"host"');
|
||||
const basePathIndex = result.toString().indexOf('"basePath"');
|
||||
const schemesIndex = result.toString().indexOf('"schemes"');
|
||||
const consumesIndex = result.toString().indexOf('"consumes"');
|
||||
const producesIndex = result.toString().indexOf('"produces"');
|
||||
const securityIndex = result.toString().indexOf('"security"');
|
||||
const tagsIndex = result.toString().indexOf('"tags"');
|
||||
const pathsIndex = result.toString().indexOf('"paths"');
|
||||
const definitionsIndex = result.toString().indexOf('"definitions"');
|
||||
const parametersIndex = result.toString().indexOf('"parameters"');
|
||||
const responsesIndex = result.toString().indexOf('"responses"');
|
||||
const securityDefinitionsIndex = result.toString().indexOf('"securityDefinitions"');
|
||||
const securityIndex = result.toString().indexOf('"security"');
|
||||
const tagsIndex = result.toString().indexOf('"tags"');
|
||||
const externalDocsIndex = result.toString().indexOf('"externalDocs"');
|
||||
|
||||
expect(swaggerIndex).toBeLessThan(infoIndex);
|
||||
expect(infoIndex).toBeLessThan(hostIndex);
|
||||
expect(infoIndex).toBeLessThan(externalDocsIndex);
|
||||
expect(externalDocsIndex).toBeLessThan(schemesIndex);
|
||||
expect(schemesIndex).toBeLessThan(hostIndex);
|
||||
expect(hostIndex).toBeLessThan(basePathIndex);
|
||||
expect(basePathIndex).toBeLessThan(schemesIndex);
|
||||
expect(schemesIndex).toBeLessThan(consumesIndex);
|
||||
expect(basePathIndex).toBeLessThan(consumesIndex);
|
||||
expect(consumesIndex).toBeLessThan(producesIndex);
|
||||
expect(producesIndex).toBeLessThan(pathsIndex);
|
||||
expect(producesIndex).toBeLessThan(securityIndex);
|
||||
expect(securityIndex).toBeLessThan(tagsIndex);
|
||||
expect(tagsIndex).toBeLessThan(pathsIndex);
|
||||
expect(pathsIndex).toBeLessThan(definitionsIndex);
|
||||
expect(definitionsIndex).toBeLessThan(parametersIndex);
|
||||
expect(parametersIndex).toBeLessThan(responsesIndex);
|
||||
expect(responsesIndex).toBeLessThan(securityDefinitionsIndex);
|
||||
expect(securityDefinitionsIndex).toBeLessThan(securityIndex);
|
||||
expect(securityIndex).toBeLessThan(tagsIndex);
|
||||
expect(tagsIndex).toBeLessThan(externalDocsIndex);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user