@ronaldphilipsen/local-action 0.0.0-stage → 7.0.1

package/eslint.config.mjs

@@ -0,0 +1,74 @@
+import { FlatCompat } from '@eslint/eslintrc'
+import js from '@eslint/js'
+import typescriptEslint from '@typescript-eslint/eslint-plugin'
+import tsParser from '@typescript-eslint/parser'
+import prettier from 'eslint-plugin-prettier'
+import globals from 'globals'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all
+})
+
+export default [
+  {
+    ignores: [
+      '__fixtures__/javascript',
+      '__fixtures__/javascript-esm',
+      '__fixtures__/typescript',
+      '__fixtures__/typescript-esm',
+      '.github',
+      '.vscode',
+      'badges',
+      'bin',
+      'coverage',
+      'megalinter-reports',
+      'node_modules',
+      'reports'
+    ]
+  },
+  ...compat.extends(
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended'
+  ),
+  {
+    plugins: {
+      prettier,
+      '@typescript-eslint': typescriptEslint
+    },
+
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        Atomics: 'readonly',
+        SharedArrayBuffer: 'readonly'
+      },
+
+      parser: tsParser,
+      ecmaVersion: 2023,
+      sourceType: 'module',
+
+      parserOptions: {
+        project: ['tsconfig.eslint.json']
+      }
+    },
+
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+      camelcase: 'off',
+      'eslint-comments/no-use': 'off',
+      'eslint-comments/no-unused-disable': 'off',
+      'i18n-text/no-en': 'off',
+      'no-console': 'off',
+      'no-shadow': 'off',
+      'no-unused-vars': 'off',
+      'prettier/prettier': 'error'
+    }
+  }
+]

package/jest.config.ts

@@ -0,0 +1,41 @@
+import type { JestConfigWithTsJest } from 'ts-jest'
+
+const config: JestConfigWithTsJest = {
+  clearMocks: true,
+  collectCoverage: true,
+  collectCoverageFrom: ['src/**'],
+  coverageDirectory: 'coverage',
+  coveragePathIgnorePatterns: [
+    'node_modules',
+    'src/types/quibble.d.ts',
+    'src/commands/run.ts',
+    'src/stubs/artifact/artifact.ts',
+    'src/index.ts'
+  ],
+  coverageReporters: ['json-summary', 'lcov', 'text'],
+  coverageThreshold: {
+    global: {
+      branches: 100,
+      functions: 100,
+      lines: 100,
+      statements: 100
+    }
+  },
+  extensionsToTreatAsEsm: ['.ts'],
+  moduleFileExtensions: ['js', 'ts'],
+  preset: 'ts-jest',
+  reporters: ['default', 'jest-junit'],
+  resolver: 'ts-jest-resolver',
+  roots: ['<rootDir>/src/', '<rootDir>/__fixtures__/', '<rootDir>/__tests__/'],
+  testMatch: ['**/*.test.ts'],
+  testPathIgnorePatterns: ['/dist/', '/megalinter-reports/', '/node_modules/'],
+  transform: {
+    '\\.[jt]sx?$': [
+      'ts-jest',
+      { useESM: true, tsconfig: 'tsconfig.eslint.json' }
+    ]
+  },
+  verbose: true
+}
+
+export default config

package/package.json

@@ -1,6 +1,95 @@
 {
   "name": "@ronaldphilipsen/local-action",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "description": "Local Debugging for GitHub Actions",
+  "version": "7.0.1",
+  "type": "module",
+  "author": "Nick Alteen <ncalteen@github.com>",
+  "private": false,
+  "homepage": "https://github.com/RonaldPhilipsen/local-action",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/RonaldPhilipsen/local-action.git"
+  },
+  "bugs": {
+    "url": "https://github.com/RonaldPhilipsen/local-action/issues"
+  },
+  "keywords": [
+    "actions",
+    "node",
+    "typescript"
+  ],
+  "engines": {
+    "node": "^20 || ^22 || ^24 || ^26"
+  },
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "bin": {
+    "local-action": "bin/local-action.js"
+  },
+  "scripts": {
+    "ci-test": "NODE_OPTIONS=\"$NODE_OPTIONS --no-warnings --experimental-vm-modules\" jest --ci --reporters=default --reporters=jest-junit --no-cache",
+    "coverage": "make-coverage-badge --output-path ./badges/coverage.svg",
+    "format:write": "prettier --write .",
+    "format:check": "prettier --check .",
+    "lint": "eslint .",
+    "test": "NODE_OPTIONS=\"$NODE_OPTIONS --no-warnings --experimental-vm-modules\" jest --no-cache",
+    "all": "npm run format:write && npm run lint && npm run test && npm run coverage"
+  },
+  "license": "MIT",
+  "jest-junit": {
+    "outputDirectory": "reports",
+    "outputName": "jest-junit.xml"
+  },
+  "dependencies": {
+    "@actions/artifact": "^5.0.2",
+    "@actions/cache": "^5.0.3",
+    "@actions/core": "^2.0.2",
+    "@actions/exec": "^2.0.0",
+    "@actions/github": "^7.0.0",
+    "@actions/http-client": "^3.0.1",
+    "@octokit/core": "^7.0.6",
+    "@octokit/plugin-paginate-rest": "^13.2.1",
+    "@octokit/plugin-request-log": "^6.0.0",
+    "@octokit/plugin-rest-endpoint-methods": "^17.0.0",
+    "@octokit/plugin-retry": "^8.0.3",
+    "@octokit/rest": "^22.0.1",
+    "archiver": "^7.0.1",
+    "chalk": "^5.6.2",
+    "commander": "^14.0.3",
+    "comment-json": "^4.5.1",
+    "dotenv": "^17.3.1",
+    "figlet": "^1.10.0",
+    "quibble": "^0.9.2",
+    "semver": "^7.7.4",
+    "tsconfig-paths": "^4.2.0",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3",
+    "yaml": "^2.8.2"
+  },
+  "devDependencies": {
+    "@eslint/compat": "^2.0.2",
+    "@eslint/eslintrc": "^3.3.3",
+    "@eslint/js": "^10.0.1",
+    "@jest/globals": "^30.2.0",
+    "@types/archiver": "^7.0.0",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^25.2.3",
+    "@types/semver": "^7.7.1",
+    "@types/unzip-stream": "^0.3.4",
+    "@typescript-eslint/eslint-plugin": "^8.56.0",
+    "@typescript-eslint/parser": "^8.56.0",
+    "eslint": "^10.0.0",
+    "eslint-plugin-prettier": "^5.5.5",
+    "jest": "^30.2.0",
+    "jest-junit": "^16.0.0",
+    "make-coverage-badge": "^1.2.0",
+    "prettier": "^3.8.1",
+    "ts-jest": "^29.4.6",
+    "ts-jest-resolver": "^2.0.1",
+    "ts-node": "^10.9.2"
+  },
+  "overrides": {
+    "undici": ">=6.23.0"
+  }
+}

package/src/command.ts

@@ -0,0 +1,171 @@
+import { Command, InvalidArgumentError } from 'commander'
+import { dirname } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { action } from './commands/run.js'
+import { EnvMeta } from './stubs/env.js'
+
+/**
+ * Creates the CLI Program
+ *
+ * @returns Command Program Object
+ */
+export async function makeProgram(): Promise<Command> {
+  const program: Command = new Command()
+  const fs = await import('fs')
+  const path = await import('path')
+  const __dirname = dirname(fileURLToPath(import.meta.url))
+
+  /**
+   * Checks if Action Path is Valid
+   *
+   * @param value Action Path
+   * @returns Resolved Action Path
+   * @throws InvalidArgumentError
+   */
+  function checkActionPath(value: string): string {
+    const actionPath: string = path.resolve(value)
+
+    try {
+      // Confirm the value is a directory
+      if (!fs.statSync(actionPath).isDirectory())
+        throw new InvalidArgumentError('Action path must be a directory')
+    } catch (err: any) {
+      if ('code' in err && err.code === 'ENOENT')
+        throw new InvalidArgumentError('Action path does not exist')
+      else throw new InvalidArgumentError(err.message as string)
+    }
+
+    // Save the action path to environment metadata
+    EnvMeta.actionPath = actionPath
+
+    // Confirm there is an `action.yml` or `action.yaml` in the directory and
+    // save the path to environment metadata
+    if (fs.existsSync(path.resolve(actionPath, 'action.yml')))
+      EnvMeta.actionFile = path.resolve(EnvMeta.actionPath, 'action.yml')
+    else if (fs.existsSync(path.resolve(actionPath, 'action.yaml')))
+      EnvMeta.actionFile = path.resolve(EnvMeta.actionPath, 'action.yaml')
+    else
+      throw new InvalidArgumentError(
+        'Path must contain an action.yml / action.yaml file'
+      )
+
+    return path.resolve(value)
+  }
+
+  /**
+   * Checks if `main` Entrypoint is Valid
+   *
+   * @param value Entrypoint
+   * @returns Resolved Entrypoint Path
+   * @throws InvalidArgumentError
+   */
+  function checkEntrypoint(value: string): string {
+    const entrypoint: string = path.resolve(EnvMeta.actionPath, value)
+
+    // Confirm the entrypoint exists
+    if (!fs.existsSync(entrypoint))
+      throw new InvalidArgumentError(`Entrypoint does not exist: ${value}`)
+
+    // Save the action entrypoint to environment metadata
+    EnvMeta.entrypoint = entrypoint
+
+    return entrypoint
+  }
+
+  /**
+   * Checks if `pre` Entrypoint is Valid
+   *
+   * @param value Entrypoint
+   * @returns Resolved Entrypoint Path
+   * @throws InvalidArgumentError
+   */
+  function checkPreEntrypoint(value: string): string {
+    const entrypoint: string = path.resolve(EnvMeta.actionPath, value)
+
+    // Confirm the entrypoint exists
+    if (!fs.existsSync(entrypoint))
+      throw new InvalidArgumentError(
+        `PRE entrypoint does not exist: ${entrypoint}`
+      )
+
+    // Save the action entrypoint to environment metadata
+    EnvMeta.preEntrypoint = entrypoint
+
+    return entrypoint
+  }
+
+  /**
+   * Checks if `post` Entrypoint is Valid
+   *
+   * @param value Entrypoint
+   * @returns Resolved Entrypoint Path
+   * @throws InvalidArgumentError
+   */
+  function checkPostEntrypoint(value: string): string {
+    const entrypoint: string = path.resolve(EnvMeta.actionPath, value)
+
+    // Confirm the entrypoint exists
+    if (!fs.existsSync(entrypoint))
+      throw new InvalidArgumentError(`POST entrypoint does not exist: ${value}`)
+
+    // Save the action entrypoint to environment metadata
+    EnvMeta.postEntrypoint = entrypoint
+
+    return entrypoint
+  }
+
+  /**
+   * Checks if `dotenv` File is Valid
+   *
+   * @param value Dotenv File Path
+   * @returns Resolved Dotenv File Path
+   * @throws InvalidArgumentError
+   */
+  function checkDotenvFile(value: string): string {
+    const dotenvFile: string = path.resolve(value)
+
+    // Confirm the dotenv file exists
+    if (!fs.existsSync(dotenvFile))
+      throw new InvalidArgumentError('Environment file does not exist')
+
+    // Save the .env file path to environment metadata
+    EnvMeta.dotenvFile = dotenvFile
+
+    return dotenvFile
+  }
+
+  program
+    .name('local-action')
+    .description('Test a GitHub Action locally')
+    .version(
+      `Version: ${JSON.parse(fs.readFileSync(path.resolve(__dirname, '..', 'package.json'), 'utf-8')).version as string}`
+    )
+
+  program
+    .command('run', { isDefault: true })
+    .description('Run a GitHub Action locally')
+    .argument('<action path>', 'Path to the action directory', checkActionPath)
+    .argument(
+      '<entrypoint>',
+      'Action entrypoint (relative to the action directory)',
+      checkEntrypoint
+    )
+    .argument('<dotenv file>', 'Path to the local .env file', checkDotenvFile)
+    .option(
+      '--pre <pre>',
+      'Action pre entrypoint (relative to the action directory)',
+      checkPreEntrypoint,
+      undefined
+    )
+    .option(
+      '--post <post>',
+      'Action post entrypoint (relative to the action directory)',
+      checkPostEntrypoint,
+      undefined
+    )
+    .action(async (actionPath, entrypoint, dotenvFile, options) => {
+      await action(actionPath, entrypoint, dotenvFile, options)
+    })
+
+  return program
+}