Skip to content
Developer kits for Nuo FE.
JavaScript TypeScript
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
packages
scaffolds
.editorconfig
.eslintignore
.eslintrc.js
.gitignore
.npmignore
.prettierignore
.prettierrc.js
.svnignore
LICENSE
README.md
babel.config.js
lerna.json
ndk.config.js
package.json
tsconfig.json
yarn.lock

README.md

Nuo FE Developer Kits

Developer kits for Nuo FE.

使用手册

前端开发工具 NDK 基于 “搭建 -> 开发 -> 测试 -> 发布”的前端工作流,为前端开发者提供自动化、标准化的工具,用于减少重复及非必要的劳动。

现阶段会通过技术收敛和强制约等手段来保障标准化工作流的落地。

环境准备

前端开发工具基于 Node.js 开发,可在 Windows 、 Mac 、 Linux 等系统中使用。请先行确认 Node.js 和 Yarn 能够正常安装和使用。

Node.js

检查系统中是否安装 Node.js 。如果没有安装,请到官网 https://nodejs.org/zh-cn/ 下载 LTS 版本安装使用。

注意:

如果系统中已安装 Node.js ,需要确认 Node.js 版本号高于 10.16.0 。可以在命令行工具中使用 node -v 命令查看当前版本号。

由于公司网络访问 npm 源速度会比较慢,可以用以下命令切换为 cnpm 源来加快 npm 包的安装速度:

npm config set registry https://registry.npm.taobao.org/

注意:

前端开发工具在使用时会自动切换 npm 源为 cnpm 源。

Yarn

我们使用 Yarn 作为包管理工具。因为 yarn 比 npm 的依赖版本锁更优秀。使用方法可访问 https://yarnpkg.com/zh-Hans/ 了解。

注意:

前端开发工具在使用时会自动安装或更新 yarn 。

Windows 用户请检查 yarn 是否通过程序安装,如果是,请将其卸载。

Windows 7 :开始 -> 控制面板 -> 程序 -> 卸载程序 -> 搜索 yarn -> 卸载

Windows 10 :开始 -> 设置 -> 应用 -> 搜索 yarn -> 卸载

工具安装

所有工具只需安装一次,工具在运行时会自动检测版本更新,按照提示信息操作即可。

注意:

请确认各个工具是全局安装,而不是安装到应用依赖中。

在命令后面追加 --next 参数可以检测最新的测试版本。如果测试版本号低于正式版本号,则会忽略测试版本。

@nuofe/ndk-build-tool

打包工具,用于初始化或升级应用编译打包配置。

  • 安装命令:

    npm i @nuofe/ndk-build-tool -g
  • 运行命令:

    ndk-init 初始化或升级应用编译打包配置

    ndk-dev 启动开发环境

    ndk-build 打包项目用于提测或发布

注意:

在开发时应该使用此工具的命令来保障应用配置的自动升级和统一。

@nuofe/ndk-lint-tool

代码检测工具,用于统一应用代码检测配置。

  • 安装命令:

    npm i @nuofe/ndk-lint-tool -g
  • 运行命令:

    ndk-lint 格式化及检测代码

注意:

在无法使用 @nuofe/ndk-build-tool 的项目中,可以使用此工具来做代码检测。

@nuofe/ndk

前端开发工具

  • 安装命令:

    npm i @nuofe/ndk -g
  • 运行命令:

    ndk generate 创建一个项目

注意:

此工具其他功能还在开发中,更多信息请移步 https://github.com/nuofe/ndk/tree/master/packages/ndk 了解。

应用开发

新应用开发

  • 安装好 @nuofe/ndk 工具后,运行 ndk generate 命令,根据提示选择对应的脚手架创建应用。

注意:

默认脚手架为基础的通用脚手架模板,也可参考 https://github.com/nuofe/scaffolds 自行开发脚手架模板。

  • 创建完成后,运行 ndk-dev 命令即可启动开发环境进行编码工作。

注意:

可修改 ndk.config.js 中的配置项调整编译打包配置,详情请看文件中的注释信息。

  • 开发完应用后,运行 ndk-build 命令进行代码编译打包。

老应用升级

  • 在应用根目录下,运行 ndk-init 命令进行应用升级,基本上按照提示一直下一步即可。

注意:

升级完成后请检查 ndk.config.js 中的 aliasentrytemplate 等配置项是否正确。

  • 升级完成后,运行 ndk-dev 命令即可启动开发环境进行编码工作。

注意:

如果启动失败或运行报错,请检查并调整 ndk.config.js 中配置项。

  • 最后,运行 ndk-build 命令进行代码编译打包。

代码检测

TODO

You can’t perform that action at this time.