Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/browserify/commonjs-assert

Node.js's require('assert') for all engines
https://github.com/browserify/commonjs-assert

assert browserify javascript node-shim nodejs

Last synced: 2 days ago
JSON representation

Node.js's require('assert') for all engines

Host: GitHub
URL: https://github.com/browserify/commonjs-assert
Owner: browserify
License: mit
Created: 2013-11-20T20:04:10.000Z (almost 11 years ago)
Default Branch: main
Last Pushed: 2023-09-07T20:12:39.000Z (about 1 year ago)
Last Synced: 2024-11-08T21:03:05.373Z (6 days ago)
Topics: assert, browserify, javascript, node-shim, nodejs
Language: JavaScript
Homepage:
Size: 220 KB
Stars: 298
Watchers: 9
Forks: 58
Open Issues: 6
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: .github/SECURITY.md

Awesome Lists containing this project

README

# assert

> The [`assert`](https://nodejs.org/api/assert.html) module from Node.js, for the browser.

[![Build Status](https://travis-ci.org/browserify/commonjs-assert.svg?branch=master)](https://travis-ci.org/browserify/commonjs-assert)
[![npm](https://img.shields.io/npm/dm/assert.svg)](https://www.npmjs.com/package/assert)
[![npm](https://img.shields.io/npm/v/assert.svg)](https://www.npmjs.com/package/assert)

With browserify, simply `require('assert')` or use the `assert` global and you will get this module.

The goal is to provide an API that is as functionally identical to the [Node.js `assert` API](https://nodejs.org/api/assert.html) as possible. Read the [official docs](https://nodejs.org/api/assert.html) for API documentation.

## Install

To use this module directly (without browserify), install it as a dependency:

```
npm install assert
```

## Inconsistencies with Node.js `assert`

Due to differences between browsers, some error properties such as `message` and `stack` will be inconsistent. However the assertion behaviour is as close as possible to Node.js and the same error `code` will always be used.

## Usage with bundlers that don't automatically include polyfills for Node.js APIs

Bundlers like `webpack 5` and `Vite.js` (and possibly others) don't automatically include polyfills for Node.js APIs. Like most packages on npm, this module depends on other Node.js APIs, so it won't work with these bundlers without also including a polyfill for the `process` Node.js global. You can use [this library](https://github.com/defunctzombie/node-process) to polyfill the `process` global.

Note that this is not a flaw in this package - this package will work without any manual configuration with `browserify` and `webpack 4` and other working bundlers. Unfortunately, some bundlers decided to require an explicit allow-list of all Node.js API specific packages instead of having them work out of the box, hence the incompatibility. See https://github.com/browserify/commonjs-assert/issues/55 for some more context.

## Contributing

To contribute, work on the source files. Then build and run the tests against the built files. Be careful to not introduce syntax that will be transpiled down to unsupported syntax. For example, `for...of` loops will be transpiled to use `Symbol.iterator` which is unavailable in IE.

### Build scripts

#### `npm run build`

Builds the project into the `build` dir.

#### `npm run dev`

Watches source files for changes and rebuilds them into the `build` dir.

#### `npm run test`

Builds the source files into the `build` dir and then runs the tests against the built project.

#### `npm run test:nobuild`

Runs the tests against the built project without rebuilding first.

This is useful if you're debugging in the transpiled code and want to re-run the tests without overwriting any changes you may have made.

#### `npm run test:source`

Runs the tests against the unbuilt source files.

This will only work on modern Node.js versions.

#### `npm run test:browsers`

Run browser tests against the all targets in the cloud.

Requires airtap credentials to be configured on your machine.

#### `npm run test:browsers:local`

Run a local browser test server. No airtap configuration required.

When paired with `npm run dev` any changes you make to the source files will be automatically transpiled and served on the next request to the test server.

## License