Do things in development and nothing otherwise
npm install devlop[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
Some tools to make developing easier while not including code in production.
* What is this?
* When should I use this?
* Install
* Use
* API
* [deprecate(fn, message[, code])](#deprecatefn-message-code)
* [equal(actual, expected[, message])](#equalactual-expected-message)
* [ok(value[, message])](#okvalue-message)
* unreachable(message?)
* Types
* Compatibility
* Security
* Related
* Contribute
* License
This package lets you do things in development that are free in production.
It contains useful assert functions and a deprecate function that are
useful when developing JavaScript packages while being small in production.
If you know Rust, you might know how nice having a
[debug_assert!][rust-debug-assert] is.
This is that, and a bit more.
For more on why they’re nice, see
[“Rust’s Two Kinds of ‘Assert’ Make for Better Code”][rust-two-kinds]
Many JavaScript programs do not use assertions at all (perhaps because they’re
typed and so assume type safety) or include lots of code to throw errors when
users do weird things (weighing down production code).
This package hopes to improve the sitation by making assertions free and
deprecations cheap.
This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:
``sh`
npm install devlop
In Deno with [esm.sh][esmsh]:
`js`
import {deprecate, equal, ok, unreachable} from 'https://esm.sh/devlop@1'
// For development code:
// import {deprecate, equal, ok} from 'https://esm.sh/devlop@1?conditions=development'
In browsers with [esm.sh][esmsh]:
`html`
Say we have a small ponyfill for the ES5 String#includes function.String#includes
It’s deprecated, because folks can use nowadays.
It’s nicely typed so users should be able to figure out what to pass but we
include assertions to show nicer errors when they get it wrong.
example/string-includes.js:
`js
import {deprecate, ok} from 'devlop'
export const stringIncludes = deprecate(
includes,
'Since ES5, please use String#includes itself.'
)
/**
* @deprecated
* Since ES5, please use String#includes itself.0
* @param {string} value
* Value to search in.
* @param {string} search
* Value to search for.
* @param {number | undefined} [position=0]
* Position to search from (default: ).value
* @returns {boolean}
* Whether the searched for value exists in the searched value after position.
*/
function includes(value, search, position) {
ok(typeof value === 'string', 'expected string for ')search
ok(typeof search === 'string', 'expected string for ')`
ok(position === undefined || typeof position === 'number', 'expected number')
ok(
position === undefined ||
(typeof position === 'number' &&
!(/ #__PURE__ / Number.isNaN(position))),
'expected number'
)
// eslint-disable-next-line unicorn/prefer-includes
return value.indexOf(search, position || 0) !== -1
}
example/index.js:
`js
import {stringIncludes} from './example-includes.js'
console.log(stringIncludes('blue whale', 'dolphin')) //=> false
console.log(stringIncludes('blue whale', 'whale')) //=> true
`
Say we’d bundle that in development with [esbuild][esbuild] and check thegzip-size-cli
gzip size ([][gzip-size-cli]), we’d get 1.02 kB of code:
`sh`
$ esbuild example/index.js --bundle --conditions=development --format=esm --minify --target=es2022 | gzip-size
1.02 kB
But because devlop is light in production we’d get:
`sh`
$ esbuild example/index.js --bundle --format=esm --minify --target=es2022 | gzip-size
169 B
The bundle looks as follows:
`jsString#includes
function u(n){return n}var r=u(c,"Since ES5, please use itself.");function c(n,t,e){return n.indexOf(t,e||0)!==-1}console.log(r("blue whale","dolphin"));console.log(r("blue whale","whale"));`
It depends a bit on which bundler and minifier you use how small the code is:
esbuild keeps the unused message parameter to the deprecate function aroundNumber.isNaN
and does not know can be dropped without a / #__PURE__ /
annotation.
[rollup][rollup] with [@rollup/plugin-node-resolve][node-resolve]@rollup/plugin-terser
and [][terser] performs even better:
`sh`
$ rollup example/index.js -p node-resolve -p terser | gzip-size
118 B
The bundle looks as follows:
`js`
const l=function(l,e,o){return-1!==l.indexOf(e,o||0)};console.log(l("blue whale","dolphin")),console.log(l("blue whale","whale"));
Rollup doesn’t need the / #__PURE__ / comment either!
This package exports the identifiers [deprecate][api-deprecate],equal
[][api-equal], [ok][api-ok], and [unreachable][api-unreachable].
There is no default export.
The export map supports the [development condition][node-condition].node --conditions development module.js
Run to get dev code.
Without this condition, no-ops are loaded.
Wrap a function or class to show a deprecation message when first called.
> 👉 Important: only shows a message when the development condition is
> used, does nothing in production.
When the resulting wrapped fn is called, emits a warning once toconsole.error (stderr).
If a code is given, one warning message will be emitted in total per code.
###### Parameters
* fn (Function)message
— function or class
* (string)code
— message explaining deprecation
* (string, optional)
— deprecation identifier (optional); deprecation messages will be generated
only once per code
###### Returns
Wrapped fn.
Assert deep strict equivalence.
> 👉 Important: only asserts when the development condition is used, does
> nothing in production.
###### Parameters
* actual (unknown)expected
— value
* (unknown)message
— baseline
* (Error or string, default: 'Expected values to be deeply
equal')
— message for assertion error
###### Returns
Nothing (undefined).
###### Throws
Throws (AssertionError) when actual is not deep strict equal to expected.
Assert if value is truthy.
> 👉 Important: only asserts when the development condition is used, does
> nothing in production.
###### Parameters
* actual (unknown)message
— value to assert
* (Error or string, default: 'Expected value to be truthy')
— message for assertion error
###### Returns
Nothing (undefined).
###### Throws
Throws (AssertionError) when value is falsey.
Assert that a code path never happens.
> 👉 Important: only asserts when the development condition is used,
> does nothing in production.
###### Parameters
* message (Error or string, default: 'Unreachable')
— message for assertion error
###### Returns
Never (never).
###### Throws
Throws (AssertionError), always.
This package is fully typed with [TypeScript][].
It exports no additional types.
This project is compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line, devlop@^1,
compatible with Node.js 16.
This package is safe.
* babel-plugin-unassert
— encourage reliable programming with assertions while compiling them away
in production (can remove arbitrary assert` modules, works regardless of
conditions, so has to be configured by the end user)
Yes please!
See [How to Contribute to Open Source][contribute].
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/wooorm/devlop/workflows/main/badge.svg
[build]: https://github.com/wooorm/devlop/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/devlop.svg
[coverage]: https://codecov.io/github/wooorm/devlop
[downloads-badge]: https://img.shields.io/npm/dm/devlop.svg
[downloads]: https://www.npmjs.com/package/devlop
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=devlop
[size]: https://bundlejs.com/?q=devlop
[npm]: https://docs.npmjs.com/cli/install
[esmsh]: https://esm.sh
[license]: license
[author]: https://wooorm.com
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[typescript]: https://www.typescriptlang.org
[contribute]: https://opensource.guide/how-to-contribute/
[node-condition]: https://nodejs.org/api/packages.html#packages_resolving_user_conditions
[rust-debug-assert]: https://doc.rust-lang.org/std/macro.debug_assert.html
[rust-two-kinds]: https://tratt.net/laurie/blog/2023/rusts_two_kinds_of_assert_make_for_better_code.html
[esbuild]: https://esbuild.github.io
[gzip-size-cli]: https://github.com/sindresorhus/gzip-size-cli/tree/main
[rollup]: https://rollupjs.org
[node-resolve]: https://github.com/rollup/plugins/tree/master/packages/node-resolve
[terser]: https://github.com/rollup/plugins/tree/master/packages/terser#readme
[api-deprecate]: #deprecatefn-message-code
[api-equal]: #equalactual-expected-message
[api-ok]: #okvalue-message
[api-unreachable]: #unreachablemessage