Skip to content
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

Add Typescript support #13

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
+366 −161
Open

Add Typescript support #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
555e2db
adding typescript
remorses Jan 6, 2025
66eef13
fix imports for tests
remorses Jan 6, 2025
6b6d9ee
convert to typescript
remorses Jan 6, 2025
783a9e4
add return types
remorses Jan 6, 2025
27d0c2b
lower c8 tresh
remorses Jan 6, 2025
e19fb8d
nn
remorses Jan 28, 2025
1fabd44
nn
remorses Feb 10, 2025
41ccb0d
updates
remorses Feb 18, 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
440 changes: 323 additions & 117 deletions index.js → lib/index.ts
View file
Open in desktop

Large diffs are not rendered by default.

27 changes: 0 additions & 27 deletions lib/utils.js
View file
Open in desktop

This file was deleted.

16 changes: 10 additions & 6 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@
"name": "openapi-schema-diff",
"version": "0.0.1",
"description": "Finds changes between two OpenAPI schemas",
"main": "index.js",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"scripts": {
"lint": "eslint",
"prepublishOnly": "tsc",
"lint:fix": "eslint --fix",
"test:unit": "c8 --100 node --test",
"test:unit": "c8 --check-coverage --lines 98 --functions 100 node --test",
"test": "npm run lint && npm run test:unit"
},
"repository": {
Expand Down Expand Up @@ -36,12 +38,14 @@
}
],
"dependencies": {
"json-schema-ref-resolver": "^2.0.0",
"semver": "^7.5.4"
"json-schema-ref-resolver": "^2.0.1",
"semver": "^7.6.3"
},
"devDependencies": {
"@types/node": "^22.13.4",
"c8": "^10.1.3",
"eslint": "^9.17.0",
"neostandard": "^0.12.0"
"eslint": "^9.19.0",
"neostandard": "^0.12.0",
"typescript": "^5.7.3"
}
}
2 changes: 1 addition & 1 deletion test/added-routes.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

const assert = require('node:assert/strict')
const { test } = require('node:test')
const compareOpenApiSchemas = require('../index.js')
const compareOpenApiSchemas = require('../dist/index.js')

test('adding new route', () => {
const source = {
Expand Down
2 changes: 1 addition & 1 deletion test/deleted-routes.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

const assert = require('node:assert/strict')
const { test } = require('node:test')
const compareOpenApiSchemas = require('../index.js')
const compareOpenApiSchemas = require('../dist/index.js')

test('removing a route', () => {
const source = {
Expand Down
2 changes: 1 addition & 1 deletion test/ignored-properties.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

const assert = require('node:assert/strict')
const { test } = require('node:test')
const compareOpenApiSchemas = require('../index.js')
const compareOpenApiSchemas = require('../dist/index.js')

test('should not count summery and description properties', () => {
const source = {
Expand Down
2 changes: 1 addition & 1 deletion test/openapi-schema.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

const assert = require('node:assert/strict')
const { test } = require('node:test')
const compareOpenApiSchemas = require('../index.js')
const compareOpenApiSchemas = require('../dist/index.js')

test('should throw if source schema is not an object', () => {
const source = 3
Expand Down
2 changes: 1 addition & 1 deletion test/parameters-changes.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

const assert = require('node:assert/strict')
const { test } = require('node:test')
const compareOpenApiSchemas = require('../index.js')
const compareOpenApiSchemas = require('../dist/index.js')

test('adding request query schema property value', () => {
const source = {
Expand Down
2 changes: 1 addition & 1 deletion test/refs.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

const assert = require('node:assert/strict')
const { test } = require('node:test')
const compareOpenApiSchemas = require('../index.js')
const compareOpenApiSchemas = require('../dist/index.js')

test('modifying routes schema through ref', () => {
const source = {
Expand Down
2 changes: 1 addition & 1 deletion test/request-body-changes.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

const assert = require('node:assert/strict')
const { test } = require('node:test')
const compareOpenApiSchemas = require('../index.js')
const compareOpenApiSchemas = require('../dist/index.js')

test('adding request body schema property value', () => {
const source = {
Expand Down
2 changes: 1 addition & 1 deletion test/response-body-changes.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

const assert = require('node:assert/strict')
const { test } = require('node:test')
const compareOpenApiSchemas = require('../index.js')
const compareOpenApiSchemas = require('../dist/index.js')

test('adding response body schema', () => {
const source = {
Expand Down
2 changes: 1 addition & 1 deletion test/response-headers-changes.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

const assert = require('node:assert/strict')
const { test } = require('node:test')
const compareOpenApiSchemas = require('../index.js')
const compareOpenApiSchemas = require('../dist/index.js')

test('adding response header schema property', () => {
const source = {
Expand Down
2 changes: 1 addition & 1 deletion test/same-routes.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

const assert = require('node:assert/strict')
const { test } = require('node:test')
const compareOpenApiSchemas = require('../index.js')
const compareOpenApiSchemas = require('../dist/index.js')

test('compare two equal schemas', () => {
const source = {
Expand Down
2 changes: 1 addition & 1 deletion test/versions.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

const assert = require('node:assert/strict')
const { test } = require('node:test')
const compareOpenApiSchemas = require('../index.js')
const compareOpenApiSchemas = require('../dist/index.js')

test('should throw source schema version is missing', () => {
const source = { paths: {} }
Expand Down
22 changes: 22 additions & 0 deletions tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"compilerOptions": {
"target": "ES2017",
"outDir": "dist",
"rootDir": "lib",
"module": "commonjs",
"allowJs": true,
"moduleResolution": "Node",

"lib": ["es2022", "es2017", "es7", "es6", "dom"],
"declaration": true,
"declarationMap": true,
"strict": true,
"downlevelIteration": true,
"esModuleInterop": true,
"noImplicitAny": false,
"sourceMap": true,
"jsx": "react",
"skipLibCheck": true,
},
"include": ["lib/**/*"],
}
Loading