Merge pull request #8 from omelkonian/main

Provide library for other actions to use.

Author: Jared Weakly

setup/.eslintignore

@@ -1,4 +1,5 @@
 dist/
+lib/
 .out/
 __tests__/
 node_modules/

setup/.gitignore

@@ -1,4 +1,5 @@
 node_modules
 dist-newstyle
 .out
+**/tsbuildinfo
 .eslintcache

setup/.lintstagedrc.js

@@ -1,9 +1,9 @@
 module.exports = {
-  'setup/!(*test).{js,ts,json}': [
+  '!(*test).{js,ts,json}': [
     'eslint --cache --fix',
-    () => 'ncc build',
-    () => 'git add dist'
+    () => 'npm run bundle',
+    () => 'git add setup/dist/ setup/lib/'
   ],
-  'setup/src/**/*.ts': () => 'tsc -p tsconfig.json',
-  'setup/*.{js,ts,json,md}': 'prettier --write'
+  'src/**/*.ts': () => 'tsc -p tsconfig.json',
+  '*.{js,ts,json,md}': 'prettier --write'
 };

setup/__tests__/find-haskell.test.ts

@@ -1,6 +1,5 @@
 import {getOpts, getDefaults} from '../src/opts';
 import type {OS, Revisions, Tool} from '../src/opts';
-import {getInput} from '@actions/core';
 import * as supported_versions from '../src/versions.json';
 import * as rv from '../src/release-revisions.json';
 
@@ -17,29 +16,13 @@ const latestRevisions = (os: OS) => ({
   stack: release_revisions?.[os]?.stack?.[0]?.to
 });
 
-const mkName = (s: string): string =>
-  `INPUT_${s.replace(/ /g, '_').toUpperCase()}`;
-
-const setupEnv = (o: Record<string, unknown>): void =>
-  Object.entries(o).forEach(([k, v]) => v && (process.env[mkName(k)] = `${v}`));
-
 const forAllOS = (fn: (t: OS) => any) =>
   (['win32', 'darwin', 'linux'] as const).forEach(fn);
 
 const forAllTools = (fn: (t: Tool) => any) =>
   (['ghc', 'cabal', 'stack'] as const).forEach(fn);
 
 describe('haskell/actions/setup', () => {
-  const OLD_ENV = process.env;
-
-  beforeEach(() => {
-    jest.resetModules();
-    process.env = {...OLD_ENV};
-    delete process.env.NODE_ENV;
-  });
-
-  afterEach(() => (process.env = OLD_ENV));
-
   it('Parses action.yml to get correct default versions', () => {
     forAllOS(os =>
       forAllTools(t =>
@@ -55,43 +38,34 @@ describe('haskell/actions/setup', () => {
       forAllTools(t => expect(def(os)[t].supported).toBe(supported_versions[t]))
     ));
 
-  it('[meta] Setup Env works', () => {
-    setupEnv({input: 'value'});
-    const i = getInput('input');
-    expect(i).toEqual('value');
-  });
-
   it('getOpts grabs defaults correctly from environment', () => {
-    setupEnv({});
     forAllOS(os => {
-      const options = getOpts(def(os), os);
+      const options = getOpts(def(os), os, {});
       forAllTools(t => expect(options[t].raw).toBe(def(os)[t].version));
     });
   });
 
   it('Versions resolve correctly', () => {
     const v = {ghc: '8.6.5', cabal: '2.4.1.0', stack: '2.1.3'};
-    setupEnv({
-      'enable-stack': 'true',
-      'stack-version': '2.1',
-      'ghc-version': '8.6',
-      'cabal-version': '2.4'
-    });
     forAllOS(os => {
-      const options = getOpts(def(os), os);
+      const options = getOpts(def(os), os, {
+        'enable-stack': 'true',
+        'stack-version': '2.1',
+        'ghc-version': '8.6',
+        'cabal-version': '2.4'
+      });
       forAllTools(t => expect(options[t].resolved).toBe(v[t]));
     });
   });
 
   it('"latest" Versions resolve correctly', () => {
-    setupEnv({
-      'enable-stack': 'true',
-      'stack-version': 'latest',
-      'ghc-version': 'latest',
-      'cabal-version': 'latest'
-    });
     forAllOS(os => {
-      const options = getOpts(def(os), os);
+      const options = getOpts(def(os), os, {
+        'enable-stack': 'true',
+        'stack-version': 'latest',
+        'ghc-version': 'latest',
+        'cabal-version': 'latest'
+      });
       forAllTools(t =>
         expect(options[t].resolved).toBe(
           latestRevisions(os)[t] ?? latestVersions[t]
@@ -101,9 +75,10 @@ describe('haskell/actions/setup', () => {
   });
 
   it('Enabling stack does not disable GHC or Cabal', () => {
-    setupEnv({'enable-stack': 'true'});
     forAllOS(os => {
-      const {ghc, cabal, stack} = getOpts(def(os), os);
+      const {ghc, cabal, stack} = getOpts(def(os), os, {
+        'enable-stack': 'true'
+      });
       expect({
         ghc: ghc.enable,
         stack: stack.enable,
@@ -113,9 +88,11 @@ describe('haskell/actions/setup', () => {
   });
 
   it('Enabling stack-no-global disables GHC and Cabal', () => {
-    setupEnv({'enable-stack': 'true', 'stack-no-global': 'true'});
     forAllOS(os => {
-      const {ghc, cabal, stack} = getOpts(def(os), os);
+      const {ghc, cabal, stack} = getOpts(def(os), os, {
+        'enable-stack': 'true',
+        'stack-no-global': 'true'
+      });
       expect({
         ghc: ghc.enable,
         cabal: cabal.enable,
@@ -125,12 +102,14 @@ describe('haskell/actions/setup', () => {
   });
 
   it('Enabling stack-no-global without setting enable-stack errors', () => {
-    setupEnv({'stack-no-global': 'true'});
-    forAllOS(os => expect(() => getOpts(def(os), os)).toThrow());
+    forAllOS(os =>
+      expect(() => getOpts(def(os), os, {'stack-no-global': 'true'})).toThrow()
+    );
   });
 
   it('Enabling stack-setup-ghc without setting enable-stack errors', () => {
-    setupEnv({'stack-setup-ghc': 'true'});
-    forAllOS(os => expect(() => getOpts(def(os), os)).toThrow());
+    forAllOS(os =>
+      expect(() => getOpts(def(os), os, {'stack-setup-ghc': 'true'})).toThrow()
+    );
   });
 });

setup/dist/index.js

@@ -40,7 +40,7 @@ module.exports =
 /******/ 	// the startup function
 /******/ 	function startup() {
 /******/ 		// Load entry module and return exports
-/******/ 		return __webpack_require__(661);
+/******/ 		return __webpack_require__(131);
 /******/ 	};
 /******/
 /******/ 	// run startup
@@ -868,21 +868,21 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOpts = exports.getDefaults = void 0;
+exports.getOpts = exports.getDefaults = exports.yamlInputs = void 0;
 const core = __importStar(__webpack_require__(470));
 const fs_1 = __webpack_require__(747);
 const js_yaml_1 = __webpack_require__(414);
 const path_1 = __webpack_require__(622);
 const supported_versions = __importStar(__webpack_require__(447));
 const rv = __importStar(__webpack_require__(859));
 const release_revisions = rv;
+exports.yamlInputs = js_yaml_1.safeLoad(fs_1.readFileSync(__webpack_require__.ab + "action.yml", 'utf8')
+// The action.yml file structure is statically known.
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+).inputs;
 function getDefaults(os) {
-    const inpts = js_yaml_1.safeLoad(fs_1.readFileSync(__webpack_require__.ab + "action.yml", 'utf8')
-    // The action.yml file structure is statically known.
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    ).inputs;
     const mkVersion = (v, vs, t) => ({
-        version: resolve(inpts[v].default, vs, t, os),
+        version: resolve(exports.yamlInputs[v].default, vs, t, os),
         supported: vs
     });
     return {
@@ -899,14 +899,16 @@ function resolve(version, supported, tool, os) {
         : (_a = supported.find(v => v.startsWith(version))) !== null && _a !== void 0 ? _a : version;
     return ((_e = (_d = (_c = (_b = release_revisions === null || release_revisions === void 0 ? void 0 : release_revisions[os]) === null || _b === void 0 ? void 0 : _b[tool]) === null || _c === void 0 ? void 0 : _c.find(({ from }) => from === resolved)) === null || _d === void 0 ? void 0 : _d.to) !== null && _e !== void 0 ? _e : resolved);
 }
-function getOpts({ ghc, cabal, stack }, os) {
-    const stackNoGlobal = core.getInput('stack-no-global') !== '';
-    const stackSetupGhc = core.getInput('stack-setup-ghc') !== '';
-    const stackEnable = core.getInput('enable-stack') !== '';
+function getOpts({ ghc, cabal, stack }, os, inputs) {
+    core.debug(`Inputs are: ${JSON.stringify(inputs)}`);
+    const stackNoGlobal = (inputs['stack-no-global'] || '') !== '';
+    const stackSetupGhc = (inputs['stack-setup-ghc'] || '') !== '';
+    const stackEnable = (inputs['enable-stack'] || '') !== '';
+    core.debug(`${stackNoGlobal}/${stackSetupGhc}/${stackEnable}`);
     const verInpt = {
-        ghc: core.getInput('ghc-version') || ghc.version,
-        cabal: core.getInput('cabal-version') || cabal.version,
-        stack: core.getInput('stack-version') || stack.version
+        ghc: inputs['ghc-version'] || ghc.version,
+        cabal: inputs['cabal-version'] || cabal.version,
+        stack: inputs['stack-version'] || stack.version
     };
     const errors = [];
     if (stackNoGlobal && !stackEnable) {
@@ -933,7 +935,7 @@ function getOpts({ ghc, cabal, stack }, os) {
             raw: verInpt.stack,
             resolved: resolve(verInpt.stack, stack.supported, 'stack', os),
             enable: stackEnable,
-            setup: core.getInput('stack-setup-ghc') !== ''
+            setup: stackSetupGhc
         }
     };
     // eslint-disable-next-line github/array-foreach
@@ -1143,6 +1145,42 @@ exports.issueCommand = issueCommand;
 
 module.exports = require("child_process");
 
+/***/ }),
+
+/***/ 131:
+/***/ (function(__unusedmodule, exports, __webpack_require__) {
+
+"use strict";
+
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core = __importStar(__webpack_require__(470));
+const opts_1 = __webpack_require__(54);
+const setup_haskell_1 = __importDefault(__webpack_require__(661));
+setup_haskell_1.default(Object.fromEntries(Object.keys(opts_1.yamlInputs).map(k => [k, core.getInput(k)])));
+
+
 /***/ }),
 
 /***/ 139:
@@ -8775,11 +8813,11 @@ async function cabalConfig() {
     });
     return out.toString().trim().split('\n').slice(-1)[0].trim();
 }
-(async () => {
+async function run(inputs) {
     try {
         core.info('Preparing to setup a Haskell environment');
         const os = process.platform;
-        const opts = opts_1.getOpts(opts_1.getDefaults(os), os);
+        const opts = opts_1.getOpts(opts_1.getDefaults(os), os, inputs);
         for (const [t, { resolved }] of Object.entries(opts).filter(o => o[1].enable))
             await core.group(`Installing ${t} version ${resolved}`, async () => installer_1.installTool(t, resolved, os));
         if (opts.stack.setup)
@@ -8803,7 +8841,8 @@ async function cabalConfig() {
     catch (error) {
         core.setFailed(error.message);
     }
-})();
+}
+exports.default = run;
 
 
 /***/ }),

setup/docs/contributors.md

@@ -4,6 +4,7 @@
 
 - Do checkin source (src)
 - Do checkin build output (dist)
+- Do checkin library build output (lib)
 
 ### Dependencies
 
@@ -16,7 +17,8 @@ git add abc.ext                             # Add the files you've changed. This
 git commit -m "Informative commit message"  # Commit. This will run Husky
 ```
 
-During the commit step, Husky will take care of formatting all files with [Prettier](https://github.com/prettier/prettier). It will also bundle the code into a single `dist/index.js` file.
+During the commit step, Husky will take care of formatting all files with [Prettier](https://github.com/prettier/prettier).
+It will also bundle the code into a single `dist/index.js` file and output the transpiled library under `lib/`.
 Finally, it will make sure these changes are appropriately included in your commit--no further work is needed.
 
 ## Versions

setup/lib/installer.d.ts

@@ -0,0 +1,6 @@
+import type {OS, Tool} from './opts';
+export declare function installTool(
+  tool: Tool,
+  version: string,
+  os: OS
+): Promise<void>;