@form8ion/github-workflows-core 1.0.0-alpha.1 → 1.0.0

package/README.md

@@ -14,6 +14,8 @@ core functionality for form8ion plugins that manage github workflows
 * [Usage](#usage)
   * [Installation](#installation)
   * [Example](#example)
+    * [Import](#import)
+    * [Execute](#execute)
 * [Contributing](#contributing)
   * [Dependencies](#dependencies)
   * [Verification](#verification)
@@ -25,6 +27,7 @@ core functionality for form8ion plugins that manage github workflows
 [![MIT license][license-badge]][license-link]
 [![npm][npm-badge]][npm-link]
 [![Try @form8ion/github-workflows-core on RunKit][runkit-badge]][runkit-link]
+![node][node-badge]
 
 <!--consumer-badges end -->
 
@@ -39,17 +42,56 @@ $ npm install @form8ion/github-workflows-core --save-prod
 #### Import
 
 ```javascript
-import {scaffold} from './lib/index.cjs';
+import {
+  scaffoldCheckoutStep,
+  scaffoldNodeSetupStep,
+  scaffoldDependencyInstallationStep,
+  scaffoldVerificationStep
+} from '@form8ion/github-workflows-core';
 ```
 
 #### Execute
 
 ```javascript
 (async () => {
-  await scaffold({projectRoot: process.cwd()});
+  scaffoldCheckoutStep();
+
+  scaffoldNodeSetupStep({versionDeterminedBy: 'nvmrc'});
+
+  scaffoldDependencyInstallationStep();
+
+  scaffoldVerificationStep();
 })();
 ```
 
+### API
+
+#### `scaffoldCheckoutStep`
+
+Scaffolder to define the details for a step to check out the project in a
+GitHub workflow
+
+#### `scaffoldNodeSetupStep`
+
+Scaffolder to define the details for a step to set up a node.js environment in
+a GitHub workflow
+
+Takes a single options object as an argument, containing:
+
+##### `versionDeterminedBy` __string__ (_required_)
+
+Source of node version for use in the configured step. Valid options are `nvmrc`
+or `matrix`
+
+#### `scaffoldDependencyInstallationStep`
+
+Scaffolder to define the details for a step to install dependencies in a GitHub
+workflow
+
+#### `scaffoldVerificationStep`
+
+Scaffolder to define the details for a step to execute verification
+
 ## Contributing
 
 <!--contribution-badges start -->
@@ -114,3 +156,5 @@ $ npm test
 [runkit-link]: https://npm.runkit.com/@form8ion/github-workflows-core
 
 [runkit-badge]: https://badge.runkitcdn.com/@form8ion/github-workflows-core.svg
+
+[node-badge]: https://img.shields.io/node/v/@form8ion/github-workflows-core?logo=node.js

package/example.js

@@ -1,7 +1,12 @@
 // #### Import
 // remark-usage-ignore-next
 import stubbedFs from 'mock-fs';
-import {scaffold} from './lib/index.js';
+import {
+  scaffoldCheckoutStep,
+  scaffoldNodeSetupStep,
+  scaffoldDependencyInstallationStep,
+  scaffoldVerificationStep
+} from './lib/index.js';
 
 // remark-usage-ignore-next
 stubbedFs();
@@ -9,5 +14,11 @@ stubbedFs();
 // #### Execute
 
 (async () => {
-  await scaffold({projectRoot: process.cwd()});
+  scaffoldCheckoutStep();
+
+  scaffoldNodeSetupStep({versionDeterminedBy: 'nvmrc'});
+
+  scaffoldDependencyInstallationStep();
+
+  scaffoldVerificationStep();
 })();

package/lib/index.js

@@ -2,9 +2,33 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-function scaffolder () {
-  return undefined;
+function setupNode({versionDeterminedBy}) {
+  return {
+    name: 'Setup node',
+    uses: 'actions/setup-node@v3',
+    with: {
+      ...'nvmrc' === versionDeterminedBy && {'node-version-file': '.nvmrc'},
+      // eslint-disable-next-line no-template-curly-in-string
+      ...'matrix' === versionDeterminedBy && {'node-version': '${{ matrix.node }}'},
+      cache: 'npm'
+    }
+  };
 }
 
-exports.scaffold = scaffolder;
+function executeVerification() {
+  return {run: 'npm test'};
+}
+
+function installDependencies() {
+  return {run: 'npm clean-install'};
+}
+
+function checkout() {
+  return {uses: 'actions/checkout@v3'};
+}
+
+exports.scaffoldCheckoutStep = checkout;
+exports.scaffoldDependencyInstallationStep = installDependencies;
+exports.scaffoldNodeSetupStep = setupNode;
+exports.scaffoldVerificationStep = executeVerification;
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/scaffolder.js"],"sourcesContent":["export default function () {\n  return undefined;\n}\n"],"names":[],"mappings":";;;;AAAe,mBAAQ,IAAI;AAC3B,EAAE,OAAO,SAAS,CAAC;AACnB;;;;"}
+{"version":3,"file":"index.js","sources":["../src/steps/scaffolders.js"],"sourcesContent":["export function setupNode({versionDeterminedBy}) {\n  return {\n    name: 'Setup node',\n    uses: 'actions/setup-node@v3',\n    with: {\n      ...'nvmrc' === versionDeterminedBy && {'node-version-file': '.nvmrc'},\n      // eslint-disable-next-line no-template-curly-in-string\n      ...'matrix' === versionDeterminedBy && {'node-version': '${{ matrix.node }}'},\n      cache: 'npm'\n    }\n  };\n}\n\nexport function executeVerification() {\n  return {run: 'npm test'};\n}\n\nexport function installDependencies() {\n  return {run: 'npm clean-install'};\n}\n\nexport function checkout() {\n  return {uses: 'actions/checkout@v3'};\n}\n"],"names":[],"mappings":";;;;AAAO,SAAS,SAAS,CAAC,CAAC,mBAAmB,CAAC,EAAE;AACjD,EAAE,OAAO;AACT,IAAI,IAAI,EAAE,YAAY;AACtB,IAAI,IAAI,EAAE,uBAAuB;AACjC,IAAI,IAAI,EAAE;AACV,MAAM,GAAG,OAAO,KAAK,mBAAmB,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC;AAC3E;AACA,MAAM,GAAG,QAAQ,KAAK,mBAAmB,IAAI,CAAC,cAAc,EAAE,oBAAoB,CAAC;AACnF,MAAM,KAAK,EAAE,KAAK;AAClB,KAAK;AACL,GAAG,CAAC;AACJ,CAAC;AACD;AACO,SAAS,mBAAmB,GAAG;AACtC,EAAE,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;AAC3B,CAAC;AACD;AACO,SAAS,mBAAmB,GAAG;AACtC,EAAE,OAAO,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;AACpC,CAAC;AACD;AACO,SAAS,QAAQ,GAAG;AAC3B,EAAE,OAAO,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;AACvC;;;;;;;"}

package/lib/index.mjs

@@ -1,6 +1,27 @@
-function scaffolder () {
-  return undefined;
+function setupNode({versionDeterminedBy}) {
+  return {
+    name: 'Setup node',
+    uses: 'actions/setup-node@v3',
+    with: {
+      ...'nvmrc' === versionDeterminedBy && {'node-version-file': '.nvmrc'},
+      // eslint-disable-next-line no-template-curly-in-string
+      ...'matrix' === versionDeterminedBy && {'node-version': '${{ matrix.node }}'},
+      cache: 'npm'
+    }
+  };
 }
 
-export { scaffolder as scaffold };
+function executeVerification() {
+  return {run: 'npm test'};
+}
+
+function installDependencies() {
+  return {run: 'npm clean-install'};
+}
+
+function checkout() {
+  return {uses: 'actions/checkout@v3'};
+}
+
+export { checkout as scaffoldCheckoutStep, installDependencies as scaffoldDependencyInstallationStep, setupNode as scaffoldNodeSetupStep, executeVerification as scaffoldVerificationStep };
 //# sourceMappingURL=index.mjs.map

package/lib/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":["../src/scaffolder.js"],"sourcesContent":["export default function () {\n  return undefined;\n}\n"],"names":[],"mappings":"AAAe,mBAAQ,IAAI;AAC3B,EAAE,OAAO,SAAS,CAAC;AACnB;;;;"}
+{"version":3,"file":"index.mjs","sources":["../src/steps/scaffolders.js"],"sourcesContent":["export function setupNode({versionDeterminedBy}) {\n  return {\n    name: 'Setup node',\n    uses: 'actions/setup-node@v3',\n    with: {\n      ...'nvmrc' === versionDeterminedBy && {'node-version-file': '.nvmrc'},\n      // eslint-disable-next-line no-template-curly-in-string\n      ...'matrix' === versionDeterminedBy && {'node-version': '${{ matrix.node }}'},\n      cache: 'npm'\n    }\n  };\n}\n\nexport function executeVerification() {\n  return {run: 'npm test'};\n}\n\nexport function installDependencies() {\n  return {run: 'npm clean-install'};\n}\n\nexport function checkout() {\n  return {uses: 'actions/checkout@v3'};\n}\n"],"names":[],"mappings":"AAAO,SAAS,SAAS,CAAC,CAAC,mBAAmB,CAAC,EAAE;AACjD,EAAE,OAAO;AACT,IAAI,IAAI,EAAE,YAAY;AACtB,IAAI,IAAI,EAAE,uBAAuB;AACjC,IAAI,IAAI,EAAE;AACV,MAAM,GAAG,OAAO,KAAK,mBAAmB,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC;AAC3E;AACA,MAAM,GAAG,QAAQ,KAAK,mBAAmB,IAAI,CAAC,cAAc,EAAE,oBAAoB,CAAC;AACnF,MAAM,KAAK,EAAE,KAAK;AAClB,KAAK;AACL,GAAG,CAAC;AACJ,CAAC;AACD;AACO,SAAS,mBAAmB,GAAG;AACtC,EAAE,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;AAC3B,CAAC;AACD;AACO,SAAS,mBAAmB,GAAG;AACtC,EAAE,OAAO,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;AACpC,CAAC;AACD;AACO,SAAS,QAAQ,GAAG;AAC3B,EAAE,OAAO,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;AACvC;;;;"}

package/package.json

@@ -3,7 +3,10 @@
   "description": "core functionality for form8ion plugins that manage github workflows",
   "license": "MIT",
   "type": "commonjs",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0",
+  "engines": {
+    "node": "^14.15 || >=16"
+  },
   "files": [
     "example.js",
     "lib/"
@@ -49,7 +52,8 @@
     "pregenerate:md": "run-s build",
     "lint:sensitive": "ban",
     "prepare": "husky install",
-    "lint:peer": "npm ls >/dev/null"
+    "lint:peer": "npm ls >/dev/null",
+    "lint:engines": "ls-engines"
   },
   "devDependencies": {
     "@babel/register": "7.17.7",
@@ -71,6 +75,7 @@
     "gherkin-lint": "4.2.2",
     "husky": "8.0.1",
     "lockfile-lint": "4.7.4",
+    "ls-engines": "0.6.6",
     "mocha": "10.0.0",
     "mock-fs": "5.1.2",
     "npm-run-all": "4.1.5",