前端目录构建规范

一、前端目录构建规范的作用

  目的是与项目开发的目录结构保持一致,便于项目的构建与管理。

 

二、资源分类

  1、源代码资源

    指开发者编写的源代码,包括html、css、template等

  2、内容资源

    指希望作为内容提供给访问者的资源,包括图片、字体、flash、pdf等,最常用的应该就是readme.md文件

三、目录命名规则

  1、简洁  有习惯性的缩写单词,采用容易理解的缩写。如源代码目录src,不要写成source

  2、常用的一些文件名称  

    img:图片  不要使用image、images、imgs等

    js:JavaScript脚本  不要使用script、scripts等

    css:样式表  不要使用style、styles等

    swf:flash  不要使用flash等

    src:源文件目录  不要使用source等

    dep:第三方依赖包  不要使用lib、library、dependency等

    注意:不允许出现复数形式,如imgs、deps是不允许的。

四、根目录的划分

  根目录下按照职能进行划分,不允许将资源类型或者业务逻辑的目录划分到根目录下。

  根目录下常用的文件如下:

    src

    test

    doc

    dep

 

五、业务逻辑划分src目录结构

  业务项目的src目录内,绝大多数情况应该根据业务逻辑划分目录结构。

  业务逻辑下常用的文件如下:

    utils

    common    

    components

    routers

    assets

    api

    store

    view

    static

  注意:这是按照vue/react进行的划分,不是固定的,个人习惯。

原文地址:https://www.cnblogs.com/wuqilang/p/11609049.html