Skip to content

Latest commit

 

History

History
45 lines (32 loc) · 1.5 KB

README.md

File metadata and controls

45 lines (32 loc) · 1.5 KB
Raw

@j154004/yeoman-assert

Build Status npm

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

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 Copyright (c) elementsweb

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