Add Support for ESM Actions (#90)

This PR converts `local-action` to ESM, as well as adds support for
JavaScript/TypeScript actions written in ESM syntax.

This is accomplished by replacing proxyquire with quibble, which allows
for stubbing out both CommonJS and ESM packages with less issues.

.eslintignore

@@ -1,3 +1,7 @@
+__fixtures__/javascript
+__fixtures__/javascript-esm
+__fixtures__/typescript
+__fixtures__/typescript-esm
 .github/
 .vscode/
 badges/

.eslintrc.yml

@@ -38,6 +38,7 @@ rules:
     'camelcase': 'off',
     'eslint-comments/no-use': 'off',
     'i18n-text/no-en': 'off',
+    'import/no-namespace': 'off',
     'no-console': 'off',
     'no-unused-vars': 'off'
   }

.node-version

@@ -1 +1 @@
-21.6.2
+20.5.1

__fixtures__/core.ts

@@ -0,0 +1,13 @@
+import { jest } from '@jest/globals'
+
+export const debug = jest.fn().mockImplementation(() => {})
+export const error = jest.fn().mockImplementation(() => {})
+export const info = jest.fn().mockImplementation(() => {})
+export const getInput = jest.fn().mockImplementation(() => {})
+export const setOutput = jest.fn().mockImplementation(() => {})
+export const setFailed = jest.fn().mockImplementation(() => {})
+export const warning = jest.fn().mockImplementation(() => {})
+export const summary = {
+  addRaw: jest.fn().mockImplementation(() => {}),
+  write: jest.fn().mockImplementation(() => {})
+}

__fixtures__/javascript-esm/no-import/.env.fixture

@@ -0,0 +1,2 @@
+ACTIONS_STEP_DEBUG=false
+INPUT_MILLISECONDS=2400

__fixtures__/javascript-esm/no-import/action.yml

@@ -0,0 +1,16 @@
+name: JavaScript (No Import)
+description: This action doesn't import any dependencies
+
+inputs:
+  myInput:
+    description: An input
+    required: true
+    default: value
+
+outputs:
+  myOutput:
+    description: An output
+
+runs:
+  using: node20
+  main: dist/index.js

__fixtures__/javascript-esm/no-import/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "javascript-action",
+  "description": "GitHub Actions JavaScript template",
+  "version": "0.0.0",
+  "type": "module",
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "@actions/core": "^1.10.1"
+  },
+  "devDependencies": {}
+}

__fixtures__/javascript-esm/no-import/src/index.js

@@ -0,0 +1,3 @@
+const { run } = require('./main')
+
+run()

__fixtures__/javascript-esm/no-import/src/main.js

@@ -0,0 +1,7 @@
+async function run() {
+  return Promise.resolve()
+}
+
+module.exports = {
+  run
+}

__fixtures__/javascript-esm/success/.env.fixture

@@ -0,0 +1,2 @@
+ACTIONS_STEP_DEBUG=false
+INPUT_MILLISECONDS=2400

__fixtures__/typescript/success-yaml/action.yaml → __fixtures__/javascript-esm/success/action.yml

@@ -1,11 +1,11 @@
-name: TypeScript (Success)
+name: JavaScript (Success)
 description: This action returns without error
 
 inputs:
   myInput:
     description: An input
     required: true
-    default: 'default value'
+    default: value
 
 outputs:
   myOutput:

__fixtures__/javascript-esm/success/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "javascript-action",
+  "description": "GitHub Actions JavaScript template",
+  "version": "0.0.0",
+  "type": "module",
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "@actions/core": "^1.10.1"
+  },
+  "devDependencies": {}
+}

__fixtures__/javascript-esm/success/src/index.js

@@ -0,0 +1,3 @@
+const { run } = require('./main')
+
+run()

__fixtures__/javascript-esm/success/src/main.js

@@ -0,0 +1,13 @@
+const { getInput, info, setOutput } = require('@actions/core')
+
+async function run() {
+  const myInput = getInput('myInput')
+
+  setOutput('myOutput', myInput)
+
+  info('JavaScript Action Succeeded!')
+}
+
+module.exports = {
+  run
+}

__fixtures__/javascript/no-import/.env.fixture

@@ -1,8 +1,2 @@
-# Do not commit your actual .env file to Git! This may contain secrets or other
-# private information.
-
-# GitHub Actions inputs should follow `INPUT_<name>` format (case-insensitive).
-INPUT_milliseconds=2400
-
-# Enable/disable step debug logs
-ACTIONS_STEP_DEBUG=false
+ACTIONS_STEP_DEBUG=false
+INPUT_MILLISECONDS=2400

__fixtures__/javascript/no-import/action.yml

@@ -5,7 +5,7 @@ inputs:
   myInput:
     description: An input
     required: true
-    default: 'default value'
+    default: value
 
 outputs:
   myOutput:

__fixtures__/javascript/no-import/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "javascript-action",
+  "description": "GitHub Actions JavaScript template",
+  "version": "0.0.0",
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "@actions/core": "^1.10.1"
+  },
+  "devDependencies": {}
+}

__fixtures__/javascript/no-import/src/index.js

@@ -1,7 +1,3 @@
-/* eslint-disable @typescript-eslint/no-floating-promises */
-/* eslint-disable @typescript-eslint/no-var-requires */
-/* eslint-disable import/no-commonjs */
-
 const { run } = require('./main')
 
 run()

__fixtures__/javascript/no-import/src/main.js

@@ -1,5 +1,3 @@
-/* eslint-disable import/no-commonjs */
-
 async function run() {
   return Promise.resolve()
 }

__fixtures__/javascript/success/.env.fixture

@@ -1,11 +1,2 @@
-# Do not commit your actual .env file to Git! This may contain secrets or other
-# private information.
-
-# GitHub Actions inputs should follow `INPUT_<name>` format (case-insensitive).
-INPUT_milliseconds=2400
-
-# Enable/disable step debug logs
 ACTIONS_STEP_DEBUG=false
-
-# Step summary output location
-GITHUB_STEP_SUMMARY='summary.md'
+INPUT_MILLISECONDS=2400

__fixtures__/javascript/success/action.yml

@@ -5,7 +5,7 @@ inputs:
   myInput:
     description: An input
     required: true
-    default: 'default value'
+    default: value
 
 outputs:
   myOutput:

__fixtures__/javascript/success/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "javascript-action",
+  "description": "GitHub Actions JavaScript template",
+  "version": "0.0.0",
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "@actions/core": "^1.10.1"
+  },
+  "devDependencies": {}
+}

__fixtures__/javascript/success/src/index.js

@@ -1,7 +1,3 @@
-/* eslint-disable @typescript-eslint/no-floating-promises */
-/* eslint-disable @typescript-eslint/no-var-requires */
-/* eslint-disable import/no-commonjs */
-
 const { run } = require('./main')
 
 run()

__fixtures__/javascript/success/src/main.js

@@ -1,17 +1,11 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-/* eslint-disable import/no-commonjs */
-
-const core = require('@actions/core')
+const { getInput, info, setOutput } = require('@actions/core')
 
 async function run() {
-  const myInput = core.getInput('myInput')
-
-  core.setOutput('myOutput', myInput)
+  const myInput = getInput('myInput')
 
-  core.summary.addRaw('JavaScript Action Succeeded!')
-  await core.summary.write()
+  setOutput('myOutput', myInput)
 
-  core.info('JavaScript Action Succeeded!')
+  info('JavaScript Action Succeeded!')
 }
 
 module.exports = {

__fixtures__/tsconfig-paths.ts

@@ -0,0 +1,4 @@
+import { jest } from '@jest/globals'
+
+export const loadConfig = jest.fn().mockImplementation(() => {})
+export const register = jest.fn().mockImplementation(() => {})

__fixtures__/typescript-esm/no-import/.env.fixture

@@ -0,0 +1,2 @@
+ACTIONS_STEP_DEBUG=false
+INPUT_MILLISECONDS=2400

__fixtures__/typescript-esm/no-import/action.yml

@@ -0,0 +1,17 @@
+name: The name of your action here
+description: Provide a description here
+author: Your name or organization here
+
+inputs:
+  milliseconds:
+    description: Your input description here
+    required: true
+    default: '1000'
+
+outputs:
+  time:
+    description: Your output description here
+
+runs:
+  using: node20
+  main: dist/index.js

__fixtures__/typescript-esm/no-import/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "typescript-action",
+  "description": "GitHub Actions TypeScript template",
+  "version": "0.0.0",
+  "type": "module",
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "@actions/core": "^1.10.1"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.7",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.5.2"
+  }
+}

__fixtures__/typescript-esm/no-import/src/index.ts

@@ -0,0 +1,3 @@
+import { run } from './main.js'
+
+run()

__fixtures__/typescript-esm/no-import/src/main.ts

@@ -0,0 +1,3 @@
+export async function run(): Promise<void> {
+  console.log('TypeScript ESM Action (no-import)!')
+}

__fixtures__/typescript-esm/no-import/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "allowSyntheticDefaultImports": true,
+    "declaration": true,
+    "declarationMap": false,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "lib": ["ES2022"],
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "newLine": "lf",
+    "noImplicitAny": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": false,
+    "pretty": true,
+    "resolveJsonModule": true,
+    "sourceMap": true,
+    "strict": true,
+    "strictNullChecks": true,
+    "target": "ES2022"
+  },
+  "exclude": ["node_modules"],
+  "include": ["src"]
+}

__fixtures__/typescript-esm/success/.env.fixture

@@ -0,0 +1,2 @@
+ACTIONS_STEP_DEBUG=false
+INPUT_MILLISECONDS=2400

__fixtures__/typescript-esm/success/action.yml

@@ -0,0 +1,17 @@
+name: The name of your action here
+description: Provide a description here
+author: Your name or organization here
+
+inputs:
+  milliseconds:
+    description: Your input description here
+    required: true
+    default: '1000'
+
+outputs:
+  time:
+    description: Your output description here
+
+runs:
+  using: node20
+  main: dist/index.js

__fixtures__/typescript-esm/success/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "typescript-action",
+  "description": "GitHub Actions TypeScript template",
+  "version": "0.0.0",
+  "type": "module",
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "@actions/core": "^1.10.1"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.7",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.5.2"
+  }
+}