首页 > 解决方案 > 将 Docusaurus v2 部署到 GitHub 页面时,Travis CI 中未定义 Jest

问题描述

我目前正在 GitHub 页面上设置 Docusaurus v2 站点。我为自己的组件编写了自己的 Jest 和 Enzyme 测试。目前 Jest 被列为 adevDependency和 my.travis.yml如下:

# .travis.yml
language: node_js
node_js:
  - '10'
branches:
  only:
    - master
cache:
  npm: true
install:
  npm i
script:
  - git config --global user.name "${GH_NAME}"
  - git config --global user.email "${GH_EMAIL}"
  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
  - npm t && GIT_USER="${GH_NAME}" npm run deploy

我已经更新了我的package.jsonscrips 部分以调用 jest 相对于node_modules这样的:

"test": "cross-env NODE_ENV=test ./node_modules/jest/bin/jest.js --detectOpenHandles"

这在 travis 中运行得非常好,我看到我所有的测试都通过了。我遇到的问题是当它尝试将站点部署到 GitHub 页面时,如:scripts部分的最后一行所示。我随后收到以下错误:.travis.ymlnpm t && GIT_USER="${GH_NAME}" npm run deploy

ReferenceError: jest is not defined
(undefined) ReferenceError: jest is not defined
    at Module.module.exports.Object.defineProperty.value (main:26124:1)
    at __webpack_require__ (main:21:30)
    at Promise.resolve.then (main:79206:682)
Error: Failed to compile with errors.
    at compiler.run (/home/travis/build/myorg/myrepository/node_modules/@docusaurus/core/lib/commands/build.js:37:24)
    at finalCallback (/home/travis/build/myorg/myrepository/node_modules/webpack/lib/MultiCompiler.js:254:12)
    at runWithDependencies.err (/home/travis/build/myorg/myrepository/node_modules/webpack/lib/MultiCompiler.js:277:6)
    at done (/home/travis/build/myorg/myrepository/node_modules/neo-async/async.js:2931:13)
    at runCompilers (/home/travis/build/myorg/myrepository/node_modules/webpack/lib/MultiCompiler.js:181:48)
    at err (/home/travis/build/myorg/myrepository/node_modules/webpack/lib/MultiCompiler.js:188:7)
    at compiler.run (/home/travis/build/myorg/myrepository/node_modules/webpack/lib/MultiCompiler.js:270:7)
    at finalCallback (/home/travis/build/myorg/myrepository/node_modules/webpack/lib/Compiler.js:257:39)
    at hooks.done.callAsync.err (/home/travis/build/myorg/myrepository/node_modules/webpack/lib/Compiler.js:273:13)
    at AsyncSeriesHook.eval [as callAsync] (eval at create (/home/travis/build/myorg/myrepository/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:42:1)
    at AsyncSeriesHook.lazyCompileHook (/home/travis/build/myorg/myrepository/node_modules/tapable/lib/Hook.js:154:20)
    at onCompiled (/home/travis/build/myorg/myrepository/node_modules/webpack/lib/Compiler.js:271:21)
    at hooks.afterCompile.callAsync.err (/home/travis/build/myorg/myrepository/node_modules/webpack/lib/Compiler.js:681:15)
    at AsyncSeriesHook.eval [as callAsync] (eval at create (/home/travis/build/myorg/myrepository/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:6:1)
    at AsyncSeriesHook.lazyCompileHook (/home/travis/build/myorg/myrepository/node_modules/tapable/lib/Hook.js:154:20)
    at compilation.seal.err (/home/travis/build/myorg/myrepository/node_modules/webpack/lib/Compiler.js:678:31)
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! my-repository@1.0.0 deploy: `docusaurus deploy`
npm ERR! Exit status 1
npm ERR! 
npm ERR! Failed at the my-repository@1.0.0 deploy script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

我可能是错的,但我相信这是因为我的测试被部署为代码库的一部分,并且开玩笑的是,devDependency它在这个阶段不存在;因此,当它在我的文件中使用时,webpack 找不到它*.spec.js,即jest.mock(...). 因此,我认为将 jest 添加为正常依赖项可以解决此问题,尽管您可以理解这既不理想也不是正确的方法。作为参考,我没有我的测试文件__TESTS__或任何形式的测试目录。当我遵循容器模式时,我的所有规范文件都与他们正在测试的内容相邻。其结构与此类似:

components
  - Header
    - HeaderComponent.js
    - HeaderComponent.spec.js
    - HeaderContainer.js
    - HeaderContainer.spec.js
    - Header.module.css

快速旁注: 由于反应钩子,并不是我所有的组件都有容器,但有些组件确实使用了多个状态、事件处理程序等;在这些情况下,我觉得将它们分成一个容器更干净。

除了让 jest 成为常规依赖项之外,我还有更好的方法来解决这个问题吗?我之后的设置是:

  1. 用户提出拉取请求并 Travis 构建分支(仅传递要合并的 PR)。
  2. 一旦 PR 登陆 master Travis 就会运行上面的脚本并部署到 Github 页面。

任何帮助将非常感激 :)

标签: reactjsjestjstravis-cigithub-pagesdocusaurus

解决方案


Docusaurus 维护者在这里!

奇怪的是 webpack 正在获取测试文件。您是否将组件放在页面目录中?如果是这样,它可能会导致 Docusaurus 认为测试是页面本身。

你的回购是公开的吗?分享它肯定会有所帮助。里面的所有 JS 文件src/pages都会变成路由,所以请确保里面的所有 JS 文件src/pages都可以变成页面并导出一个 React 组件。您的components目录不在src/pages. 它应该在src/components.


推荐阅读