[enhance-log]to add log filename, line, argument name and separator
Published: 2023-07-16 10:41:58


<p align="center">
<h1 align="center">vite-plugin-enhance-log</h1>
</p>

<div align="center">
  A vite Plugin to add log filename, log line, log argument name and separator.



</div>

---




There is also a babel pluin with the same features 👉 [babel-plugin-enhance-log](https://github.com/baozouai/babel-plugin-enhance-log)
 


## 📦  Install

```sh
pnpm add vite-plugin-enhance-log -D
# or
yarn add vite-plugin-enhance-log -D
# or
npm i vite-plugin-enhance-log -D
```


## ⚙️ Options

```ts
interface Options {
  /**
   * 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
  }
  /**
   * tip of start argument default 🚀🚀🚀🚀🚀🚀🚀🚀🚀🚀
   * @example
   * console.log(' 🚀🚀🚀🚀🚀🚀🚀🚀🚀🚀', ...)
   */
  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， only if startLine unequal endLine
   * @example
   * console.log('line of 1 🚀🚀🚀🚀🚀🚀🚀🚀🚀🚀 ~ main.tsx', ..., 'line of 10 🚀🚀🚀🚀🚀🚀🚀🚀🚀🚀 ~ main.tsx')
   *  */
  endLine?: boolean
}
```
##  🔨 Usage

```ts
import { defineConfig } from 'vite'
import EnhanceLog from 'vite-plugin-enhance-log'

const config = defineConfig({
  plugins: [
    // if you use vue, ensure the vuePlugin before the log plugin
    EnhanceLog({
      splitBy: '\n',
      preTip: '🐖🐖🐖🐖🐖🐖🐖🐖🐖🐖',
      enableFileName: true, // or enableFileName: { enableDir: false}
    }),
  ],
})

export default config

```

## 👇 Example

Clone the [project](https://github.com/baozouai/vite-plugin-enhance-log) and start playgrounds by running:

```shell
pnpm play # corresponding to vue
# or
pnpm play:react # corresponds to react
```


For specific configuration, see [vue/vite.config.ts](https://github.com/baozouai/vite-plugin-enhance-log/blob/master/playgrounds/vue/vite.config.ts) or [react/vite.config.ts](https://github.com/baozouai/vite-plugin-enhance-log/blob/master/playgrounds/react/vite.config.ts)

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

![pig_pretip](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/tyvy59vaf0ym6z3d5jym.png)

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

![linefeed](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/n91htm8n8m3x041ofxwa.png)

Or the delimiter is `;`:


![semicolon_delimiter](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/tbgutsq74ne0mez8b1cr.png)

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


![dog_delimiter](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/ynrn2gp6gws6lgg55zna.png)

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):


![filename](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/iyrgvrjhrwafefd47efr.png)

If the file path is too long:

![deep_file](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/kj2niahwqvjfxzj89bwn.png)


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

![only_file_name](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/vcerjbfsc73w6etyqwp7.png)

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:



![log_multi_line](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/gzykpu8f6w5dysvnx0kd.png)

![log_multi_line_res](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/2gmhue1u5v98ia284zqb.png)

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

## 📄 License

vite-plugin-enhance-log is [MIT licensed](https://github.com/baozouai/vite-plugin-enhance-log/blob/master/LICENSE).