简介

该文档主要的设计目标是公司前端项目文件（夹）命名规范化。

编码范围

[MUST] 文件（夹）的命名均不允许包含空格。

[MUST] 使用半角符号，也即不允许使用中文命名。

项目命名

[MUST] 全部采用小写形式，以连字符分隔。

示例：my-project-name、x-client。

目录命名

[MUST] 全部采用小写形式，以连字符或下划线分隔。推荐采用连字符。

[MUST] 有复数结构时，采用复数命名法。

[MUST] 简洁且有习惯性缩写的单词必须采用容易理解的缩写。

示例：pdf-previewer、node_modules、scripts、src。

文件命名

[MUST] 全部采用小写形式。

[MUST] 以连字符分隔。

解释：为什么要小写 (opens new window)。

示例：html-parser.js、error-detector.js、index.css、logo-cropped.png。

特例：

[RECOMMENDED] 为了醒目，某些说明文件的文件名，允许使用大写字母，建议只是文件名大写，文件扩展名不必大写。

示例：README.md、LICENSE、CODE_OF_CONDUCT.md。

注意事项

[RECOMMENDED] 基于遗留项目时，如果项目的命名风格和本规范风格不一致，但是命名清晰，或者有时间、人员等原因无法进行重构时，允许遵循已有风格即可。但是团队风格必须保持一致。