diff --git a/README.md b/README.md index 23e011b5..eddedd9d 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,13 @@ $ npm install @form8ion/jest-scaffolder --save-prod ### Example ```javascript -import jestScaffolder from '@form8ion/jest-scaffolder'; +import {scaffold} from '@form8ion/jest-scaffolder'; + +async function example() { + await scaffold(); +} + +example(); ``` ## Contributing diff --git a/example.js b/example.js index 6f7dff85..004d985c 100644 --- a/example.js +++ b/example.js @@ -1,3 +1,7 @@ -// remark-usage-ignore-next -/* eslint-disable-next-line no-unused-vars */ -import jestScaffolder from './lib/index.cjs'; +import {scaffold} from './lib/index.cjs'; + +async function example() { + await scaffold(); +} + +example(); diff --git a/src/canary-test.js b/src/canary-test.js deleted file mode 100644 index 98ac6072..00000000 --- a/src/canary-test.js +++ /dev/null @@ -1,7 +0,0 @@ -import {assert} from 'chai'; - -suite('canary test', () => { - test('that mocha is wired together correctly', () => { - assert.isTrue(true); - }); -}); diff --git a/src/index.js b/src/index.js index e69de29b..bfe13e6e 100644 --- a/src/index.js +++ b/src/index.js @@ -0,0 +1 @@ +export {default} from './scaffolder'; diff --git a/src/scaffolder-test.js b/src/scaffolder-test.js new file mode 100644 index 00000000..1cbed0cb --- /dev/null +++ b/src/scaffolder-test.js @@ -0,0 +1,8 @@ +import {assert} from 'chai'; +import scaffold from './scaffolder'; + +suite('scaffolder', () => { + test('that jest gets scaffolder', async () => { + assert.deepEqual(await scaffold(), {devDependencies: ['jest', 'jest-when']}); + }); +}); diff --git a/src/scaffolder.js b/src/scaffolder.js new file mode 100644 index 00000000..510d7d8d --- /dev/null +++ b/src/scaffolder.js @@ -0,0 +1,3 @@ +export default function () { + return {devDependencies: ['jest', 'jest-when']}; +}