feat(description): pass description through to settings scaffolder

src/scaffolder.js

@@ -5,15 +5,15 @@ import {scaffold as scaffoldSettings} from '@form8ion/repository-settings';
 import {factory as getAuthenticatedOctokit} from './octokit/factory.js';
 import {scaffold as scaffoldRepository} from './repository/index.js';
 
-export default async function ({name, owner, visibility, projectRoot}) {
+export default async function ({name, owner, visibility, description, projectRoot}) {
   info('Initializing GitHub');
 
   const octokit = getAuthenticatedOctokit();
 
   const [repositoryResult] = await Promise.all([
     scaffoldRepository({octokit, name, owner, visibility}),
     fs.mkdir(`${projectRoot}/.github`, {recursive: true}),
-    scaffoldSettings({projectRoot, projectName: name, visibility})
+    scaffoldSettings({projectRoot, projectName: name, visibility, description})
   ]);
 
   return {...repositoryResult};

src/scaffolder.test.js

@@ -22,13 +22,15 @@ describe('scaffolder', () => {
     const name = any.word();
     const owner = any.word();
     const visibility = any.word();
+    const description = any.sentence();
     octokitFactory.mockReturnValue(octokitClient);
     when(scaffoldRepository)
       .calledWith({octokit: octokitClient, name, owner, visibility})
       .mockResolvedValue(repositoryResult);
 
-    expect(await scaffold({name, owner, visibility, projectRoot})).toEqual({...repositoryResult});
+    expect(await scaffold({name, owner, visibility, projectRoot, description}))
+      .toEqual({...repositoryResult});
     expect(fs.mkdir).toHaveBeenCalledWith(`${projectRoot}/.github`, {recursive: true});
-    expect(scaffoldSettings).toHaveBeenCalledWith({projectRoot, projectName: name, visibility});
+    expect(scaffoldSettings).toHaveBeenCalledWith({projectRoot, projectName: name, visibility, description});
   });
 });

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

@@ -18,6 +18,7 @@ Before(async function () {
   ({scaffold, test, lift} = await import('@form8ion/github'));
 
   this.projectName = any.word();
+  this.projectDescription = any.sentence();
   this.projectRoot = process.cwd();
 });
 
@@ -36,7 +37,8 @@ When('the project is scaffolded', async function () {
       projectRoot: this.projectRoot,
       name: this.projectName,
       owner: this.githubUser,
-      visibility: this.projectVisibility
+      visibility: this.projectVisibility,
+      description: this.projectDescription
     });
   } catch (err) {
     debug(err);

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

@@ -22,10 +22,8 @@ Then('repository settings are configured', async function () {
       _extends: '.github',
       repository: {
         name: this.projectName,
-        // description: this.projectDescription,
-        // homepage: this.projectHomepage,
+        description: this.projectDescription,
         private: 'Public' !== this.projectVisibility
-        // topics: this.topics.join(', ')
       }
     }
   );