Perf(Explore Config): Reduce size by removing glob support and trivial utils

Author: 1aron

packages/explore-config/README.md

@@ -62,24 +62,31 @@ npm install explore-config
 
 ## Usage
 ```ts
-exploreConfig(
-    sources: Pattern | Pattern[],
-    options?: {
-        cwd?: string,
-        keys?: string[],
-        on?: {
-            found?: (foundPath: string) => void,
-            notFound?: () => void
-        }
-    }
-): any
+exploreConfig(name: string, options: ExploreConfigOptions)
 ```
-
 ```ts
 import exploreConfig from 'explore-config'
 
-config = exploreConfig('master.css.*')
-// {...}
+ /**
+  * 1. explore -> techor.config.js
+  * 2. explore -> techor.config.ts
+  * 3. explore -> techor.config.cjs
+  * 4. explore -> techor.config.cts
+  * 5. explore -> techor.config.mjs
+  * 6. explore -> techor.config.mts
+  * */
+const config = exploreConfig('techor.config')
+
+console.log(config)
+// -> {...}
+```
+```ts
+export interface ExploreConfigOptions {
+    extensions?: ('js' | 'ts' | 'cjs' | 'cts' | 'mjs' | 'mts')[]
+    resolvedKeys?: string[]
+    cwd?: string
+    found?: (basename: string, configPath: string) => void
+}
 ```
 
 <br>

packages/explore-config/package.json

@@ -55,9 +55,6 @@
         "access": "public"
     },
     "dependencies": {
-        "@techor/extend": "workspace:^",
-        "@techor/log": "workspace:^",
-        "@techor/glob": "workspace:^",
         "cross-import": "workspace:^"
     }
 }

packages/explore-config/src/index.ts

@@ -1,44 +1,40 @@
-import path from 'path'
-import log from '@techor/log'
-import extend from '@techor/extend'
-import { explorePathSync } from '@techor/glob'
 import crossImport from 'cross-import'
+import { existsSync } from 'fs'
+import { resolve } from 'path'
 
-export default function exploreConfig(
-    source: string | string[],
-    options?: {
-        cwd?: string,
-        keys?: string[],
-        on?: {
-            found?: (foundPath: string) => void,
-            notFound?: () => void
-        }
-    }
-) {
-    options = extend({
-        keys: ['config', 'default'],
-        on: {
-            found: (foundPath: string) => log.ok`**${foundPath}** config file found`,
-            notFound: () => log.i`No **${source}** config file found`
-        }
+export interface ExploreConfigOptions {
+    extensions?: ('js' | 'ts' | 'cjs' | 'cts' | 'mjs' | 'mts')[]
+    resolvedKeys?: string[]
+    cwd?: string
+    found?: (basename: string, configPath: string) => void
+}
+
+export default function exploreConfig(name: string, options: ExploreConfigOptions = {}) {
+    options = Object.assign({
+        extensions: ['js', 'mjs', 'ts', 'cjs', 'cts', 'mts'],
+        resolvedKeys: ['config', 'default'],
     }, options)
-    const { on, keys } = options
-    let foundConfig: any
-    const foundPath = explorePathSync(source, options)
-    if (foundPath) {
-        const foundConfigModule = crossImport(path.resolve(options.cwd || '', foundPath))
-        for (const key of keys) {
-            foundConfig = foundConfigModule[key]
-            if (foundConfig) {
-                break
-            }
+    let config: any
+    // try to find the config file with the given name and options.extensions
+    let foundConfigPath: string | undefined
+    let foundBasename: string | undefined
+    for (const eachExtension of options.extensions) {
+        const eachBasename = name + '.' + eachExtension
+        const eachPath = resolve(options.cwd || '', eachBasename)
+        if (existsSync(eachPath)) {
+            foundConfigPath = eachPath
+            foundBasename = eachBasename
+            break
         }
-        if (!foundConfig) {
-            foundConfig = foundConfigModule
+    }
+    if (foundConfigPath) {
+        const configModule = crossImport(foundConfigPath)
+        for (const eachResolvedKey of options.resolvedKeys) {
+            config = configModule[eachResolvedKey]
+            if (config) break
         }
-        on.found?.(foundPath)
-    } else {
-        on.notFound?.()
+        if (!config) config = configModule
+        options?.found(foundBasename, foundConfigPath)
     }
-    return foundConfig
-}
+    return config
+}

packages/explore-config/tests/test.ts

@@ -6,21 +6,21 @@ const __filename = fileURLToPath(import.meta.url)
 const __dirname = path.dirname(__filename)
 
 it('read .js config', () => {
-    const config = exploreConfig('master.css.js', { cwd: __dirname })
+    const config = exploreConfig('master.css', { cwd: __dirname, extensions: ['js'] })
     expect(config).toEqual({ colors: { primary: '#ff0' } })
 })
 
 it('read .ts config', () => {
-    const config = exploreConfig('master.css.ts', { cwd: __dirname })
+    const config = exploreConfig('master.css', { cwd: __dirname, extensions: ['ts'] })
     expect(config).toEqual({ colors: { primary: '#ff0' } })
 })
 
 it('read .mjs config', () => {
-    const config = exploreConfig('master.css.mjs', { cwd: __dirname })
+    const config = exploreConfig('master.css', { cwd: __dirname, extensions: ['mjs'] })
     expect(config).toEqual({ colors: { primary: '#ff0' } })
 })
 
 it('cannot read config', () => {
-    const config = exploreConfig('vite.config.*')
+    const config = exploreConfig('vite.config')
     expect(config).toBeUndefined()
 })

packages/techor/src/commands/build.ts

@@ -16,7 +16,7 @@ import clsx from 'clsx'
 import getWideExternal from '../utils/get-wide-external'
 import { BuildCommonOptions, Config, default as defaultConfig } from '../config'
 import yargsParser, { Options as YargsParserOptions } from 'yargs-parser'
-import exploreConfig from 'explore-config'
+import loadConfig from '../load-config'
 
 // core plugins
 import esmShim from '../plugins/esm-shim'
@@ -50,7 +50,7 @@ export default async function build() {
     const { _, ...cmdConfig } = yargsParser(process.argv.slice(2), yargsParserOptions)
     const [commandName, ...commandInputs] = _ as [string, ...string[]]
     try {
-        const useConfig = exploreConfig('techor.config.*') as Config
+        const useConfig = loadConfig()
         const config = extend(defaultConfig, useConfig, { build: cmdConfig }) as Config
         if (commandName === 'dev') {
             process.env.NODE_ENV = 'development'
@@ -59,7 +59,7 @@ export default async function build() {
             process.env.NODE_ENV = 'production'
         }
 
-        if (process.env.DEBUG) console.log('[DEBUG] cmdConfig', cmdConfig)
+        if (process.env.DEBUG) console.log('[techor] cmdConfig', cmdConfig)
         const pkg: PackageJson = readJSONFileSync('package.json') || {}
         const { dependencies, peerDependencies, optionalDependencies, types } = pkg
         const buildMap = new Map<RollupInputOptions['input'], BuildOptions>()
@@ -101,7 +101,7 @@ export default async function build() {
                 for (const [eachInput, eachBuildOptions] of buildMap) {
                     for (const eachOutputOptions of eachBuildOptions.outputOptionsList) {
                         if (normalize(eachOutputOptions.output.file) === normalize(extendedBuild.output.file)) {
-                            if (process.env.DEBUG) console.log('[DEBUG] extendedBuild', extendedBuild)
+                            if (process.env.DEBUG) console.log('[techor] extendedBuild', extendedBuild)
                             return
                         }
                     }
@@ -147,7 +147,7 @@ export default async function build() {
                     ]
                         .filter((existence) => existence)
                 )
-                if (process.env.DEBUG) console.log('[DEBUG] buildOptions', buildOptions)
+                if (process.env.DEBUG) console.log('[techor] buildOptions', buildOptions)
                 buildMap.set(entries, buildOptions)
             }
         }

packages/techor/src/commands/version.ts

@@ -7,6 +7,7 @@ import yargsParser, { Options as YargsParserOptions } from 'yargs-parser'
 import exploreConfig from 'explore-config'
 import extend from '@techor/extend'
 import { Config, default as defaultConfig } from '../config'
+import loadConfig from '../load-config'
 
 export const yargsParserOptions: YargsParserOptions = {
     alias: {
@@ -23,7 +24,7 @@ export const yargsParserOptions: YargsParserOptions = {
 export default async function version() {
     const { _, ...cmdConfig } = yargsParser(process.argv.slice(2), yargsParserOptions)
     const [commandName, version] = _ as [string, ...string[]]
-    const useConfig = exploreConfig('techor.config.*') as Config
+    const useConfig = loadConfig()
     const config = extend(defaultConfig, useConfig, { version: cmdConfig }) as Config
     if (!config.version.workspaces) {
         const packageManager = explorePackageManager()

packages/techor/src/load-config.ts

@@ -0,0 +1,13 @@
+import exploreConfig from 'explore-config'
+import { Config } from './config'
+import log from '@techor/log'
+
+export default function loadConfig() {
+    const basename = 'techor.config'
+    const useConfig = exploreConfig(basename, {
+        found: (basename) => log.i`Loaded **${basename}**`
+    }) as Config
+    if (useConfig) {
+        return useConfig
+    }
+}