Migrating Summary.licenseFile and Summary.licenses to AnalysisResult.…

…licenses

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 - Updated dependency: `tar: ^2.0.0`.
 - New text logging format.
+- Migrating `Summary.licenseFile` and `Summary.licenses` to `AnalysisResult.licenses`.
 
 ## 0.22.7
 

lib/src/model.dart

@@ -51,7 +51,9 @@ class Summary {
   final String? packageName;
   final Version? packageVersion;
   final Pubspec? pubspec;
+  @Deprecated('Use `result.licenses` instead.')
   final LicenseFile? licenseFile;
+  @Deprecated('Use `result.licenses` instead.')
   final List<License>? licenses;
 
   /// The packages that are either direct-, dev- or transient dependencies.
@@ -160,6 +162,8 @@ class PanaRuntimeInfo {
 @JsonSerializable()
 class License {
   /// The file path that was recognized as a license.
+  @Deprecated(
+      'The field will be removed, as we only accept `LICENSE` as filename.')
   final String path;
 
   /// The SPDX identifier of the license.
@@ -177,6 +181,7 @@ class License {
 }
 
 @JsonSerializable()
+@Deprecated('The class will be removed.')
 class LicenseFile {
   final String path;
   final String name;
@@ -207,6 +212,7 @@ class LicenseFile {
   int get hashCode => path.hashCode ^ name.hashCode ^ version.hashCode;
 }
 
+@Deprecated('The class will be removed.')
 abstract class LicenseNames {
   static const String agpl = 'AGPL';
   static const String apache = 'Apache';
@@ -327,6 +333,7 @@ class AnalysisResult {
   final List<String>? fundingUrls;
   final Repository? repository;
   final String? contributingUrl;
+  final List<License>? licenses;
   final int? grantedPoints;
   final int? maxPoints;
 
@@ -338,6 +345,7 @@ class AnalysisResult {
     this.fundingUrls,
     this.repository,
     this.contributingUrl,
+    this.licenses,
     this.grantedPoints,
     this.maxPoints,
   });

lib/src/package_analyzer.dart

@@ -303,6 +303,7 @@ Future<AnalysisResult> _createAnalysisResult(
     fundingUrls: fundingUrls.isEmpty ? null : fundingUrls,
     repository: repository,
     contributingUrl: repoVerification?.contributingUrl,
+    licenses: await context.licenses,
     grantedPoints: report.grantedPoints,
     maxPoints: report.maxPoints,
   );

pubspec.yaml

@@ -19,7 +19,7 @@ dependencies:
   html: ^0.15.0
   http: ^1.0.0
   io: ^1.0.0
-  json_annotation: ^4.8.1
+  json_annotation: ^4.9.0
   lints: ^4.0.0
   logging: ^1.0.0
   markdown: ^7.0.0