Skip to content
This repository has been archived by the owner on Nov 10, 2020. It is now read-only.
/ chai-jscodeshift Public archive

A custom assertion for jscodeshift to check whether a given input fixture matches an output fixture after being transformed by the transformer under test.

Notifications You must be signed in to change notification settings

Shopify/chai-jscodeshift

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

chai-jscodeshift

Circle CI

chai-jscodeshift provides a custom assertion for jscodeshift to check whether a given input fixture matches an output fixture after being transformed by the transformer under test.

Setup

import chai from 'chai';
import chaiJSCodeShift from 'chai-jscodeshift';
chai.use(chaiJSCodeShift());

Usage

import myTransform from '../src/my-transform';

describe('myTransform', () => {
  it('transforms properly', () => {
    expect(myTransform).to.transform('my-fixture');

    // or

    assert.transforms(myTransform, 'my-fixture');
  });
});

Customization

By default, this plugin will look for fixtures in the fixtures in the working directory. You will probably want to customize this by setting the directory in which your fixtures appear:

import path from 'path';

chai.use(chaiJSCodeShift({
  fixtureDirectory: path.join(__dirname, 'fixtures')
}));

When you declare that you want a transformer to transform a particular fixture, this plugin will look for a file named <fixtureName>.input.js, relative to the fixtureDirectory declared above. It will read this file, transform the contents using your transformer, and compare it against a file named <fixtureName>.output.js relative to the fixture directory. You can customize either of these paths by passing a custom inputFixturePath or outputFixturePath in your options (both of which take two arguments, the fixture name and the root of the fixture directory):

chai.use(chaiJSCodeShift({
  fixtureDirectory: path.join(__dirname, 'fixtures'),
  inputFixturePath(fixtureName, fixtureDirectory) {
    return path.join(fixtureDirectory, 'input', `${fixtureName}.js`);
  },
  inputFixturePath(fixtureName, fixtureDirectory) {
    return path.join(fixtureDirectory, 'output', `${fixtureName}.js`);
  },
}));

You can also set custom options that will be passed as the third argument to your transformer on every call using the transformOptions configuration option:

chai.use(chaiJSCodeShift({
  transformOptions: {
    printOptions: {space: 'single'},
  },
}));

About

A custom assertion for jscodeshift to check whether a given input fixture matches an output fixture after being transformed by the transformer under test.

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published