Module: RuboCop
- Defined in:
- lib/rubocop/sketchup/features.rb,
lib/rubocop/sketchup.rb,
lib/rubocop/sketchup/cop.rb,
lib/rubocop/sketchup/config.rb,
lib/rubocop/sketchup/inject.rb,
lib/rubocop/sketchup/version.rb,
lib/rubocop/sketchup/namespace.rb,
lib/rubocop/sketchup/dc_globals.rb,
lib/rubocop/sketchup/dc_methods.rb,
lib/rubocop/sketchup/range_help.rb,
lib/rubocop/sketchup/tool_checker.rb,
lib/rubocop/sketchup/sketchup_version.rb,
lib/rubocop/sketchup/extension_project.rb,
lib/rubocop/sketchup/namespace_checker.rb,
lib/rubocop/sketchup/no_comment_disable.rb,
lib/rubocop/sketchup/cop/bugs/render_mode.rb,
lib/rubocop/sketchup/cop/requirements/exit.rb,
lib/rubocop/sketchup/sketchup_target_range.rb,
lib/rubocop/sketchup/cop/bugs/material_name.rb,
lib/rubocop/sketchup/cop/performance/openssl.rb,
lib/rubocop/sketchup/cop/bugs/uniform_scaling.rb,
lib/rubocop/sketchup/cop/performance/typename.rb,
lib/rubocop/sketchup/cop/suggestions/add_group.rb,
lib/rubocop/sketchup/cop/performance/type_check.rb,
lib/rubocop/sketchup/cop/requirements/load_path.rb,
lib/rubocop/sketchup/formatter/extension_review.rb,
lib/rubocop/sketchup/cop/deprecations/require_all.rb,
lib/rubocop/sketchup/cop/requirements/gem_install.rb,
lib/rubocop/sketchup/cop/suggestions/dc_internals.rb,
lib/rubocop/sketchup/cop/deprecations/sketchup_set.rb,
lib/rubocop/sketchup/cop/suggestions/compatibility.rb,
lib/rubocop/sketchup/cop/suggestions/file_encoding.rb,
lib/rubocop/sketchup/cop/suggestions/toolbar_timer.rb,
lib/rubocop/sketchup/cop/performance/selection_bulk.rb,
lib/rubocop/sketchup/cop/requirements/api_namespace.rb,
lib/rubocop/sketchup/cop/suggestions/model_entities.rb,
lib/rubocop/sketchup/cop/suggestions/operation_name.rb,
lib/rubocop/sketchup/cop/requirements/file_structure.rb,
lib/rubocop/sketchup/cop/requirements/global_include.rb,
lib/rubocop/sketchup/cop/requirements/global_methods.rb,
lib/rubocop/sketchup/cop/suggestions/tool_invalidate.rb,
lib/rubocop/sketchup/cop/suggestions/tool_user_input.rb,
lib/rubocop/sketchup/cop/deprecations/show_ruby_panel.rb,
lib/rubocop/sketchup/cop/requirements/global_constants.rb,
lib/rubocop/sketchup/cop/requirements/global_variables.rb,
lib/rubocop/sketchup/cop/requirements/sketchup_require.rb,
lib/rubocop/sketchup/cop/suggestions/monkey_patched_api.rb,
lib/rubocop/sketchup/cop/requirements/register_extension.rb,
lib/rubocop/sketchup/cop/requirements/sketchup_extension.rb,
lib/rubocop/sketchup/cop/suggestions/tool_drawing_bounds.rb,
lib/rubocop/sketchup/cop/performance/operation_disable_ui.rb,
lib/rubocop/sketchup/cop/requirements/extension_namespace.rb,
lib/rubocop/sketchup/cop/requirements/ruby_core_namespace.rb,
lib/rubocop/sketchup/cop/requirements/minimal_registration.rb,
lib/rubocop/sketchup/cop/deprecations/add_separator_to_menu.rb,
lib/rubocop/sketchup/cop/requirements/get_extension_license.rb,
lib/rubocop/sketchup/cop/requirements/ruby_stdlib_namespace.rb,
lib/rubocop/sketchup/cop/deprecations/set_texture_projection.rb,
lib/rubocop/sketchup/cop/requirements/language_handler_globals.rb,
lib/rubocop/sketchup/cop/requirements/observers_start_operation.rb,
lib/rubocop/sketchup/cop/suggestions/sketchup_find_support_file.rb,
lib/rubocop/sketchup/cop/deprecations/operation_next_transparent.rb,
lib/rubocop/sketchup/cop/requirements/shipped_extensions_namespace.rb
Overview
How to update this file:
FEATURES constant:
-
Run the ‘rubocop-changelog` YARD template on the API stubs repository: (github.com/SketchUp/rubocop-sketchup/issues/4#issuecomment-370753043)
yardoc -c -t rubocop-changelog -f text > rubocop-changelog.txt
-
Prune out any unreleased versions.
INSTANCE_METHODS constant:
Manually curated list of method names which are believed to yield few false positives. The method names should be names that are not commonly used in general context.
Since it’s difficult to know what a variable in Ruby code represent by static analysis, these methods are assumed to belong to the FEATURES list.
When a new version is released and FEATURES is updated the new methods from the new version should be considered for this list.
TODO(thomthom): Investigate if Solargraph’s static analysis can be used to
provide a more accurate analysis. Not sure how well it works on code bases
that isn't well documented with YARD type tags.
OBSERVER_METHODS constant:
Currently manually curated.
TODO(thomthom): Tag observer methods in YARD for automatic extraction.