文件名称:doctest-js:在您的测试套件中运行JSDoc样式的文档示例作为测试
文件大小:182KB
文件格式:ZIP
更新时间:2024-05-22 07:45:03
hacktoberfest JavaScript
doctest-js 让您的文档成为您的测试套件。 在所有函数上编写样式的doc示例,然后使用doctest-js对其进行测试。 内容 入门 1.安装 npm install @supabase/doctest-js 2.编写@example注释 在要测试的任何函数上创建一个JSDoc风格的@example 。 /** * Returns the sum of 2 numbers * * @example sum(1, 2) * //=> 3 */ export const sum = ( a , b ) => { return a + b } 请注意,期望的返回值必须以//=>为前缀。 3.运行测试 在您的测试套件中导入doctest函数,并将其指向该文件。 import doctest from '@supabase/doctest-js' ; descri
【文件预览】:
doctest-js-master
----.gitignore(63B)
----.babelrc(39B)
----.eslintrc(121B)
----package.json(1KB)
----package-lock.json(383KB)
----src()
--------doctest.js(888B)
--------index.js(56B)
--------safe_eval.js(1022B)
--------doctest_parser.js(3KB)
----webpack.config.js(599B)
----dist()
--------index.js(274KB)
----LICENSE(1KB)
----.github()
--------FUNDING.yml(724B)
--------workflows()
----.prettierignore(7B)
----README.md(3KB)
----.eslintignore(16B)
----test()
--------doctest_parser_test.js(1KB)
--------support()
--------safe_eval_test.js(1KB)
--------doctest_test.js(1KB)
----.prettierrc(107B)