Merge pull request #1 from form8ion/alpha

initial version

Author: travi

.eslintrc.yml

@@ -1,3 +1,9 @@
 extends:
   - '@form8ion'
-  - '@form8ion/mocha'
+  - '@form8ion/mocha'
+  - '@form8ion/cucumber'
+
+overrides:
+  - files: example.js
+    rules:
+      import/no-extraneous-dependencies: off

.gherkin-lintrc

@@ -0,0 +1,6 @@
+{
+  "no-restricted-tags": ["on", {"tags": ["@focus"]}],
+  "use-and": "on",
+  "no-multiple-empty-lines": "on",
+  "no-dupe-feature-names": "on"
+}

README.md

@@ -13,6 +13,8 @@ opinionated scaffolder for [remark](https://github.com/remarkjs/remark) [plugins
 * [Usage](#usage)
   * [Installation](#installation)
   * [Example](#example)
+    * [Import](#import)
+    * [Execute](#execute)
 * [Contributing](#contributing)
   * [Dependencies](#dependencies)
   * [Verification](#verification)
@@ -35,8 +37,16 @@ $ npm install @form8ion/remark-plugin-scaffolder --save-prod
 
 ### Example
 
+#### Import
+
+```javascript
+import {scaffold} from '@form8ion/remark-plugin-scaffolder';
+```
+
+#### Execute
+
 ```javascript
-import remarkPluginScaffolder from '@form8ion/remark-plugin-scaffolder';
+scaffold({projectRoot: process.cwd(), projectName: 'name-of-the-package', tests: {integration: true}});
 ```
 
 ## Contributing

cucumber.js

@@ -0,0 +1,6 @@
+module.exports = {
+  base: '--require-module @babel/register --format-options \'{"snippetInterface": "async-await"}\'',
+  wip: '--tags "@wip"',
+  noWip: '--tags "not @wip"',
+  focus: '--tags @focus'
+};

example.js

@@ -1,3 +1,14 @@
+// #### Import
 // remark-usage-ignore-next
-/* eslint-disable-next-line no-unused-vars */
-import remarkPluginScaffolder from './lib/index.cjs';
+import stubbedFs from 'mock-fs';
+import {scaffold} from './lib/index.cjs';
+
+// remark-usage-ignore-next
+stubbedFs();
+
+// #### Execute
+
+scaffold({projectRoot: process.cwd(), projectName: 'name-of-the-package', tests: {integration: true}});
+
+// remark-usage-ignore-next
+stubbedFs.restore();