danger-localizationlinter 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a4afdaf597ba934bea40d09e3b0fd3648a224466512c2c24b676093cce3ee40
-  data.tar.gz: 4c69e69f4e56d1eaf50933469c97c18522b5d4db9347a1a3551144b75eeb4fe1
+  metadata.gz: ceb9d92872f544b3fa2e93706e8db77f41768087dd5e0d1fa8b8f21c007fa8ea
+  data.tar.gz: ec9b6d88a7eb6c451ee786c504efdb626216db6fb91926f7aafe9f27c56f2125
 SHA512:
-  metadata.gz: 2a9728aa8b54a0120d00986eaa34321beb6109228f948cdff0c0c558465c7a7e0263811293c35a35cac3b302d727362887370dea1c0ec1ee5e055d17d0da48b0
-  data.tar.gz: ba9a05927c1ef36c54386dae856b16099cd202b9052c4319d075fb2744ff1a5f563f4f12f9216c098a253e2bf8764128e17f579bb7e3911ddca66d383c56af5b
+  metadata.gz: c9fac08ecfc14db788cab6691d4b38d1bd246a2d5590d6a718cc0ba4f4646158f949d64154d4a1753f6253509efad3780ffbbc595bc4c91bbd50af86e38bb8c5
+  data.tar.gz: 4c15c67551e1538273f46f126723631875e016c96f78fb21dffdebda63800ae1d563275877cd650fb484f170424d64190b59de3aa3e2590485924491975fa748

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-localizationlinter (0.0.1)
+    danger-localizationlinter (0.0.3)
       danger-plugin-api (~> 1.0)
       json-diff (~> 0.4)
       xcodeproj (~> 1.19)

data/README.md

@@ -1,4 +1,4 @@
-# danger-localizationlinter
+### localizationlinter
 
 Verify consistency over your project localizable files (localizable.strings and Localizable.stringdict)
  It uses Swiftgen to generate a localizables output per target and language and compare the output with
@@ -8,15 +8,11 @@ Verify consistency over your project localizable files (localizable.strings and
    - additional keys
    - wrong parameters in string format
 
-## Installation
-
-    $ gem install danger-localizationlinter
+<blockquote>Verify my project localizables consistency
+  <pre>localizationlinter.lint</pre>
+</blockquote>
 
-## Usage
 
-Methods and attributes from this plugin are available in your `Dangerfile` under the `localizationlinter` namespace.
-
-	localizationlinter.lint
 
 #### Attributes
 
@@ -27,11 +23,13 @@ Methods and attributes from this plugin are available in your `Dangerfile` under
 `verbose` - Print execution logs
 
 `language_configuration_path` - Path to language configuration yml, defining main language per target
-	example:
-		My_target: en
-		My_other_target: fr
-
-default value is Configuration/Defaults/all_target_main_language.yml
+example:
+```yml
+My_target: en
+My_other_target: fr
+```
+Default value is `Configuration/Defaults/all_target_main_language.yml`
+If no file is provided, the default language for each target is `en`
 
 `swift_gen_path` - Path to swift gen, default value is Pods/SwiftGen/bin/swiftgen
 
@@ -41,6 +39,9 @@ default value is Configuration/Defaults/all_target_main_language.yml
 
 `project_path` - Path to xcode project, default is taking the first project in root folder
 
+
+
+
 #### Methods
 
 `lint` - Verify the localizable files integrity over the project
@@ -48,15 +49,25 @@ rubocop:disable Metrics/MethodLength
 
 `linter` - Returns the object in charge of verification
 
+
+
+
+## Installation
+
+     $ gem install danger-localizationlinter
+
+
+
+
 ## Development
 
-1. Clone this repo
-2. Run `bundle install` to setup dependencies.
-3. Run `bundle exec rake spec` to run the tests.
-4. Use `bundle exec guard` to automatically have tests run as you make changes.
-5. Make your changes.
+ 1. Clone this repo
+ 2. Run `bundle install` to setup dependencies.
+ 3. Run `bundle exec rake spec` to run the tests.
+ 4. Use `bundle exec guard` to automatically have tests run as you make changes.
+ 5. Make your changes.
 
-To update swiftgen bin, use Test project in `spec`:
-1. `cd spec/Test`
-2. Open Podfile and update SwiftGen version
-3. `pod update SwiftGen`
+ To update swiftgen bin, use Test project in `spec`:
+ 1. `cd spec/Test`
+ 2. Open Podfile and update SwiftGen version
+ 3. `pod update SwiftGen`

data/ext/localizationlinter/localizationlinter.rb

@@ -177,12 +177,14 @@ class LocalizationLinter
 
   def main_region_for_target(target)
     path = language_configuration_path
-    return "File #{path} does not exist." unless File.exist?(path)
-
+    unless File.exist?(path)
+      log "Language configuration file not found, selecting default region 'en' for #{target}"
+      return 'en'
+    end
     languages = YAML.safe_load(File.read(path)) || {}
     unless languages[target]
-      log "Missing main region for #{target} in file #{path}, put the same one as in Swiftgen Localizables build phase"
-      return nil
+      log "Language configuration file not found, selecting default region 'en' for #{target}"
+      return 'en'
     end
 
     languages[target]

data/lib/localizationlinter/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Localizationlinter
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/localizationlinter/plugin.rb

@@ -12,12 +12,11 @@ module Danger
   #    - wrong parameters in string format
   #
   # @example Verify my project localizables consistency
-  #
   #          localizationlinter.lint
   #
   # @see  https://github.com/fabernovel/danger-localizationlinter
   # @tags iOS, Localization
-  #
+
   class DangerLocalizationlinter < Plugin
     # Keep or clean derived data after execution
     # @return  [void]
@@ -33,11 +32,12 @@ module Danger
 
     # Path to language configuration yml, defining main language per target
     # example:
-    #
+    #```yml
     # My_target: en
     # My_other_target: fr
-    #
-    # default value is Configuration/Defaults/all_target_main_language.yml
+    #```
+    # Default value is `Configuration/Defaults/all_target_main_language.yml`
+    # If no file is provided, the default language for each target is `en`
     # @return  [void]
     attr_accessor :language_configuration_path
 
@@ -62,7 +62,9 @@ module Danger
     # rubocop:disable Metrics/MethodLength
     def lint
       differences = linter.find_differences
-      if inline_mode
+      if differences.empty?
+        message "Localization Linter finished with no error"
+      elsif inline_mode
         differences.each do |issue|
           warn(
             issue[:message],
@@ -70,7 +72,7 @@ module Danger
             line: issue[:line]
           )
         end
-      elsif !differences.empty?
+      else
         message = differences.map do |difference|
           "#{difference[:filename]}:#{difference[:line]} #{difference[:message]}"
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-localizationlinter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Fabernovel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-05 00:00:00.000000000 Z
+date: 2021-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api