Skip to content

Docs / Results

Assessment report

A multi-page report of a Lintsure check, written for a person to review, sign and keep.

What it is

The assessment report is one self-contained HTML file, laid out as A4 pages. Open it in any browser to read it, print it, or save it as a PDF with Print → Save as PDF. It needs no internet connection and loads nothing from outside.

It is a draft until a qualified person reviews it and fills in its sign-off page.

Create one

lintsure scan ./my-app --report --project "My app"

This writes lintsure-assessment.html in the folder you run the command from, alongside the usual lintsure-report.md. --project sets the name on the cover; without it, Lintsure uses the folder name. You can combine --report with --framework, --json and --fail-on.

What’s inside

Section What it covers
Cover Project, date, frameworks, number of files checked, rules version, draft status, and the disclaimer
Summary Counts of gaps, partial findings, rules with no finding and outside-code items, overall and per framework, plus what the summary does not mean
Scope and method What was read and skipped, how results are produced, what each status means, and the known limits
Possible issues and fixes Every finding, most severe first: file and line, rules it may affect, why it matters, a possible fix, and a reviewer decision box (fix, accept the risk, or not applicable, with initials and date)
Framework by framework Each framework’s obligations in plain words, with what Lintsure saw for each one
Work outside code A checklist of what code can’t show, the evidence an auditor may ask for, and owner and done columns
What to do next The steps a person still needs to take
Human review and sign-off Reviewer name, role, date, scope reviewed, notes and signature
Disclaimer What the report is and is not

How it’s worded

The report never says you are compliant, certified or ready. Tests in the repository check for that wording. When the rules find nothing, the report says so plainly, and adds that this is not the same as having no issues, and that the outside-code work still applies.

Repeatable

The same scan and the same date give a byte-identical file. Keep each signed report with the rules version printed on its cover.

Lintsure is a readiness tool, not an audit or legal advice. Results cover code only; a qualified person should review them. Disclaimer