
Security News
Crates.io Implements Trusted Publishing Support
Crates.io adds Trusted Publishing support, enabling secure GitHub Actions-based crate releases without long-lived API tokens.
做好单元测试是保证代码质量的有效手段。这里介绍一种用示例代码转为测试用例的工具。 这样做可以降低写测试用例的学习和使用成本。
通常在示例代码中我们会用注释给出一个输出预判。
var a = 1;
var b = 2;
console.log(a === b); // false
这样方便复制到控制台编辑运行。
如果写测试用例就会这样:
var a = 1;
var b = 2;
assert.equal(a === b, false);
可以看出来:示例代码和测试代码都有一个输出预判!
那么为何不能用示例代码写测试用例呢?也就是做一下简单的转换即可。
只要做简单的约定就能达到,分别是:
jsdoc
中用 @example
标记,例如:
/**
* @example xxyy
* var a = 1;
* var b = 2;
* console.log(a === b); // false
*/
但这种每行都有 *
的代码,复制粘贴后还需要清理一次,所以我倾向于这种:
/**
* @example xxyy
var a = 1;
var b = 2;
console.log(a === b); // false
*/
为区分运行环境,所以得指定语言,如:
/**
* @example xxyy
```js
var a = 1;
var b = 2;
console.log(a === b); // false
```
*/
/**
* @example 表达式相等预判
```js
var a = 1;
var b = 2;
console.log(a === b);
// > false
```
*/
/**
* @example 表达式结果预判
```js
var a = 1;
var b = 2;
console.log(a + b);
// > 3
```
*/
/*
* @example 表达式类型预判
```js
var a = 1;
console.log(JSON.stringify(a + '1'));
// > "11"
```
*/
/*
* @example 批量表达式预判
```js
for (var i = 0; i < 5; i++) {
console.log(i);
}
// > 0
// > 1
// > 2
// > 3
// > 4
```
*/
/*
* @example 异步执行预判
```js
var a = 1;
setTimeout(function () {
console.log(a);
// > 2
// * done
}, 1000);
a++;
```
*/
/*
* @example 异常执行预判
```js
var a = JSON.parse('#error');
// * throw
```
*/
/*
* @example 浏览器环境
```html
<div></div>
```
```js
console.log(document.querySelector('div') !== null);
// > true
```
*/
/*
* @example jQuery
```css
.red {
background-color: red;
}
```
```html
<div class="red"></div>
<script src="https://code.jquery.com/jquery-3.1.0.min.js"></script>
```
```js
$(function () {
console.log($('.red').css('background-color'));
// > red
// * done
})
```
*/
$ npm install examplejs -g
$ examplejs main.js -o test/main.test.js
var examplejs = require('gulp-examplejs');
gulp.task('example-js', function() {
return gulp.src('src/**.js')
.pipe(examplejs({
head: 'head.js'
}))
.pipe(gulp.dest('test'));
});
MIT © zswang
FAQs
A tool for converting example code into test cases
The npm package examplejs receives a total of 15 weekly downloads. As such, examplejs popularity was classified as not popular.
We found that examplejs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Crates.io adds Trusted Publishing support, enabling secure GitHub Actions-based crate releases without long-lived API tokens.
Research
/Security News
Undocumented protestware found in 28 npm packages disrupts UI for Russian-language users visiting Russian and Belarusian domains.
Research
/Security News
North Korean threat actors deploy 67 malicious npm packages using the newly discovered XORIndex malware loader.