element如何初始化组件功能详解

 更新时间:2022年12月21日 08:36:17   作者:codeniu  
Element UI是一套基于Vue的桌面端组件库,封装好了很多常用的UI组件,下面这篇文章主要给大家介绍了关于element如何初始化组件功能的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下

前言

上篇文章学习了 tdesign-vue 初始化组件的方式,这篇文章学习一下element组件库是如何初始化组件的。

资源:

源码

入口文件

找到用于初始化组件的脚本,位置如图:

开始

脚本的开始引用了一些文件,说明了脚本所要用到的工具都有那些。

'use strict';

console.log();
process.on('exit', () => {
  console.log();
});

if (!process.argv[2]) {
  console.error('[组件名]必填 - Please enter new component name');
  process.exit(1);
}

// 处理文件和目录路径
const path = require('path');
// 内置的 Node.js 模块,它提供文件系统操作,比如对文件系统的读写。
const fs = require('fs');
// 用于文本保存
const fileSave = require('file-save');
// 这是一个将字符串转换为 upperCamelcase 的库
const uppercamelcase = require('uppercamelcase');

const componentname = process.argv[2];
const chineseName = process.argv[3] || componentname;
const ComponentName = uppercamelcase(componentname);
const PackagePath = path.resolve(__dirname, '../../packages', componentname);

该脚本首先使用 process 对象的 on 方法注册一个回调函数,以便在进程退出时执行。回调函数将一个空行记录到控制台。

然后,脚本检查第二个命令行参数(process.argv [2])是否为真。如果它不是真值,那么脚本将记录一条错误消息,并使用非零退出代码退出进程(指示一个错误)。

然后,脚本声明一些变量:

  • componentname 设置为第二个命令行参数(组件名)。
  • chineseName 设置为第三个命令行参数(组件的中文名称) ,如果没有提供第三个参数,则设置为组件名称。
  • 组件名设置为使用 upperCamelCase 库将组件名转换为 UpperCamelCase 的结果。
  • PackagePath 设置为包目录的路径,后跟组件名。

文件列表

const Files = [
  {
    filename: 'index.js',
    content: `import ${ComponentName} from './src/main';
    ... 省略部分内容
    `
   },
   
   // ... 
 ]

之后脚本定义了一个Files变量,这个变量存储了需要添加或者需要修改的文件列表,同时也指示了添加或者修改的内容是什么。

那么具体都会修改那些文件呢:

  • index.js
  • 4个说明文档(zh-CN、en-US、es、fr-FR)
  • 测试文件 (/test/unit/specs)
  • 主题文件 (theme-chalk/src)
  • 类型文件

添加到 components.json

// 添加到 components.json
const componentsFile = require('../../components.json');
if (componentsFile[componentname]) {
  console.error(`${componentname} 已存在.`);
  process.exit(1);
}
componentsFile[componentname] = `./packages/${componentname}/index.js`;
fileSave(path.join(__dirname, '../../components.json'))
  .write(JSON.stringify(componentsFile, null, '  '), 'utf8')
  .end('\n');

检查组件名称的对象属性是否已经存在于 componentsFile 对象中。如果存在,脚本将记录一条错误消息,并使用非零退出代码退出进程。

如果组件不存在于 ComponentsFile 中,脚本将在对象上设置一个新属性,其中包含组件的名称和到达组件主入口点的路径的值(./package/${ Component entname }/index.js).

最后,脚本使用文件保存库将修改后的 ComponentsFile 对象写入 Components.json 文件,该文件采用缩进格式,并在文件末尾使用换行符。

其他文件的添加

// 添加到 index.scss
const sassPath = path.join(__dirname, '../../packages/theme-chalk/src/index.scss');
const sassImportText = `${fs.readFileSync(sassPath)}@import "./${componentname}.scss";`;
fileSave(sassPath)
  .write(sassImportText, 'utf8')
  .end('\n');

// 添加到 element-ui.d.ts
const elementTsPath = path.join(__dirname, '../../types/element-ui.d.ts');

let elementTsText = `${fs.readFileSync(elementTsPath)}
/** ${ComponentName} Component */
export class ${ComponentName} extends El${ComponentName} {}`;

const index = elementTsText.indexOf('export') - 1;
const importString = `import { El${ComponentName} } from './${componentname}'`;

elementTsText = elementTsText.slice(0, index) + importString + '\n' + elementTsText.slice(index);

fileSave(elementTsPath)
  .write(elementTsText, 'utf8')
  .end('\n');
  
// 创建 package
Files.forEach(file => {
  fileSave(path.join(PackagePath, file.filename))
    .write(file.content, 'utf8')
    .end('\n');
});

// 添加到 nav.config.json
const navConfigFile = require('../../examples/nav.config.json');

Object.keys(navConfigFile).forEach(lang => {
  let groups = navConfigFile[lang][4].groups;
  groups[groups.length - 1].list.push({
    path: `/${componentname}`,
    title: lang === 'zh-CN' && componentname !== chineseName
      ? `${ComponentName} ${chineseName}`
      : ComponentName
  });
});

fileSave(path.join(__dirname, '../../examples/nav.config.json'))
  .write(JSON.stringify(navConfigFile, null, '  '), 'utf8')
  .end('\n');

console.log('DONE!');

之后的代码将修改 index.scss 与 element-ui.d.ts,创建 package,修改nav.config.json,使用的方式也和上述相同。

总结

组件初始化脚本,很大程度上提高了开发效率,避免了程序员们将精力浪费在做重复的事情上,在我们日常的开发中也可尝试写一些这样的脚本。

到此这篇关于element如何初始化组件功能的文章就介绍到这了,更多相关element初始化组件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • vue中组件的3种使用方式详解

    vue中组件的3种使用方式详解

    这篇文章主要给大家介绍了关于vue中组件的3种使用方式,文中通过示例代码介绍的非常详细,对大家学习或者使用vue具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2019-03-03
  • Vue render函数使用详细讲解

    Vue render函数使用详细讲解

    vue中的render函数,它返回的是一个虚拟节点vnode,也就是我们要渲染的节点,下面这篇文章主要给大家介绍了关于Vue中render函数的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2023-01-01
  • Element-ui tree组件自定义节点使用方法代码详解

    Element-ui tree组件自定义节点使用方法代码详解

    本文通过实例代码给大家介绍了Element-ui tree组件自定义节点使用方法 ,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下
    2018-09-09
  • 关于el-tooltip使用\n换行的情况显示

    关于el-tooltip使用\n换行的情况显示

    这篇文章主要介绍了关于el-tooltip使用\n换行的情况显示,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-04-04
  • vue3.0 CLI - 2.5 - 了解组件的三维

    vue3.0 CLI - 2.5 - 了解组件的三维

    通过本文带领大家去学习vue3.0 CLI - 2.5 - 了解组件的三维的相关知识,感兴趣的朋友跟随脚本之家小编一起学习吧
    2018-09-09
  • vue之el-form表单校验以及常用正则详解

    vue之el-form表单校验以及常用正则详解

    这篇文章主要介绍了vue之el-form表单校验以及常用正则,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-05-05
  • vue中如何使用elementUI表格动态行合并

    vue中如何使用elementUI表格动态行合并

    这篇文章主要介绍了vue中如何使用elementUI表格动态行合并,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-10-10
  • vue-cli 为项目设置别名的方法

    vue-cli 为项目设置别名的方法

    这篇文章主要介绍了vue-cli 为项目设置别名的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-10-10
  • Vue+Java+Base64实现条码解析的示例

    Vue+Java+Base64实现条码解析的示例

    这篇文章主要介绍了Vue+Java+Base64实现条码解析的示例,帮助大家实现条码解析,感兴趣的朋友可以了解下
    2020-09-09
  • Vue非父子组件之间的通信方式详解

    Vue非父子组件之间的通信方式详解

    在实际业务中,除了父子组件通信外,还有很多非父子组件通信的场景,下面这篇文章主要给大家介绍了关于Vue非父子组件之间的通信方式,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2022-07-07

最新评论