Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Doesn’t read commonmark when included in unit testing

未关闭
#253 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
45/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
停滞
技术栈
javascript
领域
testing-qa

调研方向

先从 services/util/markdown.js 和 markdown.test.js 开始,然后检查 commonmark 在此项目中是如何向模块公开的。运行针对性测试,并确认该工具能够构建 parser 和 renderer,并为 “Hello world” 返回预期的 HTML。

由索引模型根据 Issue 内容生成。

描述

I create a util function that uses commonmark to convert markdown to HTML. And then I tried to write a test case for that function, it throws error saying that commonmark is not defined.

Here is my code:

markdown.test.js

const {markdownToHtml} = require('../../services/util/markdown');
const assert = require('assert');

describe('Commonmark plugin', () => {
  it('normal text returns HTML string', () => {
    assert.strictEqual(markdownToHtml('Hello world').toBe('<p>Hello world</p>\n'));
  });
});

markdown.js

const markdownToHtml = (text) => {
  const reader = new commonmark.Parser();
  const writer = new commonmark.HtmlRenderer({safe: true});

  const parsed = reader.parse(text); // parsed is a 'Node' tree
  // transform parsed if you like...
  const result = writer.render(parsed); // result is a String
  return result;
};

module.exports = {markdownToHtml};

I get the following error when I run the test:
ReferenceError: commonmark is not defined

主要语言
JavaScript
星标
1.6k
派生
234
平均合并
1 天 27 分钟
30 天内合并 PR
1

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

commonmark/commonmark.js 的其他 Issue

查看 commonmark/commonmark.js 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。