promote to stable

README.md

@@ -92,21 +92,34 @@ The settings file generated by this tool assumes that it is extending an
 
 ```javascript
 import any from '@travi/any';
-import {scaffold, test, lift} from '@form8ion/github';
+import {lift, promptConstants, scaffold, test} from '@form8ion/github';
 ```
 
 #### Execute
 
 ```javascript
 const projectRoot = process.cwd();
 
-await scaffold({
-  projectRoot,
-  name: 'foo',
-  owner: 'travi',
-  visibility: any.fromList(['Public', 'Private']),
-  description: any.sentence()
-});
+await scaffold(
+  {
+    projectRoot,
+    projectName: 'foo',
+    visibility: any.fromList(['Public', 'Private']),
+    description: any.sentence()
+  },
+  {
+    prompt: async ({id}) => {
+      const {questionNames, ids} = promptConstants;
+      const expectedPromptId = ids.GITHUB_DETAILS;
+
+      if (expectedPromptId === id) {
+        return {[questionNames[expectedPromptId].GITHUB_ACCOUNT]: any.word()};
+      }
+
+      throw new Error(`Unknown prompt with ID: ${id}`);
+    }
+  }
+);
 
 if (await test({projectRoot})) {
   await lift({

example.js

@@ -3,7 +3,7 @@
 import {resolve} from 'path';
 import stubbedFs from 'mock-fs';
 import any from '@travi/any';
-import {scaffold, test, lift} from './lib/index.js';
+import {lift, promptConstants, scaffold, test} from './lib/index.js';
 
 // remark-usage-ignore-next
 stubbedFs({node_modules: stubbedFs.load(resolve('node_modules'))});
@@ -12,13 +12,26 @@ stubbedFs({node_modules: stubbedFs.load(resolve('node_modules'))});
 
 const projectRoot = process.cwd();
 
-await scaffold({
-  projectRoot,
-  name: 'foo',
-  owner: 'travi',
-  visibility: any.fromList(['Public', 'Private']),
-  description: any.sentence()
-});
+await scaffold(
+  {
+    projectRoot,
+    projectName: 'foo',
+    visibility: any.fromList(['Public', 'Private']),
+    description: any.sentence()
+  },
+  {
+    prompt: async ({id}) => {
+      const {questionNames, ids} = promptConstants;
+      const expectedPromptId = ids.GITHUB_DETAILS;
+
+      if (expectedPromptId === id) {
+        return {[questionNames[expectedPromptId].GITHUB_ACCOUNT]: any.word()};
+      }
+
+      throw new Error(`Unknown prompt with ID: ${id}`);
+    }
+  }
+);
 
 if (await test({projectRoot})) {
   await lift({