feat(platform): convert to typescript (#3988)

lib/platform/index.js → lib/platform/index.ts

-const URL = require('url');
-const addrs = require('email-addresses');
-const hostRules = require('../util/host-rules');
+import URL from 'url';
+import addrs from 'email-addresses';
+import * as hostRules from '../util/host-rules';
 
+// TODO: move to definitions: platform.allowedValues
 /* eslint-disable global-require */
 const platforms = new Map([
   ['azure', require('./azure')],
@@ -12,11 +13,12 @@ const platforms = new Map([
 ]);
 /* eslint-enable global-require */
 
-function setPlatformApi(platform) {
+// TODO: lazy load platform
+export function setPlatformApi(platform: string) {
   global.platform = platforms.get(platform);
 }
 
-async function initPlatform(config) {
+export async function initPlatform(config: any) {
   setPlatformApi(config.platform);
   if (!global.platform) {
     const supportedPlatforms = [...platforms.keys()].join(', ');
@@ -24,7 +26,8 @@ async function initPlatform(config) {
       `Init: Platform "${config.platform}" not found. Must be one of: ${supportedPlatforms}`
     );
   }
-  const platformInfo = await global.platform.initPlatform(config);
+  // TODO: types
+  const platformInfo: any = await global.platform.initPlatform(config);
   const returnConfig = { ...config, ...platformInfo };
   let gitAuthor;
   if (config && config.gitAuthor) {
@@ -37,9 +40,9 @@ async function initPlatform(config) {
     logger.info('Using platform gitAuthor: ' + platformInfo.gitAuthor);
     gitAuthor = platformInfo.gitAuthor;
   }
-  let gitAuthorParsed;
+  let gitAuthorParsed: addrs.ParsedMailbox | null = null;
   try {
-    gitAuthorParsed = addrs.parseOneAddress(gitAuthor);
+    gitAuthorParsed = addrs.parseOneAddress(gitAuthor) as addrs.ParsedMailbox;
   } catch (err) /* istanbul ignore next */ {
     logger.debug({ gitAuthor, err }, 'Error parsing gitAuthor');
   }
@@ -51,7 +54,8 @@ async function initPlatform(config) {
     name: gitAuthorParsed.name,
     email: gitAuthorParsed.address,
   };
-  const platformRule = {
+  // TODO: types
+  const platformRule: any = {
     hostType: returnConfig.platform,
     hostName: URL.parse(returnConfig.endpoint).hostname,
   };
@@ -66,8 +70,3 @@ async function initPlatform(config) {
   hostRules.add(platformRule);
   return returnConfig;
 }
-
-module.exports = {
-  initPlatform,
-  setPlatformApi,
-};

lib/types.d.ts

@@ -28,5 +28,7 @@ declare namespace NodeJS {
     logger: Renovate.Logger;
 
     renovateVersion: string;
+    // TODO: declare interface for all platforms
+    platform: typeof import('./platform/github');
   }
 }

test/platform/index.spec.js → test/platform/index.spec.ts

-const github = require('../../lib/platform/github');
-const gitlab = require('../../lib/platform/gitlab');
-const azure = require('../../lib/platform/azure');
-const bitbucket = require('../../lib/platform/bitbucket');
-const bitbucketServer = require('../../lib/platform/bitbucket-server');
+import * as github from '../../lib/platform/github';
+import * as gitlab from '../../lib/platform/gitlab';
+import * as azure from '../../lib/platform/azure';
+import * as bitbucket from '../../lib/platform/bitbucket';
+import * as bitbucketServer from '../../lib/platform/bitbucket-server';
 
-const platform = require('../../lib/platform');
+import * as platform from '../../lib/platform';
 
 describe('platform', () => {
   it('throws if wrong platform', async () => {