@xcelera/cli 0.0.1

package/dist/cli.js

@@ -0,0 +1,95 @@
+#!/usr/bin/env node
+import { parseArgs } from 'node:util';
+
+async function requestAudit(url, token, github) {
+    const apiUrl = `${getApiBaseUrl()}/api/v1/audit`;
+    const response = await fetch(apiUrl, {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json',
+            Authorization: `Bearer ${token}`
+        },
+        body: JSON.stringify({
+            url,
+            github
+        })
+    });
+    if (!response.ok) {
+        const errorText = await response.text();
+        throw new Error(`API request failed: ${response.status} ${response.statusText} - ${errorText}`);
+    }
+    const data = await response.json();
+    return data;
+}
+function getApiBaseUrl() {
+    if (process.env.NODE_ENV === 'development' ||
+        process.env.GITHUB_ACTIONS !== 'true') {
+        return 'http://localhost:3000';
+    }
+    return 'https://xcelera.dev';
+}
+
+const options = {
+    url: {
+        type: 'string',
+        required: true
+    },
+    token: {
+        type: 'string',
+        required: true,
+        default: process.env.XCELERA_TOKEN
+    }
+};
+const { positionals, values } = parseArgs({
+    options,
+    allowPositionals: true,
+    args: process.argv.slice(2)
+});
+const command = positionals[0];
+if (!command) {
+    console.error('A command is required. Only "audit" is currently supported.');
+    printHelp();
+    process.exit(1);
+}
+if (command === 'help') {
+    printHelp();
+}
+if (command !== 'audit') {
+    console.error('Invalid command. Only "audit" is currently supported.');
+    printHelp();
+    process.exit(1);
+}
+const { url, token } = values;
+if (!url) {
+    console.error('URL is required. Use --url <url> to specify the URL to audit.');
+    process.exit(1);
+}
+if (!token) {
+    console.error('A token is required. Use --token or set XCELERA_TOKEN environment variable.');
+    process.exit(1);
+}
+try {
+    //   const githubContext = inferGitContext()
+    const githubContext = {
+        owner: 'xcelera-dev',
+        repo: 'app',
+        sha: 'fc0cb4434f8275ea67931f78dcd19f0f1c8f2366'
+    };
+    await requestAudit(url, token, githubContext);
+    console.log('✅ Audit scheduled successfully!');
+}
+catch (error) {
+    const errorMessage = error instanceof Error ? error.message : 'Unknown error occurred';
+    console.error(`❌ ${errorMessage}`);
+    process.exit(1);
+}
+function printHelp() {
+    console.log('Usage: xcelera audit --url <url> [--token <token>]');
+    console.log('');
+    console.log('Options:');
+    console.log('  --token <token>  The xcelera API token to use for authentication.');
+    console.log('Can also be set with the XCELERA_TOKEN environment variable.');
+    console.log('  --url <url>      The URL to audit.');
+    console.log('');
+}
+//# sourceMappingURL=cli.js.map

package/eslint.config.mjs

@@ -0,0 +1,81 @@
+// See: https://eslint.org/docs/latest/use/configure/configuration-files
+
+import { fixupPluginRules } from '@eslint/compat'
+import { FlatCompat } from '@eslint/eslintrc'
+import js from '@eslint/js'
+import typescriptEslint from '@typescript-eslint/eslint-plugin'
+import tsParser from '@typescript-eslint/parser'
+import _import from 'eslint-plugin-import'
+import jest from 'eslint-plugin-jest'
+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: ['**/coverage', '**/dist', '**/linter', '**/node_modules']
+  },
+  ...compat.extends(
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:jest/recommended',
+    'plugin:prettier/recommended'
+  ),
+  {
+    plugins: {
+      import: fixupPluginRules(_import),
+      jest,
+      prettier,
+      '@typescript-eslint': typescriptEslint
+    },
+
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.jest,
+        Atomics: 'readonly',
+        SharedArrayBuffer: 'readonly'
+      },
+
+      parser: tsParser,
+      ecmaVersion: 2023,
+      sourceType: 'module',
+
+      parserOptions: {
+        project: ['tsconfig.eslint.json'],
+        tsconfigRootDir: '.'
+      }
+    },
+
+    settings: {
+      'import/resolver': {
+        typescript: {
+          alwaysTryTypes: true,
+          project: 'tsconfig.eslint.json'
+        }
+      }
+    },
+
+    rules: {
+      camelcase: 'off',
+      'eslint-comments/no-use': 'off',
+      'eslint-comments/no-unused-disable': 'off',
+      'i18n-text/no-en': 'off',
+      'import/no-namespace': 'off',
+      'no-console': 'off',
+      'no-shadow': 'off',
+      'no-unused-vars': 'off',
+      'prettier/prettier': 'error'
+    }
+  }
+]

package/jest.config.js

@@ -0,0 +1,40 @@
+// See: https://jestjs.io/docs/configuration
+
+/** @type {import('ts-jest').JestConfigWithTsJest} **/
+export default {
+  clearMocks: true,
+  collectCoverage: true,
+  collectCoverageFrom: ['./src/**'],
+  coverageDirectory: './coverage',
+  coveragePathIgnorePatterns: ['/node_modules/', '/dist/'],
+  coverageReporters: ['json-summary', 'text', 'lcov'],
+  // Uncomment the below lines if you would like to enforce a coverage threshold
+  // for your action. This will fail the build if the coverage is below the
+  // specified thresholds.
+  // coverageThreshold: {
+  //   global: {
+  //     branches: 100,
+  //     functions: 100,
+  //     lines: 100,
+  //     statements: 100
+  //   }
+  // },
+  extensionsToTreatAsEsm: ['.ts'],
+  moduleFileExtensions: ['ts', 'js'],
+  preset: 'ts-jest',
+  reporters: ['default'],
+  resolver: 'ts-jest-resolver',
+  testEnvironment: 'node',
+  testMatch: ['**/*.test.ts'],
+  testPathIgnorePatterns: ['/dist/', '/node_modules/'],
+  transform: {
+    '^.+\\.ts$': [
+      'ts-jest',
+      {
+        tsconfig: 'tsconfig.eslint.json',
+        useESM: true
+      }
+    ]
+  },
+  verbose: true
+}

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@xcelera/cli",
+  "description": "CLI for xcelera.dev",
+  "version": "0.0.1",
+  "author": "",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/xcelera-dev/cli.git"
+  },
+  "bugs": {
+    "url": "https://github.com/xcelera-dev/cli/issues"
+  },
+  "keywords": [
+    "actions",
+    "xcelera",
+    "performance",
+    "lighthouse"
+  ],
+  "exports": {
+    ".": "./dist/action.js"
+  },
+  "bin": {
+    "xcelera": "./dist/cli.js"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "bundle": "npm run format:write && npm run package",
+    "ci-test": "NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 npx jest --passWithNoTests",
+    "coverage": "npx make-coverage-badge --output-path ./badges/coverage.svg",
+    "format:write": "npx prettier --write .",
+    "format:check": "npx prettier --check .",
+    "lint": "npx eslint .",
+    "local-action": "npx @github/local-action . src/action.ts .env",
+    "package": "npx rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript",
+    "package:watch": "npm run package -- --watch",
+    "test": "NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 npx jest --passWithNoTests",
+    "all": "npm run format:write && npm run lint && npm run test && npm run coverage && npm run package"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@actions/core": "^1.11.1",
+    "parse-github-url": "^1.0.3"
+  },
+  "devDependencies": {
+    "@eslint/compat": "^1.3.1",
+    "@github/local-action": "^3.2.1",
+    "@jest/globals": "^30.0.4",
+    "@rollup/plugin-commonjs": "^28.0.6",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-typescript": "^12.1.4",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^20.19.4",
+    "@typescript-eslint/eslint-plugin": "^8.35.1",
+    "@typescript-eslint/parser": "^8.32.1",
+    "eslint": "^9.30.1",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jest": "^29.0.1",
+    "eslint-plugin-prettier": "^5.5.1",
+    "jest": "^30.0.4",
+    "make-coverage-badge": "^1.2.0",
+    "prettier": "^3.6.2",
+    "prettier-eslint": "^16.4.2",
+    "rollup": "^4.44.2",
+    "ts-jest": "^29.4.0",
+    "ts-jest-resolver": "^2.0.1",
+    "typescript": "^5.8.3"
+  },
+  "optionalDependencies": {
+    "@rollup/rollup-linux-x64-gnu": "*"
+  }
+}

package/rollup.config.ts

@@ -0,0 +1,30 @@
+// See: https://rollupjs.org/introduction/
+
+import commonjs from '@rollup/plugin-commonjs'
+import nodeResolve from '@rollup/plugin-node-resolve'
+import typescript from '@rollup/plugin-typescript'
+
+const config = [
+  {
+    input: 'src/action.ts',
+    output: {
+      esModule: true,
+      file: 'dist/action.js',
+      format: 'es',
+      sourcemap: true
+    },
+    plugins: [typescript(), nodeResolve({ preferBuiltins: true }), commonjs()]
+  },
+  {
+    input: 'src/cli.ts',
+    output: {
+      esModule: true,
+      file: 'dist/cli.js',
+      format: 'es',
+      sourcemap: true
+    },
+    plugins: [typescript(), nodeResolve({ preferBuiltins: true }), commonjs()]
+  }
+]
+
+export default config

package/script/release

@@ -0,0 +1,133 @@
+#!/bin/bash
+
+# Exit early
+# See: https://www.gnu.org/savannah-checkouts/gnu/bash/manual/bash.html#The-Set-Builtin
+set -e
+
+# About:
+#
+# This is a helper script to tag and push a new release. GitHub Actions use
+# release tags to allow users to select a specific version of the action to use.
+#
+# See: https://github.com/actions/typescript-action#publishing-a-new-release
+# See: https://github.com/actions/toolkit/blob/master/docs/action-versioning.md#recommendations
+#
+# This script will do the following:
+#
+# 1. Retrieve the latest release tag
+# 2. Display the latest release tag
+# 3. Prompt the user for a new release tag
+# 4. Validate the new release tag
+# 5. Remind user to update the version field in package.json
+# 6. Tag a new release
+# 7. Set 'is_major_release' variable
+# 8. Point separate major release tag (e.g. v1, v2) to the new release
+# 9. Push the new tags (with commits, if any) to remote
+# 10. If this is a major release, create a 'releases/v#' branch and push
+#
+# Usage:
+#
+# script/release
+
+# Variables
+semver_tag_regex='v[0-9]+\.[0-9]+\.[0-9]+$'
+semver_tag_glob='v[0-9].[0-9].[0-9]*'
+git_remote='origin'
+major_semver_tag_regex='\(v[0-9]*\)'
+
+# Terminal colors
+OFF='\033[0m'
+BOLD_RED='\033[1;31m'
+BOLD_GREEN='\033[1;32m'
+BOLD_BLUE='\033[1;34m'
+BOLD_PURPLE='\033[1;35m'
+BOLD_UNDERLINED='\033[1;4m'
+BOLD='\033[1m'
+
+# 1. Retrieve the latest release tag
+if ! latest_tag=$(git describe --abbrev=0 --match="$semver_tag_glob"); then
+	# There are no existing release tags
+	echo -e "No tags found (yet) - Continue to create and push your first tag"
+	latest_tag="[unknown]"
+fi
+
+# 2. Display the latest release tag
+echo -e "The latest release tag is: ${BOLD_BLUE}${latest_tag}${OFF}"
+
+# 3. Prompt the user for a new release tag
+read -r -p 'Enter a new release tag (vX.X.X format): ' new_tag
+
+# 4. Validate the new release tag
+if echo "$new_tag" | grep -q -E "$semver_tag_regex"; then
+	# Release tag is valid
+	echo -e "Tag: ${BOLD_BLUE}$new_tag${OFF} is valid syntax"
+else
+	# Release tag is not in `vX.X.X` format
+	echo -e "Tag: ${BOLD_BLUE}$new_tag${OFF} is ${BOLD_RED}not valid${OFF} (must be in ${BOLD}vX.X.X${OFF} format)"
+	exit 1
+fi
+
+# 5. Remind user to update the version field in package.json
+echo -e -n "Make sure the version field in package.json is ${BOLD_BLUE}$new_tag${OFF}. Yes? [Y/${BOLD_UNDERLINED}n${OFF}] "
+read -r YN
+
+if [[ ! ($YN == "y" || $YN == "Y") ]]; then
+	# Package.json version field is not up to date
+	echo -e "Please update the package.json version to ${BOLD_PURPLE}$new_tag${OFF} and commit your changes"
+	exit 1
+fi
+
+# 6. Tag a new release
+git tag "$new_tag" --annotate --message "$new_tag Release"
+echo -e "Tagged: ${BOLD_GREEN}$new_tag${OFF}"
+
+# 7. Set 'is_major_release' variable
+new_major_release_tag=$(expr "$new_tag" : "$major_semver_tag_regex")
+
+if [[ "$latest_tag" = "[unknown]" ]]; then
+	# This is the first major release
+	is_major_release='yes'
+else
+	# Compare the major version of the latest tag with the new tag
+	latest_major_release_tag=$(expr "$latest_tag" : "$major_semver_tag_regex")
+
+	if ! [[ "$new_major_release_tag" = "$latest_major_release_tag" ]]; then
+		is_major_release='yes'
+	else
+		is_major_release='no'
+	fi
+fi
+
+# 8. Point separate major release tag (e.g. v1, v2) to the new release
+if [ $is_major_release = 'yes' ]; then
+	# Create a new major version tag and point it to this release
+	git tag "$new_major_release_tag" --annotate --message "$new_major_release_tag Release"
+	echo -e "New major version tag: ${BOLD_GREEN}$new_major_release_tag${OFF}"
+else
+	# Update the major version tag to point it to this release
+	git tag "$latest_major_release_tag" --force --annotate --message "Sync $latest_major_release_tag tag with $new_tag"
+	echo -e "Synced ${BOLD_GREEN}$latest_major_release_tag${OFF} with ${BOLD_GREEN}$new_tag${OFF}"
+fi
+
+# 9. Push the new tags (with commits, if any) to remote
+git push --follow-tags
+
+if [ $is_major_release = 'yes' ]; then
+	# New major version tag is pushed with the '--follow-tags' flags
+	echo -e "Tags: ${BOLD_GREEN}$new_major_release_tag${OFF} and ${BOLD_GREEN}$new_tag${OFF} pushed to remote"
+else
+	# Force push the updated major version tag
+	git push $git_remote "$latest_major_release_tag" --force
+	echo -e "Tags: ${BOLD_GREEN}$latest_major_release_tag${OFF} and ${BOLD_GREEN}$new_tag${OFF} pushed to remote"
+fi
+
+# 10. If this is a major release, create a 'releases/v#' branch and push
+if [ $is_major_release = 'yes' ]; then
+	git branch "releases/$new_major_release_tag" "$new_major_release_tag"
+	echo -e "Branch: ${BOLD_BLUE}releases/$new_major_release_tag${OFF} created from ${BOLD_BLUE}$new_major_release_tag${OFF} tag"
+	git push --set-upstream $git_remote "releases/$new_major_release_tag"
+	echo -e "Branch: ${BOLD_GREEN}releases/$new_major_release_tag${OFF} pushed to remote"
+fi
+
+# Completed
+echo -e "${BOLD_GREEN}Done!${OFF}"

package/src/action.ts

@@ -0,0 +1,35 @@
+import * as core from '@actions/core'
+import * as github from '@actions/github'
+import { requestAudit } from './api.js'
+
+run()
+
+async function run(): Promise<void> {
+  try {
+    const url = core.getInput('url', { required: true })
+    const token = core.getInput('token', { required: true })
+
+    core.debug(`Auditing URL: ${url}`)
+
+    core.debug('Calling Xcelera audit API...')
+    const githubContext = {
+      owner: github.context.repo.owner,
+      repo: github.context.repo.repo,
+      sha: github.context.sha
+    }
+    const response = await requestAudit(url, token, githubContext)
+
+    // Set outputs
+    core.setOutput('auditId', response.auditId)
+    core.setOutput('status', response.status)
+
+    core.info(`✅ Audit scheduled successfully!`)
+    core.info(`Audit ID: ${response.auditId}`)
+    core.info(`Status: ${response.status}`)
+  } catch (error) {
+    const errorMessage =
+      error instanceof Error ? error.message : 'Unknown error occurred'
+    core.setFailed(errorMessage)
+    core.setOutput('status', 'failed')
+  }
+}

package/src/api.ts

@@ -0,0 +1,46 @@
+import type { GitContext } from './types/git.js'
+
+export interface AuditResponse {
+  auditId: string
+  status: string
+}
+
+export async function requestAudit(
+  url: string,
+  token: string,
+  github: GitContext
+): Promise<AuditResponse> {
+  const apiUrl = `${getApiBaseUrl()}/api/v1/audit`
+
+  const response = await fetch(apiUrl, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      Authorization: `Bearer ${token}`
+    },
+    body: JSON.stringify({
+      url,
+      github
+    })
+  })
+
+  if (!response.ok) {
+    const errorText = await response.text()
+    throw new Error(
+      `API request failed: ${response.status} ${response.statusText} - ${errorText}`
+    )
+  }
+
+  const data = await response.json()
+  return data as AuditResponse
+}
+
+function getApiBaseUrl(): string {
+  if (
+    process.env.NODE_ENV === 'development' ||
+    process.env.GITHUB_ACTIONS !== 'true'
+  ) {
+    return 'http://localhost:3000'
+  }
+  return 'https://xcelera.dev'
+}

package/src/cli.ts

@@ -0,0 +1,84 @@
+#!/usr/bin/env node
+
+import { parseArgs } from 'node:util'
+
+import { requestAudit } from './api.js'
+import { inferGitContext } from './git.js'
+
+const options = {
+  url: {
+    type: 'string' as const,
+    required: true
+  },
+  token: {
+    type: 'string' as const,
+    required: true,
+    default: process.env.XCELERA_TOKEN
+  }
+}
+
+const { positionals, values } = parseArgs({
+  options,
+  allowPositionals: true,
+  args: process.argv.slice(2)
+})
+
+const command = positionals[0]
+
+if (!command) {
+  console.error('A command is required. Only "audit" is currently supported.')
+  printHelp()
+  process.exit(1)
+}
+
+if (command === 'help') {
+  printHelp()
+}
+
+if (command !== 'audit') {
+  console.error('Invalid command. Only "audit" is currently supported.')
+  printHelp()
+  process.exit(1)
+}
+
+const { url, token } = values
+
+if (!url) {
+  console.error('URL is required. Use --url <url> to specify the URL to audit.')
+  process.exit(1)
+}
+
+if (!token) {
+  console.error(
+    'A token is required. Use --token or set XCELERA_TOKEN environment variable.'
+  )
+  process.exit(1)
+}
+
+try {
+  //   const githubContext = inferGitContext()
+  const githubContext = {
+    owner: 'xcelera-dev',
+    repo: 'app',
+    sha: 'fc0cb4434f8275ea67931f78dcd19f0f1c8f2366'
+  }
+  await requestAudit(url, token, githubContext)
+  console.log('✅ Audit scheduled successfully!')
+} catch (error) {
+  const errorMessage =
+    error instanceof Error ? error.message : 'Unknown error occurred'
+  console.error(`❌ ${errorMessage}`)
+  process.exit(1)
+}
+
+function printHelp() {
+  console.log('Usage: xcelera audit --url <url> [--token <token>]')
+  console.log('')
+  console.log('Options:')
+  console.log(
+    '  --token <token>  The xcelera API token to use for authentication.'
+  )
+  console.log('Can also be set with the XCELERA_TOKEN environment variable.')
+  console.log('  --url <url>      The URL to audit.')
+  console.log('')
+}

package/src/git.ts

@@ -0,0 +1,66 @@
+import { execSync } from 'node:child_process'
+import parseGithubUrl from 'parse-github-url'
+import type { GitContext } from './types/git.js'
+
+export function inferGitContext(): GitContext {
+  if (!isGitRepository()) {
+    throw new Error('Not git repository detected.')
+  }
+
+  const remoteUrl = getRemoteUrl()
+
+  const parsed = parseGithubUrl(remoteUrl)
+  if (!parsed || !parsed.owner || !parsed.repo) {
+    throw new Error(
+      `Could not parse GitHub URL: ${remoteUrl}. Expected format: https://github.com/owner/repo or git@github.com:owner/repo`
+    )
+  }
+
+  const { owner, repo } = parsed
+
+  const sha = getCurrentSha()
+
+  // repo is parsed as owner/repo but we want to use just the repo name
+  const repoName = repo.replace(`${owner}/`, '')
+
+  return { owner, repo: repoName, sha }
+}
+
+function isGitRepository(): boolean {
+  try {
+    execSync('git rev-parse --git-dir', { stdio: 'ignore' })
+    return true
+  } catch {
+    return false
+  }
+}
+
+function getRemoteUrl(): string {
+  try {
+    const remoteUrl = execSync('git remote get-url origin', {
+      encoding: 'utf8',
+      stdio: 'pipe'
+    }).trim()
+
+    if (!remoteUrl) {
+      throw new Error('No origin remote found')
+    }
+
+    return remoteUrl
+  } catch {
+    throw new Error(
+      'Could not determine git remote URL. Please ensure you have an origin remote configured.'
+    )
+  }
+}
+
+function getCurrentSha(): string {
+  try {
+    return execSync('git rev-parse HEAD', {
+      encoding: 'utf8',
+      stdio: 'pipe'
+    }).trim()
+  } catch {
+    throw new Error('Could not determine current commit SHA')
+  }
+}

package/src/types/git.ts

@@ -0,0 +1,5 @@
+export interface GitContext {
+  owner: string
+  repo: string
+  sha: string
+}