pana library Null safety

Classes

AnalysisResult
NOTE: the content of the class is experimental, clients should not rely on it yet. The normalized and verified references and derived values of the analysis.
DartdocResult
DartSdkInfo
InspectOptions
License
Describes the details of the license detection results. NOTE: the content of the class is experimental, clients should not rely on it yet.
LicenseFile
LicenseNames
PackageAnalyzer
PanaRuntimeInfo
ProcessedScreenshot
A processed screenshot contains paths with processed images as stored using storeResource as passed to PackageAnalyzer.inspectPackage.
Pubspec
Report
Models the 'new-style' pana report.
ReportSection
ReportSectionId
Repository
NOTE: the content of the class is experimental, clients should not rely on it yet. To get successful verification, the remote repository:
SdkConstraintStatus
Detailed support coverage for the SDK constraint.
Summary
ToolEnvironment
UrlChecker
Checks if an URL is valid and accessible.
UrlProblem
UrlProblemCodes
Possible values for UrlProblem.problem.
UrlStatus
The URL's parsed and queried status.

Extensions

RepositoryUrlResolverExt

Constants

currentAnalysisOptionsFileName → const String
'analysis_options.yaml'
documentationSectionTitle → const String
'Provide documentation'
packageVersion → const String
'0.21.18'

Properties

analysisOptionsFiles List<String>
final
changelogFileNames List<String>
final
licenseFileNames List<String>
final
readmeFileNames List<String>
final

Functions

dartdocFailedSection(String abortMessage) ReportSection
Creates a report section when running dartdoc failed to produce content.
documentationCoverageSection({required int documented, required int total, List<String>? symbolsMissingDocumentation}) ReportSection
Creates a report section about documentation coverage. 20% coverage grants the maximum number of points.
downloadPackage(String package, String? version, {required String destination, String? pubHostedUrl}) Future<void>
Downloads package and unpacks it into destination
exampleFileCandidates(String package, {bool caseSensitive = false}) List<String>
Returns the candidates in priority order to display under the 'Example' tab.
firstFileFromNames(List<String> files, List<String> names, {bool caseSensitive = false}) String?
getRepositoryUrl(String? repository, String relativePath, {String? branch}) String?
Returns an URL that is likely the downloadable URL of the given path.
@Deprecated('The method will be removed in a future release.')
minStatus(ReportStatus? a, ReportStatus? b) ReportStatus?
Returns the lowest status of a and b ranked in the order of the enum.
pubspecParseError(dynamic error) String
Returns a markdown-formatted error message for pubspec.yaml parse error.
renderSimpleSectionSummary({required String title, required String? description, required int grantedPoints, required int maxPoints}) String
Renders a summary block for sections that can have only a single issue.
runProc(List<String> arguments, {String? workingDirectory, Map<String, String>? environment, Duration? timeout, int? maxOutputBytes}) Future<PanaProcessResult>
Runs the arguments as a program|script + its argument list.
summarizeStatuses(Iterable<ReportStatus> statuses) ReportStatus
Returns the lowest of statuses to represent them.
textFileNameCandidates(String base) List<String>
Returns common file name candidates for base (specified without any extension).
yamlToJson(String? yamlContent) Map<String, dynamic>?

Enums

ReportStatus
RepositoryProvider
The identifier of repository provider, which could influence how relative URLs are resolved.

Exceptions / Errors

ToolException