From 933305dd9f0531c66cff544120f6024cce16f745 Mon Sep 17 00:00:00 2001 From: Andre Loker Date: Fri, 19 Jan 2018 12:58:21 +0100 Subject: [PATCH 1/4] fix: invalid configuration of line-rule max-line-length --- tslint.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tslint.json b/tslint.json index fd3b6d97f..6062ae00c 100644 --- a/tslint.json +++ b/tslint.json @@ -11,7 +11,7 @@ "interface-name": [ true, "never-prefix" ], "jsdoc-format": true, "label-position": true, - "max-line-length": 120, + "max-line-length": [true, 120], "member-access": false, "member-ordering": false, "no-any": false, From c4059c7dc68bf9935e8715557c38de551aeb9aa0 Mon Sep 17 00:00:00 2001 From: Andre Loker Date: Fri, 19 Jan 2018 13:09:36 +0100 Subject: [PATCH 2/4] fix: compilation errors due to (lack of) use of ReadonlyArray --- src/lib/converter/converter.ts | 4 ++-- src/lib/utils/loggers.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/lib/converter/converter.ts b/src/lib/converter/converter.ts index 625c2f7f3..5a02111e6 100644 --- a/src/lib/converter/converter.ts +++ b/src/lib/converter/converter.ts @@ -18,7 +18,7 @@ export interface ConverterResult { /** * An array containing all errors generated by the TypeScript compiler. */ - errors: ts.Diagnostic[]; + errors: ReadonlyArray; /** * The resulting project reflection. @@ -351,7 +351,7 @@ export class Converter extends ChildableComponent { const program = context.program; program.getSourceFiles().forEach((sourceFile) => { diff --git a/src/lib/utils/loggers.ts b/src/lib/utils/loggers.ts index d4c709ea7..c4b8be5e6 100644 --- a/src/lib/utils/loggers.ts +++ b/src/lib/utils/loggers.ts @@ -116,7 +116,7 @@ export class Logger { * * @param diagnostics The TypeScript messages that should be logged. */ - public diagnostics(diagnostics: ts.Diagnostic[]) { + public diagnostics(diagnostics: ReadonlyArray) { diagnostics.forEach((diagnostic) => { this.diagnostic(diagnostic); }); From 847063b608a4b801d7dcb5996d45cd45965412b5 Mon Sep 17 00:00:00 2001 From: Andre Loker Date: Fri, 19 Jan 2018 13:35:04 +0100 Subject: [PATCH 3/4] format: upgrade to a more generous max 160 characters per line Fixes format issues in those files that exceed even the 160 characters limit. --- src/lib/converter/plugins/PackagePlugin.ts | 3 ++- src/lib/converter/types/array.ts | 6 +++++- src/lib/serialization/browser.ts | 14 +++++++++++++- src/lib/utils/events.ts | 6 +++++- tslint.json | 2 +- 5 files changed, 26 insertions(+), 5 deletions(-) diff --git a/src/lib/converter/plugins/PackagePlugin.ts b/src/lib/converter/plugins/PackagePlugin.ts index eff18320c..61be42746 100644 --- a/src/lib/converter/plugins/PackagePlugin.ts +++ b/src/lib/converter/plugins/PackagePlugin.ts @@ -20,7 +20,8 @@ import { Option } from '../../utils/component'; export class PackagePlugin extends ConverterComponent { @Option({ name: 'readme', - help: 'Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page and start the documentation on the globals page.' + help: 'Path to the readme file that should be displayed on the index page. Pass `none` to disable the index ' + + 'page and start the documentation on the globals page.' }) readme: string; diff --git a/src/lib/converter/types/array.ts b/src/lib/converter/types/array.ts index d6d1b3fad..cb2bad5a1 100644 --- a/src/lib/converter/types/array.ts +++ b/src/lib/converter/types/array.ts @@ -18,7 +18,11 @@ export class ArrayConverter extends ConverterTypeComponent implements TypeConver */ supportsType(context: Context, type: ts.TypeReference): boolean { // Is there a better way to detect the {"type":"reference","name":"Array","typeArguments":{...}} types that are in fact arrays? - return !!(type.flags & ts.TypeFlags.Object) && !!type.symbol && type.symbol.name === 'Array' && !type.symbol.parent && !!type.typeArguments && type.typeArguments.length === 1; + return !!(type.flags & ts.TypeFlags.Object) + && !!type.symbol && type.symbol.name === 'Array' + && !type.symbol.parent + && !!type.typeArguments + && type.typeArguments.length === 1; } /** diff --git a/src/lib/serialization/browser.ts b/src/lib/serialization/browser.ts index c7f345dae..e401fd0cf 100644 --- a/src/lib/serialization/browser.ts +++ b/src/lib/serialization/browser.ts @@ -205,7 +205,19 @@ export interface TypeObject { /** * The type name identifier. */ - type: 'void' | 'array' | 'intersection' | 'intrinsic' | 'reference' | 'reflection' | 'stringLiteral' | 'tuple' | 'typeParameter' | 'union' | 'unknown' | string; + type: + | 'void' + | 'array' + | 'intersection' + | 'intrinsic' + | 'reference' + | 'reflection' + | 'stringLiteral' + | 'tuple' + | 'typeParameter' + | 'union' + | 'unknown' + | string; // array /** diff --git a/src/lib/utils/events.ts b/src/lib/utils/events.ts index f398e468b..3997fb8b9 100644 --- a/src/lib/utils/events.ts +++ b/src/lib/utils/events.ts @@ -199,7 +199,11 @@ function onceMap(map: EventMap, name: string, callback: EventCallback, offer: Fu /** * Handles triggering the appropriate event callbacks. */ -function triggerApi(objEvents: EventHandlers, name: string, callback: Function, args: any[], triggerer: {(events: EventHandler[], args: any[]): void} = triggerEvents): EventHandlers { +function triggerApi(objEvents: EventHandlers, + name: string, + callback: Function, + args: any[], + triggerer: {(events: EventHandler[], args: any[]): void} = triggerEvents): EventHandlers { if (objEvents) { const events = objEvents[name]; let allEvents = objEvents['all']; diff --git a/tslint.json b/tslint.json index 6062ae00c..b8957e117 100644 --- a/tslint.json +++ b/tslint.json @@ -11,7 +11,7 @@ "interface-name": [ true, "never-prefix" ], "jsdoc-format": true, "label-position": true, - "max-line-length": [true, 120], + "max-line-length": [true, 160], "member-access": false, "member-ordering": false, "no-any": false, From 1174e03dfefa782a90e8c118bf5e43daad317ed9 Mon Sep 17 00:00:00 2001 From: Andre Loker Date: Fri, 19 Jan 2018 13:35:40 +0100 Subject: [PATCH 4/4] chore: upgrade TypeScript to 2.6.2 --- package.json | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index cc1d135c4..e0fa38b36 100644 --- a/package.json +++ b/package.json @@ -12,6 +12,11 @@ "name": "Sebastian Lenz", "url": "http://www.sebastian-lenz.de/" }, + "contributors": [ + { + "name": "Andre Loker" + } + ], "license": "Apache-2.0", "repository": { "type": "git", @@ -46,7 +51,7 @@ "progress": "^2.0.0", "shelljs": "^0.7.0", "typedoc-default-themes": "^0.5.0", - "typescript": "2.5.3" + "typescript": "2.6.2" }, "devDependencies": { "@types/mocha": "^2.2.39",