actions

Author: flycran

CODEOWNERS

@@ -1,62 +1,93 @@
 /**
  * Unit tests for the action's main functionality, src/main.ts
- *
- * To mock dependencies in ESM, you can create fixtures that export mock
- * functions and objects. For example, the core module is mocked in this test,
- * so that the actual '@actions/core' module is not imported.
  */
 import { jest } from '@jest/globals'
 import * as core from '../__fixtures__/core.js'
-import { wait } from '../__fixtures__/wait.js'
 
 // Mocks should be declared before the module being tested is imported.
 jest.unstable_mockModule('@actions/core', () => core)
-jest.unstable_mockModule('../src/wait.js', () => ({ wait }))
+jest.unstable_mockModule('node:fs', () => ({
+  writeFileSync: jest.fn<(...args: unknown[]) => void>()
+}))
+
+// Mock gensvg to avoid heavy physics simulation in tests
+const mockGensvg = jest
+  .fn<(...args: unknown[]) => Promise<string>>()
+  .mockResolvedValue('<svg>test</svg>' as never)
+jest.unstable_mockModule('../src/gensvg.js', () => ({
+  gensvg: mockGensvg
+}))
 
-// The module being tested should be imported dynamically. This ensures that the
-// mocks are used in place of any actual dependencies.
 const { run } = await import('../src/main.js')
 
 describe('main.ts', () => {
   beforeEach(() => {
-    // Set the action's inputs as return values from core.getInput().
-    core.getInput.mockImplementation(() => '500')
-
-    // Mock the wait function so that it does not actually wait.
-    wait.mockImplementation(() => Promise.resolve('done!'))
+    core.getInput.mockImplementation((name: string) => {
+      if (name === 'username') return 'testuser'
+      return ''
+    })
   })
 
   afterEach(() => {
     jest.resetAllMocks()
   })
 
-  it('Sets the time output', async () => {
+  it('generates SVG and sets output', async () => {
     await run()
 
-    // Verify the time output was set.
-    expect(core.setOutput).toHaveBeenNthCalledWith(
-      1,
-      'time',
-      // Simple regex to match a time string in the format HH:MM:SS.
-      expect.stringMatching(/^\d{2}:\d{2}:\d{2}/)
-    )
+    expect(core.setOutput).toHaveBeenCalledWith('svg-path', 'gravity.svg')
   })
 
-  it('Sets a failed status', async () => {
-    // Clear the getInput mock and return an invalid value.
-    core.getInput.mockClear().mockReturnValueOnce('this is not a number')
+  it('uses custom output path', async () => {
+    core.getInput.mockImplementation((name: string) => {
+      if (name === 'username') return 'testuser'
+      if (name === 'output-path') return 'custom.svg'
+      return ''
+    })
+
+    await run()
+
+    expect(core.setOutput).toHaveBeenCalledWith('svg-path', 'custom.svg')
+  })
+
+  it('uses text input when provided', async () => {
+    core.getInput.mockImplementation((name: string) => {
+      if (name === 'username') return 'testuser'
+      if (name === 'text') return 'Custom Text'
+      return ''
+    })
+
+    await run()
 
-    // Clear the wait mock and return a rejected promise.
-    wait
-      .mockClear()
-      .mockRejectedValueOnce(new Error('milliseconds is not a number'))
+    expect(mockGensvg).toHaveBeenCalledWith(
+      expect.objectContaining({
+        username: 'testuser',
+        text: 'Custom Text'
+      })
+    )
+  })
+
+  it('falls back to username when text is empty', async () => {
+    core.getInput.mockImplementation((name: string) => {
+      if (name === 'username') return 'testuser'
+      return ''
+    })
 
     await run()
 
-    // Verify that the action was marked as failed.
-    expect(core.setFailed).toHaveBeenNthCalledWith(
-      1,
-      'milliseconds is not a number'
+    expect(mockGensvg).toHaveBeenCalledWith(
+      expect.objectContaining({
+        username: 'testuser',
+        text: 'testuser'
+      })
     )
   })
+
+  it('sets failed status on error', async () => {
+    mockGensvg.mockRejectedValueOnce(new Error('Simulation failed'))
+
+    await run()
+
+    expect(core.setFailed).toHaveBeenCalledWith('Simulation failed')
+  })
 })

__tests__/main.test.ts

@@ -1,23 +1,34 @@
-name: The name of your action here
-description: Provide a description here
-author: Your name or organization here
+name: GitHub Gravity
+description: Generate an animated SVG of your GitHub contribution graph falling under gravity, with custom text as collision obstacles.
+author: flycran
 
-# Add your action's branding here. This will appear on the GitHub Marketplace.
 branding:
-  icon: heart
-  color: red
+  icon: git-pull-request
+  color: green
 
-# Define your inputs here.
 inputs:
-  milliseconds:
-    description: Your input description here
+  username:
+    description: GitHub username to fetch contributions for
     required: true
-    default: '1000'
+  text:
+    description: Text to display as collision obstacles (defaults to username)
+    required: false
+  output-path:
+    description: Path to write the generated SVG file
+    required: false
+    default: gravity.svg
+  font-size:
+    description: Font size of the collision text
+    required: false
+    default: '80'
+  sample-rate:
+    description: Trajectory sample rate (higher = smaller SVG, less smooth animation)
+    required: false
+    default: '4'
 
-# Define your outputs here.
 outputs:
-  time:
-    description: Your output description here
+  svg-path:
+    description: Path to the generated SVG file
 
 runs:
   using: node24

action.yml

@@ -31,7 +31,7 @@ export default {
     '^.+\\.ts$': [
       'ts-jest',
       {
-        tsconfig: 'tsconfig.json',
+        tsconfig: 'tsconfig.jest.json',
         useESM: true
       }
     ]

dist/index.js

@@ -1,5 +1,5 @@
 {
-  "name": "typescript-action",
+  "name": "github-gravity",
   "description": "GitHub Actions TypeScript template",
   "version": "0.0.0",
   "author": "",
@@ -13,7 +13,9 @@
   "bugs": {
     "url": "https://github.com/actions/typescript-action/issues"
   },
-  "keywords": ["actions"],
+  "keywords": [
+    "actions"
+  ],
   "exports": {
     ".": "./dist/index.js"
   },
@@ -70,4 +72,4 @@
   "optionalDependencies": {
     "@rollup/rollup-linux-x64-gnu": "*"
   }
-}
+}

dist/index.js.map

@@ -12,7 +12,14 @@ const config = {
     format: 'es',
     sourcemap: true
   },
-  plugins: [typescript(), nodeResolve({ preferBuiltins: true }), commonjs()]
+  plugins: [
+    typescript({
+      tsconfig: 'tsconfig.bun.json',
+      compilerOptions: { composite: false }
+    }),
+    nodeResolve({ preferBuiltins: true }),
+    commonjs()
+  ]
 }
 
 export default config

jest.config.js

@@ -3,8 +3,6 @@ import { startSimulation } from './server/physics'
 import { GITHUB_ID, TEXT } from './utils'
 import pageApp from './web/index.html'
 
-const res = await startSimulation(GITHUB_ID, TEXT)
-
 Bun.serve({
   port: 3000,
   development: {
@@ -14,10 +12,20 @@ Bun.serve({
   routes: {
     '/': pageApp,
     '/trajectory': async () => {
-      return Response.json(res)
+      return Response.json(
+        await startSimulation({
+          username: GITHUB_ID,
+          text: TEXT,
+          sampleRate: 8
+        })
+      )
     },
     '/svg': async () => {
-      const svg = await gensvg({ username: GITHUB_ID, text: TEXT })
+      const svg = await gensvg({
+        username: GITHUB_ID,
+        text: TEXT,
+        sampleRate: 8
+      })
       return new Response(svg, {
         headers: { 'Content-Type': 'image/svg+xml' }
       })

package.json

@@ -5,6 +5,9 @@ import { HEIGHT, SCALE, SIZE, WIDTH } from './utils'
 export interface GensvgOptions {
   username: string
   text: string
+  fontSize?: number
+  /** 轨迹采样率，每隔 N 步记录一个轨迹点。默认为 1（不采样）。值越大，SVG 越小 */
+  sampleRate?: number
 }
 
 /**
@@ -16,9 +19,16 @@ export interface GensvgOptions {
  */
 export async function gensvg({
   username,
-  text
+  text,
+  fontSize,
+  sampleRate
 }: GensvgOptions): Promise<string> {
-  const result: SimulationResult = await startSimulation(username, text)
+  const result: SimulationResult = await startSimulation({
+    username,
+    text,
+    fontSize,
+    sampleRate
+  })
 
   const svgWidth = WIDTH * SCALE
   const svgHeight = HEIGHT * SCALE