https://github.com/unassert-js/unassert-cli
CLI for unassert: encourage reliable programming by writing assertions in production code, and compiling them away from release
https://github.com/unassert-js/unassert-cli
Last synced: 4 months ago
JSON representation
CLI for unassert: encourage reliable programming by writing assertions in production code, and compiling them away from release
- Host: GitHub
- URL: https://github.com/unassert-js/unassert-cli
- Owner: unassert-js
- License: mit
- Created: 2016-01-26T14:35:22.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-01-09T09:40:51.000Z (over 3 years ago)
- Last Synced: 2025-09-30T20:55:39.568Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 186 KB
- Stars: 12
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
unassert-cli
================================
CLI for [unassert](https://github.com/unassert-js/unassert). Provides `unassert` command which compiles assertions away from target file.
[![unassert][unassert-banner]][unassert-url]
[![Build Status][ci-image]][ci-url]
[![NPM version][npm-image]][npm-url]
[![Code Style][style-image]][style-url]
[![License][license-image]][license-url]
#### RELATED MODULES
- [unassert](https://github.com/unassert-js/unassert): Encourages programming with assertions by providing tools to compile them away.
- [unassertify](https://github.com/unassert-js/unassertify): Browserify transform for unassert
- [babel-plugin-unassert](https://github.com/unassert-js/babel-plugin-unassert): Babel plugin for unassert
- [webpack-unassert-loader](https://github.com/unassert-js/webpack-unassert-loader): Webpack loader for unassert
- [gulp-unassert](https://github.com/unassert-js/gulp-unassert): Gulp plugin for unassert
- [rollup-plugin-unassert](https://github.com/unassert-js/rollup-plugin-unassert): RollupJS plugin for unassert
CHANGELOG
---------------------------------------
See [CHANGELOG](https://github.com/unassert-js/unassert-cli/blob/master/CHANGELOG.md)
EXAMPLE
---------------------------------------
For given `math.js` below,
```javascript
'use strict';
const assert = require('node:assert/strict');
function add (a, b) {
console.assert(typeof a === 'number');
assert(!isNaN(a));
assert.equal(typeof b, 'number');
assert.ok(!isNaN(b));
return a + b;
}
```
Install `unassert` command, run it and redirect its output into file.
```
$ npm install -g unassert-cli
$ unassert /path/to/src/math.js > /path/to/dist/math.js
```
Then you will see assert calls in `/path/to/dist/math.js` disappear.
```javascript
'use strict';
function add(a, b) {
return a + b;
}
```
See [unassert](https://github.com/unassert-js/unassert) project for more documentation.
INSTALL
---------------------------------------
### via npm
Install globally,
$ npm install -g unassert-cli
and/or locally.
$ npm install --save-dev unassert-cli
USAGE
---------------------------------------
```
$ unassert /path/to/src/target.js > /path/to/build/target.js
```
```
$ cat /path/to/src/target.js | unassert > /path/to/build/target.js
```
OUR SUPPORT POLICY
---------------------------------------
We support Node under maintenance. In other words, we stop supporting old Node version when [their maintenance ends](https://github.com/nodejs/LTS).
This means that any other environment is not supported.
NOTE: If unassert-cli works in any of the unsupported environments, it is purely coincidental and has no bearing on future compatibility. Use at your own risk.
AUTHOR
---------------------------------------
* [Takuto Wada](https://github.com/twada)
LICENSE
---------------------------------------
Licensed under the [MIT](https://github.com/unassert-js/unassert-cli/blob/master/LICENSE) license.
[unassert-url]: https://github.com/unassert-js/unassert
[unassert-banner]: https://raw.githubusercontent.com/unassert-js/unassert-js-logo/master/banner/banner-official-fullcolor.png
[npm-url]: https://npmjs.org/package/unassert-cli
[npm-image]: https://badge.fury.io/js/unassert-cli.svg
[ci-url]: https://github.com/unassert-js/unassert-cli/actions?query=workflow%3A%22Node.js+CI%22
[ci-image]: https://github.com/unassert-js/unassert-cli/workflows/Node.js%20CI/badge.svg
[style-url]: https://github.com/standard/semistandard
[style-image]: https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg
[license-url]: https://github.com/unassert-js/unassert-cli/blob/master/LICENSE
[license-image]: https://img.shields.io/badge/license-MIT-brightgreen.svg