开源项目 bem-cn
使用教程
1. 项目的目录结构及介绍
bem-cn
项目的目录结构如下:
bem-cn/
├── dist/
│ ├── bem-cn.js
│ └── bem-cn.min.js
├── src/
│ ├── index.js
│ └── utils.js
├── .gitignore
├── LICENSE
├── package.json
├── README.md
└── webpack.config.js
目录介绍
dist/
: 包含编译后的文件,如bem-cn.js
和bem-cn.min.js
。src/
: 源代码目录,包含项目的主要逻辑文件index.js
和工具文件utils.js
。.gitignore
: Git 忽略文件配置。LICENSE
: 项目许可证文件。package.json
: 项目依赖和脚本配置文件。README.md
: 项目说明文档。webpack.config.js
: Webpack 配置文件。
2. 项目的启动文件介绍
项目的启动文件主要是 src/index.js
,该文件是 bem-cn
库的入口点。它导出了用于生成 BEM 类名的主要方法。
// src/index.js
import BemCn from './bem-cn';
export default BemCn;
3. 项目的配置文件介绍
package.json
package.json
文件包含了项目的元数据和依赖信息。以下是一些关键部分:
{
"name": "bem-cn",
"version": "2.1.1",
"description": "Friendly BEM class names generator, greate for Vue.js",
"main": "dist/bem-cn.js",
"scripts": {
"build": "webpack --config webpack.config.js",
"prepublish": "npm run build"
},
"dependencies": {},
"devDependencies": {
"webpack": "^4.41.2",
"webpack-cli": "^3.3.10"
}
}
webpack.config.js
webpack.config.js
文件用于配置 Webpack,定义如何打包项目文件。
const path = require('path');
module.exports = {
entry: './src/index.js',
output: {
path: path.resolve(__dirname, 'dist'),
filename: 'bem-cn.js',
library: 'bemCn',
libraryTarget: 'umd'
},
module: {
rules: [
{
test: /\.js$/,
exclude: /node_modules/,
use: {
loader: 'babel-loader'
}
}
]
}
};
通过以上配置,可以了解如何构建和使用 bem-cn
项目。