betterer

API > @betterer/betterer

JavaScript API for running betterer.

Classes

Class	Description
BettererFileTest	A very common usecase for Betterer is to track issues across all the files in a project. BettererFileTest provides a wrapper around BettererTest that makes it easier to implement such a test.
BettererTest	The main interface to the Betterer test system.

Functions

Function	Description
betterer(options)	Run Betterer with the given options.
merge(options)	Resolve any merge conflicts in the specified results file.
results(options)	Get a summary of the results of the defined BettererTests.Betterer will read the test definition file and the results file and return a summary of the results.
runner(options)	Create a BettererRunner with the given options.
watch(options)	Create a BettererRunner with the given options. Also starts up a file watcher for tracked files in the current working directory.

Interfaces

Interface	Description
BettererConfig	Full validated config object for Betterer.
BettererContext	The context of a set of test suite runs.
BettererContextSummary	The summary of a set of test suite runs.
BettererDiff	The result of computing the difference between two results.
BettererFile	Basic information about a file and its issues.
BettererFileBase	Basic information about a file and its issues.
BettererFileDiff	A diff object for a single file.
BettererFileIssue	An issue in a file
BettererFileResolver	A helper for resolving file paths in a BettererFileTest.
BettererFileTestResult	A set of BettererFiles which each have their own set of BettererFileIssues.
BettererFileTestResultSummary	The summary of the result of a BettererFileTest.
BettererOptionsMerge	Options for when merging conflicts in the results file via the betterer.merge() API.
BettererOptionsOverride	Options for when you override the config via the BettererContext.options() API.
BettererOptionsResults	Options for when you create a BettererResultsSummary via the betterer.results() API.
BettererOptionsWatch	Options for when you create a BettererRunner via the betterer.watch() JS API.
BettererReporter	The interface for hooking into Betterer's reporter system.
BettererResult	The deserialised result object for a single run of a single BettererTest.
BettererResultsSummary	A summary of the results of the defined BettererTests.
BettererRun	A single BettererTest run. Will become a BettererRunSummary when the test run is completed.
BettererRunner	The JS API for controlling Betterer runs.
BettererRunSummary	The summary of a BettererTest run. Includes everything from BettererRun.
BettererSerialiser	The functions that convert between SerialisedType and DeserialisedType.
BettererSuite	A set of BettererTest runs. Will become a BettererSuiteSummary when the test suite is completed.
BettererSuiteSummary	The summary of a BettererSuite suite. Includes everything from BettererSuite.
BettererTestConfig	The validated configuration for a BettererTest.
BettererTestOptionsBasic	The least complex version of a BettererTest operates on simple numbers and can be defined with just a few properties.
BettererTestOptionsComplex	For a more complex version of a BettererTest that operates on more complex objects, you need to define more complex behaviour.
BettererTestResultSummary	The summary of the result of a BettererTest.

Type Aliases

Type Alias	Description
BettererConfigExcludes	An array of Regular Expressions that match file paths that will be excluded from an operation.
BettererConfigFilters	An array of Regular Expressions that match names of relevant tests.
BettererConfigIgnores	An array of absolute glob patterns that match file paths that will be ignored by the file watcher in watch mode.
BettererConfigIncludes	An array of absolute glob patterns that match file paths that will be included in an operation.
BettererConfigPaths	An array of absolute test definition file paths containing Betterer tests.
BettererDelta	The change between a test runs and its baseline. A BettererRun has a delta property if the test has a progress() handler.
BettererDeserialise	The function that converts from a SerialisedType to a DeserialisedType.
BettererDiffer	A function that compares two test results.
BettererFileGlobs	An array of glob patterns that match file paths that will be included in an operation. All globs should be relative to the current .
BettererFileIssues	An array of BettererFileIssues.
BettererFileIssueSerialised	A serialised BettererFileIssue.
BettererFileIssuesSerialised	An array of BettererFileIssueSerialiseds.
BettererFilePath	The path to a file on disk.
BettererFilePaths	An array of paths to files on disk.
BettererFilePatterns	An array of Regular Expressions that match file paths that will be excluded from an operation.
BettererFilesDiff	A map from file path to BettererFileDiff.
BettererFileTestDiff	A diff object for a complete BettererFileTest run.
BettererFileTestFunction	A function that runs an actual file test.
BettererFileTestResultSerialised	A map from file path to BettererFileIssuesSerialised.
BettererFileTestResultSummaryDetails	The summarised result of a BettererFileTest. A mapping from the path to a file to an array of BettererFileIssues.
BettererOptionsExcludes	A string or Regular Expression to match file paths that should be excluded from an operation, or an array of them.
BettererOptionsFilters	A string or Regular Expression to match the names of relevant tests, or an array of them.
BettererOptionsIgnores	A glob pattern to match file paths that should be ignored by the file watcher in watch mode, or an array of them.
BettererOptionsIncludes	A glob pattern to match file paths that should be included in an operation, or an array of them.
BettererOptionsPaths	A path to a test definition file containing Betterer tests, or an array of them.
BettererOptionsReporters	An array of names of npm packages that export a BettererReporter, or objects that implement BettererReporter.
BettererOptionsRunner	Options for when you create a BettererRunner via the betterer.runner() API.
BettererOptionsStart	Options for when you run Betterer via the JS API.
BettererPrinter	A function that converts a serialised test result into the string that will be saved in the results file.
BettererProgress	A function that converts a test result to a numeric value that represents the progress towards the goal.
BettererResultSummaries	An array of BettererResultSummary.
BettererResultSummary	The summary of the result of a BettererTest or BettererFileTest.
BettererRuns	An array of BettererRuns.
BettererRunSummaries	An array of BettererRunSummaries.
BettererSerialise	The function that converts from a DeserialisedType to a SerialisedType.
BettererSuiteSummaries	An array of BettererSuiteSummaries.
BettererTestConstraint	A function that checks if a test result is better, worse, or the same than the expected result.
BettererTestDeadline	The date when the test should be completed by. The test will be marked as expired if it runs after the specified date.
BettererTestFunction	A function that runs the actual test.
BettererTestGoal	A function that returns whether the test has met its goal.
BettererTestNames	An array of test names.
BettererTestOptions	Options for creating a BettererTest.
BettererTestResultSummaryDetails	The summarised result of a BettererTest.