npm 包 @akitecht/workshopper 使用教程

在前端开发的过程中,我们经常需要学习新的技能和知识。而学习过程中,我们可能需要一些指导和练习。因此,很多开发者会选择使用交互式教程平台,比如 Codecademy

同样地,对于学习前端开发的人来说, @akitecht/workshopper 是一个非常好的 npm 包。这个包可以通过一个非常简单的方式来提供交互式教程。本篇文章将会详细介绍 npm 包 @akitecht/workshopper 的使用方法以及实际示例。

@akitecht/workshopper 是什么?

@akitecht/workshopper 是一个基于 Node.js 开发的 npm 包,它可以提供交互式教程。这样一来,学习者可以在练习的同时,通过不断的反馈来加深对知识点的理解。

使用 @akitecht/workshopper ,可以很方便地创建属于自己的教程,并能够随着需求的变化不断的更新它们。

安装 npm 包 @akitecht/workshopper

在使用 @akitecht/workshopper 之前,需要确保 Node.js 已经被正确安装。可以通过以下命令检查 Node.js 是否安装成功:

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

如果输出了当前 Node.js 版本号,那么说明 Node.js 已经被正确安装了。接下来,就可以通过命令行工具来安装 @akitecht/workshopper

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

常用命令:

  • workshopper list :列出所有的教程包
  • workshopper select :选择要做的教程包
  • workshopper start :开始教程

创建一个教程

创建教程分为两部分:

  1. 创建教程的题目/练习 (大量使用文本)

  2. 编写代码验证练习题答案

接下来,我们将分别介绍这两个步骤。

创建教程的练习

我们先通过一个简单的例子,来介绍 @akitecht/workshopper 的练习创建方式。为了演示方便,我们创建一个简单的练习,用于计算两个数字的和。打开命令行工具,执行以下命令:

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

该命令会要求输入一些信息。根据提示,输入以下信息:

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

接着,@akitecht/workshopper 会自动生成一个练习的模板。打开 exercises/add-numbers/problem.md,该文件包含了练习的标题、说明、问题和答案等信息。

修改 problem.md,将题目内容改为 "输入两个数字,然后求它们的和。"。将答案改为以下内容:

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

接下来,我们需要更新 package.json 文件。将 workshopper-adventure 替换为 @akitecht/workshopper

package.json 中添加以下代码:

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

编写代码验证练习题答案

练习的题目和答案已经准备好了,接下来需要编写代码对答案进行验证。打开 exercises/add-numbers/verify.js,以下是需要输入其中的代码:

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

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

这里,我们首先导入 verifysolution 函数。然后,将 input (用户输入的内容)通过字符串的 .split() 方法,将其转换为数值。

最后,我们与预期的答案比较。如果比较结果是 true,则意味着用户输入的答案正确。反之,如果比较结果是 false,则提示用户输入有误。

save 和 test 一下。可以看到交互式教程已经可以跑起来了,执行以下命令查看效果:

----------- ----
  • learn-you-node : "Learn You The Node.js For Much Win!"
  • add-numbers     : "输入两个数字,然后求它们的和"

可以看到添加的 add-numbers 教程已经被列出来了。执行以下命令,开始做练习:

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

然后就可以愉快的练习了。

结论

以上是 @akitecht/workshopper 的基本用法,希望本文对你有所帮助。如果你有其他的学习方法或者建议,欢迎在评论区中分享。

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


猜你喜欢

  • npm 包 @mixint/bytepipette 使用教程

    在前端开发过程中,我们经常需要对图像进行操作,比如缩放、剪裁、调整亮度、对比度等等。BytePipette 是一个专为前端设计的图像处理库,它提供了丰富的 API,方便我们快速实现图像处理的需求。

    3 年前
  • npm 包 rails-nodejs 使用教程

    前言 Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境,许多现代 web 应用程序都是基于 Node.js 构建的,同时也有着丰富的 npm 包库支持,而 Rai...

    3 年前
  • npm包react-native-animated-dialog使用教程

    在现代化的web开发过程中,移动端应用程序已成为不可或缺的一部分。这就导致开发人员需要为多个平台创建许多应用程序。React Native是一种用于开发跨平台移动应用的工具,其中,npm包react-...

    3 年前
  • npm 包 retry-assert 使用教程

    在前端开发中,我们经常会遇到需要对某些操作进行重试的情况,比如网络请求失败、数据库连接超时等。通常情况下,我们需要手动编写重试逻辑,这不仅费时费力,而且容易出错。在这种情况下,npm 包 retry-...

    3 年前
  • npm 包 yarn-workspace-commands 使用教程

    现代的前端项目通常由多个子项目组成,这些子项目各自拥有自己的代码库和依赖管理。管理这么多子项目会给我们带来一定的困难,例如如何一次性地安装所有依赖、如何快速地启动多个开发服务器等等。

    3 年前
  • npm 包 @nelreina/react-hooks 使用教程

    在前端开发中,我们经常会使用到各种各样的框架和库来提高开发效率。而在现代的 React 应用中,我们可以通过使用 Hooks 充分利用函数式编程的特性,让代码更加简洁明了。

    3 年前
  • NPM 包 vapor-cli 使用教程

    介绍 vapor-cli 是一个基于 Node.js 和 Vapor 框架的命令行工具,用于快速搭建和开发 Swift 服务器端应用程序。它提供了一系列的命令,可以帮助我们创建、运行和管理 Vapor...

    3 年前
  • npm 包 bz-mailer 使用教程

    简介 bz-mailer 是一个 Node.js 的 npm 包,它提供了一个简单易用的接口,让你能够通过 Node.js 应用程序发送电子邮件。bz-mailer 包含了多个常用邮件服务商(如 Gm...

    3 年前
  • npm 包 handlebars-subresource-integrity 使用教程

    在前端开发中,我们经常使用模板引擎来生成 HTML 页面。Handlebars 是一款非常流行的模板引擎,它允许我们在 HTML 中嵌入 JavaScript 代码以及通过数据来自动生成 HTML。

    3 年前
  • npm 包 aerijo-test 使用教程

    前言 前端开发工作中有许多需要自动化的部分,例如测试。为了使测试更加方便和高效,我们可以使用一些测试工具或测试框架。npm 包 aerijo-test 就是其中一种可以帮助前端开发人员更加愉悦地进行测...

    3 年前
  • npm 包 gs-plugin 使用教程

    在前端开发中,通过使用 npm 包可以更加便捷地管理依赖项和进行开发。gs-plugin 是一款前端开发用的 npm 包,它提供了一些实用的工具以加速前端开发的进度。

    3 年前
  • npm 包 object-predicate 使用教程

    前言 在前端开发中,经常需要对一个对象或者数组进行筛选或者过滤,这时可以用到 object-predicate 这个 npm 包。object-predicate 是一个小巧的库,可以快速且方便地进行...

    3 年前
  • npm包rayyen使用教程

    前言 在前端开发领域,npm (Node Package Manager) 是至关重要的一环。它是一个包管理工具,用于添加、更新和维护 JavaScript 库和工具。

    3 年前
  • Nuxt_Prismic: 一个方便的 Prismic 集成

    如果您正在寻找一个简单易用的 Prismic 集成框架,那么 nuxt_prismic 就是你的不二之选。 nuxt_prismic 是一个为 Nuxt.js 框架提供的 Prismic 集成方法。

    3 年前
  • npm 包 testcafe-reporter-slack-errors-only 使用教程

    前言 在前端开发中,自动化测试时,我们经常需要将测试结果及时反馈给开发和测试团队。而 TestCafe 是一个用于 Web 应用程序自动化测试的工具,它可以在多个浏览器和平台上运行测试并生成报告。

    3 年前
  • npm 包 angular7-csv 使用教程

    简介 npm 包 angular7-csv 是一个用于处理 CSV 文件的 Angular 7 模块。使用该模块可以方便地将数据以 CSV 格式导出或导入。 安装 在使用 angular7-csv 之...

    3 年前
  • npm 包 ci-ui-base 使用教程

    前言 在前端开发中,我们常常需要使用一些 UI 组件库来实现页面的布局和美化。ci-ui-base 就是一种常用的 UI 组件库,它包含了很多常见的 UI 组件,如按钮、表格、表单等等,可以大大地提高...

    3 年前
  • npm 包 react-use-former 使用教程

    1. 背景 在使用 React 开发 web 程序时,我们经常需要使用表单来收集用户的输入信息。React 中如何实现表单处理呢? 使用 React 可以手动处理表单,但是这样的代码相对比较冗杂,而且...

    3 年前
  • npm包Typing-Music使用教程

    简介 Typing-Music 是一个 npm 包,它为用户提供了一种全新的打字体验,能够加强打字技能。本文将通过对 Typing-Music 的介绍和使用指南,帮助读者更好地了解和使用它。

    3 年前
  • npm 包 vue-mixed-props 使用教程

    在 Vue 组件中,我们经常需要在 props 中定义多个类型的参数,比如 String、Number、Array 或者 Object。在项目逐渐复杂的情况下,这些类型在组件中的使用也会变得越来越复杂...

    3 年前

相关推荐

    暂无文章