senhorh/repo-pulse

★ 15TypeScriptAudience · developerComplexity · 2/5Setup · moderate

Mindmap

mindmap
  root((repo-pulse))
    What it does
      Scans local repo
      Prints health report
      Flags TODO markers
    Checks performed
      Package manager
      Documentation files
      GitHub Actions
    Output formats
      Markdown report
      JSON output
    Setup
      Node.js required
      Build and link globally

mindmap root((repo-pulse)) What it does Scans local repo Prints health report Flags TODO markers Checks performed Package manager Documentation files GitHub Actions Output formats Markdown report JSON output Setup Node.js required Build and link globally

Click or tap to explore — scroll the page freely

Things people build with this

USE CASE 1

Run a pre-publish health check on your project to catch missing docs, stale TODO comments, or absent GitHub Actions config before sharing.

USE CASE 2

Output a JSON health report in CI to automatically fail the pipeline if required documentation files like README or LICENSE are missing.

USE CASE 3

Scan a project you inherited to quickly understand its structure, available scripts, and how many unfinished TODO markers are left in the code.

Tech stack

TypeScriptNode.js

Getting it running

Difficulty · moderate Time to first run · 30min

Requires Node.js and a manual build step followed by npm link to make the command available globally.

In plain English

repo-pulse is a small command-line tool that scans a local code repository and prints a summary of its health. It is designed for quick triage before you publish a project, send it to a reviewer, or hand it off to someone else. Running it in a project folder produces a compact report covering several categories. It detects what package manager and package metadata the project uses, lists the available scripts (like build, lint, and test), and counts how many dependencies are declared. It checks whether common documentation files are present: a README, a license file, a changelog, and a contributing guide. It checks for GitHub Actions configuration and whether the folder is a git repository. It also scans source files to count TODO, FIXME, HACK, and XXX markers, which are notes that developers leave in code to flag unfinished work. The output can be formatted as readable Markdown or as JSON for automated use. When Markdown output detects something worth flagging, it shows short action items, like a reminder to add a LICENSE file before inviting contributors or to review any leftover TODO markers before releasing. All scanning happens locally. The tool makes no network requests, sends no telemetry, and does not upload or modify any files. Installation requires Node.js. You clone the repository, install dependencies, build the TypeScript source, and link the command globally. The README's roadmap mentions planned additions: git dirty-state summaries, severity scoring for missing project basics, a flag for failing CI checks, and terminal color output.

Copy-paste prompts

Prompt 1

I have repo-pulse installed. Scan my TypeScript project and output a JSON health report so I can parse the results in a GitHub Actions step.

Prompt 2

Using repo-pulse, list all TODO and FIXME markers in my project so I can review them before tagging a new release.

Prompt 3

Write a GitHub Actions workflow step that runs repo-pulse and fails the build if any required documentation files are missing.

Prompt 4

I cloned an unfamiliar project. Run repo-pulse on it and summarize what package manager it uses, what scripts are available, and how many dependencies it declares.

Open on GitHub → Explain another repo

← senhorh on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.