Auto Test File

• Auto-generate test files in a watched directory for matching extensions.
• Ask for test specs and insert into the generated test.
• Generate test files based on default templates or define custom templates.

Getting Started

Installing

• npm install auto-test-file
• This will provide access to the atf command which can be used to start the file watcher.

Setup

• Add a watcher script to your package.json file, eg "atf": "atf -d 'src' -e 'ts' 'tsx'"
• Add config settings either directly in the command line or using a config file. (See below.)
• Use the default test file templates or replace with custom templates. (See below.)
• Run the script, which will launch the watcher.
• Files will be auto-generated while the script is running.
• Index files and dot files are ignored.

Using the config file

auto-test-file can be configured either directly via the command line or using a config file. Settings passed into the command line will override config file settings.

By default, auto-test-file will look for a file named atf.config.js in the root of the project directory. The path to the file can be changed using the --config option.

Below is a sample config file:

module.exports = {
  directory: "src",
  extensions: ["ts", "tsx"],
  noSpecInput: true
};

Using Custom Test File Templates

• Test files are generated using two templates, the describeBlock and the specBlock template.
• The default templates, found in /src/lib/templates, can be overridden by adding a corresponding template in the config file, eg

module.exports = {
  directory: "src",
  extensions: ["ts", "tsx"],
  specTemplate: `
    test('<%= spec %>', () => {
       expect.hasAssertions();
    });
`
};

• For templates to function, they must include the necessary properties. See the documentation in each template file for properties that are used.

• Templates use Lodash Template - see their documentation for supported syntax.

Config Options

--config/ -c: point to a different config file than the default (atf.config.js) eg '/Users/bobsmith/my_project/foo.config.js'.

--directory/ -d: name of directory to be watched eg 'src'.

--extensions / -e: extensions for which to create test files eg 'js' 'jsx'.

--noSpecInput: do not ask for specs on add of a file.

describeTemplate: config file only. See "Using Custom Test File Templates".

specTemplate: config file only. See "Using Custom Test File Templates".

License

MIT © Anders Ramsay