feat(settings): lift the settings file

Author: travi

README.md

@@ -92,7 +92,7 @@ The settings file generated by this tool assumes that it is extending an
 
 ```javascript
 import any from '@travi/any';
-import {scaffold, test} from '@form8ion/github';
+import {scaffold, test, lift} from '@form8ion/github';
 ```
 
 #### Execute
@@ -104,10 +104,19 @@ await scaffold({
   projectRoot,
   name: 'foo',
   owner: 'travi',
-  visibility: any.fromList(['Public', 'Private'])
+  visibility: any.fromList(['Public', 'Private']),
+  description: any.sentence()
 });
 
-await test({projectRoot});
+if (await test({projectRoot})) {
+  await lift({
+    projectRoot,
+    results: {
+      projectDetails: {homepage: any.url()},
+      tags: any.listOf(any.word)
+    }
+  });
+}
 ```
 
 ## Contributing

example.js

@@ -3,7 +3,7 @@
 import {resolve} from 'path';
 import stubbedFs from 'mock-fs';
 import any from '@travi/any';
-import {scaffold, test} from './lib/index.js';
+import {scaffold, test, lift} from './lib/index.js';
 
 // remark-usage-ignore-next
 stubbedFs({node_modules: stubbedFs.load(resolve('node_modules'))});
@@ -16,7 +16,16 @@ await scaffold({
   projectRoot,
   name: 'foo',
   owner: 'travi',
-  visibility: any.fromList(['Public', 'Private'])
+  visibility: any.fromList(['Public', 'Private']),
+  description: any.sentence()
 });
 
-await test({projectRoot});
+if (await test({projectRoot})) {
+  await lift({
+    projectRoot,
+    results: {
+      projectDetails: {homepage: any.url()},
+      tags: any.listOf(any.word)
+    }
+  });
+}

package-lock.json

@@ -85,7 +85,7 @@
   },
   "dependencies": {
     "@form8ion/core": "^4.3.0",
-    "@form8ion/repository-settings": "^1.0.1",
+    "@form8ion/repository-settings": "^1.1.2",
     "@octokit/rest": "^20.0.0",
     "@travi/cli-messages": "^1.1.1",
     "octokit-auth-netrc": "^3.1.1"

package.json

@@ -1,2 +1,3 @@
 export {default as scaffold} from './scaffolder.js';
 export {default as test} from './tester.js';
+export {default as lift} from './lifter.js';

src/index.js

@@ -0,0 +1,9 @@
+import {test as repositoryMaintainedWithRepositorySettings, lift as liftSettings} from '@form8ion/repository-settings';
+
+export default async function ({projectRoot, results}) {
+  if (await repositoryMaintainedWithRepositorySettings({projectRoot})) {
+    return liftSettings({projectRoot, results});
+  }
+
+  return {};
+}

src/lifter.js

@@ -0,0 +1,28 @@
+import {lift as liftSettings, test as repositoryMaintainedWithRepositorySettings} from '@form8ion/repository-settings';
+
+import any from '@travi/any';
+import {when} from 'jest-when';
+import {describe, expect, it, vi} from 'vitest';
+
+import lift from './lifter.js';
+
+vi.mock('@form8ion/repository-settings');
+
+describe('lifter', () => {
+  const projectRoot = any.string();
+  const results = any.simpleObject();
+
+  it('should apply the settings lifter if the project is managed with the settings app', async () => {
+    const settingsResult = any.simpleObject();
+    when(repositoryMaintainedWithRepositorySettings).calledWith({projectRoot}).mockResolvedValue(true);
+    when(liftSettings).calledWith({projectRoot, results}).mockResolvedValue(settingsResult);
+
+    expect(await lift({projectRoot, results})).toEqual(settingsResult);
+  });
+
+  it('should apply not the settings lifter if the project is not managed with the settings app', async () => {
+    when(repositoryMaintainedWithRepositorySettings).calledWith({projectRoot}).mockResolvedValue(false);
+
+    expect(await lift({projectRoot, results})).toEqual({});
+  });
+});

src/lifter.test.js

@@ -0,0 +1,18 @@
+Feature: Lift
+
+  Scenario: lift settings
+    Given the project is versioned on GitHub
+    And the repository settings are managed by the settings app
+    When the scaffolder results are processed
+    Then properties are updated in the settings file
+
+  Scenario: lift but settings not managed by the repository-settings app
+    Given the project is versioned on GitHub
+    But the repository settings are not managed by the settings app
+    When the scaffolder results are processed
+    Then no settings file exists
+
+  Scenario: non-GitHub project
+    Given the project is not versioned on GitHub
+    When the scaffolder results are processed
+    Then no settings file exists

test/integration/features/lift.feature

@@ -5,16 +5,17 @@ import {After, Before, When} from '@cucumber/cucumber';
 import stubbedFs from 'mock-fs';
 import any from '@travi/any';
 import debugTest from 'debug';
+import yaml from 'js-yaml';
 
 const debug = debugTest('test');
 const __dirname = dirname(fileURLToPath(import.meta.url));          // eslint-disable-line no-underscore-dangle
 const stubbedNodeModules = stubbedFs.load(resolve(__dirname, '..', '..', '..', '..', 'node_modules'));
 
-let scaffold;
+let scaffold, test, lift;
 
 Before(async function () {
   // eslint-disable-next-line import/no-extraneous-dependencies,import/no-unresolved
-  ({scaffold} = await import('@form8ion/github'));
+  ({scaffold, test, lift} = await import('@form8ion/github'));
 
   this.projectName = any.word();
   this.projectRoot = process.cwd();
@@ -42,3 +43,27 @@ When('the project is scaffolded', async function () {
     this.scaffoldError = err;
   }
 });
+
+When('the scaffolder results are processed', async function () {
+  this.tags = any.listOf(any.word);
+  this.existingSettingsContent = {...any.simpleObject(), repository: any.simpleObject()};
+
+  stubbedFs({
+    ...this.github && {
+      '.github': {
+        ...this.settingsApp && {'settings.yml': yaml.dump(this.existingSettingsContent)}
+      }
+    },
+    node_modules: stubbedNodeModules
+  });
+
+  if (await test({projectRoot: this.projectRoot})) {
+    await lift({
+      projectRoot: this.projectRoot,
+      results: {
+        projectDetails: this.projectDetails,
+        tags: this.tags
+      }
+    });
+  }
+});

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

@@ -115,6 +115,14 @@ Given('a repository already exists for the {string} on GitHub', async function (
   }
 });
 
+Given('the project is versioned on GitHub', async function () {
+  this.github = true;
+});
+
+Given('the project is not versioned on GitHub', async function () {
+  this.github = false;
+});
+
 Then('repository details are returned', async function () {
   assert.equal(this.result.sshUrl, sshUrl);
   assert.equal(this.result.htmlUrl, htmlUrl);

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

@@ -1,8 +1,17 @@
 import {promises as fs} from 'node:fs';
 import yaml from 'js-yaml';
+import {fileExists} from '@form8ion/core';
 
 import assert from 'node:assert';
-import {Then} from '@cucumber/cucumber';
+import {Given, Then} from '@cucumber/cucumber';
+
+Given('the repository settings are managed by the settings app', async function () {
+  this.settingsApp = true;
+});
+
+Given('the repository settings are not managed by the settings app', async function () {
+  this.settingsApp = false;
+});
 
 Then('repository settings are configured', async function () {
   const settings = yaml.load(await fs.readFile(`${process.cwd()}/.github/settings.yml`));
@@ -21,3 +30,21 @@ Then('repository settings are configured', async function () {
     }
   );
 });
+
+Then('properties are updated in the settings file', async function () {
+  assert.deepEqual(
+    yaml.load(await fs.readFile(`${this.projectRoot}/.github/settings.yml`, 'utf-8')),
+    {
+      ...this.existingSettingsContent,
+      repository: {
+        ...this.existingSettingsContent.repository,
+        ...this.homepage && {homepage: this.homepage},
+        topics: this.tags.join(', ')
+      }
+    }
+  );
+});
+
+Then('no settings file exists', async function () {
+  assert.equal(await fileExists(`${this.projectRoot}/.github/settings.yml`), false);
+});