@spark-ui/cli-utils 2.13.4 → 2.13.5-beta.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.13.5](https://github.com/adevinta/spark/compare/@spark-ui/cli-utils@2.13.4...@spark-ui/cli-utils@2.13.5) (2024-05-30)
+
+### Bug Fixes
+
+- **cli-utils:** improve log messages ([9623f94](https://github.com/adevinta/spark/commit/9623f9490cda5af0d00bbb10545e3769922cfc63))
+
 ## [2.13.4](https://github.com/adevinta/spark/compare/@spark-ui/cli-utils@2.13.3...@spark-ui/cli-utils@2.13.4) (2024-05-27)
 
 ### Bug Fixes

package/bin/spark-scan.mjs

@@ -1,15 +1,21 @@
 #! /usr/bin/env node
 
 import { Command } from 'commander'
-import { adoption } from '../src/scan/index.mjs'
+import { adoption, config } from '../src/scan/index.mjs'
 
 const program = new Command()
 
 program
   .command('adoption')
   .description('Scan @spark-ui adoption for .tsx files with given imports')
-  .option('-c, --configuration <path>', 'configuration file route', '.spark-ui.cjs')
-  .option('-o, --output <path>', 'output file route')
+  .option('-c, --configuration <config>', 'configuration file route', '.spark-ui.cjs')
+  .option('-o, --output <output>', 'output file route')
+  .option('-v, --verbose', 'output log information', false)
+  .option('-d, --details', 'output information about each match', config.details)
+  .option('-s, --sort <sort>', 'sort results (count or alphabetical)', config.sort)
+  .option('-dir, --directory <directory>', 'directory to parse', config.directory)
+  .option('-ext, --extensions <extensions...>', 'file extensions to parse', config.extensions)
+  .option('-i, --imports <imports...>', 'import patterns to identify', config.imports)
   .action(adoption)
 
 program.parse(process.argv)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spark-ui/cli-utils",
-  "version": "2.13.4",
+  "version": "2.13.5-beta.0",
   "description": "Spark CLI utils",
   "publishConfig": {
     "access": "public"
@@ -39,11 +39,11 @@
     "esbuild": "0.21.3",
     "fs-extra": "11.2.0",
     "glob": "8.1.0",
+    "lodash.merge": "4.6.2",
     "pascal-case": "3.1.2",
     "ts-morph": "22.0.0"
   },
   "devDependencies": {
     "@types/fs-extra": "11.0.4"
-  },
-  "gitHead": "af658fa8212d61109674b7fc0584678c0ded401b"
+  }
 }

package/src/scan/config.mjs

@@ -0,0 +1,7 @@
+export const details = false
+export const sort = 'count'
+export const imports = ['@spark-ui']
+export const extensions = ['.tsx', '.ts']
+export const directory = '.'
+export const verbose = false
+export const output = null

package/src/scan/index.mjs

@@ -1,47 +1,52 @@
 import * as process from 'node:process'
 
-import { appendFileSync, existsSync } from 'fs'
+import { appendFileSync, existsSync, mkdirSync } from 'fs'
+import merge from 'lodash.merge'
 import path from 'path'
 
+import * as defaultConfig from './config.mjs'
 import { scanCallback } from './scanCallback.mjs'
-import { logger } from './utils/logger.mjs'
-import { scanDirectories } from './utils/scan-directories.mjs'
-
-const DEFAULT_CONFIG = {
-  adoption: {
-    details: false,
-    sort: 'count',
-    imports: ['@spark-ui'],
-    extensions: ['.tsx', '.ts'],
-    directory: '.',
-  },
-}
+import { Logger, scanDirectories } from './utils/index.mjs'
 
 export async function adoption(options) {
-  let config = DEFAULT_CONFIG
+  const { configuration, ...optionsConfig } = options
+  const configFileRoute = path.join(process.cwd(), configuration || '.spark-ui.cjs')
+
+  let config = {
+    adoption: Object.assign(
+      { ...defaultConfig },
+      {
+        ...optionsConfig,
+      }
+    ),
+  }
+
+  const { verbose } = config.adoption
+  const logger = new Logger({ verbose })
 
-  const configFileRoute = path.join(process.cwd(), options.configuration || '.spark-ui.cjs')
   try {
     if (existsSync(configFileRoute)) {
-      console.log('✨✨✨ loading spark-ui custom configuration file ✨✨✨')
-      const { default: customConfig } = await import(
-        path.join(process.cwd(), options.configuration)
-      )
-      config = structuredClone(customConfig, DEFAULT_CONFIG)
+      logger.info('ℹ️ Loading spark-ui custom configuration file')
+      const { default: customConfig } = await import(configFileRoute)
+      config = merge(config, customConfig)
+    } else {
+      logger.warn('⚠️ No custom configuration file found')
+      logger.info('ℹ️ Loading default configuration')
     }
   } catch (error) {
-    logger.info('ℹ️ Loading default configuration')
+    logger.error('💥 Something went wrong loading the custom configuration file')
   }
 
-  const extensions = config.adoption.extensions
-
   let importCount = 0
   const importResults = {}
   let importsUsed = {}
   let importsCount = {}
-  config.adoption.imports.forEach(moduleName => {
-    console.log(`scanning adoption for ${moduleName}`)
-    const directoryPath = path.join(process.cwd(), config.adoption.directory)
+
+  const { details, directory, extensions, imports, sort, output } = config.adoption
+
+  imports.forEach(moduleName => {
+    logger.info(`ℹ️ Scanning adoption for ${moduleName}`)
+    const directoryPath = path.join(process.cwd(), directory)
 
     const response = scanDirectories(directoryPath, moduleName, extensions, scanCallback, {
       importCount,
@@ -51,16 +56,18 @@ export async function adoption(options) {
     })
     if (importCount !== response.importCount) {
       logger.success(
-        `Found ${response.importCount - importCount} imports with "${moduleName}" modules across directory ${directoryPath}.`
+        `🎉 Found ${response.importCount - importCount} imports with "${moduleName}" modules across directory ${directoryPath}.`
       )
     } else {
-      logger.warn(`No files found with "${moduleName}" imports across directory ${directoryPath}.`)
+      logger.warn(
+        `⚠️ No files found with "${moduleName}" imports across directory ${directoryPath}.`
+      )
     }
     importCount = response.importCount
   })
 
   // Sort importsUsed by alphabet
-  if (config.adoption.sort === 'alphabetical') {
+  if (sort === 'alphabetical') {
     importsUsed = Object.fromEntries(
       Object.entries(importsUsed)
         .sort(([pkgNameA], [pkgNameB]) => pkgNameA.localeCompare(pkgNameB))
@@ -79,7 +86,7 @@ export async function adoption(options) {
           ]
         })
     )
-  } else if (config.adoption.sort === 'count') {
+  } else if (sort === 'count') {
     // Sort importsUsed by most used
     importsUsed = Object.fromEntries(
       Object.entries(importsUsed)
@@ -106,17 +113,25 @@ export async function adoption(options) {
   const result = Object.fromEntries(
     Object.entries(importsUsed).map(([pkgName, value]) => [
       pkgName,
-      { ...value, ...(config.adoption.details && { results: importResults[pkgName] }) },
+      { ...value, ...(details && { results: importResults[pkgName] }) },
     ])
   )
 
-  if (options.output) {
+  if (output) {
     try {
-      appendFileSync(`${options.output}`, JSON.stringify(result, null, 2))
+      const { dir } = path.parse(path.join(process.cwd(), output))
+      if (!existsSync(dir)) {
+        mkdirSync(dir, { recursive: true })
+      }
+      appendFileSync(`${path.join(process.cwd(), output)}`, JSON.stringify(result, null, 2))
     } catch (err) {
-      logger.error(`Error writing file: ${err}`)
+      logger.error(`💥 Error writing file: ${err}`)
+      process.exit(1)
     }
   } else {
-    logger.info(JSON.stringify(result, null, 2))
+    // logger.force().info(JSON.stringify(result, null, 2))
+    process.exit(0)
   }
 }
+
+export const config = { ...defaultConfig }

package/src/scan/utils/index.mjs

@@ -1,5 +1,5 @@
 export { extractImports } from './extract-imports.mjs'
 export { fileContainsImport } from './file-contains-import.mjs'
 export { getFormatedTimestamp } from './get-formated-timestamp.mjs'
-export { logger } from './logger.mjs'
+export { Logger } from './logger.mjs'
 export { scanDirectories } from './scan-directories.mjs'

package/src/scan/utils/logger.mjs

@@ -1,19 +1,55 @@
 import chalk from 'chalk'
 
-export const logger = {
+export class Logger {
+  #force = false
+
+  constructor({ verbose }) {
+    this.verbose = verbose
+
+    if (typeof Logger.instance === 'object') {
+      return Logger.instance
+    }
+
+    Logger.instance = this
+
+    return this
+  }
+
+  #log({ type = v => v, force, verbose }, ...args) {
+    if (force || verbose) {
+      console.log(type(...args)) // eslint-disable-line no-console
+    }
+    this.#force = false
+  }
+
+  force() {
+    this.#force = true
+
+    return this
+  }
+
   error(...args) {
-    console.log(chalk.red(...args))
-  },
+    this.#log({ type: chalk.red, force: this.#force, verbose: this.verbose }, ...args)
+    // this.verbose && console.log(chalk.red(...args))
+  }
+
   warn(...args) {
-    console.log(chalk.yellow(...args))
-  },
+    this.#log({ type: chalk.yellow, force: this.#force, verbose: this.verbose }, ...args)
+    // this.verbose && console.log(chalk.yellow(...args))
+  }
+
   info(...args) {
-    console.log(chalk.cyan(...args))
-  },
+    this.#log({ type: chalk.cyan, force: this.#force, verbose: this.verbose }, ...args)
+    // this.verbose && console.log(chalk.cyan(...args))
+  }
+
   success(...args) {
-    console.log(chalk.green(...args))
-  },
+    this.#log({ type: chalk.green, force: this.#force, verbose: this.verbose }, ...args)
+    // this.verbose && console.log(chalk.green(...args))
+  }
+
   break() {
-    console.log('')
-  },
+    this.#log({ type: chalk.green, force: this.#force, verbose: this.verbose }, '')
+    // this.verbose && console.log('')
+  }
 }