前端代码差异化检测

最近开发需求中要用到code差异化:

当场翻车

开始今天主角  [v-code-diff](https://github.com/Shimada666/v-code-diff/blob/master/README-zh.md)和`vue-code-diff`两者都是代码差异化的组件。今天之说`v-code-diff`.不要问什么,没有为什么,就是简单而已。Vue2 / Vue3 都支持的 code diff 插件

### 1、如何使用?

```bash


// 安装 v-code-diff

# With NPM

$ npm i v-code-diff

# With Yarn

$ yarn add v-code-diff

# Vue2 用户需要额外安装 composition-api

$ yarn add @vue/composition-api


```

### 2、使用

* 2.1、Vue2使用

  `全局注册`

 

  ```js


  // app.js

  import Vue from 'vue';

  import CodeDiff from 'v-code-diff'

 

  Vue.use(CodeDiff);

 

  ```

 

  ```vue

  // 文件中使用

  // *.vue

  <template>

    <code-diff

        :old-string="'12345'"

        :new-string="'3456'"

        file-name="test.txt"

        output-format="side-by-side"/>

  </template>

  ```

 

  `局部注册`

  ```vue

  <template>

    <code-diff

        :old-string="'12345'"

        :new-string="'3456'"

        file-name="test.txt"

        output-format="side-by-side"/>

  </template>

  <script>

  import {CodeDiff} from 'v-code-diff'

 

  export default {

    name: 'App',

    components: {

      CodeDiff

    }

  }

  </script>


  ```

 

* 2.2、Vue3使用

  `全局注册`

  ```js

  // main.js

  import {createApp} from 'vue'

  import CodeDiff from 'v-code-diff'

  import App from 'App'

 

  const app=createApp(App)

      app.use(CodeDiff).mount('#app')

  ```

  ```vue

  // 文件中使用

  // *.vue

  <template>

    <code-diff

        :old-string="'12345'"

        :new-string="'3456'"

        file-name="test.txt"

        output-format="side-by-side"/>

  </template>

  ```

 

  `局部注册`

  ```vue

  // 文件中使用

  // *.vue

  <template>

    <code-diff

        :old-string="'12345'"

        :new-string="'3456'"

        file-name="test.txt"

        output-format="side-by-side"/>

  </template>

  <script lang="ts">

  import {defineComponent} from 'vue'

  import {CodeDiff} from 'v-code-diff'

 

  export default defineComponent({

    components: {

      CodeDiff

    }

  })

  </script>

  ```

* 提供的参数事件

  事件

  | 事件名称      | 说明      | 回调参数 |

  | ------------- | ---------- | -------- |

  | before-render | 渲染前触发 | -        |

  | after-render  | 渲染后触发 | -        |

  参数

  | 参数                  | 说明                                                        | 类型    | 可选值                    | 默认值      |

  | ---------------------- | ------------------------------------------------------------ | ------- | -------------------------- | ------------ |

  | highlight              | 控制是否高亮代码                                            | boolean | -                          | true        |

  | language              | 代码语言,如 `typescript`。不填会自动判断。 [查看全部支持语言](https://github.com/highlightjs/highlight.js/blob/main/SUPPORTED_LANGUAGES.md) | string  | -                          | -            |

  | old-string            | 陈旧的字符串                                                | string  | -                          | -            |

  | new-string            | 新的字符串                                                  | string  | -                          | -            |

  | context                | 不同地方上下间隔多少行不隐藏                                | number  | -                          | -            |

  | outputFormat          | 展示的方式                                                  | string  | line-by-line,side-by-side | line-by-line |

  | drawFileList          | 展示对比文件列表                                            | boolean | -                          | false        |

  | renderNothingWhenEmpty | 当无对比时不渲染                                            | boolean | -                          | false        |

  | diffStyle              | 差异风格, 单词级差异或字母级差异                            | string  | word, char                | word        |

  | fileName              | 文件名                                                      | string  | -                          | -            |

  | isShowNoChange        | 当无对比时展示源代码                                        | boolean | -                          | false        |

  | trim                  | 移除字符串前后空白字符                                      | boolean | -                          | false        |

  | language              | 对比的文本语言                                              | boolean | -                          | false        |

 

* 结束

  最后欢迎订阅,文章若有不足欢迎指出。

```

```

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 228,316评论 6 531
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 98,481评论 3 415
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 176,241评论 0 374
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 62,939评论 1 309
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 71,697评论 6 409
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 55,182评论 1 324
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 43,247评论 3 441
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 42,406评论 0 288
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 48,933评论 1 334
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 40,772评论 3 354
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 42,973评论 1 369
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 38,516评论 5 359
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 44,209评论 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 34,638评论 0 26
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 35,866评论 1 285
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 51,644评论 3 391
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 47,953评论 2 373

推荐阅读更多精彩内容