Configure ts-node via tsconfig #921
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,3 +3,5 @@ coverage/ | |
| .DS_Store | ||
| npm-debug.log | ||
| dist/ | ||
| tsconfig.schema.json | ||
| tsconfig.schemastore-schema.json | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| #!/usr/bin/env ts-node | ||
|
There was a problem hiding this comment. I'm assuming this line doesn't work, since we use There was a problem hiding this comment. It should work if you have |
||
| /* | ||
| * Create a complete JSON schema for tsconfig.json | ||
| * by merging the schemastore schema with our ts-node additions. | ||
| * This merged schema can be submitted in a pull request to | ||
| * SchemaStore. | ||
| */ | ||
|
There was a problem hiding this comment. Is this script necessary? Why can't we specify a URL within our schema to have it already be up-to-date with the remote schema? I'm worried this will mean that every TypeScript version I'll need to be generating and releasing the updated schema. You're meant to be able to use There was a problem hiding this comment. Correct, I'm generating 2 schemas. First is @G-Rath suggested patching ts-node's additions into the official file on Schemastore. This script produces that merged schema. The idea is that it would live in SchemaStore, so editors would tab-complete the ts-node fields without any configuration on the user's part. I'm not sure if they'll ever merge it, though, because if someone tab-completes the ts-node options, they'll still need to install ts-node. It could be nice publicity for the library; I dunno. There was a problem hiding this comment. They will merge it, since it's not a breaking change (they don't reject PRs - like, ever) :) The configuration options are harmless if |
||
|
|
||
| import axios from 'axios'; | ||
| import * as Path from 'path'; | ||
|
There was a problem hiding this comment. Nit: Casing on |
||
| import * as fs from 'fs'; | ||
|
|
||
| async function main() { | ||
| /** schemastore definition */ | ||
| const schemastoreSchema = (await axios.get( | ||
| 'https://schemastore.azurewebsites.net/schemas/json/tsconfig.json', | ||
| { responseType: "json" } | ||
| )).data; | ||
|
|
||
| /** ts-node schema auto-generated from ts-node source code */ | ||
| const typescriptNodeSchema = require('../tsconfig.schema.json'); | ||
|
|
||
| /** Patch ts-node stuff into the schemastore definition. */ | ||
| const mergedSchema = { | ||
| ...schemastoreSchema, | ||
| definitions: { | ||
| ...schemastoreSchema.definitions, | ||
| tsNodeDefinition: { | ||
| properties: { | ||
| 'ts-node': { | ||
| ...typescriptNodeSchema.definitions.TsConfigOptions, | ||
| description: typescriptNodeSchema.definitions.TsConfigSchema.properties['ts-node'].description, | ||
| properties: { | ||
| ...typescriptNodeSchema.definitions.TsConfigOptions.properties, | ||
| compilerOptions: { | ||
| ...typescriptNodeSchema.definitions.TsConfigOptions.properties.compilerOptions, | ||
| allOf: [{ | ||
| $ref: '#/definitions/compilerOptionsDefinition/properties/compilerOptions' | ||
| }] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| }, | ||
| allOf: [ | ||
| ...schemastoreSchema.allOf.slice(0, 4), | ||
|
There was a problem hiding this comment. Just so it gets spliced into the array at a point that looks nice. https://github.com/SchemaStore/schemastore/blob/master/src/schemas/json/tsconfig.json#L630-L631 |
||
| { "$ref": "#/definitions/tsNodeDefinition" }, | ||
| ...schemastoreSchema.allOf.slice(4), | ||
| ] | ||
| }; | ||
| fs.writeFileSync( | ||
| Path.resolve(__dirname, '../tsconfig.schemastore-schema.json'), | ||
| JSON.stringify(mergedSchema, null, 2) | ||
| ); | ||
| } | ||
|
|
||
| main(); | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: Consistent dash casing is currently used.