@spark-ui/cli-utils 2.14.0-beta.8 → 2.15.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.15.0](https://github.com/adevinta/spark/compare/@spark-ui/cli-utils@2.14.0...@spark-ui/cli-utils@2.15.0) (2024-07-03)
+
+### Bug Fixes
+
+- **cli-utils:** add some feedback when not loading a given config file ([1231fe6](https://github.com/adevinta/spark/commit/1231fe6cb94c15643a11278c3210836e81059364))
+- **cli-utils:** fix config merge method to allow proper option override ([8b6a124](https://github.com/adevinta/spark/commit/8b6a124c6e70f05769305bf6ca84137c7a05510c))
+- **cli-utils:** fix logger issue on generate script after changes ([083c9b0](https://github.com/adevinta/spark/commit/083c9b043d1837a807b159a8143fd16bf8d7087e))
+- **cli-utils:** merge values ([a7e8129](https://github.com/adevinta/spark/commit/a7e81292d452d4ee026f3d4705198ac4ecc6363e))
+- **cli-utils:** merging configs ([aeb6251](https://github.com/adevinta/spark/commit/aeb6251d23bc506674e4545ebad928081292f520))
+- **cli-utils:** missalignment on the default config values nesting ([79729f7](https://github.com/adevinta/spark/commit/79729f722f4ecf6f0c671e2c1c1d5929a87d98c9))
+- **cli-utils:** output file creates new content ([973ffa8](https://github.com/adevinta/spark/commit/973ffa85e6987dbd87a119e9253db57556a705d4))
+- **cli-utils:** remove betta tagging ([96cafae](https://github.com/adevinta/spark/commit/96cafae45e4a4759ef9ff4a763963f26cb898cb6))
+- **cli-utils:** remove extra logs ([f588649](https://github.com/adevinta/spark/commit/f588649eb299fc42ef9d6dbf8f8f4eebd0cfd6a9))
+- **cli-utils:** remove unnecesary log ([614d834](https://github.com/adevinta/spark/commit/614d834d5d7a0f3084b3097e2dee5436b369fbb6))
+- log config setted ([190a058](https://github.com/adevinta/spark/commit/190a0581ab6219591c5d3a3ecde2ee46d504d7ca))
+- priority of commands ([ed178a5](https://github.com/adevinta/spark/commit/ed178a51a8cea0255c96467b0d8760daf8f851dd))
+
+### Features
+
+- **cli-utils:** exoposes all configuration parameters as a build argument ([3e88a99](https://github.com/adevinta/spark/commit/3e88a998c05da026cd196b3dd54a2ad50506266c))
+- mixing parameters ([da1bf1d](https://github.com/adevinta/spark/commit/da1bf1d838df2c577755eb3c651cd0bba8d07203))
+
 # [2.14.0](https://github.com/adevinta/spark/compare/@spark-ui/cli-utils@2.13.8...@spark-ui/cli-utils@2.14.0) (2024-06-14)
 
 ### Features

package/bin/spark-generate.mjs

@@ -6,7 +6,7 @@ import { TemplateGenerator } from '../src/generate/generators/index.mjs'
 import { Logger, System } from '../src/core/index.mjs'
 import { DescriptionValidator, NameValidator } from '../src/generate/validators/index.mjs'
 
-const logger = new Logger()
+const logger = new Logger({ verbose: true })
 const system = new System({ logger })
 const generator = new TemplateGenerator({ system })
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spark-ui/cli-utils",
-  "version": "2.14.0-beta.8",
+  "version": "2.15.0",
   "description": "Spark CLI utils",
   "publishConfig": {
     "access": "public"
@@ -39,11 +39,11 @@
     "esbuild": "0.21.5",
     "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": "8a312bf6a9f20c8dd0cc3cc10649359c4313a2a7"
 }

package/src/core/Logger.mjs

@@ -3,7 +3,7 @@ import chalk from 'chalk'
 export class Logger {
   #force = false
 
-  constructor({ verbose }) {
+  constructor({ verbose } = {}) {
     this.verbose = verbose
 
     if (typeof Logger.instance === 'object') {

package/src/scan/index.mjs

@@ -3,7 +3,6 @@
 import * as process from 'node:process'
 
 import { existsSync, mkdirSync, writeFileSync } from 'fs'
-import merge from 'lodash.merge'
 import path from 'path'
 
 import { Logger } from '../core/index.mjs'
@@ -19,14 +18,12 @@ export async function adoption(options = {}) {
   let config = await loadConfig(configuration, { logger })
 
   config = {
-    adoption: merge(
-      { ...config.adoption },
-      {
-        ...optionsConfig,
-        imports: optionsConfig.imports || config.imports,
-        extensions: optionsConfig.extensions || config.extensions,
-      }
-    ),
+    adoption: {
+      ...config.adoption,
+      ...optionsConfig,
+      imports: optionsConfig.imports || config.adoption.imports,
+      extensions: optionsConfig.extensions || config.adoption.extensions,
+    },
   }
 
   let importCount = 0

package/src/scan/loadConfig.mjs

@@ -1,7 +1,6 @@
 import process from 'node:process'
 
 import { existsSync } from 'fs'
-import merge from 'lodash.merge'
 import path from 'path'
 
 import * as defaultConfig from './config.mjs'
@@ -14,11 +13,12 @@ export async function loadConfig(configuration, { logger }) {
       const { default: customConfig } = await import(configFileRoute)
 
       const config = {
-        adoption: merge(defaultConfig, {
+        adoption: {
+          ...defaultConfig,
           ...customConfig.adoption,
-          imports: customConfig.imports || defaultConfig.imports,
-          extensions: customConfig.extensions || defaultConfig.extensions,
-        }),
+          imports: customConfig.adoption.imports || defaultConfig.imports,
+          extensions: customConfig.adoption.extensions || defaultConfig.extensions,
+        },
       }
 
       return config

package/test/spark-generate.test.ts

@@ -12,21 +12,28 @@ const cliPath = path.join(__dirname, '../../bin/spark.mjs')
 const cliProcess = cmd.create(cliPath)
 
 describe('CLI `spark generate` (component package)', () => {
-  it('should properly generate package from CLI when arguments are valid', async () => {
-    // GIVEN a package definition
-    const packageName = 'bar'
-    const packageType = 'component'
+  const packageType = 'component'
+
+  const contextPath = TemplateGenerator.CONTEXTS[packageType] as string
+
+  const packagePath = path.join(process.cwd(), 'packages', contextPath, 'bar')
+  const invalidPackagePath = path.join(process.cwd(), 'packages', contextPath, '123')
+
+  beforeEach(() => {
+    if (fse.existsSync(packagePath)) fse.removeSync(packagePath)
+  })
+
+  afterAll(() => {
+    if (fse.existsSync(packagePath)) fse.removeSync(packagePath)
+  })
 
-    // WHEN we execute the `spark generate` command
+  it('should properly generate package from CLI when arguments are valid', async () => {
     const response = await cliProcess.execute(
       ['generate'],
-      [packageName, ENTER, packageType, ENTER, 'This is my foo component', ENTER]
+      ['bar', ENTER, packageType, ENTER, 'This is my foo component', ENTER]
     )
-    const contextPath = TemplateGenerator.CONTEXTS[packageType] as string
-    const packagePath = path.join(process.cwd(), 'packages', contextPath, packageName)
 
-    // THEN each file is created and the user is informed about it
-    const expectedFiles = [
+    ;[
       '/.npmignore',
       '/package.json',
       '/src/index.ts',
@@ -37,33 +44,19 @@ describe('CLI `spark generate` (component package)', () => {
       '/src/Bar.test.tsx',
       '/src/Bar.stories.tsx',
       '/tsconfig.json',
-    ]
-
-    const assertExpectedFiles = (filePath: string) => {
+    ].forEach((filePath: string) => {
       expect(response).toContain(`Created ${packagePath}${filePath}`)
       expect(fse.pathExistsSync(`${packagePath}${filePath}`)).toBe(true)
-    }
-
-    expectedFiles.forEach(assertExpectedFiles)
-
-    // Finally we clean up the generated component package
-    fse.removeSync(packagePath)
+    })
   })
 
   it('should prevent generating package when argument are invalid', async () => {
-    // GIVEN the package name is not using kebab-case notation
-    const packageName = '123'
-    const packageType = 'component'
-
-    // WHEN we try to create it
-    const response = await cliProcess.execute(['generate'], [packageName, ENTER])
-    const contextPath = TemplateGenerator.CONTEXTS[packageType] as string
-    const packagePath = path.join(process.cwd(), 'packages', contextPath, packageName)
+    const response = await cliProcess.execute(['generate'], ['123', ENTER])
 
-    // THEN it throws an error and fails to create files for this package
     expect(response).toContain(
       'Name name must contain letters and dash symbols only (ex: "my-package")'
     )
-    expect(fse.pathExistsSync(packagePath)).toBe(false)
+
+    expect(fse.pathExistsSync(invalidPackagePath)).toBe(false)
   })
 })