Skip to content

[shiplog/plan] package shiplog for the TanStack Intent registry #91

@devallibus

Description

@devallibus

Context

shiplog is currently installable through npx skills add, Claude plugin manifests, and direct skill-folder copies, but the repository does not yet include the npm packaging and Intent-specific metadata required for TanStack Intent registry distribution.

Verified external requirements from the official TanStack Intent registry docs:

  • Registry libraries are distributed through npm packages.
  • Packages must include the tanstack-intent keyword to be discoverable.
  • The maintainer quick start provides generated package metadata, an intent bin shim, and GitHub workflows for validation/publication.

Design Summary

  • Add a root package.json that packages the shiplog skill for npm distribution without changing the existing Claude plugin/manual-copy install paths.
  • Add the TanStack Intent package metadata and bin/intent.js entry point so the package can be consumed by the registry tooling.
  • Add CI/release workflow files required to validate and publish the package.
  • Update README installation/distribution docs to include the TanStack Intent registry path while keeping the current install methods accurate.

Approach

Implement the smallest complete packaging layer needed to make this repository registry-ready: package metadata, shipped file list, Intent bin shim, workflow automation, and documentation. Do not claim successful publication or listing until npm publish and the registry submission steps are actually completed against external services.

Alternatives Considered

  • Documentation-only update: rejected because the repo currently lacks the package metadata and workflow files the registry expects.
  • Replace existing install paths with TanStack Intent: rejected because npx skills add, Claude plugin loading, and manual copy flows are already valid and should remain documented.

Tasks

  • Task 1: Add TanStack Intent package metadata [tier-3]

    • What: Create the root npm package manifest and Intent metadata required for registry packaging.
    • Files: package.json, bin/intent.js, .npmignore or package file whitelist if needed
    • Allowed to change: new packaging files and related metadata
    • Must not change: the skill content or existing install semantics unless required for package correctness
    • Forbidden judgment calls: do not rename the skill or change repository ownership/package identity without explicit evidence
    • Stop and ask if: the official tooling requires a published package name that conflicts with the current repo naming
    • Verification: inspect package fields against the TanStack maintainer quick-start requirements and verify the package ships skills/
    • Return artifact: final package manifest summary and shipped file list
    • Decision budget: none
    • Accept when: the repository contains a coherent npm package definition for the shiplog skill plus an Intent entry point
    • Context: the repo currently has only Claude plugin metadata, not npm/Intent metadata
  • Task 2: Add registry validation/publication automation [tier-3]

    • What: Add the GitHub workflow files needed to validate the package and support publish/listing preparation.
    • Files: .github/workflows/*
    • Allowed to change: new workflow files and any minimal supporting metadata they require
    • Must not change: unrelated repo automation
    • Forbidden judgment calls: do not claim actual registry listing from local workflow creation alone
    • Stop and ask if: the generated workflow would require secrets or release semantics that are unclear from the repository context
    • Verification: inspect workflow triggers and commands for consistency with TanStack Intent maintainer guidance
    • Return artifact: workflow list and the validation/publish commands they run
    • Decision budget: none
    • Accept when: the repo includes a sane automated path for package validation and publish readiness
    • Context: the repo currently has no GitHub workflows in .github/workflows
  • Task 3: Document the new distribution path [tier-3]

    • What: Update the README so TanStack Intent registry usage is documented without regressing the existing install docs.
    • Files: README.md
    • Allowed to change: installation and distribution sections plus any brief packaging notes tied directly to this feature
    • Must not change: unrelated conceptual sections
    • Forbidden judgment calls: do not present the package as already published/listed unless that external step is completed
    • Stop and ask if: documenting the flow requires choosing between conflicting external commands not resolved by the primary docs
    • Verification: read the resulting install/distribution copy for internal consistency with the actual files added in Tasks 1-2
    • Return artifact: updated install/distribution section summary
    • Decision budget: none
    • Accept when: a reader can understand how shiplog is packaged for TanStack Intent and what still remains external
    • Context: this change should broaden distribution docs, not replace the current multi-agent install story

Open Questions

  • Whether the final npm package name should remain shiplog or use a scoped package to avoid registry naming collisions. Keep the local implementation neutral until the official tooling or publish step forces a choice.

Authored-by: openai/gpt-5.4 (codex, effort: high)
Captain's log entry created by shiplog

Metadata

Metadata

Assignees

No one assigned

    Labels

    shiplog/planBrainstorm captured as a planning issue

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions