简介
npm 包 nigel 是一个用于前端项目的命名规范和目录结构管理的工具。它可以帮助开发者遵循一致的命名约定,并提供了一种标准的文件组织方式,从而提高代码的可维护性和可读性。
安装
要使用 nigel,需要先在全局安装它:
npm install -g nigel
使用方法
初始化项目
在项目根目录下执行以下命令,即可初始化一个符合 nigel 规范的项目结构:
nigel init
执行完该命令后,会在当前目录下创建一个 src
目录,包含了基本的项目结构,如下所示:
-- -------------------- ---- ------- ---- --- ------- - --- ------- - --- ------- --- ----------- --- ------ --- ------- --- --------- --- ------ --- ------ --- -------
其中,assets
目录用于存放静态资源,如图片、样式等;components
目录用于存放可复用的组件;pages
目录用于存放页面组件;router
目录用于存放路由相关代码;services
目录用于存放 API 服务相关代码;store
目录用于存放 Vuex 相关代码;utils
目录用于存放通用工具函数;App.vue
是项目的入口组件。
创建模块
要创建一个新的模块,可以使用以下命令:
nigel generate module <module-name>
其中,<module-name>
为模块名称,比如 user
。
执行该命令后,会在 src
目录下创建一个新的目录,包含了与该模块相关的组件、服务和 store 等代码,如下所示:
src/ └── user/ ├── components/ ├── services/ ├── store/ └── index.js
创建组件
要创建一个新的组件,可以使用以下命令:
nigel generate component <component-name> [--page <page-name>] [--section <section-name>]
其中,<component-name>
为组件名称,比如 button
;--page
参数表示该组件所属的页面名称,可选;--section
参数表示该组件所属的页面中的哪个 section,可选。
执行该命令后,会在对应的目录下创建一个新的 .vue
文件,包含了基本的组件代码,如下所示:
src/ ├── pages/ │ ├── home/ │ ├── user/ │ │ └── components/ │ │ └── Button.vue // 新创建的组件文件 │ └── ... └── ...
创建服务
要创建一个新的服务,可以使用以下命令:
nigel generate service <service-name> [--module <module-name>]
其中,<service-name>
为服务名称,比如 userApi
;--module
参数表示该服务所属的模块名称,可选。如果不指定该参数,则会在 src/services
目录下创建一个独立的服务文件。
执行该命令后,会在对应的目录下创建一个新的 .js
文件,包含了基本的服务代码,如下所示:
src/ ├── services/ │ ├── userApi.js // 新创建的服务文件 │ └── ... └── ...
创建 store
要创建一个新的 store,可以使用以下命令:
nigel generate store <store-name> [--module <module-name>]
其中,<store-name>
为 store 名称,比如 userStore
;--module
参数表示该 store 所属的模块名称,可选。如果不指定该
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/44936