Vue-Highlight.js 项目教程

1. 项目的目录结构及介绍

vue-highlight.js/
├── dist/
│   ├── vue-highlight.js
│   └── vue-highlight.min.js
├── src/
│   ├── index.js
│   └── components/
│       └── Highlight.js
├── .gitignore
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── package.json
├── rollup.config.js
└── tsconfig.json

目录结构介绍

• dist/: 存放构建后的文件，包括 vue-highlight.js 和 vue-highlight.min.js。
• src/: 源代码目录，包含项目的核心代码。
  • index.js: 项目的入口文件。
  • components/: 存放 Vue 组件，如 Highlight.js。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• package.json: 项目的依赖和脚本配置。
• rollup.config.js: Rollup 构建配置文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js，该文件是整个项目的入口点。它负责初始化 Vue 插件并导出插件对象。

// src/index.js
import Highlight from './components/Highlight.js';

export default {
  install(Vue) {
    Vue.component('highlightjs', Highlight);
  }
};

启动文件介绍

• 导入组件: 从 components/Highlight.js 导入 Highlight 组件。
• 插件安装: 通过 install 方法将 Highlight 组件注册为 Vue 的全局组件。

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的依赖、脚本命令和其他元数据。

{
  "name": "vue-highlight.js",
  "version": "1.0.0",
  "description": "Highlight.js plugin for Vue.js",
  "main": "dist/vue-highlight.js",
  "scripts": {
    "build": "rollup -c",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "gluons",
  "license": "MIT",
  "dependencies": {
    "highlight.js": "^11.0.0"
  },
  "devDependencies": {
    "rollup": "^2.0.0"
  }
}

配置文件介绍

• name: 项目名称。
• version: 项目版本号。
• description: 项目描述。
• main: 项目的入口文件路径。
• scripts: 定义了项目的脚本命令，如 build 和 test。
• dependencies: 项目的生产依赖，如 highlight.js。
• devDependencies: 项目的开发依赖，如 rollup。

rollup.config.js

rollup.config.js 文件是 Rollup 的配置文件，用于构建项目的输出文件。

// rollup.config.js
import babel from '@rollup/plugin-babel';
import commonjs from '@rollup/plugin-commonjs';
import resolve from '@rollup/plugin-node-resolve';

export default {
  input: 'src/index.js',
  output: {
    file: 'dist/vue-highlight.js',
    format: 'umd',
    name: 'vueHighlightjs'
  },
  plugins: [
    resolve(),
    commonjs(),
    babel({ babelHelpers: 'bundled' })
  ]
};

配置文件介绍

• input: 指定 Rollup 的入口文件。
• output: 定义输出文件的路径、格式和名称。
• plugins: 配置 Rollup 插件，如 babel、commonjs 和 node-resolve。

通过以上配置，项目可以顺利构建并生成最终的 dist/vue-highlight.js 文件。