Class: FlutterRb::PluginPubspecDescriptionCheck

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 ‘description’ 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 ‘description’ 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:



80
81
82
83
84
85
86
87
88
89
 
# File 'lib/flutter_rb/checks/plugin_pubspec_check.rb', line 80

def check(project)
  pubspec = project.pubspec

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

#pubspec_parameter ⇒ String

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

Returns:

  • (String) —

    the parameter to be checked



71
72
73
 
# File 'lib/flutter_rb/checks/plugin_pubspec_check.rb', line 71

def pubspec_parameter
  'description'
end