chore: cleanups

Author: chenasraf

src/config.ts

@@ -1,8 +1,10 @@
 import path from "path"
 import {
   AsyncResolver,
+  ConfigLoadConfig,
   FileResponse,
   FileResponseHandler,
+  LogConfig,
   LogLevel,
   Resolver,
   ScaffoldCmdConfig,
@@ -99,9 +101,7 @@ function wrapNoopResolver<T, R = T>(value: Resolver<T, R>): Resolver<T, R> {
 }
 
 /** @internal */
-export async function getConfig(
-  config: Pick<ScaffoldCmdConfig, "quiet" | "verbose" | "config">,
-): Promise<ScaffoldConfigFile> {
+export async function getConfig(config: ConfigLoadConfig): Promise<ScaffoldConfigFile> {
   const { config: configFile, ...logConfig } = config as Required<typeof config>
   const url = new URL(configFile)
 
@@ -127,7 +127,7 @@ export async function getConfig(
 
 async function getGitConfig(
   url: URL,
-  logConfig: Pick<ScaffoldCmdConfig, "verbose" | "quiet">,
+  logConfig: LogConfig,
 ): Promise<AsyncResolver<ScaffoldCmdConfig, ScaffoldConfigMap>> {
   const repoUrl = `${url.protocol}//${url.host}${url.pathname}`
 

src/logger.ts

@@ -1,9 +1,6 @@
-import { LogLevel, ScaffoldConfig } from "./types"
+import { LogConfig, LogLevel, ScaffoldConfig } from "./types"
 import chalk from "chalk"
 
-/** @internal */
-export type LogConfig = Pick<ScaffoldConfig, "quiet" | "verbose">
-
 export function log(config: LogConfig, level: LogLevel, ...obj: any[]): void {
   if (config.quiet || config.verbose === LogLevel.None || level < (config.verbose ?? LogLevel.Info)) {
     return

src/scaffold.ts

@@ -17,7 +17,7 @@ import {
   copyFileTransformed,
   getTemplateFileInfo,
 } from "./file"
-import { LogLevel, Resolver, ScaffoldCmdConfig, ScaffoldConfig } from "./types"
+import { LogLevel, MinimalConfig, Resolver, ScaffoldCmdConfig, ScaffoldConfig } from "./types"
 import { OptionsBase } from "massarg/types"
 import { pascalCase, registerHelpers } from "./parser"
 import { log, logInitStep, logInputFile } from "./logger"
@@ -112,8 +112,11 @@ export async function Scaffold(config: ScaffoldConfig): Promise<void> {
  * @return {Promise<void>} A promise that resolves when the scaffold is complete
  */
 Scaffold.fromConfig = async function (
+  /** The path or URL to the config file */
   pathOrUrl: string,
-  config: Pick<ScaffoldCmdConfig, "name" | "key">,
+  /** Information needed before loading the config */
+  config: MinimalConfig,
+  /** Any overrides to the loaded config */
   overrides?: Resolver<ScaffoldCmdConfig, Partial<Omit<ScaffoldConfig, "name">>>,
 ): Promise<void> {
   const _cmdConfig: ScaffoldCmdConfig & OptionsBase = {

src/types.ts

@@ -1,4 +1,5 @@
 import { HelperDelegate } from "handlebars/runtime"
+import { LogConfig } from "./logger"
 
 /**
  * The config object for defining a scaffolding group.
@@ -371,3 +372,12 @@ export type Resolver<T, R = T> = R | ((value: T) => R)
 
 /** @internal */
 export type AsyncResolver<T, R = T> = Resolver<T, Promise<R> | R>
+
+/** @internal */
+export type LogConfig = Pick<ScaffoldConfig, "quiet" | "verbose">
+
+/** @internal */
+export type ConfigLoadConfig = LogConfig & Pick<ScaffoldCmdConfig, "config">
+
+/** @internal */
+export type MinimalConfig = Pick<ScaffoldCmdConfig, "name" | "key">

tests/scaffold.test.ts

@@ -3,7 +3,7 @@ import FileSystem from "mock-fs/lib/filesystem"
 import Scaffold from "../src/scaffold"
 import { readdirSync, readFileSync } from "fs"
 import { Console } from "console"
-import { defaultHelpers } from "../src/utils"
+import { defaultHelpers } from "../src/parser"
 import { join } from "path"
 import * as dateFns from "date-fns"
 import crypto from "crypto"

tests/utils.test.ts

@@ -1,8 +1,9 @@
-import { dateHelper, handlebarsParse, nowHelper, parseAppendData } from "../src/utils"
 import { ScaffoldCmdConfig, ScaffoldConfig } from "../src/types"
 import path from "path"
 import * as dateFns from "date-fns"
 import { OptionsBase } from "massarg/types"
+import { dateHelper, handlebarsParse, nowHelper } from "../src/parser"
+import { parseAppendData } from "../src/config"
 
 const blankConf: ScaffoldConfig = {
   verbose: 0,