@ronaldphilipsen/local-action 0.0.0-stage → 7.0.1

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

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

package/__fixtures__/typescript-esm/no-export/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"]
+}

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

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

package/__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

package/__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": ">=24"
+  },
+  "dependencies": {
+    "@actions/core": "^2.0.2"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.7",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.6.3"
+  }
+}

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

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

package/__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)!')
+}

package/__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"]
+}

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

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

package/__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

package/__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": ">=24"
+  },
+  "dependencies": {
+    "@actions/core": "^2.0.2"
+  },
+  "devDependencies": {
+    "@types/node": "^22.14.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.6.3"
+  }
+}

package/__fixtures__/typescript-esm/success/post/index.ts

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

package/__fixtures__/typescript-esm/success/post/main.ts

@@ -0,0 +1,9 @@
+import { getInput, info, setOutput } from '@actions/core'
+
+export async function run(): Promise<void> {
+  const myInput: string = getInput('myInput')
+
+  setOutput('myOutput', myInput)
+
+  info('TypeScript ESM Action Succeeded!')
+}

package/__fixtures__/typescript-esm/success/pre/index.ts

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

package/__fixtures__/typescript-esm/success/pre/main.ts

@@ -0,0 +1,9 @@
+import { getInput, info, setOutput } from '@actions/core'
+
+export async function run(): Promise<void> {
+  const myInput: string = getInput('myInput')
+
+  setOutput('myOutput', myInput)
+
+  info('TypeScript ESM Action Succeeded!')
+}

package/__fixtures__/typescript-esm/success/src/index.ts

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

package/__fixtures__/typescript-esm/success/src/main.ts

@@ -0,0 +1,9 @@
+import { getInput, info, setOutput } from '@actions/core'
+
+export async function run(): Promise<void> {
+  const myInput: string = getInput('myInput')
+
+  setOutput('myOutput', myInput)
+
+  info('TypeScript ESM Action Succeeded!')
+}

package/__fixtures__/typescript-esm/success/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"]
+}

package/__fixtures__/typescript-esm/tsconfig-comments/.env.fixture

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

package/__fixtures__/typescript-esm/tsconfig-comments/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

package/__fixtures__/typescript-esm/tsconfig-comments/package.json

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

package/__fixtures__/typescript-esm/tsconfig-comments/src/index.ts

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

package/__fixtures__/typescript-esm/tsconfig-comments/src/main.ts

@@ -0,0 +1,9 @@
+import { getInput, info, setOutput } from '@actions/core'
+
+export async function run(): Promise<void> {
+  const myInput: string = getInput('myInput')
+
+  setOutput('myOutput', myInput)
+
+  info('TypeScript ESM Action Succeeded!')
+}

package/__fixtures__/typescript-esm/tsconfig-comments/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  /* Visit https://aka.ms/tsconfig to read more about this file */
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "target": "ES2022" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    "module": "NodeNext" /* Specify what module code is generated. */,
+    "rootDir": "./src",
+    "moduleResolution": "NodeNext" /* Specify how TypeScript looks up a file from a given module specifier. */,
+    "baseUrl": "./",
+    "sourceMap": true,
+    "outDir": "./dist" /* Specify an output folder for all emitted files. */,
+    "noImplicitAny": true,
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+    "strict": true /* Enable all strict type-checking options. */,
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */,
+    "newLine": "lf"
+  },
+  "exclude": ["node_modules"],
+  "include": ["src"]
+}

package/__tests__/command.test.ts

@@ -0,0 +1,224 @@
+import { jest } from '@jest/globals'
+import { Command } from 'commander'
+import path from 'path'
+import { ResetCoreMetadata } from '../src/stubs/core/core.js'
+import { EnvMeta, ResetEnvMetadata } from '../src/stubs/env.js'
+
+const action = jest.fn()
+
+jest.unstable_mockModule('../src/commands/run.js', () => {
+  return {
+    action
+  }
+})
+
+const process_exitSpy = jest.spyOn(process, 'exit').mockImplementation(() => {
+  throw new Error(`process.exit()`)
+})
+
+const { makeProgram } = await import('../src/command.js')
+
+describe('Commmand', () => {
+  beforeEach(async () => {
+    // Reset metadata
+    ResetEnvMetadata()
+    ResetCoreMetadata()
+  })
+
+  afterEach(() => {
+    jest.resetAllMocks()
+  })
+
+  describe('makeProgram()', () => {
+    it('Returns a Program', async () => {
+      const program = await makeProgram()
+
+      expect(program).not.toBe(null)
+      expect(program).toBeInstanceOf(Command)
+    })
+
+    it('Has a run command', async () => {
+      const program = await makeProgram()
+
+      expect(program.commands.find(c => c.name() === 'run')).toBeInstanceOf(
+        Command
+      )
+    })
+
+    it('Runs if all arguments are provided (action.yml)', async () => {
+      const program = await makeProgram()
+      EnvMeta.actionPath = path.resolve('./__fixtures__/typescript/success')
+
+      program.parse(
+        [
+          './__fixtures__/typescript/success',
+          'src/main.ts',
+          './__fixtures__/typescript/success/.env.fixture',
+          '--pre',
+          'pre/main.ts',
+          '--post',
+          'post/main.ts'
+        ],
+        {
+          from: 'user'
+        }
+      )
+
+      expect(action).toHaveBeenCalled()
+    })
+
+    it('Runs if all arguments are provided (action.yaml)', async () => {
+      const program = await makeProgram()
+      EnvMeta.actionPath = path.resolve(
+        './__fixtures__/typescript/success-yaml'
+      )
+
+      program.parse(
+        [
+          './__fixtures__/typescript/success-yaml',
+          'src/main.ts',
+          './__fixtures__/typescript/success-yaml/.env.fixture',
+          '--pre',
+          'pre/main.ts',
+          '--post',
+          'post/main.ts'
+        ],
+        {
+          from: 'user'
+        }
+      )
+
+      expect(action).toHaveBeenCalled()
+    })
+
+    it('Exits if no path argument is provided', async () => {
+      const program = await makeProgram()
+
+      program.parse([], { from: 'user' })
+
+      expect(process_exitSpy).toHaveBeenCalled()
+    })
+
+    it('Exits if no entrypoint argument is provided', async () => {
+      const program = await makeProgram()
+      EnvMeta.actionPath = path.resolve('./__fixtures__/typescript/success')
+
+      program.parse(['./__fixtures__/typescript/success', ''], { from: 'user' })
+
+      expect(process_exitSpy).toHaveBeenCalled()
+    })
+
+    it('Exits if no env-file argument is provided', async () => {
+      const program = await makeProgram()
+      EnvMeta.actionPath = path.resolve('./__fixtures__/typescript/success')
+
+      program.parse(['./__fixtures__/typescript/success', 'src/main.ts'], {
+        from: 'user'
+      })
+
+      expect(process_exitSpy).toHaveBeenCalled()
+    })
+
+    it('Exits if the action path is not a directory', async () => {
+      const program = await makeProgram()
+      EnvMeta.actionPath = path.resolve('./__fixtures__/typescript/success')
+
+      expect(() => {
+        program.parse(['./package.json', 'src/main.ts', '.env'], {
+          from: 'user'
+        })
+      }).toThrow('Action path must be a directory')
+    })
+
+    it('Exits if the action path does not exist', async () => {
+      const program = await makeProgram()
+      EnvMeta.actionPath = path.resolve('/test/path/does/not/exist')
+
+      expect(() => {
+        program.parse(['/test/path/does/not/exist', 'src/main.ts', '.env'], {
+          from: 'user'
+        })
+      }).toThrow('Action path does not exist')
+    })
+
+    it('Exits if the action path does not contain an action.yml or action.yaml', async () => {
+      const program = await makeProgram()
+      EnvMeta.actionPath = path.resolve('./__fixtures__')
+
+      expect(() => {
+        program.parse(['./__fixtures__', 'src/main.ts', '.env'], {
+          from: 'user'
+        })
+      }).toThrow('Path must contain an action.yml / action.yaml file')
+    })
+
+    it('Exits if the entrypoint does not exist', async () => {
+      const program = await makeProgram()
+
+      expect(() => {
+        program.parse(
+          ['./__fixtures__/typescript/success', 'src/fake.ts', '.env'],
+          {
+            from: 'user'
+          }
+        )
+      }).toThrow('Entrypoint does not exist')
+    })
+
+    it('Exits if the pre entrypoint does not exist', async () => {
+      const program = await makeProgram()
+      EnvMeta.actionPath = path.resolve('./__fixtures__/typescript/success')
+
+      expect(() => {
+        program.parse(
+          [
+            './__fixtures__/typescript/success',
+            'src/main.ts',
+            './__fixtures__/typescript/success/.env.fixture',
+            '--pre',
+            'pre/fake.ts'
+          ],
+          {
+            from: 'user'
+          }
+        )
+      }).toThrow('PRE entrypoint does not exist')
+    })
+
+    it('Exits if the post entrypoint does not exist', async () => {
+      const program = await makeProgram()
+      EnvMeta.actionPath = path.resolve('./__fixtures__/typescript/success')
+
+      expect(() => {
+        program.parse(
+          [
+            './__fixtures__/typescript/success',
+            'src/main.ts',
+            './__fixtures__/typescript/success/.env.fixture',
+            '--pre',
+            'pre/main.ts',
+            '--post',
+            'post/fake.ts'
+          ],
+          {
+            from: 'user'
+          }
+        )
+      }).toThrow('POST entrypoint does not exist')
+    })
+
+    it('Throws if the dotenv file does not exist', async () => {
+      const program = await makeProgram()
+      EnvMeta.actionPath = path.resolve('./__fixtures__/typescript/success')
+
+      expect(() => {
+        program.parse(
+          ['./__fixtures__/typescript/success', 'src/main.ts', '.notreal.env'],
+          {
+            from: 'user'
+          }
+        )
+      }).toThrow('Environment file does not exist')
+    })
+  })
+})