nx-betterer

Supported Versions

Package Version	Nx Version	Supported
6.x	20.x	:white_check_mark:
5.x	19.x	:white_check_mark:
3.x, 4.x	18.x	:white_check_mark:
2.x	17.x	:white_check_mark:
1.x	16.x	:white_check_mark:
0.x	15.x	:x:

This library was generated with Nx.

Quick Start

1. Add @spaceribs/nx-betterer to your project:

   $ npm install @spaceribs/nx-betterer --save-dev
   # or
   $ yarn add @spaceribs/nx-betterer --dev
   Copy

2. Generate the betterer configuration in your project:

   $ nx g @spaceribs/nx-betterer:add my-project
   
   >  NX  Generating @spaceribs/nx-betterer:init
   Copy

3. Open the blank rules configuration added to your project and follow the guide at: https://phenomnomnominal.github.io/betterer/docs/test-definition-file.

4. Run the executor to generate the initial results file.

   $ nx run my-project:betterer
   
      \ | /     _         _   _
    '-.ooo.-'  | |__  ___| |_| |_ ___ _ __ ___ _ __
   ---ooooo--- | '_ \/ _ \ __| __/ _ \ '__/ _ \ '__|
    .-'ooo'-.  | |_)|  __/ |_| ||  __/ | |  __/ |
      / | \    |_.__/\___|\__|\__\___|_|  \___|_|
   
   🎉 Betterer (1,078ms): 1 test done!
   ✅ stricter compilation: "stricter compilation" has already met its goal! ✨
   1 test got checked. 🤔
   1 test met its goal! 🎉
   Copy

5. Commit your changes.

NOTE: Keep in mind that due to a lack of ESModule support in NxNrwl, you'll need to use CommonJS syntax.

Check Results

If you wish to check your results, run the following on your pull request job:

nx run my-project:betterer
Copy

Update Results

If you wish to update results automatically, run the following on your release job:

nx run my-project:betterer
git add --all
git commit -m 'chore: update betterer results'
git push
Copy

Ignore errors as not all changes will generate changes.

Force Update Results

If you wish to update all of your results, overriding failures, you can run the following:

nx run my-project:betterer --forceUpdate
Copy

Watch Mode

If you wish to keep betterer open as you fix issues, you can run the following:

nx run my-project:betterer --watch
Copy