Skip to main content

Swamp Extension Checker

@puddleworks/swamp-extension-checkerv2026.11.11.1· MIT· 10d agoBEHAVIORSWORKFLOWSACCEPTED WARNINGS
01README

Say whether a git repository has a licence file at its root, which file it is, and the licence's SPDX name when GitHub reports one.

02Behaviors1
@puddleworks/swamp-extension-checkerv2026.11.11.1swamp_extension_checker.ts
fn run(repo?: string, path?: string)
Say whether a git repository has a licence file at its root, which file it is, and the licence's SPDX name when GitHub reports one.
ArgumentTypeDescription
repo?stringA GitHub repository as owner/name or a github.com URL. Empty means check path instead.
path?stringA local directory; the git repository it is in is checked at its working-tree root. Used when repo is empty.

Resources

result(infinite)— One record: whether the repository has a licence file at its root, the file's path (or none), the licence's SPDX name when GitHub reports one, and where it was checked (the local working tree or the GitHub default branch). Outside a git repository it says so instead.
03Workflows2
@puddleworks/swamp-extension-checkera34f785e-c03d-457c-b969-b61422735767

Say whether a git repository has a licence file at its root, which file it is, and the licence's SPDX name when GitHub reports one.

mainRun swamp-extension-checker once with the user's inputs.
1.runswamp-extension-checker-model.run— One record: whether the repository has a licence file at its root, the file's path (or none), the licence's SPDX name when GitHub reports one, and where it was checked (the local working tree or the GitHub default branch). Outside a git repository it says so instead.
@puddleworks/swamp-extension-checker-licence-recipe3def8ae8-d07e-4cf1-ae76-8642fac519ac

The recipe @puddleworks/recipes answers "does owner/name have a licence?" with: it checks the named GitHub repository.

mainCheck the named GitHub repository for a licence file.
1.runswamp-extension-checker-model.run— One record saying whether the repository has a licence file at its root, which file it is and its SPDX name.
04Previous Versions1
2026.10.30.1MIT
05Stats
A
100 / 100
Downloads
17
Archive size
7.7 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned

07Platforms
08Labels