codelenny / ava-test-style Goto Github PK

Tests may include some constant values in the file:

const test = require("ava");

const name = "bob";

test.beforeEach("create user", t => {
  t.context.user = new User(name);
});

test("has name", t => {
  const { user } = t.context;
  t.is(user.getName(), name);
});

• Add to the "Test File Structure" list
• Add description to a section under "Test File Structure"
• See if it should be included in some of the test file examples in the README.

Running tests via NODE_PATH=. ava allows tests to require source files by name, instead of using a local path.

As AVA test files are generally stored in different directories (at multiple levels), this can help standardize test files across the repository, and allow easier copy-pasting between test files.

• Create a section in the README
  • (probably near the start of the file)
  • describe these benefits
  • explain how to set up the test files
• Include in the highlights?

Include a "Test Documentation" section outlining what styles of documentation are useful, and what isn't.

DO: Mention top-level test architecture (e.g. AVA) in the README.
DO: Mention test style (e.g. this guide) in the README.
DO: Call out local test resources that can help (e.g. prebuilt ConfigurableArbitrary in the test directory) in the README.
DO: Assume that readers will scan through the dependencies in a file, and don't need any explanation about the library.
DON'T: List all test libraries/resources that are used in the repository (e.g. JSVerify, Lodash, etc.)

DO: Use test titles instead of comments.
DO: Explain lengthy or complex test architecture (in a block comment).

You may provide line-by-line comments in the test file describing the functionality of a test according to the repositories style guide for code. If you are providing these comments, write them well. Quickly written descriptions of functionality can hurt more than they help.

DO: Explain test architecture.
DON'T: Explain test implementation.

DO: Use AVA test description features (e.g. skip, failing) for specific purposes (describe)