wazehq / yaml-validator Goto Github PK

https://github.com/braingourmets/gethdo/releases/tag/test%2Fyaml-lint

In this project, we have nested subfolders for the locales. Particularly, we currently have EN and DE locale files directly in the config/locales/ folder, and then some files in config/locales/views/home/index. Running yaml-validator on this causes a crash:

klee@gonzales:~/eclipse/gethdo$ yaml-validator validate config/locales/
Validating config/locales/...

/home/klee/.rvm/gems/ruby-2.0.0-p247/gems/yaml-validator-0.1.9/lib/yaml-validator.rb:223:in get_all_variables': undefined methodeach' for "":String (NoMethodError)
from /home/klee/.rvm/gems/ruby-2.0.0-p247/gems/yaml-validator-0.1.9/lib/yaml-validator.rb:29:in en_with_vars' from /home/klee/.rvm/gems/ruby-2.0.0-p247/gems/yaml-validator-0.1.9/lib/yaml-validator.rb:33:invalidate'
from /home/klee/.rvm/gems/ruby-2.0.0-p247/gems/yaml-validator-0.1.9/bin/yaml-validator:15:in validate' from /home/klee/.rvm/gems/ruby-2.0.0-p247@global/gems/thor-0.18.1/lib/thor/command.rb:27:inrun'
from /home/klee/.rvm/gems/ruby-2.0.0-p247@global/gems/thor-0.18.1/lib/thor/invocation.rb:120:in invoke_command' from /home/klee/.rvm/gems/ruby-2.0.0-p247@global/gems/thor-0.18.1/lib/thor.rb:363:indispatch'
from /home/klee/.rvm/gems/ruby-2.0.0-p247@global/gems/thor-0.18.1/lib/thor/base.rb:439:in start' from /home/klee/.rvm/gems/ruby-2.0.0-p247/gems/yaml-validator-0.1.9/bin/yaml-validator:34:in<top (required)>'
from /home/klee/.rvm/gems/ruby-2.0.0-p247/bin/yaml-validator:23:in load' from /home/klee/.rvm/gems/ruby-2.0.0-p247/bin/yaml-validator:23:in

There are two syntaxes for interpolation in locale files, %{var} and {{var}}. Only the first is supported. YAML Validator thinks the second is a syntax error:

# en.yml
en:
  foo: "{{lol}}"

# pt.yml
pt:
  foo: "{{lol}}"

$ yaml-validator validate .
Validating ....


pt.yml: foo: invalid syntax '{{lol}'

found 1 error(s)

This repository doesn't have much recent activity. Are pull requests still welcome? This gem seems as though it could be very useful.

RubyGems.org doesn't report a license for your gem. This is because it is not specified in the gemspec of your last release.

via e.g.

spec.license = 'MIT'
# or
spec.licenses = ['MIT', 'GPL-2']

Including a license in your gemspec is an easy way for rubygems.org and other tools to check how your gem is licensed. As you can imagine, scanning your repository for a LICENSE file or parsing the README, and then attempting to identify the license or licenses is much more difficult and more error prone. So, even for projects that already specify a license, including a license in your gemspec is a good practice. See, for example, how rubygems.org uses the gemspec to display the rails gem license.

There is even a License Finder gem to help companies/individuals ensure all gems they use meet their licensing needs. This tool depends on license information being available in the gemspec. This is an important enough issue that even Bundler now generates gems with a default 'MIT' license.

I hope you'll consider specifying a license in your gemspec. If not, please just close the issue with a nice message. In either case, I'll follow up. Thanks for your time!

Appendix:

If you need help choosing a license (sorry, I haven't checked your readme or looked for a license file), GitHub has created a license picker tool. Code without a license specified defaults to 'All rights reserved'-- denying others all rights to use of the code.
Here's a list of the license names I've found and their frequencies

p.s. In case you're wondering how I found you and why I made this issue, it's because I'm collecting stats on gems (I was originally looking for download data) and decided to collect license metadata,too, and make issues for gemspecs not specifying a license as a public service :). See the previous link or my blog post about this project for more information.

'no' and 'yes' for example are interpreted as the boolean false, we should add a check that makes sure they are quoted.