yamllint 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2385493452cd1aa83778ef91e6190cf579f6dba
-  data.tar.gz: 8a1e10518d95ab9ac3b488d7ba8c2f3c8bce0845
+  metadata.gz: ae94dc3781c210160d5a36ddf4cd43cf0b8e947b
+  data.tar.gz: 4839ef892b6b0bab25e695c50bf49db96b619cc1
 SHA512:
-  metadata.gz: 452d3f5093087b39915225f094c34956ff6d491d85630feefdcc7b8fe1ecc4ca3cac21dc5da27c7b47d2e2e04ff5f7ece0f02e1e55e011d7a522e5f736f58438
-  data.tar.gz: 95facbf3993b0267735f64e90b975d9dca09096c10b72245647aa259e538663c654495f008464fd52609da5ab0917ffd46a335ee7e48a1845a8409f36c8ecf7d
+  metadata.gz: 133c438fb631b7dae2ba2d3fdce58146969815ea5dd96f04fb851a05142a7f7e839f2fe309403d9ea0219bb1797ff9b7984a46b8bdfbf6a1cc903ee8c7c59e46
+  data.tar.gz: d9f60cc006b7474918156553868d32d166cfe00bdacc80a7e3ebc08489499084bc0f4bef3e73b839c94c9f108ab72fdf49a57555dc1731f5faf244105b3e4656

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.travis.yml

@@ -1,6 +1,10 @@
 language: ruby
+cache: bundler
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.5
   - 2.2.0
+branches:
+  only:
+    - master

data/CHANGELOG.md

@@ -2,17 +2,23 @@ YamlLint gem CHANGELOG
 ======================
 This file is used to list changes made in each version of the YamlLint gem.
 
+v0.0.4 (????-??-??)
+-------------------
+- Clean up code by extracting out complex_type_start
+- Extract out valid extensions to an array
+- Allow disabling of the file extension check
+- Allow custom file extensions
+
 v0.0.3 (2015-01-15)
 -------------------
 - **[ISSUE #1](https://github.com/shortdudey123/yamllint/issues/1)** - Add more verbose output
-- **[ISSUE #2](https://github.com/shortdudey123/yamllint/issues/2)** - Add file extention verification
+- **[ISSUE #2](https://github.com/shortdudey123/yamllint/issues/2)** - Add file extension verification
 - add fail_on_error option to rake task
 
 v0.0.2 (2015-01-15)
 -------------------
 - Fix rake_task filename
 
-
 v0.0.1 (2015-01-15)
 -------------------
 - Initial gem publish

data/README.md

@@ -2,6 +2,9 @@
 
 [![Build Status](https://travis-ci.org/shortdudey123/yamllint.svg?branch=master)](https://travis-ci.org/shortdudey123/yamllint)
 [![Gem Version](http://img.shields.io/gem/v/yamllint.svg)](https://rubygems.org/gems/yamllint)
+[![Coverage Status](https://img.shields.io/coveralls/shortdudey123/yamllint/master.svg)](https://coveralls.io/r/shortdudey123/yamllint?branch=master)
+[![Code Climate](https://codeclimate.com/github/shortdudey123/yamllint/badges/gpa.svg)](https://codeclimate.com/github/shortdudey123/yamllint)
+[![Dependency Status](https://img.shields.io/gemnasium/shortdudey123/yamllint.svg)](https://gemnasium.com/shortdudey123/yamllint)
 
 Checks YAML files for correct syntax.  Currently it checks for:
 
@@ -49,6 +52,15 @@ spec/data/spaces.yaml
 $
 ```
 
+#### CLI options
+
+| Short | Long | Description | Default |
+| ------------- | ------------- | ------------- | ------------- |
+| `-d` | `--disable-ext-check` | Disable file extension check | `false` |
+| `-e` | `--extensions=` | Add more allowed extensions (comma delimited list) | `nil` |
+| `-v` | `--version` | Print version and exit | `false` |
+| `-h` | `--help` | Show help message | `false` |
+
 ### Rake task
 
 You can integrate yamllint into your build process by adding a Rake task to your project
@@ -81,7 +93,16 @@ spec/data/spaces.yaml
 $
 ```
 
-Optionally add `t.fail_on_error = false` in the Rakefile definition to continue on to the next rake task even if YamlLint finds errors.
+#### Rake task options
+
+Add these options similarly to the path option seen above.
+
+| Option | Description | Default |
+| ------------- | ------------- | ------------- | ------------- |
+| `disable_ext_check` | Disable file extension check | `false` |
+| `extensions` | Add more allowed extensions (list)| `nil` |
+| `fail_on_error` | Continue on to the next rake task and don't fail even if YamlLint finds errors | `true` |
+| `path` | List of files or paths to lint | `nil` |
 
 ## Contributing
 

data/Rakefile

@@ -1,7 +1,7 @@
 require 'bundler/gem_tasks'
 require 'rubocop/rake_task'
-
 require 'rspec/core/rake_task'
+require 'yamllint/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
@@ -12,8 +12,24 @@ end
 
 desc 'rubocop compliancy checks'
 RuboCop::RakeTask.new(:rubocop) do |t|
-  t.patterns = %w{ **/*.rb }
-  t.fail_on_error = false
+  t.patterns = %w{ lib/**/*.rb lib/*.rb spec/*.rb }
+end
+
+desc 'yamllint rake test'
+YamlLint::RakeTask.new do |t|
+  t.paths = %w{ spec/data/valid* }
+end
+
+desc 'yamllint rake test disabled file ext check'
+YamlLint::RakeTask.new(:yamlling_disable_ext_check) do |t|
+  t.paths = %w{ spec/data/wrong_extension.txt }
+  t.disable_ext_check = true
+end
+
+desc 'yamllint rake test disabled file ext check'
+YamlLint::RakeTask.new(:yamlling_custom_ext) do |t|
+  t.paths = %w{ spec/data/custom_extension.eyaml }
+  t.extensions = %w{ eyaml }
 end
 
-task default: [:rubocop, :spec]
+task default: [:rubocop, :yamllint, :yamlling_disable_ext_check, :yamlling_custom_ext, :spec]

data/lib/yamllint/cli.rb

@@ -1,4 +1,5 @@
 require 'trollop'
+require 'pry'
 
 module YamlLint
   ###
@@ -7,19 +8,20 @@ module YamlLint
   class CLI
     attr_reader :opts
 
+    # setup CLI options
     def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR,
       kernel = Kernel)
       @argv, @stdin, @stdout, @stderr, @kernel = argv, stdin, stdout,
                                                  stderr, kernel
     end
 
+    # Run the CLI command
     def execute!
-      parse_options
+      files_to_check = parse_options.leftovers
 
-      files_to_check = @argv
-
-      no_yamls_to_check_msg = 'nead at least one YAML file to check'
-      Trollop.die no_yamls_to_check_msg if files_to_check.empty?
+      no_yamls_to_check_msg = "Error: need at least one YAML file to check.\n"\
+                              'Try --help for help.'
+      abort(no_yamls_to_check_msg) if files_to_check.empty?
       lint(files_to_check)
     end
 
@@ -40,7 +42,10 @@ module YamlLint
     end
 
     def lint_files(files_to_check)
-      linter = YamlLint::Linter.new
+      ext = opts.extensions.split(',') unless opts.extensions.nil?
+      linter = YamlLint::Linter.new(disable_ext_check: opts.disable_ext_check,
+                                    extensions: ext
+                                    )
       begin
         puts "Checking #{files_to_check.flatten.length} files"
         linter.check_all(files_to_check)
@@ -64,14 +69,27 @@ module YamlLint
       linter
     end
 
-    def parse_options
-      @opts = Trollop.options(@argv) do
+    def setup_options
+      Trollop::Parser.new do
         banner 'Usage: yamllint [options] file1.yaml [file2.yaml ...]'
         version(YamlLint::VERSION)
 
         banner ''
         banner 'Options:'
+        opt :disable_ext_check, 'Disable file extension check', default: false
+        opt :extensions, 'Add more allowed extensions (comma delimited list)',
+            type: :string
       end
     end
+
+    def parse_options
+      p = setup_options
+
+      @opts = Trollop.with_standard_exception_handling p do
+        p.parse(@argv)
+      end
+
+      p
+    end
   end
 end

data/lib/yamllint/linter.rb

@@ -9,22 +9,38 @@ module YamlLint
   #
   class Linter
     attr_reader :errors
-
-    def initialize
+    attr_reader :valid_extensions
+    attr_reader :disable_extension_check
+    attr_reader :extensions
+
+    # Initilize the linter
+    # Params:
+    # +disable_ext_check+:: Disables file extension check (optional, false)
+    def initialize(opts = {})
       @errors = {}
+      @valid_extensions = %w(yaml yml)
+
+      @disable_extension_check = opts[:disable_ext_check] || false
+      @extensions = opts[:extensions]
+
+      @valid_extensions += @extensions unless @extensions.nil?
     end
 
+    # Check a list of files
     def check_all(*files_to_check)
       files_to_check.flatten.each { |f| check(f) }
     end
 
+    # Check a single file
     def check(path)
       fail FileNotFoundError, "#{path}: no such file" unless File.exist?(path)
 
       valid = false
-      unless check_filename(path)
-        errors[path] = ['File extention must be .yaml or .yml']
-        return valid
+      unless disable_extension_check
+        unless check_filename(path)
+          errors[path] = ['File extension must be .yaml or .yml']
+          return valid
+        end
       end
 
       File.open(path, 'r') do |f|
@@ -36,6 +52,7 @@ module YamlLint
       valid
     end
 
+    # Check an IO stream
     def check_stream(io_stream)
       yaml_data = io_stream.read
       error_array = []
@@ -46,14 +63,17 @@ module YamlLint
       valid
     end
 
+    # Are there any lint errors found?
     def errors?
       !errors.empty?
     end
 
+    # Return the number of lint errors found
     def errors_count
       errors.length
     end
 
+    # Output the lint errors
     def display_errors
       errors.each do |path, errors|
         puts path
@@ -65,21 +85,24 @@ module YamlLint
 
     private
 
+    # Check file extension
     def check_filename(filename)
-      extention = filename.split('.').last
-      return true if extention == 'yaml' || extention == 'yml'
+      extension = filename.split('.').last
+      return true if valid_extensions.include?(extension)
       false
     end
 
+    # Check the data in the file or stream
     def check_data(yaml_data, errors_array)
-      valid = check_not_empty(yaml_data, errors_array)
-      valid &&= check_syntax_valid(yaml_data, errors_array)
-      valid &&= check_overlapping_keys(yaml_data, errors_array)
+      valid = check_not_empty?(yaml_data, errors_array)
+      valid &&= check_syntax_valid?(yaml_data, errors_array)
+      valid &&= check_overlapping_keys?(yaml_data, errors_array)
 
       valid
     end
 
-    def check_not_empty(yaml_data, errors_array)
+    # Check that the data is not empty
+    def check_not_empty?(yaml_data, errors_array)
       if yaml_data.empty?
         errors_array << 'The YAML should not be an empty string'
         false
@@ -91,15 +114,13 @@ module YamlLint
       end
     end
 
-    def check_syntax_valid(yaml_data, errors_array)
+    # Check that the data is valid YAML
+    def check_syntax_valid?(yaml_data, errors_array)
       YAML.load(yaml_data)
       true
     rescue YAML::SyntaxError => e
       errors_array << e.message
       false
-    rescue YAML::ParseError => e
-      errors_array << e.message
-      false
     end
 
     ###
@@ -108,6 +129,7 @@ module YamlLint
     class KeyOverlapDetector
       attr_reader :overlapping_keys
 
+      # Setup class variables
       def initialize
         @seen_keys = Set.new
         @key_components = []
@@ -117,6 +139,7 @@ module YamlLint
         @array_positions = []
       end
 
+      # Get the data and send it off for duplicate key validation
       def parse(psych_parse_data)
         data_start = psych_parse_data.handler.root.children[0].children[0]
         hash_start('')
@@ -126,6 +149,7 @@ module YamlLint
 
       private
 
+      # Recusively check for duplicate keys
       def parse_recurse(psych_parse_data, is_sequence = false)
         is_key = false
         psych_parse_data.children.each do |n|
@@ -151,27 +175,21 @@ module YamlLint
             hash_end(@last_key.last)
             is_key = false
             @last_key.pop
-          else
-            YamlLint.logger.debug { "Unknown (#{n.class})" }
           end
         end
       end
 
+      # Setup a new hash
       def hash_start(key)
         YamlLint.logger.debug { "hash_start: #{key.inspect}" }
 
-        case @complex_type.last
-        when :hash
-          @key_components.push(key)
-        when :array
-          @key_components.push(@array_positions.last)
-          @array_positions[-1] += 1
-        end
+        complex_type_start(key)
 
         @complex_type.push(:hash)
         check_for_overlap!
       end
 
+      # Tear down a hash
       def hash_end(key)
         YamlLint.logger.debug { "hash_end: #{key.inspect}" }
 
@@ -179,22 +197,18 @@ module YamlLint
         @complex_type.pop
       end
 
+      # Setup a new array
       def array_start(key)
         YamlLint.logger.debug { "array_start: #{key.inspect}" }
 
-        case @complex_type.last
-        when :hash
-          @key_components.push(key)
-        when :array
-          @key_components.push(@array_positions.last)
-          @array_positions[-1] += 1
-        end
+        complex_type_start(key)
 
         @complex_type.push(:array)
         @array_positions.push(0)
         check_for_overlap!
       end
 
+      # Tear down the array
       def array_end(key)
         YamlLint.logger.debug { "array_end: #{key.inspect}" }
 
@@ -203,6 +217,7 @@ module YamlLint
         @array_positions.pop
       end
 
+      # Add a key / value pair
       def add_value(value, key)
         YamlLint.logger.debug { "add_value: #{value.inspect}, #{key.inspect}" }
 
@@ -219,6 +234,7 @@ module YamlLint
         end
       end
 
+      # Check for key overlap
       def check_for_overlap!
         full_key = @key_components.dup
         YamlLint.logger.debug { "Checking #{full_key.join('.')} for overlap" }
@@ -227,9 +243,21 @@ module YamlLint
         YamlLint.logger.debug { "Overlapping key #{full_key.join('.')}" }
         @overlapping_keys << full_key
       end
+
+      # Setup common hash and array elements
+      def complex_type_start(key)
+        case @complex_type.last
+        when :hash
+          @key_components.push(key)
+        when :array
+          @key_components.push(@array_positions.last)
+          @array_positions[-1] += 1
+        end
+      end
     end
 
-    def check_overlapping_keys(yaml_data, errors_array)
+    # Check if there is overlapping key
+    def check_overlapping_keys?(yaml_data, errors_array)
       overlap_detector = KeyOverlapDetector.new
       data = Psych.parser.parse(yaml_data)
 

data/lib/yamllint/rake_task.rb

@@ -11,10 +11,14 @@ module YamlLint
     attr_accessor :name
     attr_accessor :paths
     attr_accessor :fail_on_error
+    attr_accessor :disable_ext_check
+    attr_accessor :extensions
 
     def initialize(name = :yamllint)
       @name = name
       @fail_on_error = true
+      @disable_ext_check = false
+      @extensions = nil
 
       yield self if block_given?
 
@@ -23,6 +27,7 @@ module YamlLint
 
     private
 
+    # Rake task
     def define_task
       desc 'Run yamllint' unless ::Rake.application.last_comment
 
@@ -33,7 +38,8 @@ module YamlLint
 
         puts "Checking #{files_to_check.flatten.length} files"
 
-        linter = ::YamlLint::Linter.new
+        linter = ::YamlLint::Linter.new(disable_ext_check: disable_ext_check,
+                                        extensions: extensions)
         linter.check_all(files_to_check)
 
         if linter.errors?

data/lib/yamllint/version.rb

@@ -1,7 +1,6 @@
 ###
-# = Overview
 #
-# Contains YamlLint version number
+# YamlLint checks YAML files for correct syntax
 module YamlLint
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/yamllint.rb

@@ -4,7 +4,6 @@ require 'yamllint/version'
 require 'yamllint/linter'
 
 ###
-# = Overview
 #
 # YamlLint checks YAML files for correct syntax
 module YamlLint

data/spec/cli_spec.rb

@@ -41,9 +41,19 @@ describe 'yamllint' do
     assert_failing_with('no such file')
   end
 
-  it 'should fail with an invalid YAML file extention' do
-    yamllint spec_data('wrong_extention.txt')
-    assert_failing_with('File extention must be .yaml or .yml')
+  it 'should fail with an invalid YAML file extension' do
+    yamllint spec_data('wrong_extension.txt')
+    assert_failing_with('File extension must be .yaml or .yml')
+  end
+
+  it 'should pass with invalid file extension and extension check disabled' do
+    yamllint "-d #{spec_data('wrong_extension.txt')}"
+    assert_success(true)
+  end
+
+  it 'should pass with custom extension' do
+    yamllint "-e eyaml #{spec_data('custom_extension.eyaml')}"
+    assert_success(true)
   end
 
   it 'should fail with a path that is unreadable' do

data/spec/data/custom_extension.eyaml

@@ -0,0 +1,2 @@
+---
+foo: bar

data/spec/data/valid_very_complex.yaml

@@ -0,0 +1,22 @@
+---
+foo: bar
+my_array:
+  - 1
+  - 2
+  - 3
+my_hash:
+  foo1: bar1
+  foo2: bar2
+  foo3: bar3
+  foo4:
+  - bar
+  - bar2:
+    - biz
+    - baz
+  foo5:
+  - bar
+  - - foo
+  - bar2:
+    - biz
+    - baz: 1
+      buzz: 2

data/spec/data/wrong_extension.txt

@@ -0,0 +1,2 @@
+---
+foo: bar

data/spec/linter_spec.rb

@@ -4,6 +4,10 @@ require 'yamllint/linter'
 describe 'YamlLint::Linter' do
   let(:linter) { YamlLint::Linter.new }
 
+  before do
+    allow(linter).to receive(:puts)
+  end
+
   it 'should throw an exception if given a bogus path' do
     expect { linter.check('/does/not/exist') }.to raise_error
   end
@@ -11,10 +15,33 @@ describe 'YamlLint::Linter' do
   it 'should be happy with a valid YAML file' do
     expect(linter.check(spec_data('valid.yaml'))).to be(true)
     expect(linter.check(spec_data('valid_complex.yaml'))).to be(true)
+    expect(linter.check(spec_data('valid_very_complex.yaml'))).to be(true)
+  end
+
+  it 'should have 0 error count with a valid YAML file' do
+    linter.check(spec_data('valid.yaml'))
+    expect(linter.errors_count).to eq(0)
+  end
+
+  it 'should have 1 error count with a empty YAML file' do
+    linter.check(spec_data('empty.yaml'))
+    expect(linter.errors_count).to eq(1)
+  end
+
+  it 'should display errors for empty YAML file' do
+    linter.check(spec_data('empty.yaml'))
+    error_array = linter.display_errors
+    error_array_expected = ['The YAML should not be an empty string']
+    expect(error_array.first[1]).to eq(error_array_expected)
+  end
+
+  it 'should be happy with a multiple valid YAML files' do
+    linter.check_all([spec_data('valid.yaml'), spec_data('valid_complex.yaml')])
+    expect(linter.errors?).to be(false)
   end
 
-  it 'should be unhappy with an invalid YAML file extention' do
-    expect(linter.check(spec_data('wrong_extention.txt'))).to be(false)
+  it 'should be unhappy with an invalid YAML file extension' do
+    expect(linter.check(spec_data('wrong_extension.txt'))).to be(false)
   end
 
   it 'should be unhappy with an invalid YAML file' do

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 require 'rspec'
 
 require 'aruba'

data/yamllint.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'aruba'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'coveralls'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yamllint
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Grant Ridder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-16 00:00:00.000000000 Z
+date: 2015-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Checks YAML files for correct syntax
 email:
 - shortdudey123@gmail.com
@@ -116,6 +130,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -134,16 +149,16 @@ files:
 - lib/yamllint/rake_task.rb
 - lib/yamllint/version.rb
 - spec/cli_spec.rb
+- spec/data/custom_extension.eyaml
 - spec/data/empty.yaml
 - spec/data/invalid.yaml
 - spec/data/overlapping_keys.yaml
-- spec/data/overlapping_keys_complex.yaml
 - spec/data/overlapping_keys_deep.yaml
 - spec/data/spaces.yaml
 - spec/data/valid.yaml
 - spec/data/valid_complex.yaml
-- spec/data/valid_complex.yml
-- spec/data/wrong_extention.txt
+- spec/data/valid_very_complex.yaml
+- spec/data/wrong_extension.txt
 - spec/linter_spec.rb
 - spec/spec_helper.rb
 - yamllint.gemspec
@@ -173,15 +188,15 @@ specification_version: 4
 summary: YAML lint checker
 test_files:
 - spec/cli_spec.rb
+- spec/data/custom_extension.eyaml
 - spec/data/empty.yaml
 - spec/data/invalid.yaml
 - spec/data/overlapping_keys.yaml
-- spec/data/overlapping_keys_complex.yaml
 - spec/data/overlapping_keys_deep.yaml
 - spec/data/spaces.yaml
 - spec/data/valid.yaml
 - spec/data/valid_complex.yaml
-- spec/data/valid_complex.yml
-- spec/data/wrong_extention.txt
+- spec/data/valid_very_complex.yaml
+- spec/data/wrong_extension.txt
 - spec/linter_spec.rb
 - spec/spec_helper.rb

data/spec/data/overlapping_keys_complex.yaml

@@ -1,7 +0,0 @@
----
-foo: bar1
-keys:
-  - 1
-  - 2
-  - 3
-foo: bar2

data/spec/data/valid_complex.yml

@@ -1,112 +0,0 @@
----
-YAML: YAML Ain't Markup Language
-
-What It Is: YAML is a human friendly data serialization
-  standard for all programming languages.
-
-YAML Resources:
-  YAML 1.2 (3rd Edition): http://yaml.org/spec/1.2/spec.html
-  YAML 1.1 (2nd Edition): http://yaml.org/spec/1.1/
-  YAML 1.0 (1st Edition): http://yaml.org/spec/1.0/
-  YAML Issues Page: https://github.com/yaml/yaml/issues
-  YAML Mailing List: yaml-core@lists.sourceforge.net
-  YAML IRC Channel: "#yaml on irc.freenode.net"
-  YAML Cookbook (Ruby): http://yaml4r.sourceforge.net/cookbook/ (local)
-  YAML Reference Parser: http://yaml.org/ypaste/
-
-Projects:
-  C/C++ Libraries:
-  - libyaml       # "C" Fast YAML 1.1
-  - Syck          # (dated) "C" YAML 1.0
-  - yaml-cpp      # C++ YAML 1.2 implementation
-  Ruby:
-  - psych         # libyaml wrapper (in Ruby core for 1.9.2)
-  - RbYaml        # YAML 1.1 (PyYaml Port)
-  - yaml4r        # YAML 1.0, standard library syck binding
-  Python:
-  - PyYaml        # YAML 1.1, pure python and libyaml binding
-  - PySyck        # YAML 1.0, syck binding
-  Java:
-  - JvYaml        # Java port of RbYaml
-  - SnakeYAML     # Java 5 / YAML 1.1
-  - YamlBeans     # To/from JavaBeans
-  - JYaml         # Original Java Implementation
-  Perl Modules:
-  - YAML          # Pure Perl YAML Module
-  - YAML::XS      # Binding to libyaml
-  - YAML::Syck    # Binding to libsyck
-  - YAML::Tiny    # A small YAML subset module
-  - PlYaml        # Perl port of PyYaml
-  C#/.NET:
-  - yaml-net      # YAML 1.1 library
-  - yatools.net   # (in-progress) YAML 1.1 implementation
-  PHP:
-  - php-yaml      # libyaml bindings (YAML 1.1)
-  - syck          # syck bindings (YAML 1.0)
-  - spyc          # yaml loader/dumper (YAML 1.?)
-  OCaml:
-  - ocaml-syck    # YAML 1.0 via syck bindings
-  Javascript:
-  - JS-YAML       # Native PyYAML port to JavaScript.
-  - JS-YAML Online# Browserified JS-YAML demo, to play with YAML in your browser.
-  Actionscript:
-  - as3yaml       # port of JvYAML (1.1)
-  Haskell:
-  - YamlReference # Haskell 1.2 reference parser
-  Others:
-  - yamlvim (src) # YAML dumper/emitter in pure vimscript
-
-Related Projects:
-  - Rx            # Multi-Language Schemata Tool for JSON/YAML
-  - Kwalify       # Ruby Schemata Tool for JSON/YAML
-  - yaml_vim      # vim syntax files for YAML
-  - yatools.net   # Visual Studio editor for YAML
-  - JSON          # Official JSON Website
-  - Pygments      # Python language Syntax Colorizer /w YAML support
-
-News:
-  - 20-NOV-2011 -- JS-YAML, a JavaScript YAML parser by Alexey Zapparov and Vitaly Puzrin.
-  - 18-AUG-2010 -- Ruby 1.9.2 includes psych, a libyaml wrapper by Aaron Patterson.
-  - 17-AUG-2010 -- vimscript parser/emitter was created by Nikolay Pavlov.
-  - 01-OCT-2009 -- YAML 1.2 (3rd Edition) was patched.
-  - 21-JUL-2009 -- YAML 1.2 (3rd Edition) was released.
-  - 28-APR-2009 -- A new version of SnakeYAML was released.
-  - 01-APR-2009 -- The YAML 1.2 spec was planned to be finalized by the end of the month.
-  - 07-JAN-2009 -- Andrey Somov releases SnakeYAML, a 1.1 YAML Parser
-  - 03-JAN-2009 -- Burt Harris announced YAML for .NET and editor for Visual Studio
-  - 02-DEC-2008 -- Jesse Beder released YAML for C++
-  - 11-MAY-2008 -- Oren Ben-Kiki has released a new YAML 1.2 spec draft
-  - 29-NOV-2007 -- Alexey Zakhlestin has updated his Syck (YAML 1.0) binding for PHP
-  - 23-NOV-2007 -- Derek Wischusen has release Action Script 3 YAML 1.1
-  - 01-AUG-2006 -- Kirill Simonov has released libyaml, a parser and emitter in "C"
-  - 06-JUN-2006 -- Ola Bini is at it again, this time with a Java implementation
-  - 03-JUN-2006 -- Christophe Lambrechts and Jonathan Slenders announced a .NET parser
-  - 07-MAY-2006 -- Ola Bini released a pure-ruby YAML 1.1 parser and emitter
-  - 12-APR-2006 -- Kirill's YAML 1.1 parser for Python is now at PyYaml
-  - 05-FEB-2006 -- Spyc YAML for PHP is now at version 0.3
-  - 17-DEC-2005 -- Makoto Kuwata has released Kwalify 0.5, YAML/JSON schema validator
-  - 14-DEC-2005 -- Toby Ho has released Jyaml, a Java library for YAML based on Rolf Veen's work
-  - 30-AUG-2005 -- Kirill Simonov has produce a wonderful Python binding for Syck
-  - 08-APR-2005 -- As it turns out, YAML is a superset of the JSON serialization language
-  - 18-MAY-2005 -- Why has released version 0.55 of Syck
-  - 28-DEC-2004 -- Announcing YAML 1.1 Working Draft
-  - 01-OCT-2004 -- YAML for Cocoa was released by Will Thimbley
-  - 08-FEB-2004 -- Slaven Rezic announced a new version of his Javascript binding
-  - 29-JAN-2004 -- Ingy, Oren, and Clark spent 4 days hacking on the spec in Portland.
-  - 10-OCT-2003 -- The Syck implementation with bindings for Ruby, Python,
-                   and PHP is now at version .41
-  - 26-APR-2003 -- Mike Orr has taken over the Pure Python development.
-  - 26-APR-2003 -- Brian Ingerson has created a FIT platform for Wiki-like testing.
-  - 24-JAN-2003 -- Updates to specification.
-  - 25-JUL-2002 -- Both the Ruby and Python parsers have made significant progress.
-                   There is an article about YAML by Kendall Grant Clark at xml.com.
-                   There is also a draft XML binding.
-  - 02-JUL-2002 -- Brian Ingerson will be giving a 45 minute presentation on YAML at the
-                   O'Reilly Open Source Conference in San Diego on July 24th 2002.
-  - 01-FEB-2002 -- Brian's Perl implementation YAML.pm, has been updated with new documentation.
-                   Included in this release is YSH, a test shell for learning how YAML works.
-  - 03-JAN-2002 -- YAML(tm) starts the new year with a new name YAML Ain't Markup Language.
-  - 17-MAY-2001 -- YAML now has a mailing list at SourceForge.
-  - 15-MAY-2001 -- YAML is started with a first pass specification.
-# Maintained by Clark C. Evans
-...