Skip to content

Commit

Permalink
feat(predicate): renamed the public predicate to test to align wi…
Browse files Browse the repository at this point in the history
…th the form8ion convention

BREAKING CHANGE: the public `predicate` has been renamed to `test` to better align with the form8ion
convention
  • Loading branch information
travi committed Jul 23, 2024
1 parent 0605be9 commit f6e4b7a
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ $ npm install @form8ion/dependabot-scaffolder --save-prod
#### Import

```javascript
import {lift, predicate, scaffold} from '@form8ion/dependabot-scaffolder';
import {lift, test, scaffold} from '@form8ion/dependabot-scaffolder';
```

#### Execute
Expand All @@ -68,7 +68,7 @@ import {lift, predicate, scaffold} from '@form8ion/dependabot-scaffolder';
vcs: {owner: 'form8ion', name: 'the-repo'}
});

if (await predicate({projectRoot: process.cwd()})) {
if (await test({projectRoot: process.cwd()})) {
await lift();
}
})();
Expand Down
4 changes: 2 additions & 2 deletions example.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// remark-usage-ignore-next 2
import stubbedFs from 'mock-fs';
// eslint-disable-next-line import/order
import {lift, predicate, scaffold} from './lib/index.js';
import {lift, test, scaffold} from './lib/index.js';

// remark-usage-ignore-next 4
stubbedFs({
Expand All @@ -18,7 +18,7 @@ stubbedFs({
vcs: {owner: 'form8ion', name: 'the-repo'}
});

if (await predicate({projectRoot: process.cwd()})) {
if (await test({projectRoot: process.cwd()})) {
await lift();
}
})();
2 changes: 1 addition & 1 deletion src/lifter/index.js
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
export {default as lift} from './lifter.js';
export {default as predicate} from './predicate.js';
export {default as test} from './predicate.js';

0 comments on commit f6e4b7a

Please sign in to comment.