Class: FlutterRb::PluginPubspecAuthorCheck

Inherits:
PluginPubspecCheck show all
Defined in:
lib/flutter_rb/checks/plugin_pubspec_check.rb

Overview

This class represents a check for Flutter plugin’s pubspec.yaml file for ‘author’ parameter. It inherits from PluginPubspecCheck class.

Constant Summary

Constants inherited from Check

Check::UNIMPLEMENTED_ERROR

Instance Method Summary collapse

Methods inherited from PluginPubspecCheck

#description, #name

Methods inherited from Check

#description, #name

Instance Method Details

#check(project) ⇒ CheckReport

Performs the check for the ‘author’ parameter in the pubspec.yaml file. It creates a CheckReport object with the result of the check.

Parameters:

  • project (Project) —

    the project to be checked

Returns:



136
137
138
139
140
141
142
143
144
145
 
# File 'lib/flutter_rb/checks/plugin_pubspec_check.rb', line 136

def check(project)
  pubspec = project.pubspec

  CheckReport.new(
    name,
    pubspec.pubspec_info.author.nil? ? CheckReportStatus::NORMAL : CheckReportStatus::WARNING,
    description,
    pubspec.path
  )
end

#pubspec_parameter ⇒ String

Returns the parameter to be checked in the pubspec.yaml file. In this case, it returns ‘author’.

Returns:

  • (String) —

    the parameter to be checked



127
128
129
 
# File 'lib/flutter_rb/checks/plugin_pubspec_check.rb', line 127

def pubspec_parameter
  'author'
end