Betterer

https://phenomnomnominal.github.io/betterer/docs/introduction

Admin

Betterer is a tool that helps teams make incremental improvements to codebases by tracking test...

Tokens:456

Snippets:7

Trust Score:8.3

Update:9 months ago

Show doc for...

Tokens:

Raw

### Initialize Betterer Project

Source: https://phenomnomnominal.github.io/betterer/docs/introduction/betterer

This command initializes a new Betterer project in your current directory. It sets up the necessary configuration files and structures for Betterer to start tracking your code improvements. Ensure you have Node.js and npm installed.

```bash
npx @betterer/cli init
```

--------------------------------

### Define a Betterer Test (.betterer.ts)

Source: https://phenomnomnominal.github.io/betterer/docs/introduction/index

Defines a new test for Betterer to track. It specifies the test function, a constraint (e.g., 'smaller'), and a goal. This file is a TypeScript file.

```typescript
// .betterer.ts
import { BettererTest } from '@betterer/betterer';
import { smaller } from '@betterer/constraints';

export default {
  'thing you want to improve': () =>
    new BettererTest({
      test: () => runMyTest(),
      constraint: smaller,
      goal: 0
    })
};

```

--------------------------------

### Betterer Results File Format

Source: https://phenomnomnominal.github.io/betterer/docs/introduction/index

Stores the results of Betterer tests. On the first run, it captures the value; on subsequent runs, it compares the new value against the stored one. This file is generated by Betterer.

```javascript
// BETTERER RESULTS V2.
exports[`thing you want to improve`] = {
  value: `12345`
};

```

Tokens:

Raw