Dead Simple LESS Watch Compiler 使用教程
1. 项目的目录结构及介绍
deadsimple-less-watch-compiler/
├── src/
│ ├── main.less
│ └── aux.less
├── dist/
│ └── main.css
├── test/
│ └── test.js
├── .babelrc
├── .gitignore
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── MIT-LICENSE.txt
├── README.md
├── _config.yml
├── less-watch-compiler.sample.config.json
├── package.json
├── renovate.json
└── yarn.lock
目录结构介绍
- src/: 存放LESS源文件的目录。
main.less
: 主LESS文件。aux.less
: 辅助LESS文件。
- dist/: 存放编译后的CSS文件的目录。
main.css
: 编译后的主CSS文件。
- test/: 存放单元测试文件的目录。
test.js
: 单元测试脚本。
- .babelrc: Babel配置文件。
- .gitignore: Git忽略文件配置。
- CODE_OF_CONDUCT.md: 行为准则文件。
- CONTRIBUTING.md: 贡献指南文件。
- MIT-LICENSE.txt: 项目许可证文件。
- README.md: 项目说明文件。
- _config.yml: 项目配置文件。
- less-watch-compiler.sample.config.json: LESS监视编译器的示例配置文件。
- package.json: 项目依赖和脚本配置文件。
- renovate.json: Renovate配置文件。
- yarn.lock: Yarn锁定文件。
2. 项目的启动文件介绍
项目的启动文件是 less-watch-compiler.js
,它位于项目的根目录下。该文件负责监视指定目录中的LESS文件变化,并在检测到变化时自动编译LESS文件为CSS文件。
启动命令
node less-watch-compiler.js [options] <source_dir> <destination_dir> [main-file]
- source_dir: 源文件目录,即LESS文件所在的目录。
- destination_dir: 目标文件目录,即编译后的CSS文件存放的目录。
- main-file: 可选参数,指定主LESS文件。
示例
node less-watch-compiler.js src dist main.less
3. 项目的配置文件介绍
项目的配置文件是 less-watch-compiler.sample.config.json
,它位于项目的根目录下。该文件定义了LESS监视编译器的行为和选项。
配置文件内容
{
"watchFolder": "src",
"outputFolder": "dist",
"mainFile": "main.less",
"includeHidden": false,
"sourceMap": false,
"plugins": "plugin1,plugin2",
"lessArgs": "option1=1,option2=2",
"runOnce": false,
"enableJs": true
}
配置项说明
- watchFolder: 指定要监视的文件夹路径。
- outputFolder: 指定编译后的CSS文件输出路径。
- mainFile: 指定主LESS文件。
- includeHidden: 是否包含隐藏文件(以
.
或_
开头的文件)。 - sourceMap: 是否生成CSS的Source Map。
- plugins: 指定LESS插件,多个插件用逗号分隔。
- lessArgs: 指定LESS编译器的其他选项。
- runOnce: 是否只运行一次编译而不持续监视。
- enableJs: 是否允许在LESS文件中使用JavaScript。
通过配置文件,用户可以灵活地调整LESS监视编译器的行为,以满足不同的开发需求。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考