1 Star 1 Fork 0

我爱喝可乐 / dir-structure

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
router-path.md 3.25 KB
一键复制 编辑 原始数据 按行查看 历史

检测当前router path 是否与文件夹一一对应 (router-path)

目标:根据vue项目 router文件下定义的path目录检测对应的views,service,optons等其他类型文件夹的命名是否一致,保证项目的目录结构标准化

规则详情


"rules": {
    "dir-structure/router-path": [2, "always", {
        "includeFile": ["/configManage/dash"], //配置router指定文件进行path检测
        "excludeFile": [],// 设置无需检测的文件
        "dirTypeOptions" : { // router 中path对应的其他类型文件需要检测
            "options":".js",
            "service":".js"
        }
    }]
}

检测的规范模版如下

vue文件路径创建以2级菜单的作为根路径节点

比如管理=>计划、预算为例

├── views │ └── manage │ │── budget │ └── plan │ │── index.vue │ │── add.vue │ │── checkout.vue │ │── edit.vue │ └── components │ │── xxx.vue │ │── xxx.js │ └── xxx.scss ├── options │ └── manage │ └── plan.js ├── service │ └── manage │ └── plan.js ├── router │ └── manage │ └── plan.js

views文件名称请按照下方表格中进行命名

初期的暂时都使用detail

类型 名称
查看 checkout
编辑(普通编辑) edit
变更 change
新增 add
审核 audit
撤回 recall
编辑(提交审核(撤回)) recallEdit
编辑(变更提交审核(撤回)) changeRecallEdit
兜底修改 coverBottom
查看兜底 coverBottomDetail
审批兜底修改 coverBottomApproval
自定义 可根据实际情况进行命名

js变量名称统一使用文件路径的全拼,驼峰结构

service

// 采购执行相关接口
import api from './api'
const managePlan = {
  //...
}
export default managePlan

options

const managePlan = {
  // 项目类型 例子
  testType: [
    {
      code: 1,
      name: '示例'
    }
  ]
}

export default managePlan

vue的name名称统一使用文件路径的全拼,驼峰结构

views

<template>
计划
</template>

<script>
export default {
  name: "managePlan"
}
</script>

router的name名称统一使用文件路径的全拼,驼峰结构,path要求与路径完全一致

router

/* eslint-disable no-template-curly-in-string */

const children = [
  {
    path: '/manage/plan',
    name: 'managePlan',
    component: () => import('@/views/manage/plan/index.vue'),
    meta: {
      label: '计划'
    }
  },
  {
    path: '/manage/plan/add',
    name: 'managePlanAdd',
    component: () => import('@/views/manage/plan/add.vue'),
    meta: {
      label: '计划-新增'
    }
  }
]
export default children

如有疑问可邮箱联系作者 615683167@qq.com

JavaScript
1
https://gitee.com/zhaoshiqiang/dir-structure.git
git@gitee.com:zhaoshiqiang/dir-structure.git
zhaoshiqiang
dir-structure
dir-structure
master

搜索帮助

53164aa7 5694891 3bd8fe86 5694891