Write vanilla comments that automagically convert into full test spec files.

SpeckJS allows you to get started using Test Driven Development on a new project, to quickly add unit-tests to your existing project, or anywhere in between. Ready? Let’s get started.

• Add SpeckJS formatted comments to your file

  yourFile.js

  // test > sum function

  // # sum(1, 2) == 3 (returns the sum of both params)

  // # sum(3, 4) == 7 (returns the sum of both params)

  function sum(a, b) {

    return a + b;

  };

• Pick your favorite tool

  • npm
  • grunt
  • gulp
  • atom

• Install the npm module

  From within your project directory run:

  ~ $ npm install speckjs --save

• Hello World

  Require speckjs from within your project files:

  var speck = require('speckjs');

  speck.build(file, option);

• Install the grunt plugin

  From within your project directory run:

  ~ $ npm install grunt-speckjs --save-dev

• Set up your Gruntfile.js

  Once the plugin has been installed, it may be enabled inside your Gruntfile so:

  Gruntfile.js

  grunt.loadNpmTasks('grunt-speckjs');

  and configured as:

  Gruntfile.js

  grunt.initConfig({
      speck: {
        options: {
          specType: 'tape',
          specName: '--testSpec',
          logs: false
        },
        target: {
          src: ['src/*.js'],
          dest: 'test/specs/'
        },
      },
    });      

• Run grunt

  ~ $ grunt speck

• Install the gulp plugin

  From within your project directory run:

  ~ $ npm install gulp-speckjs --save-dev

• Set up your gulpfile.js

  Once the plugin has been installed, it may be enabled inside your gulpfile so:

  gulpfile.js

  var speck = require('gulp-speckjs');

  and configured as:

  gulpfile.js

  gulp.task('speck', function() {
    return gulp.src('./test/fixtures/*.js')
      .pipe(foreach(function(stream, file) {
        return stream
          .pipe(speck({
            testFW: 'tape',
            logs: true,
            relPath: '../specs/' + path.basename(file.path)
          }))
          .pipe(rename({
            suffix : '_tapeSpec'
          }));
      }))
      .pipe(gulp.dest('./test/fixtures/specs'));
  });       

• Run gulp

  ~ $ gulp speck

• …and Boom!

  var test = require('tape');
  var file = require('./yourFile.js');
  
  test('sum function', function(t) {
    t.plan(1);
    t.equal(3, file.sum(1,2), 'returns the sum of both params');
    t.equal(7, file.sum(3,4), 'returns the sum of both params');
  });

  This example shows a Tape test. SpeckJS compiles tests for Tape, Jasmine, and Mocha/Chai.

  Check the documentation on github.com/speckjs/speckjs for more information

• Download Atom

  Atom is a hackable text editor for the 21st Century

  Download Atom

• Install the atom plugin

  

• Open your file, run speck and...