urlarg

package

v0.8.0 Latest Latest Go to latest Published: Aug 3, 2026 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/basecamp/basecamp-cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package urlarg provides utilities for parsing Basecamp URLs into IDs. This allows users to paste URLs from the browser as command arguments.

Index ¶

func ExtractCommentWithProject(arg string) (id, projectID string)
func ExtractID(arg string) string
func ExtractIDs(args []string) []string
func ExtractProjectID(arg string) string
func ExtractWithProject(arg string) (recordingID, projectID string)
func IsURL(input string) bool
type Parsed
- func Parse(input string) *Parsed

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ExtractCommentWithProject ¶

func ExtractCommentWithProject(arg string) (id, projectID string)

ExtractCommentWithProject extracts a comment ID and project ID from an argument. For URLs with a fragment (e.g., #__recording_789), returns the comment ID. For URLs without a fragment, returns the recording ID (same as ExtractWithProject). Returns (commentOrRecordingID, projectID).

func ExtractID ¶

func ExtractID(arg string) string

ExtractID extracts the primary ID from an argument. If the argument is a Basecamp URL, extracts the recording ID. Otherwise, returns the argument as-is (assumed to be an ID).

func ExtractIDs ¶

func ExtractIDs(args []string) []string

ExtractIDs extracts IDs from multiple arguments, handling URLs and comma-separated values (e.g. "123,456,789").

func ExtractProjectID ¶

func ExtractProjectID(arg string) string

ExtractProjectID extracts the project (bucket) ID from an argument. If the argument is a Basecamp URL, extracts the bucket ID. Otherwise, returns the argument as-is.

func ExtractWithProject ¶

func ExtractWithProject(arg string) (recordingID, projectID string)

ExtractWithProject extracts both the recording ID and project ID from an argument. Returns (recordingID, projectID). If projectID is empty, it wasn't in the URL.

func IsURL ¶

func IsURL(input string) bool

IsURL checks if the input looks like a Basecamp URL. Returns true if the URL can be matched (either as an API route or structurally).

Types ¶

type Parsed ¶

type Parsed struct {
	AccountID      string
	ProjectID      string // BucketID in Basecamp terminology
	Type           string // e.g., "todos", "messages", "cards"
	RecordingID    string
	CampfireID     string // parent campfire ID for chat-line URLs (chats/{campfireId}/lines/{lineId})
	CommentID      string
	IsCollection   bool   // URL points to a list of items, not an individual resource
	OccurrenceDate string // date from schedule_entries/{id}/occurrences/{date} URLs
}

Parsed represents components extracted from a Basecamp URL.

func Parse ¶

func Parse(input string) *Parsed

Parse extracts IDs from a Basecamp URL. Returns nil if the input is not a valid Basecamp URL.

Supported URL patterns:

Source Files ¶

View all Source files

urlarg.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL