feat: improve packaging for browser support

demo.js → demo/index.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-const Consola = require('./src/cjs')
+const Consola = require('../lib/esm')
 
 const reporters = [
   'FancyReporter',

main/consola.browser.js

@@ -0,0 +1,12 @@
+import { Consola, BrowserReporter } from '../src'
+
+if (window.consola) {
+  module.exports = window.consola
+} else {
+  // Create new consola instance
+  module.exports = window.consola = new Consola({
+    reporters: [
+      new BrowserReporter()
+    ]
+  })
+}

main/consola.js

@@ -0,0 +1,22 @@
+if (global.consola) {
+  module.exports = global.consola
+} else {
+  const env = require('std-env')
+  const { Consola, BasicReporter, FancyReporter } = require('../dist/consola.cjs.js')
+
+  // Log level
+  let level = env.debug ? 4 : 3
+  if (process.env['CONSOLA_LEVEL']) {
+    level = parseInt(process.env['CONSOLA_LEVEL']) || level
+  }
+
+  // Create new consola instance
+  module.exports = global.consola = new Consola({
+    level,
+    reporters: [
+      env.minimalCLI
+        ? new BasicReporter()
+        : new FancyReporter()
+    ]
+  })
+}

package.json

@@ -4,17 +4,20 @@
   "description": "Elegant Console Logger",
   "license": "MIT",
   "repository": "nuxt/consola",
-  "main": "index.js",
+  "main": "main/node.js",
+  "browser": "dist/consola.js",
   "scripts": {
-    "build": "bili",
+    "build": "yarn build:cjs && yarn build:browser",
+    "build:cjs": "bili -t node --format cjs src/index.js",
+    "build:browser": "bili --format umd main/consola.browser.js",
     "lint": "eslint .",
     "test": "yarn lint && yarn build && jest test",
     "prepublish": "yarn build",
     "release": "standard-version && yarn build && git push --follow-tags && npm publish"
   },
   "files": [
-    "index.js",
     "dist",
+    "main",
     "src"
   ],
   "keywords": [

src/consola.js

@@ -1,12 +1,12 @@
-import defaultTypes from './types'
+import { Types } from './types'
 import { isLogObj } from './utils'
 import { version } from '../package.json'
 
-export default class Consola {
+export class Consola {
   constructor (options = {}) {
     this.reporters = options.reporters || []
     this.level = options.level != null ? options.level : 3
-    this.types = options.types || defaultTypes
+    this.types = options.types || Types
     this.defaults = options.defaults || {}
 
     // Create logger functions for current instance

src/index.js

@@ -1,36 +1,13 @@
-import env from 'std-env'
-import Consola from './consola'
-import {
-  BasicReporter,
-  FancyReporter,
-  JSONReporter,
-  WinstonReporter
-} from './reporters'
+export {
+  Consola
+} from './consola'
 
-// Log level
-let level = env.debug ? 4 : 3
-if (typeof process !== 'undefined' && process.env['CONSOLA_LEVEL']) {
-  level = parseInt(process.env['CONSOLA_LEVEL'])
-}
+export {
+  Types
+} from './types'
 
-// Create new consola instance
-const consola = new Consola({
-  level
-})
+export {
+  isLogObj
+} from './utils'
 
-// Add default reporter based on env
-if (env.minimalCLI) {
-  consola.add(new BasicReporter())
-} else {
-  consola.add(new FancyReporter())
-}
-
-Object.assign(consola, {
-  Consola,
-  BasicReporter,
-  FancyReporter,
-  JSONReporter,
-  WinstonReporter
-})
-
-export default consola
+export * from './reporters'

src/reporters/basic.js

@@ -1,5 +1,5 @@
 import util from 'util'
-import { isPlainObject } from '../utils'
+import { isPlainObject, parseStack } from '../utils'
 
 export default class BasicReporter {
   constructor (options) {
@@ -16,23 +16,8 @@ export default class BasicReporter {
     this.options.stream.write(data)
   }
 
-  parseStack (stack) {
-    let lines = stack
-      .split('\n')
-      .map(l => l
-        .trim()
-        .replace(/^at /, '')
-      )
-
-    if (lines[0].indexOf('Error: ') === 0) {
-      lines = lines.splice(1)
-    }
-
-    return lines
-  }
-
   formatStack (stack) {
-    return '> ' + this.parseStack(stack).join('\n> ')
+    return '> ' + parseStack(stack).join('\n> ')
   }
 
   format (arg) {

src/reporters/browser.js

@@ -0,0 +1,10 @@
+export default class BrowserReporter {
+  constructor (options) {
+    this.options = Object.assign({}, options)
+  }
+
+  log (logObj) {
+    // TODO: Improve me
+    console.log(logObj) // eslint-disable-line no-console
+  }
+}

src/reporters/index.js

@@ -1,4 +1,5 @@
 export { default as BasicReporter } from './basic'
+export { default as BrowserReporter } from './browser'
 export { default as FancyReporter } from './fancy'
 export { default as JSONReporter } from './json'
 export { default as WinstonReporter } from './winston'

src/types.js

@@ -1,4 +1,4 @@
-export default {
+export const Types = {
   fatal: {
     level: 0,
     color: 'red'

src/utils.js

@@ -7,3 +7,18 @@ export function isLogObj (arg) {
   // Also contains either message or args field
   return isPlainObject(arg) && (Boolean(arg.message || arg.args))
 }
+
+export function parseStack (stack) {
+  let lines = stack
+    .split('\n')
+    .map(l => l
+      .trim()
+      .replace(/^at /, '')
+    )
+
+  if (lines[0].indexOf('Error: ') === 0) {
+    lines = lines.splice(1)
+  }
+
+  return lines
+}