npm 包 @union/react-schematics 使用教程

在现代的前端开发中,使用 CLI 工具能够提高研发效率和代码质量。而 Angular CLI 便是一个很好的例子。随着 React 生态不断壮大,React CLI 工具也愈发重要。@union/react-schematics 是基于 Angular Schematics,专门为 React 应用提供的脚手架工具。本文将为你介绍如何使用 @union/react-schematics,从创建项目到自定义生成器,详细讲解其使用方法。

安装

在使用 @union/react-schematics 之前,我们需要先全局安装 Angular Schematics。使用以下命令进行全局安装:

--- ------- -- ------------

接着,我们可以使用 npm 或 yarn 对 @union/react-schematics 进行本地化安装:

--- ------- -----------------------
- --- -----
---- --- -----------------------

安装完成之后,我们就可以通过运行以下命令来验证安装是否成功:

---------- ---------

创建项目

创建 React 项目与创建 Angular 项目类似,我们可以使用 Angular CLI 的命令来快速生成项目骨架。在命令行中,输入以下命令:

-- --- --------- ------------------------------------

这个命令会在当前目录下创建名为 react-app 的 React 应用程序。--collection 参数告诉 Angular CLI 使用 @union/react-schematics 的生成器集合。

生成器

@union/react-schematics 提供了多种生成器,可以帮助你快速创建 React 组件、redux 状态等。下面我们来学习如何使用这些生成器。

组件

使用以下命令可以快速创建 React 组件:

-- - --------------- ------

其中,<name> 是组件名称。为了更好地组织文件,可以使用前缀 _ 来告诉生成器将该组件放在指定目录下:

-- - --------------- -------------------------

这个命令会在 src/components/_common 目录下创建一个名为 Button 的组件,并为其创建组件文件、样式文件和测试文件。

在项目生成器中,你还可以通过以下方式为组件添加一些额外的设置:

-- - --------------- ------------------------- ------

这个命令将为组件创建一个使用 Sass 的样式文件。

Redux 状态

要为应用程序创建一个 Redux 状态,可以使用以下命令:

-- - ----------- ------------ --------- --------------

其中,<state-name> 是状态名称。--module 参数可以指定将状态添加到的模块,如果未指定,则会自动创建一个模块。

生成器会在 src/store 目录下创建一个状态文件,并在指定模块中导入该文件。

自定义生成器

如果现有的生成器无法满足你的需求,你可以使用 @union/react-schematics 提供的生成器生成器 (Generator Generator) 来生成自定义生成器。

首先,使用以下命令创建一个自定义生成器:

-- - --------- ------

这个命令会在 schematics/ 目录下创建名为 name 的目录,并在该目录中创建 index.ts 文件。

接着,打开 index.ts 文件,定义一个生成器:

------ - ----- ----------------- -------------------- ---- - ---- -----------------------------
------ - ------- - ---- -----------

------ ------- -------- --------- --------- ---- -
  ------ ------ ----- --------- ----------------- -- -
    -- --------------- -
      ----- --- --------------------------- ------ -- ------------
    -

    -- ----------

    ------ -----
  --
-

在这个示例中,我们定义了一个名为 name 的选项,并编写了一个验证逻辑,确保该选项不为空。

最后,在 collection.json 文件中注册你的自定义生成器:

-
  ---------- ------------------------------------------------------
  ------------- -
    ------- -
      -------------- ------- -----------
      ---------- -------------------
    -
  -
-

这个示例将自定义生成器注册到 name 生成器组中。

总结

本文介绍了如何使用 @union/react-schematics 创建 React 项目,并使用其提供的生成器,从组件到 Redux 状态,快速生成代码。同时,我们还演示了如何使用 @union/react-schematics 的生成器生成器来创建自定义生成器。相信通过学习这篇文章,你已经对 @union/react-schematics 有了更深入的了解,希望本文能够成为你学习和使用 React CLI 工具的有力指引。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/194454


猜你喜欢

  • npm 包 @types/styled-system 使用教程

    在前端开发领域,css 是一个非常重要的技术点。而在大型项目中,管理 css 变得越来越复杂。为了更好地管理 css,我们有一个非常流行的工具叫做 styled-component。

    5 年前
  • npm 包 @types/react-modal 使用教程

    前言 在前端开发中,我们经常会使用到各种 npm 包来提升开发效率,其中 @types/react-modal 就是一个优秀的类型声明库。它提供了 React Modal 组件的类型定义,使我们在使用...

    5 年前
  • npm 包 @stencil/react-output-target 使用教程

    Stencil 是一款 Web 组件库,由 Ionic Team 推出,可以编写 Web 组件并在多个框架中使用。其中,@stencil/react-output-target 是Stencil中的一...

    5 年前
  • npm 包 rfs 使用教程

    在前端开发中,响应式设计越来越普及,如何处理文本以适应不同大小的屏幕是每个 web 开发人员需要处理的问题之一。而 rfs 库则是专门解决响应字体大小的问题,本篇文章将介绍如何使用 rfs 库来实现响...

    5 年前
  • npm 包 mobile-select 使用教程

    前言 在移动设备上,我们经常需要使用下拉选择框来让用户选择一个选项。mobile-select 是一个针对移动设备的下拉选择框库,它提供了多种风格样式的下拉选择框,并且使用简单方便。

    5 年前
  • npm 包 nouislider 使用教程

    前言 在前端开发中,我们经常需要使用到各种各样的 UI 组件来满足我们的需求。nouislider 是一个可以用来实现滑块组件的 npm 包,它可以让用户通过滑块来选择范围,进行取值等操作。

    5 年前
  • npm 包 @types/nouislider 使用教程

    在前端开发中,我们通常需要使用各种 JavaScript 库和框架来进行快速开发。在这个过程中,我们常常会使用 npm 包管理器来安装和管理这些库。而在使用这些库时,通常需要对其进行类型声明以方便开发...

    5 年前
  • npm 包 @types/lodash.throttle 使用教程

    在前端开发中,使用lodash.throttle可以控制函数触发频率,进而提高网站性能。@types/lodash.throttle是lodash.throttle的typescript类型定义库,可...

    5 年前
  • npm 包 @types/dom-inputevent 使用教程

    简介 在前端开发中,我们经常需要获取用户输入的值,而用户输入可能是鼠标点击、键盘输入等,其中键盘输入又分为字符输入和按键输入。为了更方便地处理这些事件,JavaScript 提供了 InputEven...

    5 年前
  • npm 包 @clxx/base 使用教程

    简介 @clxx/base 是一个前端基础库,提供了一些常用的工具函数和方法,可以辅助开发者更高效地进行开发。该包可以通过 npm 安装和使用。 安装 使用 npm 进行安装: --- -------...

    5 年前
  • npm 包 docz-theme-default 使用教程

    简介 docz-theme-default 是一款基于 Docz 的默认主题,主要为开发者提供了一个易于使用、美观大方的文档生成工具。本教程旨在向前端开发者介绍如何使用 docz-theme-defa...

    5 年前
  • npm 包 docz 使用教程

    在前端开发中,文档化开发已经成为一种通行的开发范式,来帮助我们更好地管理我们的代码和文档。但是,写文档也是一项技能,书写过程有时候会十分繁琐乏味。而 npm 包中也有一款非常优秀的文档工具 docz,...

    5 年前
  • npm 包 @class101/tslint-config 使用教程

    前言 @class101/tslint-config 是一个基于 TSLint 的 TypeScript 代码风格检查规则集,适用于前端和后端的 TypeScript 项目。

    5 年前
  • npm 包 @class101/eslint-config 使用教程

    在现代的前端开发中,代码的质量和可维护性越来越被重视。为了保证代码的质量,我们需要使用代码检查工具来检查我们的代码是否符合一定的规范。ESLint 是目前最流行和使用广泛的 JavaScript 代码...

    5 年前
  • npm 包 Swiper 使用教程

    介绍 Swiper 是一个流行的现代化滑动框架,它允许您在您的应用程序中添加各种类型的滑动效果,例如轮播图、切换效果、橫向滑動、毛玻璃效果等等。由于它已经成为了前端开发中不可缺少的一部分,因此在此我们...

    5 年前
  • npm 包 @ui-guys/stencil-markdown 使用教程

    介绍 @ui-guys/stencil-markdown 是一个使用 Markdown 格式编写文本,并将其转换为 Stencil Web Component 的 npm 包。

    5 年前
  • npm 包 @divsbhalala/video-js-thumbnails 使用教程

    简介 @divsbhalala/video-js-thumbnails 是一款基于 Video.js 的 npm 包,用于在视频播放器中显示缩略图预览。它提供了丰富的配置选项,能够让用户自定义缩略图的...

    5 年前
  • npm 包 tooltip.js 使用教程

    在前端开发中,tooltip 是一个常用的 UI 组件,它可以帮助我们在鼠标悬停在某个元素上时显示出一些提示信息。而在 Node.js 的世界中,我们可以通过使用 npm 包来快速集成 tooltip...

    5 年前
  • npm 包 Megamark 使用教程

    介绍 由于传统的 Markdown 存在一些限制,如不支持 html 标签、不支持表格等,而 Megamark 是为了解决这些限制而产生的一个 npm 包。它不仅支持原生的 Markdown 语法,还...

    5 年前
  • npm 包 domador 使用教程

    简介 domador 是一个方便快捷的 DOM 操作库,可用于在 web 应用程序中处理各种 DOM 操作。domador 使得执行诸如创建,更新或移除 DOM 元素之类的操作变得更加容易。

    5 年前

相关推荐

    暂无文章