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

enhancement bcherny#543 - Prefix items support #574

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

enhancement bcherny#543 - Prefix items support #574

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9f88141
enhancement #543
TheoAnastasiadis Jan 25, 2024
c4d25a0
enhancement #543 -- normalizer
TheoAnastasiadis Jan 25, 2024
01470b6
enhancement #543 -- options
TheoAnastasiadis Jan 25, 2024
4d3945b
enhancement #543 -- unitTest
TheoAnastasiadis Jan 25, 2024
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
378 changes: 189 additions & 189 deletions src/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,189 +1,189 @@
#!/usr/bin/env node

import minimist = require('minimist')
import getStdin from 'get-stdin'
import {readFile, writeFile, existsSync, lstatSync, readdirSync} from 'mz/fs'
import * as mkdirp from 'mkdirp'
import glob from 'glob-promise'
import isGlob = require('is-glob')
import {join, resolve, dirname, basename} from 'path'
import {compile, DEFAULT_OPTIONS, Options} from './index'
import {pathTransform, error} from './utils'

main(
minimist(process.argv.slice(2), {
alias: {
help: ['h'],
input: ['i'],
output: ['o'],
},
boolean: [
'additionalProperties',
'declareExternallyReferenced',
'enableConstEnums',
'format',
'ignoreMinAndMaxItems',
'strictIndexSignatures',
'unknownAny',
'unreachableDefinitions',
],
default: DEFAULT_OPTIONS,
string: ['bannerComment', 'cwd'],
}),
)

async function main(argv: minimist.ParsedArgs) {
if (argv.help) {
printHelp()
process.exit(0)
}

const argIn: string = argv._[0] || argv.input
const argOut: string | undefined = argv._[1] || argv.output // the output can be omitted so this can be undefined

const ISGLOB = isGlob(argIn)
const ISDIR = isDir(argIn)

if ((ISGLOB || ISDIR) && argOut && argOut.includes('.d.ts')) {
throw new ReferenceError(
`You have specified a single file ${argOut} output for a multi file input ${argIn}. This feature is not yet supported, refer to issue #272 (https://github.com/bcherny/json-schema-to-typescript/issues/272)`,
)
}

try {
// Process input as either glob, directory, or single file
if (ISGLOB) {
await processGlob(argIn, argOut, argv as Partial<Options>)
} else if (ISDIR) {
await processDir(argIn, argOut, argv as Partial<Options>)
} else {
const result = await processFile(argIn, argv as Partial<Options>)
outputResult(result, argOut)
}
} catch (e) {
error(e)
process.exit(1)
}
}

// check if path is an existing directory
function isDir(path: string): boolean {
return existsSync(path) && lstatSync(path).isDirectory()
}

async function processGlob(argIn: string, argOut: string | undefined, argv: Partial<Options>) {
const files = await glob(argIn) // execute glob pattern match

if (files.length === 0) {
throw ReferenceError(
`You passed a glob pattern "${argIn}", but there are no files that match that pattern in ${process.cwd()}`,
)
}

// we can do this concurrently for perf
const results = await Promise.all(
files.map(async file => {
return [file, await processFile(file, argv)] as const
}),
)

// careful to do this serially
results.forEach(([file, result]) => {
const outputPath = argOut && `${argOut}/${basename(file, '.json')}.d.ts`
outputResult(result, outputPath)
})
}

async function processDir(argIn: string, argOut: string | undefined, argv: Partial<Options>) {
const files = getPaths(argIn)

// we can do this concurrently for perf
const results = await Promise.all(
files.map(async file => {
if (!argOut) {
return [file, await processFile(file, argv)] as const
} else {
const outputPath = pathTransform(argOut, argIn, file)
return [file, await processFile(file, argv), outputPath] as const
}
}),
)

// careful to do this serially
results.forEach(([file, result, outputPath]) =>
outputResult(result, outputPath ? `${outputPath}/${basename(file, '.json')}.d.ts` : undefined),
)
}

async function outputResult(result: string, outputPath: string | undefined): Promise<void> {
if (!outputPath) {
process.stdout.write(result)
} else {
if (!isDir(dirname(outputPath))) {
mkdirp.sync(dirname(outputPath))
}
return await writeFile(outputPath, result)
}
}

async function processFile(argIn: string, argv: Partial<Options>): Promise<string> {
const schema = JSON.parse(await readInput(argIn))
return compile(schema, argIn, argv)
}

function getPaths(path: string, paths: string[] = []) {
if (existsSync(path) && lstatSync(path).isDirectory()) {
readdirSync(resolve(path)).forEach(item => getPaths(join(path, item), paths))
} else {
paths.push(path)
}

return paths
}

function readInput(argIn?: string) {
if (!argIn) {
return getStdin()
}
return readFile(resolve(process.cwd(), argIn), 'utf-8')
}

function printHelp() {
const pkg = require('../../package.json')

process.stdout.write(
`
${pkg.name} ${pkg.version}
Usage: json2ts [--input, -i] [IN_FILE] [--output, -o] [OUT_FILE] [OPTIONS]

With no IN_FILE, or when IN_FILE is -, read standard input.
With no OUT_FILE and when IN_FILE is specified, create .d.ts file in the same directory.
With no OUT_FILE nor IN_FILE, write to standard output.

You can use any of the following options by adding them at the end.
Boolean values can be set to false using the 'no-' prefix.

--additionalProperties
Default value for additionalProperties, when it is not explicitly set
--cwd=XXX
Root directory for resolving $ref
--declareExternallyReferenced
Declare external schemas referenced via '$ref'?
--enableConstEnums
Prepend enums with 'const'?
--format
Format code? Set this to false to improve performance.
--maxItems
Maximum number of unioned tuples to emit when representing bounded-size
array types, before falling back to emitting unbounded arrays. Increase
this to improve precision of emitted types, decrease it to improve
performance, or set it to -1 to ignore minItems and maxItems.
--style.XXX=YYY
Prettier configuration
--unknownAny
Output unknown type instead of any type
--unreachableDefinitions
Generates code for definitions that aren't referenced by the schema
`,
)
}
#!/usr/bin/env node
import minimist = require('minimist')
import getStdin from 'get-stdin'
import {readFile, writeFile, existsSync, lstatSync, readdirSync} from 'mz/fs'
import * as mkdirp from 'mkdirp'
import glob from 'glob-promise'
import isGlob = require('is-glob')
import {join, resolve, dirname, basename} from 'path'
import {compile, DEFAULT_OPTIONS, Options} from './index'
import {pathTransform, error} from './utils'
main(
minimist(process.argv.slice(2), {
alias: {
help: ['h'],
input: ['i'],
output: ['o'],
},
boolean: [
'additionalProperties',
'declareExternallyReferenced',
'enableConstEnums',
'format',
'ignoreMinAndMaxItems',
'strictIndexSignatures',
'unknownAny',
'unreachableDefinitions',
'usePrefixItems',
],
default: DEFAULT_OPTIONS,
string: ['bannerComment', 'cwd'],
}),
)
async function main(argv: minimist.ParsedArgs) {
if (argv.help) {
printHelp()
process.exit(0)
}
const argIn: string = argv._[0] || argv.input
const argOut: string | undefined = argv._[1] || argv.output // the output can be omitted so this can be undefined
const ISGLOB = isGlob(argIn)
const ISDIR = isDir(argIn)
if ((ISGLOB || ISDIR) && argOut && argOut.includes('.d.ts')) {
throw new ReferenceError(
`You have specified a single file ${argOut} output for a multi file input ${argIn}. This feature is not yet supported, refer to issue #272 (https://github.com/bcherny/json-schema-to-typescript/issues/272)`,
)
}
try {
// Process input as either glob, directory, or single file
if (ISGLOB) {
await processGlob(argIn, argOut, argv as Partial<Options>)
} else if (ISDIR) {
await processDir(argIn, argOut, argv as Partial<Options>)
} else {
const result = await processFile(argIn, argv as Partial<Options>)
outputResult(result, argOut)
}
} catch (e) {
error(e)
process.exit(1)
}
}
// check if path is an existing directory
function isDir(path: string): boolean {
return existsSync(path) && lstatSync(path).isDirectory()
}
async function processGlob(argIn: string, argOut: string | undefined, argv: Partial<Options>) {
const files = await glob(argIn) // execute glob pattern match
if (files.length === 0) {
throw ReferenceError(
`You passed a glob pattern "${argIn}", but there are no files that match that pattern in ${process.cwd()}`,
)
}
// we can do this concurrently for perf
const results = await Promise.all(
files.map(async file => {
return [file, await processFile(file, argv)] as const
}),
)
// careful to do this serially
results.forEach(([file, result]) => {
const outputPath = argOut && `${argOut}/${basename(file, '.json')}.d.ts`
outputResult(result, outputPath)
})
}
async function processDir(argIn: string, argOut: string | undefined, argv: Partial<Options>) {
const files = getPaths(argIn)
// we can do this concurrently for perf
const results = await Promise.all(
files.map(async file => {
if (!argOut) {
return [file, await processFile(file, argv)] as const
} else {
const outputPath = pathTransform(argOut, argIn, file)
return [file, await processFile(file, argv), outputPath] as const
}
}),
)
// careful to do this serially
results.forEach(([file, result, outputPath]) =>
outputResult(result, outputPath ? `${outputPath}/${basename(file, '.json')}.d.ts` : undefined),
)
}
async function outputResult(result: string, outputPath: string | undefined): Promise<void> {
if (!outputPath) {
process.stdout.write(result)
} else {
if (!isDir(dirname(outputPath))) {
mkdirp.sync(dirname(outputPath))
}
return await writeFile(outputPath, result)
}
}
async function processFile(argIn: string, argv: Partial<Options>): Promise<string> {
const schema = JSON.parse(await readInput(argIn))
return compile(schema, argIn, argv)
}
function getPaths(path: string, paths: string[] = []) {
if (existsSync(path) && lstatSync(path).isDirectory()) {
readdirSync(resolve(path)).forEach(item => getPaths(join(path, item), paths))
} else {
paths.push(path)
}
return paths
}
function readInput(argIn?: string) {
if (!argIn) {
return getStdin()
}
return readFile(resolve(process.cwd(), argIn), 'utf-8')
}
function printHelp() {
const pkg = require('../../package.json')
process.stdout.write(
`
${pkg.name} ${pkg.version}
Usage: json2ts [--input, -i] [IN_FILE] [--output, -o] [OUT_FILE] [OPTIONS]
With no IN_FILE, or when IN_FILE is -, read standard input.
With no OUT_FILE and when IN_FILE is specified, create .d.ts file in the same directory.
With no OUT_FILE nor IN_FILE, write to standard output.
You can use any of the following options by adding them at the end.
Boolean values can be set to false using the 'no-' prefix.
--additionalProperties
Default value for additionalProperties, when it is not explicitly set
--cwd=XXX
Root directory for resolving $ref
--declareExternallyReferenced
Declare external schemas referenced via '$ref'?
--enableConstEnums
Prepend enums with 'const'?
--format
Format code? Set this to false to improve performance.
--maxItems
Maximum number of unioned tuples to emit when representing bounded-size
array types, before falling back to emitting unbounded arrays. Increase
this to improve precision of emitted types, decrease it to improve
performance, or set it to -1 to ignore minItems and maxItems.
--style.XXX=YYY
Prettier configuration
--unknownAny
Output unknown type instead of any type
--unreachableDefinitions
Generates code for definitions that aren't referenced by the schema
`,
)
}
Loading