Chore: Enable strict type-checking

Fix #576
Close #1382

Co-authored-by: Antón Molleda <amolleda@gmail.com>
Co-authored-by: Jesus David García Gomez <jdgarcia@outlook.com>

Author: 3 people

@types/listr-input.d.ts

@@ -0,0 +1 @@
+declare module 'listr-input';

package.json

@@ -2,7 +2,10 @@
   "devDependencies": {
     "@alrra/travis-scripts": "^3.0.1",
     "@types/fs-extra": "5.0.4",
-    "@types/node": "8.0.14",
+    "@types/listr": "^0.13.0",
+    "@types/node": "10.9.1",
+    "@types/shelljs": "^0.8.0",
+    "@types/yargs": "^12.0.1",
     "chalk": "^2.4.1",
     "cpx": "^1.5.0",
     "eslint": "^5.6.1",
@@ -48,7 +51,7 @@
     "build:connector-edge": "node -e \"process.platform !== 'win32' && process.exit(1);\" && (cd packages/connector-edge && yarn build) || echo \"\"",
     "build:connector-jsdom": "cd packages/connector-jsdom && yarn build",
     "build:connector-local": "cd packages/connector-local && yarn build",
-    "build:connectors": "yarn build:connector-edge && yarn build:connector-chrome && yarn build:connector-jsdom && yarn build:connector-local",
+    "build:connectors": "yarn build:connector-chrome && yarn build:connector-jsdom && yarn build:connector-local",
     "build:hint": "cd packages/hint && yarn build",
     "build:parser:babel": "cd packages/parser-babel-config && yarn build",
     "build:parser:html": "cd packages/parser-html && yarn build",
@@ -65,7 +68,7 @@
     "build:utils-server": "cd packages/utils-create-server && yarn build",
     "build:utils-test": "cd packages/utils-tests-helpers && yarn build",
     "clean": "npm-run-all clean:*",
-    "clean:packages": "rimraf \"packages/!(extension-vscode)/{dist,node_modules,npm-shrinkwrap.json,package-lock.json,yarn.lock}\"",
+    "clean:packages": "rimraf \"packages/!(connector-edge|extension-vscode)/{dist,node_modules,npm-shrinkwrap.json,package-lock.json,yarn.lock}\"",
     "clean:root": "rimraf dist",
     "lint": "npm-run-all lint:*",
     "lint:md": "markdownlint *.md",

packages/connector-chrome/package.json

@@ -16,6 +16,7 @@
   "devDependencies": {
     "@hint/utils-create-server": "^1.0.3",
     "@types/is-ci": "^1.1.0",
+    "@types/lockfile": "^1.0.0",
     "@types/lodash": "^4.14.115",
     "ava": "^0.25.0",
     "cpx": "^1.5.0",

packages/connector-chrome/src/chrome-launcher.ts

@@ -17,15 +17,15 @@ import readFileAsync from 'hint/dist/src/lib/utils/fs/read-file-async';
 import writeFileAsync from 'hint/dist/src/lib/utils/fs/write-file-async';
 
 const debug: debug.IDebugger = d(__filename);
-const lock = promisify(lockfile.lock);
+const lock = promisify(lockfile.lock) as (path: string, options: lockfile.Options) => Promise<void>;
 const unlock = promisify(lockfile.unlock);
 
 export class CDPLauncher extends Launcher {
     /** Indicates if the default profile should be used by Chrome or not */
     private userDataDir: string | boolean;
     private chromeFlags: Array<string>;
 
-    public constructor(options?: LauncherOptions) {
+    public constructor(options: LauncherOptions) {
         super(options);
 
         this.chromeFlags = options && options.flags || ['--no-default-browser-check'];

packages/connector-chrome/src/connector.ts

@@ -18,8 +18,8 @@ import { Engine } from 'hint/dist/src/lib/engine';
 
 export default class ChromeConnector extends Connector {
     public constructor(server: Engine, config?: object) {
-        const launcher: ILauncher = new CDPLauncher(config);
+        const launcher: ILauncher = new CDPLauncher(config || {});
 
-        super(server, config, launcher);
+        super(server, config || {}, launcher);
     }
 }

packages/connector-chrome/tsconfig.json

@@ -1,6 +1,7 @@
 {
     "compilerOptions": {
-        "outDir": "dist"
+        "outDir": "dist",
+        "strict": true
     },
     "exclude": [
         "dist",

packages/connector-edge/src/@types/node-windows.d.ts

@@ -0,0 +1 @@
+declare module 'node-windows';

packages/connector-edge/src/connector-edge-launcher.ts

@@ -104,7 +104,7 @@ export class EdgeLauncher extends Launcher {
     private checkIfRunning(procs: Array<string>): Promise<Array<boolean>> {
         return new Promise((resolve, reject) => {
             const cmd = spawn('cmd');
-            let out = [];
+            let out: (string | Buffer)[] = [];
 
             cmd.stdout.on('data', (data) => {
                 out = out.concat(data);
@@ -133,7 +133,7 @@ export class EdgeLauncher extends Launcher {
         });
     }
 
-    public async launch(url): Promise<BrowserInfo> {
+    public async launch(url: string): Promise<BrowserInfo> {
         const osInfo = this.isWin10();
 
         if (!osInfo.isWin || osInfo.version < 10) {

packages/connector-edge/src/connector-edge.ts

@@ -4,7 +4,7 @@
  */
 
 import { Connector } from '@hint/utils-debugging-protocol-common/dist/src/debugging-protocol-connector';
-import { ILauncher } from 'hint/dist/src/lib/types';
+import { ILauncher, LauncherOptions } from 'hint/dist/src/lib/types';
 import { EdgeLauncher } from './connector-edge-launcher';
 
 import { Engine } from 'hint/dist/src/lib/engine';
@@ -15,7 +15,7 @@ export default class EdgeConnector extends Connector {
             tabUrl: 'https://empty.webhint.io/',
             useTabUrl: true
         };
-        const edgeConfig = Object.assign({}, edgeRequiredConfig, config);
+        const edgeConfig = Object.assign({}, edgeRequiredConfig, config) as LauncherOptions;
         const launcher: ILauncher = new EdgeLauncher(edgeConfig);
 
         super(server, config, launcher);

packages/connector-edge/tsconfig.json

@@ -1,6 +1,7 @@
 {
     "compilerOptions": {
-        "outDir": "dist"
+        "outDir": "dist",
+        "strict": true
     },
     "exclude": [
         "dist",

packages/connector-jsdom/src/@types/jsdom.d.ts

@@ -18,7 +18,6 @@ declare module 'jsdom' {
     /// <reference types="node" />
 
     import { EventEmitter } from 'events';
-    import { MarkupData } from 'parse5';
     import * as tough from 'tough-cookie';
     import { Script } from 'vm';
 
@@ -43,7 +42,7 @@ declare module 'jsdom' {
         /**
          * The nodeLocation() method will find where a DOM node is within the source document, returning the parse5 location info for the node.
          */
-        nodeLocation(node: Node): MarkupData.ElementLocation | null;
+        nodeLocation(node: Node): any | null;
 
         /**
          * The built-in vm module of Node.js allows you to create Script instances,

packages/connector-jsdom/src/@types/jsdomutils.d.ts

@@ -0,0 +1 @@
+declare module 'jsdom/lib/jsdom/living/generated/utils';

packages/connector-jsdom/src/before-parse.ts

@@ -9,9 +9,10 @@ import * as path from 'path';
 import * as jsdomutils from 'jsdom/lib/jsdom/living/generated/utils';
 
 import readFile from 'hint/dist/src/lib/utils/fs/read-file';
+import { DOMWindow } from 'jsdom';
 
-export const beforeParse = (finalHref) => {
-    return (window) => {
+export const beforeParse = (finalHref: string) => {
+    return (window: DOMWindow) => {
         const mutationObserverPolyfill = readFile(require.resolve('mutationobserver-shim'));
         const customElementsPolyfill = readFile(path.join(__dirname, 'polyfills', 'custom-elements.min.js'));
 
@@ -25,7 +26,7 @@ export const beforeParse = (finalHref) => {
 
         /* istanbul ignore next */
         window.matchMedia = () => {
-            return { addListener() { } };
+            return { addListener() { } } as any;
         };
 
         Object.defineProperty(window.HTMLHtmlElement.prototype, 'clientWidth', { value: 1024 });

packages/connector-jsdom/src/connector.ts

@@ -58,23 +58,21 @@ const debug: debug.IDebugger = d(__filename);
 const defaultOptions = { waitFor: 1000 };
 
 export default class JSDOMConnector implements IConnector {
-    private _options;
-    private _headers;
-    private _href: string;
-    private _targetNetworkData: NetworkData;
-    private _window: Window;
-    private _document: JSDOMAsyncHTMLDocument;
+    private _options: any;
+    private _href: string = '';
+    private _targetNetworkData!: NetworkData;
+    private _window!: Window;
+    private _document!: JSDOMAsyncHTMLDocument;
     private _timeout: number;
     private _resourceLoader: ResourceLoader;
 
     public request: Requester;
     public server: Engine;
-    public finalHref: string;
-    public fetchedHrefs: Set<string>;
+    public finalHref!: string;
+    public fetchedHrefs!: Set<string>;
 
     public constructor(server: Engine, config?: object) {
         this._options = Object.assign({}, defaultOptions, config);
-        this._headers = this._options.headers;
         this.request = new Requester(this._options);
         this.server = server;
         this._timeout = server.timeout;
@@ -156,7 +154,7 @@ export default class JSDOMConnector implements IConnector {
      * * uses the `src` attribute of `<link rel="icon">` if present.
      * * uses `favicon.ico` and the final url after redirects.
      */
-    private async getFavicon(element?: HTMLElement) {
+    private async getFavicon(element?: Element | null) {
         const href = (element && element.getAttribute('href')) || '/favicon.ico';
 
         try {
@@ -203,7 +201,7 @@ export default class JSDOMConnector implements IConnector {
             } catch (err) {
                 const hops: Array<string> = this.request.getRedirects(err.uri);
                 const fetchError: FetchError = {
-                    element: null,
+                    element: null as any,
                     /* istanbul ignore next */
                     error: err.error ? err.error : err,
                     hops,
@@ -234,11 +232,11 @@ export default class JSDOMConnector implements IConnector {
 
             const { charset, mediaType } = getContentTypeData(fetchEnd.element, fetchEnd.resource, fetchEnd.response.headers, fetchEnd.response.body.rawContent);
 
-            fetchEnd.response.mediaType = mediaType;
-            fetchEnd.response.charset = charset;
+            fetchEnd.response.mediaType = mediaType!;
+            fetchEnd.response.charset = charset!;
 
             // Event is also emitted when status code in response is not 200.
-            await this.server.emitAsync(`fetch::end::${getType(mediaType)}`, fetchEnd);
+            await this.server.emitAsync(`fetch::end::${getType(mediaType!)}`, fetchEnd);
 
             /*
              * If the target is not an HTML we don't need to
@@ -255,7 +253,7 @@ export default class JSDOMConnector implements IConnector {
 
             const virtualConsole = new VirtualConsole();
 
-            virtualConsole.on('error', (err) => {
+            virtualConsole.on('error', (err: Error) => {
                 debug(`Console: ${err}`);
             });
 
@@ -314,7 +312,7 @@ export default class JSDOMConnector implements IConnector {
                 }, this._options.waitFor);
             };
 
-            const onError = (error) => {
+            const onError = (error: ErrorEvent) => {
                 debug(`onError: ${error}`);
             };
 
@@ -377,7 +375,7 @@ export default class JSDOMConnector implements IConnector {
         return new Promise((resolve, reject) => {
             /* istanbul ignore next */
             const runner: ChildProcess = fork(path.join(__dirname, 'evaluate-runner'), [this.finalHref || this._href, this._options.waitFor], { execArgv: [] });
-            let timeoutId;
+            let timeoutId: NodeJS.Timer | null = null;
 
             runner.on('message', (result) => {
                 /* istanbul ignore if */

packages/connector-jsdom/src/evaluate-runner.ts

@@ -9,22 +9,22 @@ import { beforeParse } from './before-parse';
 
 const debug: debug.IDebugger = d(__filename);
 
-const run = async (data) => {
+const run = async (data: { source: string }) => {
     const { source } = data;
     const result = {
-        error: null,
+        error: null as ErrorEvent | null,
         evaluate: 'result'
     };
     const url = process.argv[2];
     const waitFor = parseInt(process.argv[3], 10);
 
     const virtualConsole = new VirtualConsole();
 
-    virtualConsole.on('error', (err) => {
+    virtualConsole.on('error', (err: Error) => {
         debug(err);
     });
 
-    virtualConsole.on('jsdomError', (err) => {
+    virtualConsole.on('jsdomError', (err: Error) => {
         debug(err);
     });
 
@@ -52,14 +52,14 @@ const run = async (data) => {
                 result.error = err;
             }
 
-            process.send(result);
+            process.send!(result);
         }, waitFor);
     };
 
-    const onError = (error) => {
+    const onError = (error: ErrorEvent) => {
         result.error = error;
 
-        process.send(result);
+        process.send!(result);
     };
 
     jsdom.window.addEventListener('load', onLoad, { once: true });

packages/connector-jsdom/src/resource-loader.ts

@@ -19,14 +19,14 @@ export default class CustomResourceLoader extends ResourceLoader {
         this._connector = connector;
     }
 
-    public fetch(url: string, options: { element: HTMLElement }) {
+    public async fetch(url: string, options: { element: HTMLElement }): Promise<Buffer | null> {
         /* istanbul ignore if */
         if (!url) {
             const promise = Promise.resolve(null);
 
             (promise as any).abort = () => { };
 
-            return promise;
+            return await promise;
         }
 
         const urlAsUrl = new URL(url);
@@ -47,9 +47,9 @@ export default class CustomResourceLoader extends ResourceLoader {
 
         debug(`resource ${resourceUrl} to be fetched`);
 
-        let abort;
+        let abort: Function;
 
-        const promise = new Promise(async (resolve, reject) => {
+        const promise = new Promise<Buffer>(async (resolve, reject) => {
             abort = reject;
 
             await this._connector.server.emitAsync('fetch::start', { resource: resourceUrl });
@@ -67,10 +67,10 @@ export default class CustomResourceLoader extends ResourceLoader {
                 };
 
                 const { charset, mediaType } = getContentTypeData(element, fetchEndEvent.resource, fetchEndEvent.response.headers, fetchEndEvent.response.body.rawContent);
-                const type = getType(mediaType);
+                const type = mediaType ? getType(mediaType) : /* istanbul ignore next */ 'unknown';
 
-                fetchEndEvent.response.mediaType = mediaType;
-                fetchEndEvent.response.charset = charset;
+                fetchEndEvent.response.mediaType = mediaType!;
+                fetchEndEvent.response.charset = charset!;
 
                 /*
                  * TODO: Replace `null` with `resource` once it
@@ -83,7 +83,7 @@ export default class CustomResourceLoader extends ResourceLoader {
             } catch (err) {
                 const hops: Array<string> = this._connector.request.getRedirects(err.uri);
                 const fetchError: FetchError = {
-                    element,
+                    element: element!,
                     error: err.error,
                     hops,
                     /* istanbul ignore next */

packages/connector-jsdom/tsconfig.json

@@ -1,6 +1,7 @@
 {
     "compilerOptions": {
-        "outDir": "dist"
+        "outDir": "dist",
+        "strict": true
     },
     "exclude": [
         "dist",

packages/create-hint/tests/create-hint.ts

@@ -11,7 +11,7 @@ const writeFileAsyncModule = { default() { } };
 const isOfficialModule = { default() { } };
 
 const fsExtra = { copy() { } };
-const mkdirp = (dir, callback) => {
+const mkdirp = (dir: string, callback: Function) => {
     callback();
 };
 

packages/create-hint/tsconfig-webpack.json

@@ -5,7 +5,8 @@
         "inlineSourceMap": false,
         "removeComments": true,
         "target": "esnext",
-        "outDir": "dist"
+        "outDir": "dist",
+        "strict": true
     },
     "exclude": [
         "dist",

packages/create-hint/tsconfig.json

@@ -1,6 +1,7 @@
 {
     "compilerOptions": {
-        "outDir": "./dist"
+        "outDir": "./dist",
+        "strict": true
     },
     "exclude": [
         "dist",

packages/create-hintrc/package.json

@@ -15,6 +15,7 @@
   },
   "description": "webhint's configuration file initializer package",
   "devDependencies": {
+    "@types/inquirer": "^0.0.43",
     "ava": "^0.25.0",
     "cpx": "^1.5.0",
     "eslint": "^5.6.1",