@xcelera/cli 1.2.2 → 1.3.0

package/script/release

@@ -1,133 +0,0 @@
-#!/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

@@ -1,35 +0,0 @@
-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

@@ -1,46 +0,0 @@
-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

@@ -1,79 +0,0 @@
-#!/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()
-  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

@@ -1,66 +0,0 @@
-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

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

package/src/types/parse-github-url.d.ts

@@ -1,12 +0,0 @@
-declare module 'parse-github-url' {
-  interface ParsedGithubUrl {
-    owner: string
-    name: string
-    repo: string
-    branch?: string
-  }
-
-  function parseGithubUrl(url: string): ParsedGithubUrl | null
-
-  export default parseGithubUrl
-}

package/tsconfig.base.json

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

package/tsconfig.eslint.json

@@ -1,18 +0,0 @@
-{
-  "$schema": "https://json.schemastore.org/tsconfig",
-  "extends": "./tsconfig.base.json",
-  "compilerOptions": {
-    "allowJs": true,
-    "noEmit": true
-  },
-  "exclude": ["dist", "node_modules"],
-  "include": [
-    "__fixtures__",
-    "__tests__",
-    "src",
-    "eslint.config.mjs",
-    "jest.config.js",
-    "rollup.config.ts",
-    "release.config.mjs"
-  ]
-}

package/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "$schema": "https://json.schemastore.org/tsconfig",
-  "extends": "./tsconfig.base.json",
-  "compilerOptions": {
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
-    "outDir": "./dist"
-  },
-  "exclude": ["__fixtures__", "__tests__", "coverage", "dist", "node_modules"],
-  "include": ["src"]
-}