babel-plugin-enhance-log

A babel Plugin to add log line, log filename, add log argument name and separator

English | 中文

📦 Install

pnpm add babel-plugin-enhance-log -D
# or
yarn add babel-plugin-enhance-log -D
# or
npm i babel-plugin-enhance-log -D

⚙️ Options

interface Options {
  /**
   * tip of start argument default 🚀🚀🚀🚀🚀🚀🚀🚀🚀🚀
   * @example
   * console.log('line of 1 🚀🚀🚀🚀🚀🚀🚀🚀🚀🚀', ...)
   */
  preTip?: string
  /** the delimiter for each parameter is an empty string by default, you can also use a newline \n, a semicolon';' a comma',' or even a pig '🐖' */
  splitBy?: boolean
  /** 
   * need endLine, default false
   * @example
   * console.log('line of 1 🚀🚀🚀🚀🚀🚀🚀🚀🚀🚀', ..., 'line of 10 🚀🚀🚀🚀🚀🚀🚀🚀🚀🚀')
   *  */
  endLine?: boolean
  /**
   * log file name
   * If your file name is too long,
   * and you don;t want to log the directory of  the file path, 
   * such as src/pages/xxxyyy/a.tsx, 
   * then you can configure enableDir to false, and only print a.tsx
   * @default true
   */
  enableFileName?: boolean | {
    enableDir?: boolean
  }
  /** 
   * You can specify the project root directory address, which
   * will be used to process file name generation 
   * @default process.cwd()
   * */
  root?: boolean
}

🔨 Usage

// babel.config.js

module.exports = {

  plugins: [
    ['enhance-log', 
    /** @type {import('babel-plugin-enhance-log').Options} */
    {  
      preTip: '🚀🚀🚀🚀🚀🚀🚀🚀🚀🚀', // default 
      splitBy: '', // default
      endLine: false
    }]
  ],
}

👇 Example

📢 Note that since 0.4.0, if you print the filename, it puts the line where the log is after the filename, something like this:

For example, if you don't like small 🚀, but you like piggy 🐖, you can configure preTip as 🐖🐖🐖🐖🐖🐖🐖🐖🐖🐖:

For example, in the case of many parameters, you want log to wrap each parameter, then you can configure splitBy as \n:

Or the delimiter is ;:

Of course, you can also specify it at will, such as using a dog head 🐶 to separate:

For another example, if there is a log that spans multiple lines, you want the number of lines at the beginning and end of the log, with the log entity in the middle, then you can set endLine to true:

We can see that the number of lines at the beginning is 13, and the number of lines at the end is 44, which is consistent with the source code

For example, if you want to know the file name where the log is located, you can configure enableFileName to be true (of course the default is true):

If the file path is too long:

and you only want to print the file name without the directory prefix, you can configure enableFileName: { enableDir: false }:

📄 License

babel-plugin-enhance-log is MIT licensed.