Extract local type from function that creates it

Author: ricardo-devis-agullo

src/cli/domain/local.ts

@@ -10,15 +10,15 @@ import mock from './mock';
 import packageComponents from './package-components';
 import strings from '../../resources';
 import * as validator from '../../registry/domain/validators';
-import { Local } from '../../types';
+import { Logger } from '../logger';
 
-export default function local(): Local {
+export default function local() {
   return {
     clean,
-    cleanup(compressedPackagePath: string) {
+    cleanup(compressedPackagePath: string): Promise<void> {
       return fs.unlink(compressedPackagePath);
     },
-    compress(input, output) {
+    compress(input: string, output: string): Promise<void> {
       return promisify(targz.compress)({
         src: input,
         dest: output,
@@ -32,7 +32,12 @@ export default function local(): Local {
       });
     },
     getComponentsByDir: getComponentsByDir(),
-    async init(options) {
+    async init(options: {
+      componentName: string;
+      logger: Logger;
+      componentPath: string;
+      templateType: string;
+    }): Promise<void> {
       const { componentName, logger } = options;
       let { templateType } = options;
       if (!validator.validateComponentName(componentName)) {
@@ -68,3 +73,5 @@ export default function local(): Local {
     package: packageComponents()
   };
 }
+
+export type Local = ReturnType<typeof local>;

src/cli/domain/package-components.ts

@@ -6,7 +6,7 @@ import requireTemplate from './handle-dependencies/require-template';
 import * as validator from '../../registry/domain/validators';
 import { Component } from '../../types';
 
-interface PackageOptions {
+export interface PackageOptions {
   componentPath: string;
   minify?: boolean;
   verbose?: boolean;

src/cli/facade/clean.ts

@@ -2,7 +2,7 @@ import readCb from 'read';
 import { fromPromise } from 'universalify';
 import { promisify } from 'util';
 import strings from '../../resources/index';
-import { Local } from '../../types';
+import type { Local } from '../domain/local';
 import { Logger } from '../logger';
 
 const read = promisify(readCb);

src/cli/facade/dev.ts

@@ -11,7 +11,7 @@ import * as oc from '../../index';
 import strings from '../../resources/index';
 import watch from '../domain/watch';
 import { Logger } from '../logger';
-import { Local } from '../../types';
+import type { Local } from '../domain/local';
 
 type Registry = ReturnType<typeof oc.Registry>;
 

src/cli/facade/init.ts

@@ -2,7 +2,7 @@ import path from 'path';
 import { fromPromise } from 'universalify';
 
 import strings from '../../resources/index';
-import { Local } from '../../types';
+import type { Local } from '../domain/local';
 import { Logger } from '../logger';
 
 const init = ({ local, logger }: { local: Local; logger: Logger }) =>

src/cli/facade/mock.ts

@@ -1,6 +1,6 @@
 import { fromPromise } from 'universalify';
 import strings from '../../resources/index';
-import { Local } from '../../types';
+import type { Local } from '../domain/local';
 import { Logger } from '../logger';
 
 const mock = ({ local, logger }: { local: Local; logger: Logger }) =>

src/cli/facade/package.ts

@@ -3,7 +3,8 @@ import path from 'path';
 import { fromPromise } from 'universalify';
 import handleDependencies from '../domain/handle-dependencies';
 import { Logger } from '../logger';
-import { Component, Local } from '../../types';
+import type { Local } from '../domain/local';
+import { Component } from '../../types';
 
 const cliPackage = ({ local, logger }: { local: Local; logger: Logger }) =>
   fromPromise(

src/cli/facade/publish.ts

@@ -4,7 +4,8 @@ import fs from 'fs-extra';
 import readCb from 'read';
 import { promisify } from 'util';
 import { Logger } from '../logger';
-import { Component, RegistryCli, Local } from '../../types';
+import type { Local } from '../domain/local';
+import { Component, RegistryCli } from '../../types';
 import { fromPromise } from 'universalify';
 
 import handleDependencies from '../domain/handle-dependencies';

src/cli/programmatic-api.ts

@@ -1,4 +1,4 @@
-import local from './domain/local';
+import local, { Local } from './domain/local';
 import { Logger } from './logger';
 import Registry from './domain/registry';
 
@@ -11,7 +11,7 @@ import preview from './facade/preview';
 import registryAdd from './facade/registry-add';
 import registryLs from './facade/registry-ls';
 import registryRemove from './facade/registry-remove';
-import { Local, RegistryCli } from '../types';
+import { RegistryCli } from '../types';
 
 type Options<T extends (...args: any) => any> = Parameters<ReturnType<T>>[0];
 type Cb<T extends (...args: any) => any> = Parameters<ReturnType<T>>[1];

src/types.ts

@@ -1,5 +1,4 @@
 import { NextFunction, Request, Response } from 'express';
-import { Logger } from './cli/logger';
 import { PackageJson } from 'type-fest';
 
 export interface Author {
@@ -250,36 +249,6 @@ export interface RegistryCli {
   remove(registry: string): Promise<void>;
 }
 
-export interface Local {
-  clean: {
-    fetchList: (dirPath: string) => Promise<string[]>;
-    remove: (list: string[]) => Promise<void>;
-  };
-  cleanup: (compressedPackagePath: string) => Promise<void>;
-  compress: (input: string, output: string) => Promise<void>;
-  getComponentsByDir: (
-    componentsDir: string,
-    componentsToRun?: string[]
-  ) => Promise<string[]>;
-  init: (options: {
-    componentName: string;
-    logger: Logger;
-    componentPath: string;
-    templateType: string;
-  }) => Promise<void>;
-  mock: (params: {
-    targetType: string;
-    targetValue: string;
-    targetName: string;
-  }) => Promise<void>;
-  package: (options: {
-    componentPath: string;
-    minify?: boolean;
-    verbose?: boolean;
-    production?: boolean;
-  }) => Promise<Component>;
-}
-
 declare global {
   // eslint-disable-next-line @typescript-eslint/no-namespace
   namespace Express {