Expand description
Console reports (RFC-108): one JSON document describing one project at
one commit, which tuff console publish sends to a console server.
A report is the project’s lockfile plus what only the working tree can
say: whether the installed files still match (tuff check) and,
optionally, whether newer versions exist (tuff outdated). The schema
is a published format like the lockfile, and a server refuses a
schema it does not know.
Structs§
- Project
Identity - Which project a report describes (RFC-108 D3).
repositoryandpathtogether identify it across reports;nameis a label. - Report
Constants§
- REPORT_
SCHEMA - The report schema this Tuff writes and reads.
Functions§
- build_
report - Build the report for the project at
project_root, whosetuff.lockmust exist.project_name, when given, replaces the repository value, and is required outside git or without anoriginremote.outdatedis computed by the caller, which owns the network. - find_
projects - Every folder under
rootwith atuff.lock,rootincluded, in path order..git,node_modules,target, and other hidden folders are not searched. - normalize_
remote - A git remote URL as one stable repository name: no scheme, credentials,
port, or trailing
.git, and a lowercase host.git@github.com:acme/x.gitandhttps://token@github.com/acme/xboth becomegithub.com/acme/x. A local path is kept, without a trailing.git. - project_
identity - Work out where a project sits in its repository (RFC-108 D3).