Graham/angular-cli
1
0
Fork 0
mirror of https://github.com/angular/angular-cli.git synced 2025-05-15 01:54:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

build: add support for x-deprecated when generating schema

Browse Source 
When using the CLI and a property is deprecated we emit a warning by using the `x-deprecated` field. However API consumers have no way to know that a property is deprecated at the moment.

This converts `x-deprecated` to  `@deprecated` comments
This commit is contained in:
Alan Agius 2018-11-26 09:20:34 +01:00 committed by Alex Eagle
parent 45b6df511f
commit aae1afd114
1 changed files with 25 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
tools/quicktype_runner.js
View File

@ -9,7 +9,6 @@ const fs = require('fs');
const path = require('path');
const {
InputData,
JSONSchema,
JSONSchemaInput,
JSONSchemaStore,
TypeScriptTargetLanguage,
@ -88,6 +87,8 @@ class FetchingJSONSchemaStore extends JSONSchemaStore {
return undefined;
}
content = appendDeprecatedDescription(content);
return parseJSON(content, "JSON Schema", address);
}
}
@ -116,7 +117,8 @@ async function generate(inPath) {
// Best description of how to use the API was found at
// https://blog.quicktype.io/customizing-quicktype/
const inputData = new InputData();
const source = { name: 'Schema', schema: fs.readFileSync(inPath, 'utf-8') };
const content = fs.readFileSync(inPath, 'utf-8');
const source = { name: 'Schema', schema: appendDeprecatedDescription(content) };
await inputData.addSource('schema', source, () => {
return new JSONSchemaInput(new FetchingJSONSchemaStore(inPath));
@ -137,6 +139,27 @@ async function generate(inPath) {
return header + lines.join('\n') + footer;
}
/**
* Converts `x-deprecated` to `@deprecated` comments.
* @param {string} schema
*/
function appendDeprecatedDescription(schema) {
const content = JSON.parse(schema);
const props = content.properties;
for (const key in props) {
let { description = '', 'x-deprecated': deprecated } = props[key];
if (!deprecated) {
continue;
}
description += '\n@deprecated' + (typeof deprecated === 'string' ? ` ${deprecated}` : '');
props[key].description = description;
}
return JSON.stringify(content);
}
if (require.main === module) {
// Parse arguments and run main().
const argv = process.argv.slice(2);