npm 包 github 使用教程

npm 是 node.js 的包管理工具,它允许开发者共享和重用代码。在使用 npm 的过程中,我们经常需要从 Github 上获取依赖包,本文将介绍如何在 npm 中使用 Github 上托管的依赖包,并提供一些示例代码。

步骤

1. 在 Github 上创建一个 npm 包仓库

首先,你需要在 Github 上创建一个用于存储 npm 包的仓库。这个仓库可以是公开的或私有的,根据你的需求进行选择。接下来,在仓库根目录下创建一个 package.json 文件,该文件描述了你的 npm 包的信息,例如名称、版本、作者、依赖等。示例:

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

2. 将仓库克隆到本地

使用 git 命令将刚才创建的仓库克隆到本地:

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

3. 发布到 npm

使用以下命令将包发布到 npm:

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

4. 在另一个项目中使用你的包

在另一个项目中使用你的包非常简单。只需要在该项目的 package.json 文件中添加你的包依赖,指定 git 地址和分支名:

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

然后使用以下命令进行安装:

--- -------

至此,你就可以在你的项目中使用你的 npm 包了。

示例代码

下面是一个基于 React 的示例组件,它从 Github 上获取数据并展示在页面上:

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

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

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

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

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

这个组件从 Github 上获取用户数据,并将其展示在页面上。在另一个项目中使用这个组件时,只需要在该项目的 package.json 文件中添加对你的包的依赖即可:

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

然后使用以下命令进行安装:

--- -------

最后,在你的项目中导入这个组件并使用它:

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

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

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

结论

在 npm 中使用 Github 上托管的依赖包非常简单。首先,创建一个用于存储 npm 包的 Github 仓库,并在其中添加 package.json 文件。然后将该仓库克隆到本地,并使用 npm 发布该包。

来源:JavaScript中文网 ,转载请注明来源 本文地址:https://www.javascriptcn.com/post/50456