feat(lift): exposed an initial no-op lifter through the public API

Author: travi

README.md

@@ -41,14 +41,21 @@ $ npm install @form8ion/commit-convention --save-prod
 #### Import
 
 ```javascript
-import {scaffold} from '@form8ion/commit-convention';
+import {packageManagers} from '@form8ion/javascript-core';
+import {scaffold, test, lift} from '@form8ion/commit-convention';
 ```
 
 #### Execute
 
 ```javascript
 (async () => {
-  await scaffold({projectRoot: process.cwd(), configs: {}});
+  const projectRoot = process.cwd();
+
+  await scaffold({projectRoot, configs: {}});
+
+  if (await test({projectRoot})) {
+    await lift({projectRoot, packageManager: packageManagers.NPM});
+  }
 })();
 ```
 

example.js

@@ -1,13 +1,20 @@
 // #### Import
 // remark-usage-ignore-next
 import stubbedFs from 'mock-fs';
-import {scaffold} from './lib/index.cjs';
+import {packageManagers} from '@form8ion/javascript-core';
+import {scaffold, test, lift} from './lib/index.cjs';
 
 // remark-usage-ignore-next
-stubbedFs();
+stubbedFs({'package.json': JSON.stringify({version: '0.0.0-semantically-released'})});
 
 // #### Execute
 
 (async () => {
-  await scaffold({projectRoot: process.cwd(), configs: {}});
+  const projectRoot = process.cwd();
+
+  await scaffold({projectRoot, configs: {}});
+
+  if (await test({projectRoot})) {
+    await lift({projectRoot, packageManager: packageManagers.NPM});
+  }
 })();

src/index.js

@@ -1 +1,2 @@
 export {default as scaffold} from './scaffolder';
+export {test, lift} from './semantic-release';

src/semantic-release/index.js

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

src/semantic-release/lifter-test.js

@@ -0,0 +1,9 @@
+import {assert} from 'chai';
+
+import lift from './lifter';
+
+suite('semantic-release lifter', () => {
+  test('that rsults are returned', async () => {
+    assert.deepEqual(await lift(), {});
+  });
+});

src/semantic-release/lifter.js

@@ -0,0 +1,3 @@
+export default function () {
+  return {};
+}

test/integration/features/lifter.feature

@@ -0,0 +1,4 @@
+Feature: Lift
+
+  Scenario: legacy semantic-release on GitHub Actions
+    When the project is lifted

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

@@ -1,8 +1,11 @@
 import {resolve} from 'path';
+
 import {After, When} from '@cucumber/cucumber';
 import stubbedFs from 'mock-fs';
+import any from '@travi/any';
 
 const stubbedNodeModules = stubbedFs.load(resolve(__dirname, '..', '..', '..', '..', 'node_modules'));
+const projectRoot = process.cwd();
 
 After(function () {
   stubbedFs.restore();
@@ -16,5 +19,19 @@ When('the project is scaffolded', async function () {
     node_modules: stubbedNodeModules
   });
 
-  await scaffold({projectRoot: process.cwd(), configs: {}});
+  await scaffold({projectRoot, configs: {}});
+});
+
+When('the project is lifted', async function () {
+  // eslint-disable-next-line import/no-extraneous-dependencies,import/no-unresolved
+  const {test, lift} = require('@form8ion/commit-convention');
+
+  stubbedFs({
+    node_modules: stubbedNodeModules,
+    'package.json': JSON.stringify({...any.simpleObject()})
+  });
+
+  if (await test({projectRoot})) {
+    await lift({projectRoot});
+  }
 });