npm 包 Whitesource 使用教程

阅读时长 5 分钟读完

什么是 Whitesource

Whitesource 是一家领先的开源自动化管理平台,致力于为软件公司和开发人员提供综合性的自动化管理解决方案,包括开源代码管理、风险评估与监视、安全合规、托管软件库等等。Whitesource 能够帮助开发人员快速准确地了解软件代码存在的安全漏洞和洞隙,进而为软件开发过程提供意见,以帮助开发人员更好地管理和保护自己的软件。

Whitesource 的功能

  1. 自动跟踪和审核开源组件
  2. 挖掘你项目中的风险和漏洞
  3. 监视漏洞并独立修补

Whitesource 的安装和使用

安装

安装 Whitesource 所需的 npm 包相当简单,在终端或命令行工具中输入以下命令:

使用

当安装完成后,使用 Whitesource 首先要在代码中引入它,使用以下语句引用即可:

配置

在使用 Whitesource 之前,你需要向 Whitesource 进行注册,注册后你将获得一份访问令牌,使用步骤如下:

  1. 访问 Whitesource 的官网,进入注册页面,完善相关信息并提交注册申请。

  2. 注册成功后,Whitesource 将会通知你的管理员以创建你的组织账户,并向你发送一份访问令牌。

  3. 你需要使用以下代码在你的项目源码中加载令牌:

  4. Whitesource 在启动时将会向服务器验证令牌,如果认证失败将会返回错误代码。

示例

下面给出一个使用 Whitesource 的示例,这个示例将目录中的所有 Java 文件添加到扫描列表中,并解析获取到的组件得分:

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

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

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

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

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

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

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

以上代码将会扫描当前目录及其子目录中的所有 Java 文件,并使用 Whitesource 对它们进行静态代码分析,解析得到组件得分。

Whitesource 的学习和指导意义

Whitesource 是一款全面的开源代码管理解决方案,对于开发人员来说,它既可以提供全面的代码开发过程的自动化管理解决方案,又能够从多个角度监测源代码质量,防止代码出现风险漏洞。因此,对于前端开发人员来说,了解 Whitesource 的使用方法以及相关的编程技巧,在实际开发中都具有很大的学习和指导意义。

总体来说,如果你想要保证自己的开发过程更加的严谨和优质,那么你一定不应该错过 Whitesource。无论是在代码质量分析,还是在漏洞检测方面,它都将会为你提供有力的支持,同时也会帮助你避免很多可能会出现的风险事件。

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

纠错
反馈