refactor: improvement to logs output

Author: thetutlage

index.ts

@@ -10,12 +10,12 @@
 import getops from 'getopts'
 import { isAbsolute, join } from 'path'
 import { isEmptyDir } from '@adonisjs/sink'
-import fancyLogs from '@poppinss/fancy-logs'
 import { Application } from '@poppinss/application'
 import { ensureDirSync, removeSync } from 'fs-extra'
 
 import { tasks } from './tasks'
 import { CliState } from './src/contracts'
+import { error } from './src/logger'
 
 /**
  * Running all the tasks to create a new project.
@@ -29,7 +29,7 @@ export async function runTasks () {
    * Ensure project name is defined
    */
   if (!argv._.length) {
-    fancyLogs.error('Project name is required to create a new app')
+    error('Project name is required to create a new app')
     return
   }
 
@@ -57,7 +57,7 @@ export async function runTasks () {
       'Make sure to define path to an empty directory',
     ]
 
-    fancyLogs.error(errors.join(' '))
+    error(errors.join(' '))
     return
   }
 
@@ -70,7 +70,7 @@ export async function runTasks () {
     try {
       await task(absPath, application, state)
     } catch (error) {
-      fancyLogs.error('Unable to create new project. Rolling back')
+      error('Unable to create new project. Rolling back')
       removeSync(absPath)
     }
   }

package.json

@@ -66,9 +66,9 @@
   },
   "dependencies": {
     "@adonisjs/fold": "^6.2.1",
-    "@adonisjs/sink": "^2.2.2",
+    "@adonisjs/sink": "^2.2.3",
     "@poppinss/application": "^1.0.10",
-    "@poppinss/fancy-logs": "^1.1.0",
+    "@poppinss/fancy-logs": "^1.1.1",
     "cli-width": "^2.2.0",
     "fs-extra": "^8.1.0",
     "getopts": "^2.2.5",

src/contracts.ts

@@ -12,7 +12,7 @@ export type TaskFn = (
   absPath: string,
   application: ApplicationContract,
   state: CliState,
-) => void
+) => void | Promise<void>
 
 export type CliState = {
   boilerplate: 'web' | 'api',

src/logger.ts

@@ -9,13 +9,15 @@
 
 import { Ora } from 'ora'
 import cliWidth from 'cli-width'
-import { yellow, dim, underline } from 'kleur'
+import { yellow, dim } from 'kleur'
+import { Logger } from '@poppinss/fancy-logs'
 
 /**
  * Getting width of the stdout to put log messages
  * in one line
  */
 const width = cliWidth()
+const logger = new Logger({ icon: false, underline: false, color: true })
 
 /**
  * Log installing dependencies message
@@ -51,8 +53,13 @@ export function logInstall (list: string[], spinner: Ora, dev: boolean) {
     namedDependencies.push(`and ${outOfBounds} other${outOfBounds !== 1 ? 's' : ''}`)
   }
 
-  spinner.text = ` ${yellow(underline('install'))}  ${namedDependencies.join(', ')} ${dim(`${dev ? '[dev]' : '[prod]'}`)}`
+  spinner.text = ` ${yellow('install')}  ${namedDependencies.join(', ')} ${dim(`${dev ? '[dev]' : '[prod]'}`)}`
   spinner.spinner = 'dots'
   spinner.color = 'gray'
   spinner.start()
 }
+
+export const success: typeof logger.success = logger.success.bind(logger)
+export const error: typeof logger.error = logger.error.bind(logger)
+export const fatal: typeof logger.fatal = logger.fatal.bind(logger)
+export const create: typeof logger.create = logger.create.bind(logger)

tasks/copyTemplates.ts

@@ -8,9 +8,9 @@
 */
 
 import { join } from 'path'
-import fancyLogs from '@poppinss/fancy-logs'
 import { TemplateFile } from '@adonisjs/sink'
 
+import { create } from '../src/logger'
 import { TaskFn } from '../src/contracts'
 import { packages } from '../src/boilerplate/packages'
 
@@ -53,7 +53,7 @@ const task: TaskFn = (absPath, _app, state) => {
       .apply(data)
       .commit()
 
-    fancyLogs.create({ message: template, icon: false })
+    create(template)
   })
 }
 

tasks/createEditorConfig.ts

@@ -8,9 +8,8 @@
 */
 
 import { IniFile } from '@adonisjs/sink'
-import fancyLogs from '@poppinss/fancy-logs'
-
 import { TaskFn } from '../src/contracts'
+import { create } from '../src/logger'
 
 /**
  * Creates `.editorconfig` inside the project root.
@@ -36,7 +35,7 @@ const task: TaskFn = (absPath) => {
   })
 
   editorConfig.commit()
-  fancyLogs.create({ message: '.editorconfig', icon: false })
+  create('.editorconfig')
 }
 
 export default task

tasks/createEnvFile.ts

@@ -9,9 +9,9 @@
 
 import randomstring from 'randomstring'
 import { EnvFile } from '@adonisjs/sink'
-import fancyLogs from '@poppinss/fancy-logs'
 
 import { TaskFn } from '../src/contracts'
+import { create } from '../src/logger'
 
 /**
  * Creates the `.env` file inside the project root. Also
@@ -27,7 +27,7 @@ const task: TaskFn = (absPath) => {
   env.set('APP_KEY', randomstring.generate(32))
 
   env.commit()
-  fancyLogs.create({ message: '.env, .env.example', icon: false })
+  create('.env, .env.example')
 }
 
 export default task

tasks/createGitIgnore.ts

@@ -8,9 +8,9 @@
 */
 
 import { LinesFile } from '@adonisjs/sink'
-import fancyLogs from '@poppinss/fancy-logs'
 
 import { TaskFn } from '../src/contracts'
+import { create } from '../src/logger'
 
 /**
  * Creates `.gitignore` file inside the project root.
@@ -25,7 +25,7 @@ const task: TaskFn = (absPath) => {
   gitignore.add('.DS_STORE')
 
   gitignore.commit()
-  fancyLogs.create({ message: '.gitignore', icon: false })
+  create('.gitignore')
 }
 
 export default task

tasks/createPackageFile.ts

@@ -10,11 +10,10 @@
 import ora from 'ora'
 import { basename } from 'path'
 import { PackageFile } from '@adonisjs/sink'
-import fancyLogs from '@poppinss/fancy-logs'
 
 import { TaskFn } from '../src/contracts'
-import { logInstall } from '../src/logger'
 import { packages } from '../src/boilerplate/packages'
+import { logInstall, create, fatal } from '../src/logger'
 
 /**
  * Creates the `package.json` file in the project root and installs
@@ -85,10 +84,10 @@ const task: TaskFn = async (absPath, _app, state) => {
 
   if (response && response.status === 1) {
     const errorMessage = useYarn ? 'yarn install failed' : 'npm install failed'
-    fancyLogs.fatal({ message: errorMessage, stack: response.stderr.toString() })
+    fatal({ message: errorMessage, stack: response.stderr.toString() })
     throw new Error('Installation failed')
   } else {
-    fancyLogs.create({ message: 'package.json', icon: false })
+    create('package.json')
   }
 }
 

tasks/createRcFile.ts

@@ -8,8 +8,8 @@
 */
 
 import { RcFile } from '@adonisjs/sink'
-import fancyLogs from '@poppinss/fancy-logs'
 
+import { create } from '../src/logger'
 import { TaskFn } from '../src/contracts'
 
 /**
@@ -38,7 +38,7 @@ const task: TaskFn = (absPath, _app, state) => {
   }
 
   rcFile.commit()
-  fancyLogs.create({ message: '.adonisrc.json', icon: false })
+  create('.adonisrc.json')
 }
 
 export default task