Skip to content

Commit 7f1a090

Browse files
bchernybcherny
committed
Migrate from CommonJS -> ESM
1 parent 31993de commit 7f1a090

36 files changed

+216
-173
lines changed

‎.gitignore

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ npm-debug.log
1111
node_modules
1212
*.js
1313
*.map
14-
dist/
15-
dist_tests/
14+
dist-cjs/
15+
dist-esm/
1616
yarn-error.log

‎.npmignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ node_modules
77
*.map
88
example
99
test
10-
dist/test
10+
dist-esm/test
1111
circle.yml
1212
ARCHITECTURE.md
1313
CONTRIBUTING.md

‎.vscode/launch.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"type": "node",
66
"request": "launch",
77
"name": "Launch Program",
8-
"program": "${workspaceRoot}/node_modules/.bin/ava ./dist/test/test.js",
8+
"program": "${workspaceRoot}/node_modules/.bin/ava ./dist-esm/test/test.js",
99
"cwd": "${workspaceRoot}"
1010
},
1111
{

‎package-lock.json

+17-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

+15-10
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,24 @@
22
"name": "json-schema-to-typescript",
33
"version": "14.0.5",
44
"description": "compile json schema to typescript typings",
5-
"main": "dist/src/index.js",
5+
"main": "dist-cjs/src/index.js",
6+
"exports": {
7+
"require": "./dist-cjs/src/index.js",
8+
"import": "./dist-esm/src/index.js"
9+
},
610
"bin": {
7-
"json2ts": "dist/src/cli.js"
11+
"json2ts": "dist-esm/src/cli.js"
812
},
9-
"typings": "dist/src/index.d.ts",
13+
"type": "module",
14+
"typings": "dist-esm/src/index.d.ts",
1015
"engines": {
1116
"node": ">=16.0.0"
1217
},
1318
"scripts": {
1419
"build": "npm run lint && npm run clean && npm run build:browser && npm run build:server",
15-
"build:browser": "browserify src/index.ts -s jstt -p tsify > dist/bundle.js",
16-
"build:server": "tsc -d",
17-
"clean": "shx rm -rf dist && mkdir dist",
20+
"build:browser": "browserify src/index.ts -s jstt -p tsify > dist-esm/bundle.js",
21+
"build:server": "tsc -p ./tsconfig.cjs.json -d && tsc -p ./tsconfig.esm.json -d",
22+
"clean": "shx rm -rf dist-cjs && shx rm -rf dist-esm",
1823
"format": "prettier \"{src,test}/*.ts\" --write",
1924
"format-check": "prettier \"{src,test}/*.ts\" --check",
2025
"lint": "eslint src/*.ts test/*.ts",
@@ -23,7 +28,7 @@
2328
"stresstest": "seq 1 10 | xargs -I{} npm test",
2429
"prepublishOnly": "npm test",
2530
"pre-test": "npm run clean && npm run format-check && npm run build:server",
26-
"watch": "tsc -w",
31+
"watch": "tsc -p ./tsconfig.esm.json -w",
2732
"watch:test": "ava -w"
2833
},
2934
"repository": {
@@ -50,12 +55,12 @@
5055
"dependencies": {
5156
"@apidevtools/json-schema-ref-parser": "^11.5.5",
5257
"@types/json-schema": "^7.0.15",
53-
"@types/lodash": "^4.17.0",
58+
"@types/lodash-es": "^4.17.12",
5459
"cli-color": "^2.0.4",
5560
"glob": "^10.3.12",
5661
"is-glob": "^4.0.3",
5762
"js-yaml": "^4.1.0",
58-
"lodash": "^4.17.21",
63+
"lodash-es": "^4.17.21",
5964
"minimist": "^1.2.8",
6065
"mkdirp": "^3.0.1",
6166
"node-fetch": "^3.3.2",
@@ -85,7 +90,7 @@
8590
},
8691
"ava": {
8792
"files": [
88-
"./dist/test/test.js"
93+
"./dist-esm/test/test.js"
8994
],
9095
"snapshotDir": "./test/__snapshots__"
9196
},

‎src/cli.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ import * as mkdirp from 'mkdirp'
66
import {glob} from 'glob'
77
import isGlob from 'is-glob'
88
import {join, resolve, dirname} from 'path'
9-
import {compile, DEFAULT_OPTIONS, Options} from './index'
10-
import {pathTransform, error, parseFileAsJSONSchema, justName} from './utils'
9+
import {compile, DEFAULT_OPTIONS, Options} from './index.js'
10+
import {pathTransform, error, parseFileAsJSONSchema, justName} from './utils.js'
1111

1212
main(
1313
minimist(process.argv.slice(2), {
@@ -161,7 +161,7 @@ async function readStream(stream: NodeJS.ReadStream): Promise<string> {
161161
}
162162

163163
function printHelp() {
164-
const pkg = require('../../package.json')
164+
const pkg = JSON.parse(readFileSync('../../package.json', 'utf8'))
165165

166166
process.stdout.write(
167167
`

‎src/formatter.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import {format as prettify} from 'prettier'
2-
import {Options} from './'
2+
import {Options} from './index.js'
33

44
export async function format(code: string, options: Options): Promise<string> {
55
if (!options.format) {

‎src/generator.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import {memoize, omit} from 'lodash'
2-
import {DEFAULT_OPTIONS, Options} from './index'
1+
import {memoize, omit} from 'lodash-es'
2+
import {DEFAULT_OPTIONS, Options} from './index.js'
33
import {
44
AST,
55
ASTWithStandaloneName,
@@ -13,8 +13,8 @@ import {
1313
TNamedInterface,
1414
TUnion,
1515
T_UNKNOWN,
16-
} from './types/AST'
17-
import {log, toSafeString} from './utils'
16+
} from './types/AST.js'
17+
import {log, toSafeString} from './utils.js'
1818

1919
export function generate(ast: AST, options = DEFAULT_OPTIONS): string {
2020
return (

‎src/index.ts

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
import {readFileSync} from 'fs'
22
import {JSONSchema4} from 'json-schema'
33
import {ParserOptions as $RefOptions} from '@apidevtools/json-schema-ref-parser'
4-
import {cloneDeep, endsWith, merge} from 'lodash'
4+
import {cloneDeep, endsWith, merge} from 'lodash-es'
55
import {dirname} from 'path'
66
import {Options as PrettierOptions} from 'prettier'
7-
import {format} from './formatter'
8-
import {generate} from './generator'
9-
import {normalize} from './normalizer'
10-
import {optimize} from './optimizer'
11-
import {parse} from './parser'
12-
import {dereference} from './resolver'
13-
import {error, stripExtension, Try, log, parseFileAsJSONSchema} from './utils'
14-
import {validate} from './validator'
7+
import {format} from './formatter.js'
8+
import {generate} from './generator.js'
9+
import {normalize} from './normalizer.js'
10+
import {optimize} from './optimizer.js'
11+
import {parse} from './parser.js'
12+
import {dereference} from './resolver.js'
13+
import {error, stripExtension, Try, log, parseFileAsJSONSchema} from './utils.js'
14+
import {validate} from './validator.js'
1515
import {isDeepStrictEqual} from 'util'
16-
import {link} from './linker'
17-
import {validateOptions} from './optionValidator'
18-
import {JSONSchema as LinkedJSONSchema} from './types/JSONSchema'
16+
import {link} from './linker.js'
17+
import {validateOptions} from './optionValidator.js'
18+
import {JSONSchema as LinkedJSONSchema} from './types/JSONSchema.js'
1919

20-
export {EnumJSONSchema, JSONSchema, NamedEnumJSONSchema, CustomTypeJSONSchema} from './types/JSONSchema'
20+
export {EnumJSONSchema, JSONSchema, NamedEnumJSONSchema, CustomTypeJSONSchema} from './types/JSONSchema.js'
2121

2222
export interface Options {
2323
/**

‎src/linker.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import {JSONSchema, Parent, LinkedJSONSchema} from './types/JSONSchema'
2-
import {isPlainObject} from 'lodash'
1+
import {JSONSchema, Parent, LinkedJSONSchema} from './types/JSONSchema.js'
2+
import {isPlainObject} from 'lodash-es'
33
import {JSONSchema4Type} from 'json-schema'
44

55
/**

‎src/normalizer.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
import {JSONSchemaTypeName, LinkedJSONSchema, NormalizedJSONSchema, Parent} from './types/JSONSchema'
2-
import {appendToDescription, escapeBlockComment, isSchemaLike, justName, toSafeString, traverse} from './utils'
3-
import {Options} from './'
4-
import {DereferencedPaths} from './resolver'
1+
import {JSONSchemaTypeName, LinkedJSONSchema, NormalizedJSONSchema, Parent} from './types/JSONSchema.js'
2+
import {appendToDescription, escapeBlockComment, isSchemaLike, justName, toSafeString, traverse} from './utils.js'
3+
import {Options} from './index.js'
4+
import {DereferencedPaths} from './resolver.js'
55
import {isDeepStrictEqual} from 'util'
66

77
type Rule = (

‎src/optimizer.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import {uniqBy} from 'lodash'
2-
import {Options} from '.'
3-
import {generateType} from './generator'
4-
import {AST, T_ANY, T_UNKNOWN} from './types/AST'
5-
import {log} from './utils'
1+
import {uniqBy} from 'lodash-es'
2+
import {Options} from './index.js'
3+
import {generateType} from './generator.js'
4+
import {AST, T_ANY, T_UNKNOWN} from './types/AST.js'
5+
import {log} from './utils.js'
66

77
export function optimize(ast: AST, options: Options, processed = new Set<AST>()): AST {
88
if (processed.has(ast)) {

‎src/optionValidator.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import {Options} from '.'
1+
import {Options} from './index.js'
22

33
export function validateOptions({maxItems}: Partial<Options>): void {
44
if (maxItems !== undefined && maxItems < -1) {

‎src/parser.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
import {JSONSchema4Type, JSONSchema4TypeName} from 'json-schema'
2-
import {findKey, includes, isPlainObject, map, memoize, omit} from 'lodash'
2+
import {findKey, includes, isPlainObject, map, memoize, omit} from 'lodash-es'
33
import {format} from 'util'
4-
import {Options} from './'
5-
import {typesOfSchema} from './typesOfSchema'
4+
import {Options} from './index.js'
5+
import {typesOfSchema} from './typesOfSchema.js'
66
import {
77
AST,
88
T_ANY,
@@ -14,7 +14,7 @@ import {
1414
T_UNKNOWN,
1515
T_UNKNOWN_ADDITIONAL_PROPERTIES,
1616
TIntersection,
17-
} from './types/AST'
17+
} from './types/AST.js'
1818
import {
1919
getRootSchema,
2020
isBoolean,
@@ -23,8 +23,8 @@ import {
2323
JSONSchemaWithDefinitions,
2424
SchemaSchema,
2525
SchemaType,
26-
} from './types/JSONSchema'
27-
import {generateName, log, maybeStripDefault, maybeStripNameHints} from './utils'
26+
} from './types/JSONSchema.js'
27+
import {generateName, log, maybeStripDefault, maybeStripNameHints} from './utils.js'
2828

2929
export type Processed = Map<LinkedJSONSchema, Map<SchemaType, AST>>
3030

‎src/resolver.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import {$RefParser, ParserOptions as $RefOptions} from '@apidevtools/json-schema-ref-parser'
2-
import {JSONSchema} from './types/JSONSchema'
3-
import {log} from './utils'
2+
import {JSONSchema} from './types/JSONSchema.js'
3+
import {log} from './utils.js'
44

55
export type DereferencedPaths = WeakMap<JSONSchema, string>
66

‎src/types/JSONSchema.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import {JSONSchema4, JSONSchema4Type, JSONSchema4TypeName} from 'json-schema'
2-
import {isPlainObject, memoize} from 'lodash'
2+
import {isPlainObject, memoize} from 'lodash-es'
33

44
export type SchemaType =
55
| 'ALL_OF'

‎src/typesOfSchema.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import {isPlainObject} from 'lodash'
2-
import {isCompound, JSONSchema, SchemaType} from './types/JSONSchema'
1+
import {isPlainObject} from 'lodash-es'
2+
import {isCompound, JSONSchema, SchemaType} from './types/JSONSchema.js'
33

44
/**
55
* Duck types a JSONSchema schema or property to determine which kind of AST node to parse it into.

‎src/utils.ts

+20-16
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import {deburr, isPlainObject, trim, upperFirst} from 'lodash'
1+
import {deburr, isPlainObject, trim, upperFirst} from 'lodash-es'
22
import {basename, dirname, extname, normalize, sep, posix} from 'path'
3-
import {JSONSchema, LinkedJSONSchema, Parent} from './types/JSONSchema'
3+
import {JSONSchema, LinkedJSONSchema, Parent} from './types/JSONSchema.js'
44
import {JSONSchema4} from 'json-schema'
55
import yaml from 'js-yaml'
66

@@ -208,7 +208,7 @@ export function error(...messages: any[]): void {
208208
if (!process.env.VERBOSE) {
209209
return console.error(messages)
210210
}
211-
console.error(getStyledTextForLogging('red')?.('error'), ...messages)
211+
getStyledTextForLogging('red').then(text => console.error(text?.('error'), ...messages))
212212
}
213213

214214
type LogStyle = 'blue' | 'cyan' | 'green' | 'magenta' | 'red' | 'white' | 'yellow'
@@ -221,31 +221,35 @@ export function log(style: LogStyle, title: string, ...messages: unknown[]): voi
221221
if (messages.length > 1 && typeof messages[messages.length - 1] !== 'string') {
222222
lastMessage = messages.splice(messages.length - 1, 1)
223223
}
224-
console.info(require('cli-color').whiteBright.bgCyan('debug'), getStyledTextForLogging(style)?.(title), ...messages)
225-
if (lastMessage) {
226-
console.dir(lastMessage, {depth: 6, maxArrayLength: 6})
227-
}
224+
import('cli-color').then(color => {
225+
getStyledTextForLogging(style).then(text => {
226+
console.info(color.whiteBright.bgCyan('debug'), text?.(title), ...messages)
227+
if (lastMessage) {
228+
console.dir(lastMessage, {depth: 6, maxArrayLength: 6})
229+
}
230+
})
231+
})
228232
}
229233

230-
function getStyledTextForLogging(style: LogStyle): ((text: string) => string) | undefined {
234+
function getStyledTextForLogging(style: LogStyle): Promise<((text: string) => string) | undefined> {
231235
if (!process.env.VERBOSE) {
232-
return
236+
return Promise.resolve(undefined)
233237
}
234238
switch (style) {
235239
case 'blue':
236-
return require('cli-color').whiteBright.bgBlue
240+
return import('cli-color').then(color => color.whiteBright.bgBlue)
237241
case 'cyan':
238-
return require('cli-color').whiteBright.bgCyan
242+
return import('cli-color').then(color => color.whiteBright.bgCyan)
239243
case 'green':
240-
return require('cli-color').whiteBright.bgGreen
244+
return import('cli-color').then(color => color.whiteBright.bgGreen)
241245
case 'magenta':
242-
return require('cli-color').whiteBright.bgMagenta
246+
return import('cli-color').then(color => color.whiteBright.bgMagenta)
243247
case 'red':
244-
return require('cli-color').whiteBright.bgRedBright
248+
return import('cli-color').then(color => color.whiteBright.bgRedBright)
245249
case 'white':
246-
return require('cli-color').black.bgWhite
250+
return import('cli-color').then(color => color.black.bgWhite)
247251
case 'yellow':
248-
return require('cli-color').whiteBright.bgYellow
252+
return import('cli-color').then(color => color.whiteBright.bgYellow)
249253
}
250254
}
251255

‎src/validator.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import {JSONSchema, LinkedJSONSchema} from './types/JSONSchema'
2-
import {traverse} from './utils'
1+
import {JSONSchema, LinkedJSONSchema} from './types/JSONSchema.js'
2+
import {traverse} from './utils.js'
33

44
type Rule = (schema: JSONSchema) => boolean | void
55
const rules = new Map<string, Rule>()

0 commit comments

Comments
 (0)