merge master

Author: ricardo-devis-agullo

src/cli/domain/get-mocked-plugins.js renamed to src/cli/domain/get-mocked-plugins.ts

@@ -1,26 +1,56 @@
-'use strict';
-
-const fs = require('fs-extra');
-const path = require('path');
-const _ = require('lodash');
-
-const settings = require('../../resources/settings').default;
-const strings = require('../../resources/').default;
-
-const isMockValid = plugin => {
-  const isFunction = _.isFunction(plugin);
+import fs from 'fs-extra';
+import path from 'path';
+import _ from 'lodash';
+
+import settings from '../../resources/settings';
+import strings from '../../resources/';
+import { Logger } from '../logger';
+
+interface MockedPlugin {
+  register: (options: unknown, dependencies: unknown, next: () => void) => void;
+  execute: (...args: unknown[]) => unknown;
+}
+
+interface PluginMock {
+  name: string;
+  register: {
+    register: (
+      options: unknown,
+      dependencies: unknown,
+      next: () => void
+    ) => void;
+    execute: (...args: unknown[]) => unknown;
+  };
+}
+
+const isMockValid = (
+  plugin: unknown
+): plugin is MockedPlugin | ((...args: unknown[]) => unknown) => {
+  const isFunction = typeof plugin === 'function';
   const isValidObject =
-    _.isObject(plugin) &&
-    _.isFunction(plugin.register) &&
-    _.isFunction(plugin.execute);
+    !!plugin &&
+    typeof plugin === 'object' &&
+    typeof (plugin as MockedPlugin).register === 'function' &&
+    typeof (plugin as MockedPlugin).execute === 'function';
+
   return isFunction || isValidObject;
 };
 
-const defaultRegister = (options, dependencies, next) => next();
+const defaultRegister = (
+  options: unknown,
+  dependencies: unknown,
+  next: () => void
+) => {
+  next();
+};
 
-const registerStaticMocks = (mocks, logger) =>
+const registerStaticMocks = (
+  mocks: Dictionary<string>,
+  logger: Logger
+): PluginMock[] =>
   _.map(mocks, (mockedValue, pluginName) => {
     logger.ok(`├── ${pluginName} () => ${mockedValue}`);
+
     return {
       name: pluginName,
       register: {
@@ -30,7 +60,11 @@ const registerStaticMocks = (mocks, logger) =>
     };
   });
 
-const registerDynamicMocks = (ocJsonLocation, mocks, logger) =>
+const registerDynamicMocks = (
+  ocJsonLocation: string,
+  mocks: Dictionary<string>,
+  logger: Logger
+) =>
   _.map(mocks, (source, pluginName) => {
     let pluginMock;
     try {
@@ -46,26 +80,29 @@ const registerDynamicMocks = (ocJsonLocation, mocks, logger) =>
       return;
     }
 
-    const register = pluginMock.register || defaultRegister;
-    const execute = pluginMock.execute || pluginMock;
+    const register = (pluginMock as MockedPlugin).register || defaultRegister;
+    const execute = (pluginMock as MockedPlugin).execute || pluginMock;
 
     logger.ok(`├── ${pluginName} () => [Function]`);
 
     return {
       name: pluginName,
       register: { execute, register }
     };
-  }).filter(pluginMock => pluginMock);
+  }).filter((pluginMock): pluginMock is PluginMock => !!pluginMock);
 
-const findPath = function(pathToResolve, fileName) {
+const findPath = (
+  pathToResolve: string,
+  fileName: string
+): string | undefined => {
   const rootDir = fs.realpathSync('.');
   const fileToResolve = path.join(pathToResolve, fileName);
 
   if (!fs.existsSync(fileToResolve)) {
     if (pathToResolve === rootDir) {
       return undefined;
     } else {
-      const getParent = pathToResolve =>
+      const getParent = (pathToResolve: string) =>
         pathToResolve
           .split('/')
           .slice(0, -1)
@@ -80,10 +117,13 @@ const findPath = function(pathToResolve, fileName) {
   return fileToResolve;
 };
 
-module.exports = function(logger, componentsDir) {
+export default function getMockedPlugins(
+  logger: Logger,
+  componentsDir: string
+): PluginMock[] {
   componentsDir = path.resolve(componentsDir || '.');
 
-  let plugins = [];
+  let plugins: PluginMock[] = [];
   const ocJsonFileName = settings.configFile.src.replace('./', '');
   const ocJsonPath = findPath(componentsDir, ocJsonFileName);
 
@@ -108,4 +148,4 @@ module.exports = function(logger, componentsDir) {
   );
 
   return plugins;
-};
+}

src/cli/domain/init-template/index.js

@@ -0,0 +1,33 @@
+import async from 'async';
+import fs from 'fs-extra';
+import path from 'path';
+
+import installTemplate from './install-template';
+import * as npm from '../../../utils/npm-utils';
+import scaffold from './scaffold';
+import { Logger } from '../../logger';
+
+export default function initTemplate(
+  options: {
+    componentPath: string;
+    templateType: string;
+    componentName: string;
+    compiler: string;
+    logger: Logger;
+  },
+  callback: Callback<{ ok: true }, string>
+): void {
+  const { compiler, componentPath } = options;
+  const compilerPath = path.join(componentPath, 'node_modules', compiler);
+  const npmOptions = { initPath: componentPath, silent: true };
+
+  async.series(
+    [
+      cb => fs.ensureDir(componentPath, cb),
+      cb => npm.init(npmOptions, cb as any),
+      cb => installTemplate(options, cb as any),
+      cb => scaffold(Object.assign(options, { compilerPath }), cb as any)
+    ],
+    callback as any
+  );
+}

src/cli/domain/init-template/index.ts

@@ -1,12 +1,21 @@
-'use strict';
-
-const tryRequire = require('try-require');
-
-const isTemplateValid = require('../../../utils/is-template-valid').default;
-const npm = require('../../../utils/npm-utils');
-const strings = require('../../../resources').default;
-
-module.exports = function installTemplate(options, callback) {
+import tryRequire from 'try-require';
+
+import isTemplateValid from '../../../utils/is-template-valid';
+import * as npm from '../../../utils/npm-utils';
+import strings from '../../../resources';
+import { Logger } from '../../logger';
+
+interface Options {
+  componentPath: string;
+  templateType: string;
+  compiler: string;
+  logger: Logger;
+}
+
+export default function installTemplate(
+  options: Options,
+  callback: Callback<{ ok: true }, string>
+): void {
   const { compiler, componentPath, logger, templateType } = options;
 
   const npmOptions = {
@@ -21,12 +30,14 @@ module.exports = function installTemplate(options, callback) {
   npm.installDependency(npmOptions, (err, result) => {
     const errorMessage = 'template type not valid';
     if (err) {
+      // @ts-ignore
       return callback(errorMessage);
     }
 
     const installedCompiler = tryRequire(result.dest);
 
     if (!isTemplateValid(installedCompiler, { compiler: true })) {
+      // @ts-ignore
       return callback(errorMessage);
     }
     const version = installedCompiler.getInfo().version;
@@ -40,4 +51,4 @@ module.exports = function installTemplate(options, callback) {
 
     return callback(null, { ok: true });
   });
-};
+}

src/cli/domain/init-template/install-template.js renamed to src/cli/domain/init-template/install-template.ts

@@ -25,14 +25,14 @@ export default function scaffold(
 
   const baseComponentPath = path.join(compilerPath, 'scaffold');
   const baseComponentFiles = path.join(baseComponentPath, 'src');
-  const compilerPackage = fs.readJSONSync(
+  const compilerPackage = fs.readJsonSync(
     path.join(compilerPath, 'package.json')
   );
 
   try {
     fs.copySync(baseComponentFiles, componentPath);
 
-    const componentPackage = fs.readJSONSync(
+    const componentPackage = fs.readJsonSync(
       path.join(componentPath, 'package.json')
     );
     componentPackage.name = componentName;

src/cli/domain/init-template/scaffold.ts

@@ -6,7 +6,7 @@ const _ = require('lodash');
 
 const clean = require('./clean');
 const getComponentsByDir = require('./get-components-by-dir').default;
-const initTemplate = require('./init-template');
+const initTemplate = require('./init-template').default;
 const isTemplateLegacy = require('../../utils/is-template-legacy').default;
 const mock = require('./mock').default;
 const packageComponents = require('./package-components');

src/cli/domain/local.js

@@ -6,8 +6,8 @@ import settings from '../../resources/settings';
 export default function mock() {
   return function(
     params: { targetType: string; targetValue: string; targetName: string },
-    callback: Callback
-  ) {
+    callback: (err: Error) => void
+  ): void {
     fs.readJson(settings.configFile.src, (err, localConfig) => {
       localConfig = localConfig || {};
 

src/cli/domain/mock.ts

@@ -9,7 +9,7 @@ const ComponentPreviewRoute = require('./routes/component-preview');
 const IndexRoute = require('./routes');
 const PublishRoute = require('./routes/publish');
 const StaticRedirectorRoute = require('./routes/static-redirector');
-const PluginsRoute = require('./routes/plugins');
+const PluginsRoute = require('./routes/plugins').default;
 const DependenciesRoute = require('./routes/dependencies');
 const settings = require('../resources/settings').default;