Fix violations found by new implementation

fastlane · Sep 3, 2023 · 3c4b46a · 3c4b46a
1 parent 2079206
commit 3c4b46a
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 10 deletions.
diff --git a/fastlane/helper/tool_name_formatting_helper.rb b/fastlane/helper/tool_name_formatting_helper.rb
@@ -29,9 +29,11 @@ def find_tool_name_formatting_errors
             errors << "Use <em>#{tool}<em> or _#{tool}_ instead of <ins>#{tool}</ins> to mention a tool in the docs in '#{path}:#{line_number}': #{line}" if line.include?("<ins>#{tool}</ins>")
 
             " #{line} ".scan(/([A-Z_]*)([_ `"])(#{Regexp.escape(tool.to_s)})\2([A-Z_]*)/i) do |prefix, delimiter, tool_name, suffix|
-              wrong_case = tool_name != tool.to_s.downcase
+              is_lowercase = tool_name == tool.to_s.downcase
               looks_like_an_env_var = (tool_name == tool_name.upcase) && delimiter == '_' && (!prefix.empty? || !suffix.empty?)
-              errors << "fastlane tools have to be formatted in lowercase: #{tool} in '#{path}:#{line_number}': #{line}" if !looks_like_an_env_var && wrong_case
+              looks_like_ruby_module = line == "module #{tool_name}"
+              is_valid_case = is_lowercase || looks_like_an_env_var || looks_like_ruby_module
+              errors << "fastlane tools have to be formatted in lowercase: #{tool} in '#{path}:#{line_number}': #{line}" unless is_valid_case
             end
           end
         end

diff --git a/fastlane/lib/fastlane/actions/docs/capture_android_screenshots.md b/fastlane/lib/fastlane/actions/docs/capture_android_screenshots.md
@@ -87,7 +87,7 @@ Ensure that the following permissions exist in your **src/debug/AndroidManifest.
 
 2. To capture screenshots, add the following to your tests `Screengrab.screenshot("name_of_screenshot_here");` on the appropriate screens
 
-# Generating Screenshots with Screengrab
+# Generating Screenshots with _screengrab_
 - Then, before running `fastlane screengrab` you'll need a debug and test apk
   - You can create your APKs manually with `./gradlew assembleDebug assembleAndroidTest`
   - You can also create a lane and use `build_android_app`:
@@ -228,7 +228,7 @@ When using JUnit 3 you'll need to add a bit more code:
 
 ## Clean Status Bar
 
-Screengrab can clean your status bar to make your screenshots even more beautiful.
+_screengrab_ can clean your status bar to make your screenshots even more beautiful.
 It is simply a wrapper that allows configuring SystemUI DemoMode in your code.
 Note: the clean status bar feature is only supported on devices with *API level >= 23*.
 

diff --git a/fastlane/lib/fastlane/actions/docs/check_app_store_metadata.md b/fastlane/lib/fastlane/actions/docs/check_app_store_metadata.md
@@ -2,7 +2,7 @@
   <img src="/img/actions/precheck.png" width="250">
 </p>
 
-Precheck
+_precheck_
 ============
 
 ###### Check your app using a community driven set of App Store review rules to avoid being rejected
@@ -23,8 +23,8 @@ Apple rejects builds for many avoidable metadata issues like including swear wor
 # Features
 
 
-|          |  precheck Features  |
-|----------|-----------------|
+|          |  _precheck_ Features  |
+|----------|-----------------------|
 🐛 |  product bug mentions
 🙅 | Swear word checker
 🤖 | Mentioning other platforms

diff --git a/fastlane/lib/fastlane/actions/docs/sync_code_signing.md b/fastlane/lib/fastlane/actions/docs/sync_code_signing.md
@@ -408,7 +408,7 @@ fastlane match adhoc --force_for_new_devices
 
 ##### Templates (aka: custom entitlements)
 
-Match can generate profiles that contain custom entitlements by passing in the entitlement's name with the `template_name` parameter.
+_match_ can generate profiles that contain custom entitlements by passing in the entitlement's name with the `template_name` parameter.
 
 ```
 match(type: "development",

diff --git a/fastlane/lib/fastlane/actions/docs/upload_to_testflight.md b/fastlane/lib/fastlane/actions/docs/upload_to_testflight.md
@@ -4,7 +4,7 @@
 
 ###### The best way to manage your TestFlight testers and builds from your terminal
 
-Pilot makes it easier to manage your app on Apple’s TestFlight. You can:
+_pilot_ makes it easier to manage your app on Apple’s TestFlight. You can:
 
 - Upload & distribute builds
 - Add & remove testers

diff --git a/spaceship/docs/Architecture.md b/spaceship/docs/Architecture.md
@@ -4,7 +4,7 @@ _spaceship_ uses [Faraday](https://github.com/lostisland/faraday) to interact wi
 
 ## Overview
 
-Spaceship wraps various APIs using the following pattern:
+_spaceship_ wraps various APIs using the following pattern:
 
 A simple `client` and various data models, usually subclassed from a `Base` model (e.g. Spaceship::TestFlight::Base)
 The `client` is responsible for making HTTP requests for a given API or domain. It should be very simple and have no logic.