Merge pull request #1271 from opencomponents/remove-global-types

[TYPE IMPROVEMENT] remove global callback and dictionary types

Author: ricardo-devis-agullo

src/cli/domain/clean.ts

@@ -5,19 +5,27 @@ import path from 'path';
 
 const getComponentsByDir = makeGetComponentsByDir();
 
-export function fetchList(dirPath: string, callback: Callback<string[]>): void {
+export function fetchList(
+  dirPath: string,
+  callback: (err: Error | null, data: string[]) => void
+): void {
   return getComponentsByDir(dirPath, (err, list) => {
     if (err) return (callback as any)(err);
     if (list.length === 0) return callback(null, []);
 
     const toRemove = list.map(folder => path.join(folder, 'node_modules'));
-    const folderExists = (folder: string, cb: Callback<boolean>) =>
-      fs.exists(folder, exists => cb(null, exists));
+    const folderExists = (
+      folder: string,
+      cb: (err: Error | null, data: boolean) => void
+    ) => fs.exists(folder, exists => cb(null, exists));
 
     async.filterSeries(toRemove, folderExists, callback as any);
   });
 }
 
-export function remove(list: string[], callback: Callback<string>): void {
+export function remove(
+  list: string[],
+  callback: (err: Error | null, data: string) => void
+): void {
   return async.eachSeries(list, fs.remove, callback as any);
 }

src/cli/domain/get-components-by-dir.ts

@@ -3,7 +3,10 @@ import path from 'path';
 import { Component } from '../../types';
 
 export default function getComponentsByDir() {
-  return (componentsDir: string, callback: Callback<string[]>): void => {
+  return (
+    componentsDir: string,
+    callback: (err: Error | null, data: string[]) => void
+  ): void => {
     const isOcComponent = function (file: string) {
       const filePath = path.resolve(componentsDir, file);
       const packagePath = path.join(filePath, 'package.json');

src/cli/domain/get-mocked-plugins.ts

@@ -45,7 +45,7 @@ const defaultRegister = (
 };
 
 const registerStaticMocks = (
-  mocks: Dictionary<string>,
+  mocks: Record<string, string>,
   logger: Logger
 ): PluginMock[] =>
   _.map(mocks, (mockedValue, pluginName) => {
@@ -62,7 +62,7 @@ const registerStaticMocks = (
 
 const registerDynamicMocks = (
   ocJsonLocation: string,
-  mocks: Dictionary<string>,
+  mocks: Record<string, string>,
   logger: Logger
 ) =>
   _.map(mocks, (source, pluginName) => {

src/cli/domain/handle-dependencies/ensure-compiler-is-declared-as-devDependency.ts

@@ -7,7 +7,7 @@ export default function ensureCompilerIsDeclaredAsDevDependency(
     pkg: Component;
     template: string;
   },
-  cb: Callback<string, string>
+  cb: (err: string | null, data: string) => void
 ): void {
   const { componentPath, pkg, template } = options;
   const compilerDep = `${template}-compiler`;

src/cli/domain/handle-dependencies/get-compiler.ts

@@ -10,9 +10,9 @@ export default function getCompiler(
     compilerDep: string;
     componentPath: string;
     logger: Logger;
-    pkg: { devDependencies: Dictionary<string> };
+    pkg: { devDependencies: Record<string, string> };
   },
-  cb: Callback<Template, string | number>
+  cb: (err: string | number | null, data: Template) => void
 ): void {
   const { compilerDep, componentPath, logger, pkg } = options;
   const compilerPath = path.join(componentPath, 'node_modules', compilerDep);

src/cli/domain/handle-dependencies/index.ts

@@ -14,7 +14,7 @@ import { Component } from '../../../types';
 
 const getComponentPackageJson = (
   componentPath: string,
-  cb: Callback<Component>
+  cb: (err: Error | null, data: Component) => void
 ) => fs.readJson(path.join(componentPath, 'package.json'), cb);
 
 const union = (a: ReadonlyArray<string>, b: ReadonlyArray<string>) => [
@@ -27,25 +27,25 @@ export default function handleDependencies(
     logger: Logger;
     useComponentDependencies?: boolean;
   },
-  callback: Callback<
-    {
+  callback: (
+    err: string | null,
+    data: {
       modules: string[];
       templates: Array<(...args: unknown[]) => unknown>;
-    },
-    string
-  >
+    }
+  ) => void
 ): void {
   const { components, logger, useComponentDependencies } = options;
 
-  const dependencies: Dictionary<string> = {};
-  const addDependencies = (componentDependencies?: Dictionary<string>) =>
+  const dependencies: Record<string, string> = {};
+  const addDependencies = (componentDependencies?: Record<string, string>) =>
     Object.entries(componentDependencies || {}).forEach(
       ([dependency, version]) => {
         dependencies[dependency] = version;
       }
     );
 
-  const templates: Dictionary<(...args: unknown[]) => unknown> = {};
+  const templates: Record<string, (...args: unknown[]) => unknown> = {};
   const addTemplate = (
     templateName: string,
     template: (...args: unknown[]) => unknown
@@ -59,15 +59,19 @@ export default function handleDependencies(
   ) =>
     async.waterfall(
       [
-        (cb: Callback<Component>) => getComponentPackageJson(componentPath, cb),
+        (cb: (err: Error | null, data: Component) => void) =>
+          getComponentPackageJson(componentPath, cb),
         (
           pkg: Component,
-          cb: Callback<{
-            componentPath: string;
-            logger: Logger;
-            pkg: Component;
-            template: string;
-          }>
+          cb: (
+            err: Error | null,
+            data: {
+              componentPath: string;
+              logger: Logger;
+              pkg: Component;
+              template: string;
+            }
+          ) => void
         ) => {
           addDependencies(pkg.dependencies);
 
@@ -96,7 +100,7 @@ export default function handleDependencies(
           options: {
             componentPath: string;
             logger: Logger;
-            pkg: Component & { devDependencies: Dictionary<string> };
+            pkg: Component & { devDependencies: Record<string, string> };
             template: string;
             compilerDep: string;
           },

src/cli/domain/handle-dependencies/install-compiler.ts

@@ -12,7 +12,7 @@ export default function installCompiler(
     dependency: string;
     logger: Logger;
   },
-  cb: Callback<Template, string | number>
+  cb: (err: string | number | null, data: Template) => void
 ): void {
   const { compilerPath, componentPath, dependency, logger } = options;
 

src/cli/domain/handle-dependencies/install-missing-dependencies.ts

@@ -6,7 +6,7 @@ import strings from '../../../resources/index';
 import { Logger } from '../../logger';
 
 export default function installMissingDependencies(
-  options: { dependencies: Dictionary<string>; logger: Logger },
+  options: { dependencies: Record<string, string>; logger: Logger },
   callback: (err: string | null) => void
 ): void {
   const { dependencies, logger } = options;

src/cli/domain/handle-dependencies/link-missing-dependencies.ts

@@ -8,7 +8,7 @@ import { Logger } from '../../logger';
 export default function linkMissingDependencies(
   options: {
     componentPath: string;
-    dependencies: Dictionary<string>;
+    dependencies: Record<string, string>;
     logger: Logger;
   },
   callback: (err: string | null) => void

src/cli/domain/handle-dependencies/require-template.ts

@@ -17,7 +17,7 @@ interface Template {
       verbose: boolean;
       production: boolean | undefined;
     },
-    cb: Callback<Component>
+    cb: (err: Error | null, data: Component) => void
   ) => void;
 }