https://github.com/elementsweb/yeoman-assert

Assertion module comparing file with snapshot.
https://github.com/elementsweb/yeoman-assert

assert snapshot yeoman

Last synced: 6 months ago
JSON representation

Assertion module comparing file with snapshot.

• Host: GitHub
• URL: https://github.com/elementsweb/yeoman-assert
• Owner: elementsweb
• License: bsd-2-clause
• Created: 2017-09-16T19:16:11.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-02-25T17:32:21.000Z (about 8 years ago)
• Last Synced: 2025-10-11T20:46:36.920Z (6 months ago)
• Topics: assert, snapshot, yeoman
• Language: JavaScript
• Size: 83 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

README

          
# @j154004/yeoman-assert

[![Build Status](https://travis-ci.org/elementsweb/yeoman-assert.svg?branch=master)](https://travis-ci.org/elementsweb/yeoman-assert)

[![npm](https://img.shields.io/npm/v/npm.svg)](https://www.npmjs.com/package/@j154004/yeoman-assert)

Assertion module for Yeoman generators, include comparing file with snapshot.

Extends the `yeoman-assert` module, which itself extends the native `assert` module. You only therefore need to import this assertion library to get all the functionality required for testing your Yeoman generator.

You can see an example of what a failed snapshot assertion looks like below:

![AssertionError for README.md:1 with expected and actual results](./docs/j154004-yeoman-assert.png)

## Install

```

npm install --save-dev @j154004/yeoman-assert

```

## Usage

```

const assert = require('@j154004/yeoman-assert');

const path = require('path');

```

See the example generator in `/example` to see how to structure your tests and to see an example output from a failing test.

## API

### `snapshotContent`

* __filePath__ (String) Path to generated file.

* __snapshotFilePath__ (String) Path to snapshot file.

Assert that a file matches a snapshot file.

```

assert.snapshotContent(

  'public/swagger.yaml',

  path.join(__dirname, 'snapshots', 'swagger.yaml')

)

```

Snapshot files should be stored in a `snapshot` directory where your tests are run from.

## Licence

[BSD license](/LICENSE)  Copyright (c) elementsweb

`yeoman-assert` is licensed under BSD-2-Clause Copyright (c) Google