diff --git a/tsdoc-config/README.md b/tsdoc-config/README.md index 6bd79224..4bdc683b 100644 --- a/tsdoc-config/README.md +++ b/tsdoc-config/README.md @@ -19,7 +19,7 @@ until it finds a folder containing **tsconfig.json** or **package.json**, and th **tsdoc.json** from that location. The **tsdoc.json** file conforms to the [tsdoc.schema.json]( -https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json) JSON schema. It defines tags using +https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json) JSON schema. It defines tags using similar fields as the [TSDocTagDefinition](https://github.com/microsoft/tsdoc/blob/master/tsdoc/src/configuration/TSDocTagDefinition.ts) API used by `TSDocParser` from `@microsoft/tsdoc`. @@ -29,7 +29,7 @@ Here's a simple example: **tsdoc.json** ```js { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json", + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "tagDefinitions": [ { "tagName": "@myTag", @@ -45,7 +45,7 @@ a list of paths that will be mixed in with the current file: **tsdoc.json** ```js { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json", + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "extends": [ "my-package/dist/tsdoc-base.json", "./path/to/local/file/tsdoc-local.json" diff --git a/tsdoc-config/src/TSDocConfigFile.ts b/tsdoc-config/src/TSDocConfigFile.ts index 2f78c532..5c78b314 100644 --- a/tsdoc-config/src/TSDocConfigFile.ts +++ b/tsdoc-config/src/TSDocConfigFile.ts @@ -48,7 +48,7 @@ interface IConfigJson { export class TSDocConfigFile { public static readonly FILENAME: string = 'tsdoc.json'; public static readonly CURRENT_SCHEMA_URL: string - = 'https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json'; + = 'https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json'; /** * A queryable log that reports warnings and error messages that occurred during parsing. diff --git a/tsdoc-config/src/__tests__/TSDocConfigFile.test.ts b/tsdoc-config/src/__tests__/TSDocConfigFile.test.ts index 3ae8a266..8e0af966 100644 --- a/tsdoc-config/src/__tests__/TSDocConfigFile.test.ts +++ b/tsdoc-config/src/__tests__/TSDocConfigFile.test.ts @@ -41,7 +41,7 @@ test('Load p1', () => { "filePath": "assets/p1/tsdoc.json", "messages": Array [], "tagDefinitions": Array [], - "tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json", + "tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", } `); }); @@ -90,7 +90,7 @@ test('Load p3', () => { "tagNameWithUpperCase": "@BASE1", }, ], - "tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json", + "tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", }, Object { "extendsFiles": Array [], @@ -107,7 +107,7 @@ test('Load p3', () => { "tagNameWithUpperCase": "@BASE2", }, ], - "tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json", + "tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", }, ], "extendsPaths": Array [ @@ -126,7 +126,7 @@ test('Load p3', () => { "tagNameWithUpperCase": "@ROOT", }, ], - "tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json", + "tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", } `); }); @@ -149,7 +149,7 @@ test('Load p4', () => { "tagNameWithUpperCase": "@EXAMPLE", }, ], - "tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json", + "tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", }, ], "extendsPaths": Array [ @@ -167,7 +167,7 @@ test('Load p4', () => { "tagNameWithUpperCase": "@ROOT", }, ], - "tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json", + "tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", } `); }); diff --git a/tsdoc-config/src/__tests__/assets/p1/tsdoc.json b/tsdoc-config/src/__tests__/assets/p1/tsdoc.json index 212f75bd..f4ac01a0 100644 --- a/tsdoc-config/src/__tests__/assets/p1/tsdoc.json +++ b/tsdoc-config/src/__tests__/assets/p1/tsdoc.json @@ -1,3 +1,3 @@ { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json" + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json" } diff --git a/tsdoc-config/src/__tests__/assets/p3/base1/tsdoc-base1.json b/tsdoc-config/src/__tests__/assets/p3/base1/tsdoc-base1.json index b734ade0..c2f4560a 100644 --- a/tsdoc-config/src/__tests__/assets/p3/base1/tsdoc-base1.json +++ b/tsdoc-config/src/__tests__/assets/p3/base1/tsdoc-base1.json @@ -1,5 +1,5 @@ { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json", + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "tagDefinitions": [ { "tagName": "@base1", diff --git a/tsdoc-config/src/__tests__/assets/p3/base2/tsdoc-base2.json b/tsdoc-config/src/__tests__/assets/p3/base2/tsdoc-base2.json index 9d20231c..52c66531 100644 --- a/tsdoc-config/src/__tests__/assets/p3/base2/tsdoc-base2.json +++ b/tsdoc-config/src/__tests__/assets/p3/base2/tsdoc-base2.json @@ -1,5 +1,5 @@ { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json", + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "tagDefinitions": [ { "tagName": "@base2", diff --git a/tsdoc-config/src/__tests__/assets/p3/tsdoc.json b/tsdoc-config/src/__tests__/assets/p3/tsdoc.json index 0be2eb39..e3845bcc 100644 --- a/tsdoc-config/src/__tests__/assets/p3/tsdoc.json +++ b/tsdoc-config/src/__tests__/assets/p3/tsdoc.json @@ -1,5 +1,5 @@ { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json", + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "extends": [ "./base1/tsdoc-base1.json", "./base2/tsdoc-base2.json" diff --git a/tsdoc-config/src/__tests__/assets/p4/node_modules/example-lib/dist/tsdoc-example.json b/tsdoc-config/src/__tests__/assets/p4/node_modules/example-lib/dist/tsdoc-example.json index 460126fb..870374e4 100644 --- a/tsdoc-config/src/__tests__/assets/p4/node_modules/example-lib/dist/tsdoc-example.json +++ b/tsdoc-config/src/__tests__/assets/p4/node_modules/example-lib/dist/tsdoc-example.json @@ -1,5 +1,5 @@ { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdocconfig.schema.json", + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "tagDefinitions": [ { "tagName": "@example", diff --git a/tsdoc-config/src/__tests__/assets/p4/tsdoc.json b/tsdoc-config/src/__tests__/assets/p4/tsdoc.json index 0a857667..abb4b703 100644 --- a/tsdoc-config/src/__tests__/assets/p4/tsdoc.json +++ b/tsdoc-config/src/__tests__/assets/p4/tsdoc.json @@ -1,5 +1,5 @@ { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json", + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "extends": [ "example-lib/dist/tsdoc-example.json" ],