Merge pull request #6 from form8ion/alpha

README.md

@@ -15,6 +15,8 @@ opinionated scaffolder for testing web-based projects against
 * [Usage](#usage)
   * [Installation](#installation)
   * [Example](#example)
+    * [Import](#import)
+    * [Execute](#execute)
 * [Contributing](#contributing)
   * [Dependencies](#dependencies)
   * [Verification](#verification)
@@ -47,7 +49,7 @@ import {scaffold} from '@form8ion/is-website-vulnerable';
 
 ```javascript
 (async () => {
-  await scaffold({projectRoot: process.cwd()});
+  await scaffold({baseUrl: 'http://localhost:9876'});
 })();
 ```
 

example.js

@@ -9,5 +9,5 @@ stubbedFs();
 // #### Execute
 
 (async () => {
-  await scaffold({projectRoot: process.cwd()});
+  await scaffold({baseUrl: 'http://localhost:9876'});
 })();

src/scaffolder-test.js

@@ -1,7 +1,14 @@
+import {assert} from 'chai';
+import any from '@travi/any';
 import scaffold from './scaffolder';
 
 suite('scaffolder', () => {
   test('that `is-website-vulnerable` is enabled', async () => {
-    await scaffold();
+    const baseUrl = any.url();
+
+    const {devDependencies, scripts} = await scaffold({baseUrl});
+
+    assert.deepEqual(devDependencies, ['is-website-vulnerable']);
+    assert.deepEqual(scripts, {'test:served:vulnerable': `is-website-vulnerable ${baseUrl}`});
   });
 });

src/scaffolder.js

@@ -1,3 +1,6 @@
-export default function () {
-
+export default function ({baseUrl}) {
+  return {
+    devDependencies: ['is-website-vulnerable'],
+    scripts: {'test:served:vulnerable': `is-website-vulnerable ${baseUrl}`}
+  };
 }

test/integration/features/scaffolder.feature

@@ -2,3 +2,4 @@ Feature: Scaffolder
 
   Scenario: Scaffold
     When the project is scaffolded
+    Then is-website-vulnerable is enabled

test/integration/features/step_definitions/common-steps.js

@@ -1,5 +1,6 @@
 import {resolve} from 'path';
 import {After, When} from '@cucumber/cucumber';
+import any from '@travi/any';
 import stubbedFs from 'mock-fs';
 
 const stubbedNodeModules = stubbedFs.load(resolve(__dirname, '..', '..', '..', '..', 'node_modules'));
@@ -12,10 +13,11 @@ When('the project is scaffolded', async function () {
   // eslint-disable-next-line import/no-extraneous-dependencies,import/no-unresolved
   const scaffolder = require('@form8ion/is-website-vulnerable');
   const {scaffold} = scaffolder;
+  this.baseUrl = any.url();
 
   stubbedFs({
     node_modules: stubbedNodeModules
   });
 
-  await scaffold();
+  this.results = await scaffold({baseUrl: this.baseUrl});
 });

test/integration/features/step_definitions/is-website-vulnerable-steps.js

@@ -0,0 +1,9 @@
+import {Then} from '@cucumber/cucumber';
+import {assert} from 'chai';
+
+Then('is-website-vulnerable is enabled', async function () {
+  const {devDependencies, scripts} = this.results;
+
+  assert.deepEqual(devDependencies, ['is-website-vulnerable']);
+  assert.deepEqual(scripts, {'test:served:vulnerable': `is-website-vulnerable ${this.baseUrl}`});
+});