mini_yaml 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fa30f1798b3119df42e4be52f6ca36619d032cf191d6eb1e50160f71de8bbff
-  data.tar.gz: eef3d0553e5e81cb2ff7f69c59dc88e0b1104062f146afd342b32809693295a7
+  metadata.gz: af9cb20015b87c2bdb276d606ec4c6ab05900ea52e54dfa2c639400e2ca791d6
+  data.tar.gz: e01087aebc3b3ae185d7069a07f69653dea91d8d52bb1e076b2d8c7e9ba7676e
 SHA512:
-  metadata.gz: b76adc1db8c66c704ae91384686ea930fa723a4c85c06adc1eaeed324c9987933755989113e817f24c85096b882e72ab39560e797ad310dd0171034109c66097
-  data.tar.gz: 70ad69d46711d73f698e7e0ca347fdeb7ebe9ad913cfac9d4e0a14eba552048a06067902a27a7b95656fab4897c5ec7c461c53f9c0d1a92a16b3bcca0de39128
+  metadata.gz: c87b291289805c9079b58606dfff79e425c01f975ab3c3c774995389f7c75335301405b789d918b8d7e66945593e26d16561a7d0a1b73cddcac7ce4d5a92378c
+  data.tar.gz: a564898b9bc356ed39426ce82f7a80948ce7318688a29bfe208db16165cc44adb846781fd858e7a1aec42dcca68c9db80b3f9e6b6d8bf5a865a0cdbcc8f973d9

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock

data/README.md

@@ -25,7 +25,48 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+
+To lint an indevidual file use:
+
+```ruby
+lint-yaml FILENAME
+```
+
+To amend an existing YAML file use:
+
+```ruby
+yaml = <<~YAML
+  # comment
+  - "a"
+  - b
+YAML
+
+linter = MiniYaml::Linter.new(yaml)
+linter.contents << "c"
+
+puts linter.dump
+
+```
+
+This will output:
+
+```
+---
+# comment
+- a
+- b
+- c
+```
+
+## Why not use prettier or some other tool?
+
+mini_yaml is deliberately opinionated. It enforces line length, chooses quoting styles and maintains comments.
+
+Prettier unfortunately is not as opinionated, it will not enforce quoting styles, line length and styles for multiple line strings and so on. This means that you can not rely on it to force consistent styling of YAML in your project.
+
+## Why not use mini-yaml?
+
+MiniYaml is extremely experimental, it includes a "paranoid" mode by default which makes it impossible that it will corrupt YAML, that said, it certainly may have bugs and may fail to handle all sorts of YAML files.
 
 ## Development
 

data/bin/lint-yaml

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require "mini_yaml"
+
+def usage
+  STDERR.puts "Usage: yaml-lint FILENAME"
+  exit 1
+end
+
+if !ARGV[0] || !File.exist?(ARGV[0])
+  usage
+end
+
+puts MiniYaml::Linter.new(File.read(ARGV[0])).dump
+

data/lib/mini_yaml/linter.rb

@@ -3,9 +3,10 @@ require 'yaml'
 
 module MiniYaml
   class Linter
-    def initialize(yaml, paranoid: true)
+    def initialize(yaml, paranoid: true, columns: 80)
       @comment_map = nil
       @parsed = parse(yaml)
+      @columns = columns
 
       if paranoid
         before, before_e, after, after_e = nil
@@ -88,7 +89,7 @@ module MiniYaml
             prev_char = line[index - 1]
             next_char = line[index + 1]
 
-            if col > 80 && char == " " && prev_char.match?(/\S/) && next_char.match?(/\S/)
+            if col > @columns && char == " " && prev_char.match?(/\S/) && next_char.match?(/\S/)
               buf << "\n"
               col = 0
             else
@@ -124,9 +125,9 @@ module MiniYaml
 
       val = val.to_s
 
-      if val.include?("\n") || val.length > 80
+      if val.include?("\n") || val.length > @columns
         lines = val.split("\n")
-        force_short = lines.map(&:length).max > 80
+        force_short = lines.map(&:length).max > @columns
         strip_trailing_newline = val[-1] != "\n"
 
         if force_short

data/lib/mini_yaml/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MiniYaml
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/mini_yaml.gemspec

@@ -21,10 +21,9 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.executables   = "lint-yaml"
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "rake"

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: mini_yaml
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sam Saffron
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2021-05-13 00:00:00.000000000 Z
 dependencies:
@@ -84,7 +84,8 @@ description: YAML editor that preserves comments and formats YAML using opiniona
   rules
 email:
 - sam.saffron@gmail.com
-executables: []
+executables:
+- lint-yaml
 extensions: []
 extra_rdoc_files: []
 files:
@@ -94,13 +95,11 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- bin/lint-yaml
 - lib/mini_yaml.rb
 - lib/mini_yaml/linter.rb
 - lib/mini_yaml/version.rb

data/Gemfile.lock

@@ -1,77 +0,0 @@
-PATH
-  remote: .
-  specs:
-    mini_yaml (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    coderay (1.1.3)
-    ffi (1.15.0)
-    formatador (0.2.5)
-    guard (2.16.2)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, < 4.0)
-      lumberjack (>= 1.0.12, < 2.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.9.12)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-compat (1.2.1)
-    guard-minitest (2.4.6)
-      guard-compat (~> 1.2)
-      minitest (>= 3.0)
-    listen (3.5.1)
-      rb-fsevent (~> 0.10, >= 0.10.3)
-      rb-inotify (~> 0.9, >= 0.9.10)
-    lumberjack (1.2.8)
-    method_source (1.0.0)
-    minitest (5.14.4)
-    nenv (0.3.0)
-    notiffany (0.1.3)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    parallel (1.20.1)
-    parser (3.0.1.1)
-      ast (~> 2.4.1)
-    pry (0.14.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    rb-fsevent (0.11.0)
-    rb-inotify (0.10.1)
-      ffi (~> 1.0)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rubocop (1.14.0)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.5.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.5.0)
-      parser (>= 3.0.1.1)
-    ruby-progressbar (1.11.0)
-    shellany (0.0.1)
-    thor (1.1.0)
-    unicode-display_width (2.0.0)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  guard
-  guard-minitest
-  mini_yaml!
-  minitest
-  rake
-  rubocop
-
-BUNDLED WITH
-   2.2.17

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "mini_yaml"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here