Expose config object

[RedHatter]

It would be useful for ava to expose the config object to the tests. For example I need to save some extra files with snapshots, it would be nice if I could pull the snapshotDir from the config.

---

IssueHunt Summary

ulken has been rewarded.

Backers (Total: $40.00)

• issuehunt ($40.00)

Submitted pull Requests

• #2444 Expose snapshot directory through test.meta

---

Tips

• Checkout the Issuehunt explorer to discover more funded issues.
• Need some help from other developers? Add your repositories on IssueHunt to raise funds.

---

IssueHunt has been backed by the following sponsors. Become a sponsor

[RedHatter]

My bad. You can get the config like so.

import { get as getConfig } from 'ava/lib/worker/options.js';

test('...', (t, page) => {
  getConfig();
  ...
});

[novemberborn]

You could… but that's an internal API and may break without warning.

Could you elaborate on your use case?

[RedHatter]

I'm building some until functions to create visual snapshots for regression testing using puppeteer. I need access to the config object so I can get the snapshotDir and whether ava was run with --update-snapshots

[novemberborn]

#1977 introduces a meta object we could hang this off. We should implement a memoizing getter for snapshotDir since it's takes a bunch of disk operations to compute.

I'm not sure what to do about the update flag. I can see the value in exposing it but I'm concerned it may prevent us from building interactive update UIs later. Though perhaps at that point we won't expose it if run interactively.

There's other open issues to stop AVA from creating new snapshots in CI that may impact this. What do you think?

[RedHatter]

Exposing on the meta options seems perfect.

You could expose the raw command line arguments that were passed to ava. That way if you remove the --update-snapshots option from the snapshot work flow any test or functions that depend on it would still work. In addition it would have the added benefit of allowing me to specify --update-visual-snapshots if I want.

[novemberborn]

You could expose the raw command line arguments that were passed to ava.

AVA actually forwards all arguments after a --. So if you do npx ava my.test.js -- --update-visual-snapshots you could use that to control some custom snapshotting module.

[RedHatter]

Ah, okay, was not aware of that.

[sindresorhus]

I think it should be named meta.snapshotDirectory.

[IssueHuntBot]

@IssueHunt has funded $40.00 to this issue.

---

• Submit pull request via IssueHunt to receive this reward.
• Want to contribute? Chip in to this issue via IssueHunt.
• Checkout the IssueHunt Issue Explorer to see more funded issues.
• Need help from developers? Add your repository on IssueHunt to raise funds.

[ulken]

I took a stab at this in #2444

[issuehunt-oss]

@sindresorhus has rewarded $36.00 to @ulken. See it on IssueHunt

• 💰 Total deposit: $40.00
• 🎉 Repository reward(0%): $0.00
• 🔧 Service fee(10%): $4.00