![\"readme-assert\"](\"https://raw.githubusercontent.com/laat/readme-assert/master/docs/assets/favicon.svg\")
\n\n \n
\n ![\"npm\"](\"https://img.shields.io/npm/v/readme-assert.svg?style=flat\")
\n
Code examples in READMEs go stale. readme-assert runs them as tests so they can't.
\n\nTag a code block, add an assertion comment, done:\n\n````markdown\n```javascript test\nimport { add } from 'my-package';\n\nadd(1, 2); //=> 3\n```\n````\n\n```\nnpx readme-assert\n```\n\nImports of your package name are rewritten to your local source\nautomatically.\n\n## Install\n\n```\nnpm install --save-dev readme-assert\n```\n\n## Assertions\n\n```javascript test\nlet a = 1;\na; //=> 1\n```\n\n```javascript test\nconst fail = () => {\n throw new TypeError('bad input');\n};\nfail(); //=> TypeError: bad input\n```\n\n```javascript test\nawait Promise.resolve(true); //=> true\n```\n\nSee the [full assertion syntax](https://readme-assert.laat.dev/assertions/)\nfor throws, rejects, console.log, and more.\n\n## TypeScript\n\nTypeScript blocks work out of the box — types are stripped before execution:\n\n```typescript should add two numbers\nconst sum: number = 1 + 1;\nsum; //=> 2\n```\n\n## Auto-discover\n\nSkip the `test` tag entirely. With `--auto`, any block containing an\nassertion comment is a test:\n\n```\nreadme-assert --auto\n```\n\n## Documentation\n\nFull docs at [readme-assert.laat.dev](https://readme-assert.laat.dev/):\n\n- [Assertion syntax](https://readme-assert.laat.dev/assertions/) — all comment forms\n- [Code block tags](https://readme-assert.laat.dev/code-blocks/) — tagging, grouping, and modes\n- [Import renaming](https://readme-assert.laat.dev/import-renaming/) — how package imports are resolved\n- [CLI reference](https://readme-assert.laat.dev/cli/) — all flags and options\n\n## License\n\nMIT\n","readmeFilename":"readme.md","users":{"laat":true,"rubiadias":true}}