stylus-true

This is a decremental port of true for scss.

stylus-true is a unit-testing tool for Stylus code, All of the test code is written in Stylus and JS (via stylus plugins), and can be compiled by the stylus compiler – or used alongside Javascript test runners for extra features and improved reporting.

Install

In command line:

npm install stylus-true

Import in your test directory, like any other stylus file:

@require '../node_modules/stylus-true/styl/_true.styl';

One Setting

$true-terminal-output.value (boolean), defaults to true

true will show detailed information in the terminal for debugging failed assertions or reporting final results. This is the default, and best for compiling without a JavaScript test runner.
false will turn off all terminal output from Stylus, though Mocha/Jest will continue to use the terminal for reporting.

Usage

stylus-true, just as the original, True is based on common JS-testing patterns, allowing both a test-module/test syntax, and the newer describe/it for defining the structure:

+test-module('zip [function]') {
    // Test 1
     +test('Returns two lists zipped together') {
        assert-equal(
            zip(a b c, 1 2 3),
            (a 1, b 2, c 3)
        );
    }
}

This is the same as...

+describe('zip [function]') {
    // Test 1
     +it('Returns two lists zipped together') {
        assert-equal(
            zip(a b c, 1 2 3),
            (a 1, b 2, c 3)
        );
    }
}

Stylus is able to compare values internally, meaning function-output and variable values can easily be compared and reported during Stylus compilation.

CSS output tests, on the other hand, have to be compared after compilation is complete. You can do that by hand if you want (git diff is helpful for noticing changes), or you can use our Mocha or Jest integration.

Output tests fit the same structure, but assertions take a slightly different form, with an outer assert mixin, and a matching pair of output and expect to contain the output-values.

// Test CSS output from mixins
+it('Outputs a font size and line height based on keyword') {
  +assert() {
    +output() {
      font-size('large');
    }

    +expect() {
      font-size: 2rem;
      line-height: 3rem;
    }
  }
}

You can optionally show a summary report in CSS and/or the command line, after the tests have completed:

report();

Using Mocha, Jest, or other JS test runners

Install stylus-true via npm:
```
npm install --save-dev stylus-true
```
Write some Stylus tests in **/*.spec.styl (see above).

Write a shim JS test file stylus.spec.js:

const path = require("path");
const stylTrue = require("./lib/main.js");
const glob = require("glob");

describe("SaStylusss", () => {
 const stylTestFiles = glob.sync(
   path.resolve(process.cwd(), "*.spec.styl")
 );

 stylTestFiles.forEach(file =>
   stylTrue.runStyl({ file }, { describe, it })
 );
});

Run Mocha/Jest, and see your Sass tests reported in the command line.

You can call runStyl more than once, if you have multiple Styl test files you want to run separately.

The second argument is an object with required describe and it options, and optional and contextLines options.

Any JS test runner with equivalents to Mocha's or Jest's describe and it should be usable in the same way: just pass your test runner's describe and it equivalents in the second argument to runStyl.

If True can't parse the CSS output, it'll give you some context lines of CSS as part of the error message. This context will likely be helpful in understanding the parse failure. By default it provides up to 10 lines of context; if you need more, you can provide a numeric contextLines option: the maximum number of context lines to provide.

Disclaimer

stylus-true wouldn't exist if it wasn't for oddbird's amazing job with the original true, so give her some love <3

ghaschel / stylus-true