yamlint 0.1.0 → 1.0.0

data/lib/yamlint/rules/octal_values.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Yamlint
+  module Rules
+    class OctalValues < LineRule
+      rule_id 'octal-values'
+      desc 'Forbid implicit or explicit octal values.'
+      defaults({
+                 'forbid-implicit-octal': true,
+                 'forbid-explicit-octal': false
+               })
+
+      IMPLICIT_OCTAL_PATTERN = /:\s*0[0-7]+\s*(?:#.*)?$/
+      EXPLICIT_OCTAL_PATTERN = /:\s*0o[0-7]+\s*(?:#.*)?$/i
+
+      IMPLICIT_VALUE_PATTERN = /:\s*(0[0-7]+)/
+      EXPLICIT_VALUE_PATTERN = /:\s*(0o[0-7]+)/i
+
+      def check_line(line, line_number, _context)
+        return if line.strip.empty?
+        return if line.strip.start_with?('#')
+
+        problems = []
+        check_implicit_octal(line, line_number, problems)
+        check_explicit_octal(line, line_number, problems)
+        problems
+      end
+
+      private
+
+      def check_implicit_octal(line, line_number, problems)
+        return unless @config[:'forbid-implicit-octal'] && line.match?(IMPLICIT_OCTAL_PATTERN)
+
+        match = line.match(IMPLICIT_VALUE_PATTERN)
+        return unless match
+
+        problems << problem(
+          line: line_number,
+          column: match.begin(1) + 1,
+          message: "forbidden implicit octal value \"#{match[1]}\"",
+          fixable: false
+        )
+      end
+
+      def check_explicit_octal(line, line_number, problems)
+        return unless @config[:'forbid-explicit-octal'] && line.match?(EXPLICIT_OCTAL_PATTERN)
+
+        match = line.match(EXPLICIT_VALUE_PATTERN)
+        return unless match
+
+        problems << problem(
+          line: line_number,
+          column: match.begin(1) + 1,
+          message: "forbidden explicit octal value \"#{match[1]}\"",
+          fixable: false
+        )
+      end
+    end
+
+    Registry.register(OctalValues)
+  end
+end

data/lib/yamlint/rules/quoted_strings.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Yamlint
+  module Rules
+    class QuotedStrings < LineRule
+      rule_id 'quoted-strings'
+      desc 'Check quoting style of strings.'
+      defaults({
+                 'quote-type': 'any',
+                 required: false,
+                 'extra-required': [],
+                 'extra-allowed': [],
+                 'allow-quoted-quotes': false
+               })
+
+      def check_line(line, line_number, _context)
+        return if line.strip.empty?
+        return if line.strip.start_with?('#')
+        return unless @config[:required]
+
+        problems = []
+        quote_type = @config[:'quote-type']
+
+        if line.match?(/:.*[^"']\s*$/) && !multiline_indicator?(line)
+          if @config[:required] == 'only-when-needed'
+            # Check if quoting is needed
+          else
+            problems << problem(
+              line: line_number,
+              column: line.index(':') + 1,
+              message: 'string value is not quoted',
+              fixable: false
+            )
+          end
+        end
+
+        if quote_type == 'single' && line.include?('"')
+          if (match = line.match(/:\s*"[^"]*"/))
+            problems << problem(
+              line: line_number,
+              column: match.begin(0) + 1,
+              message: 'wrong quote type (expected single)',
+              fixable: true
+            )
+          end
+        elsif quote_type == 'double' && line.include?("'")
+          if (match = line.match(/:\s*'[^']*'/))
+            problems << problem(
+              line: line_number,
+              column: match.begin(0) + 1,
+              message: 'wrong quote type (expected double)',
+              fixable: true
+            )
+          end
+        end
+
+        problems
+      end
+
+      def fixable?
+        true
+      end
+
+      private
+
+      def multiline_indicator?(line)
+        line.match?(/[|>][-+]?\s*$/)
+      end
+    end
+
+    Registry.register(QuotedStrings)
+  end
+end

data/lib/yamlint/rules/registry.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Yamlint
+  module Rules
+    class Registry
+      DISABLED_VALUES = ['disable', false].freeze
+
+      class << self
+        def rules
+          @rules ||= {}
+        end
+
+        def register(rule_class)
+          rules[rule_class.id] = rule_class
+        end
+
+        def get(rule_id)
+          rules[rule_id]
+        end
+
+        def all
+          rules.values
+        end
+
+        def ids
+          rules.keys
+        end
+
+        def build(config)
+          rules_config = config[:rules] || {}
+          enabled_rules = []
+
+          rules.each do |rule_id, rule_class|
+            rule_config = rules_config[rule_id] || rules_config[rule_id.to_sym] || {}
+
+            next if DISABLED_VALUES.include?(rule_config)
+            next if rule_config.is_a?(Hash) && rule_config[:enable] == false
+
+            rule_options = rule_config.is_a?(Hash) ? rule_config : {}
+            enabled_rules << rule_class.new(rule_options)
+          end
+
+          enabled_rules
+        end
+      end
+    end
+  end
+end

data/lib/yamlint/rules/trailing_spaces.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Yamlint
+  module Rules
+    class TrailingSpaces < LineRule
+      rule_id 'trailing-spaces'
+      desc 'Forbid trailing spaces at the end of lines.'
+      defaults({})
+
+      def check_line(line, line_number, _context)
+        return if line.chomp.empty?
+
+        trailing = line[/[ \t]+$/]
+        return unless trailing
+
+        problem(
+          line: line_number,
+          column: line.rstrip.length + 1,
+          message: 'trailing spaces',
+          fixable: true
+        )
+      end
+
+      def fixable?
+        true
+      end
+    end
+
+    Registry.register(TrailingSpaces)
+  end
+end

data/lib/yamlint/rules/truthy.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Yamlint
+  module Rules
+    class Truthy < LineRule
+      rule_id 'truthy'
+      desc 'Forbid truthy values that are not true/false.'
+      defaults({
+                 'allowed-values': %w[true false],
+                 'check-keys': true
+               })
+
+      TRUTHY_VALUES = %w[
+        YES Yes yes
+        NO No no
+        TRUE True
+        FALSE False
+        ON On on
+        OFF Off off
+      ].freeze
+
+      def check_line(line, line_number, _context)
+        return if line.strip.empty?
+        return if line.strip.start_with?('#')
+
+        problems = []
+        allowed = @config[:'allowed-values']
+
+        TRUTHY_VALUES.each do |truthy|
+          next if allowed.include?(truthy)
+
+          next unless line.match?(/:\s*#{Regexp.escape(truthy)}\s*(?:#.*)?$/)
+
+          problems << problem(
+            line: line_number,
+            column: line.index(truthy) + 1,
+            message: "truthy value should be one of [#{allowed.join(', ')}]",
+            fixable: false
+          )
+        end
+
+        problems
+      end
+    end
+
+    Registry.register(Truthy)
+  end
+end

data/lib/yamlint/rules.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Yamlint
+  module Rules
+    autoload :Base, 'yamlint/rules/base'
+    autoload :LineRule, 'yamlint/rules/base'
+    autoload :TokenRule, 'yamlint/rules/base'
+    autoload :CommentRule, 'yamlint/rules/base'
+    autoload :Registry, 'yamlint/rules/registry'
+
+    autoload :TrailingSpaces, 'yamlint/rules/trailing_spaces'
+    autoload :NewLineAtEndOfFile, 'yamlint/rules/new_line_at_end_of_file'
+    autoload :NewLines, 'yamlint/rules/new_lines'
+    autoload :LineLength, 'yamlint/rules/line_length'
+    autoload :EmptyLines, 'yamlint/rules/empty_lines'
+    autoload :Indentation, 'yamlint/rules/indentation'
+    autoload :Colons, 'yamlint/rules/colons'
+    autoload :Commas, 'yamlint/rules/commas'
+    autoload :Braces, 'yamlint/rules/braces'
+    autoload :Brackets, 'yamlint/rules/brackets'
+    autoload :Hyphens, 'yamlint/rules/hyphens'
+    autoload :Comments, 'yamlint/rules/comments'
+    autoload :CommentsIndentation, 'yamlint/rules/comments_indentation'
+    autoload :DocumentStart, 'yamlint/rules/document_start'
+    autoload :DocumentEnd, 'yamlint/rules/document_end'
+    autoload :EmptyValues, 'yamlint/rules/empty_values'
+    autoload :KeyDuplicates, 'yamlint/rules/key_duplicates'
+    autoload :KeyOrdering, 'yamlint/rules/key_ordering'
+    autoload :Truthy, 'yamlint/rules/truthy'
+    autoload :QuotedStrings, 'yamlint/rules/quoted_strings'
+    autoload :OctalValues, 'yamlint/rules/octal_values'
+    autoload :FloatValues, 'yamlint/rules/float_values'
+    autoload :Anchors, 'yamlint/rules/anchors'
+
+    def self.load_all
+      constants(false).each do |const_name|
+        const_get(const_name)
+      end
+    end
+  end
+end

data/lib/yamlint/runner.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Yamlint
+  class Runner
+    attr_reader :config, :output_format
+
+    def initialize(config: nil, output_format: 'colored')
+      @config = config || Config.load_default
+      @output_format = output_format
+      @linter = Linter.new(@config)
+      @formatter = Formatter.new(@config)
+      @output = Output.get(output_format)
+    end
+
+    def lint(paths)
+      files = collect_files(paths)
+      total_problems = 0
+      results = []
+
+      files.each do |filepath|
+        problems = @linter.lint_file(filepath)
+        total_problems += problems.length
+
+        output = @output.format(filepath, problems)
+        results << output unless output.empty?
+      end
+
+      summary = @output.format_summary(files.length, total_problems)
+
+      {
+        files: files.length,
+        problems: total_problems,
+        output: results.join("\n\n"),
+        summary:,
+        exit_code: total_problems.positive? ? 1 : 0
+      }
+    end
+
+    def format(paths, dry_run: false)
+      files = collect_files(paths)
+      changed_files = []
+
+      files.each do |filepath|
+        original = File.read(filepath)
+        formatted = @formatter.format(original, dry_run:)
+
+        if original != formatted
+          changed_files << filepath
+          File.write(filepath, formatted) unless dry_run
+        end
+      end
+
+      {
+        files: files.length,
+        changed: changed_files.length,
+        changed_files:,
+        exit_code: 0
+      }
+    end
+
+    private
+
+    def collect_files(paths)
+      files = []
+      yaml_patterns = @config.yaml_files
+
+      paths.each do |path|
+        if File.directory?(path)
+          yaml_patterns.each do |pattern|
+            files.concat(Dir.glob(File.join(path, '**', pattern)))
+          end
+        elsif File.file?(path)
+          files << path
+        end
+      end
+
+      files.uniq.sort
+    end
+  end
+end

data/lib/yamlint/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Yamlint
-  VERSION = "0.1.0"
+  VERSION = '1.0.0'
 end

data/lib/yamlint.rb

@@ -1,8 +1,16 @@
 # frozen_string_literal: true
 
-require_relative "yamlint/version"
+require_relative 'yamlint/version'
 
 module Yamlint
-  class Error < StandardError; end
-  # Your code goes here...
+  autoload :Models, 'yamlint/models'
+  autoload :Parser, 'yamlint/parser'
+  autoload :Rules, 'yamlint/rules'
+  autoload :Presets, 'yamlint/presets'
+  autoload :Config, 'yamlint/config'
+  autoload :Linter, 'yamlint/linter'
+  autoload :Formatter, 'yamlint/formatter'
+  autoload :Runner, 'yamlint/runner'
+  autoload :Output, 'yamlint/output'
+  autoload :Cli, 'yamlint/cli'
 end

metadata

@@ -1,33 +1,154 @@
 --- !ruby/object:Gem::Specification
 name: yamlint
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Yudai Takada
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description:
 email:
 - t.yudai92@gmail.com
-executables: []
+executables:
+- yamlint
 extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".serena/.gitignore"
+- ".serena/memories/project_overview.md"
+- ".serena/memories/style_and_conventions.md"
+- ".serena/memories/suggested_commands.md"
+- ".serena/memories/task_completion.md"
+- ".serena/project.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- docs/Yamlint.html
+- docs/Yamlint/Cli.html
+- docs/Yamlint/Config.html
+- docs/Yamlint/Formatter.html
+- docs/Yamlint/Linter.html
+- docs/Yamlint/Models.html
+- docs/Yamlint/Models/LintContext.html
+- docs/Yamlint/Models/Problem.html
+- docs/Yamlint/Models/Token.html
+- docs/Yamlint/Output.html
+- docs/Yamlint/Output/Base.html
+- docs/Yamlint/Output/Colored.html
+- docs/Yamlint/Output/Github.html
+- docs/Yamlint/Output/Parsable.html
+- docs/Yamlint/Output/Standard.html
+- docs/Yamlint/Parser.html
+- docs/Yamlint/Parser/Comment.html
+- docs/Yamlint/Parser/CommentExtractor.html
+- docs/Yamlint/Parser/LineParser.html
+- docs/Yamlint/Parser/TokenParser.html
+- docs/Yamlint/Parser/TokenParser/Handler.html
+- docs/Yamlint/Presets.html
+- docs/Yamlint/Rules.html
+- docs/Yamlint/Rules/Anchors.html
+- docs/Yamlint/Rules/Anchors/AnchorHandler.html
+- docs/Yamlint/Rules/Base.html
+- docs/Yamlint/Rules/Braces.html
+- docs/Yamlint/Rules/Brackets.html
+- docs/Yamlint/Rules/Colons.html
+- docs/Yamlint/Rules/Commas.html
+- docs/Yamlint/Rules/CommentRule.html
+- docs/Yamlint/Rules/Comments.html
+- docs/Yamlint/Rules/CommentsIndentation.html
+- docs/Yamlint/Rules/DocumentEnd.html
+- docs/Yamlint/Rules/DocumentStart.html
+- docs/Yamlint/Rules/EmptyLines.html
+- docs/Yamlint/Rules/EmptyValues.html
+- docs/Yamlint/Rules/FloatValues.html
+- docs/Yamlint/Rules/Hyphens.html
+- docs/Yamlint/Rules/Indentation.html
+- docs/Yamlint/Rules/KeyDuplicates.html
+- docs/Yamlint/Rules/KeyDuplicates/DuplicateKeyHandler.html
+- docs/Yamlint/Rules/KeyOrdering.html
+- docs/Yamlint/Rules/KeyOrdering/KeyOrderHandler.html
+- docs/Yamlint/Rules/LineLength.html
+- docs/Yamlint/Rules/LineRule.html
+- docs/Yamlint/Rules/NewLineAtEndOfFile.html
+- docs/Yamlint/Rules/NewLines.html
+- docs/Yamlint/Rules/OctalValues.html
+- docs/Yamlint/Rules/QuotedStrings.html
+- docs/Yamlint/Rules/Registry.html
+- docs/Yamlint/Rules/TokenRule.html
+- docs/Yamlint/Rules/TrailingSpaces.html
+- docs/Yamlint/Rules/Truthy.html
+- docs/Yamlint/Runner.html
+- docs/_index.html
+- docs/class_list.html
+- docs/css/common.css
+- docs/css/full_list.css
+- docs/css/style.css
+- docs/file.README.html
+- docs/file_list.html
+- docs/frames.html
+- docs/index.html
+- docs/js/app.js
+- docs/js/full_list.js
+- docs/js/jquery.js
+- docs/method_list.html
+- docs/top-level-namespace.html
+- exe/yamlint
 - lib/yamlint.rb
+- lib/yamlint/cli.rb
+- lib/yamlint/config.rb
+- lib/yamlint/formatter.rb
+- lib/yamlint/linter.rb
+- lib/yamlint/models.rb
+- lib/yamlint/models/lint_context.rb
+- lib/yamlint/models/problem.rb
+- lib/yamlint/models/token.rb
+- lib/yamlint/output.rb
+- lib/yamlint/output/base.rb
+- lib/yamlint/output/colored.rb
+- lib/yamlint/output/github.rb
+- lib/yamlint/output/parsable.rb
+- lib/yamlint/output/standard.rb
+- lib/yamlint/parser.rb
+- lib/yamlint/parser/comment_extractor.rb
+- lib/yamlint/parser/line_parser.rb
+- lib/yamlint/parser/token_parser.rb
+- lib/yamlint/presets.rb
+- lib/yamlint/presets/default.rb
+- lib/yamlint/presets/relaxed.rb
+- lib/yamlint/rules.rb
+- lib/yamlint/rules/anchors.rb
+- lib/yamlint/rules/base.rb
+- lib/yamlint/rules/braces.rb
+- lib/yamlint/rules/brackets.rb
+- lib/yamlint/rules/colons.rb
+- lib/yamlint/rules/commas.rb
+- lib/yamlint/rules/comments.rb
+- lib/yamlint/rules/comments_indentation.rb
+- lib/yamlint/rules/document_end.rb
+- lib/yamlint/rules/document_start.rb
+- lib/yamlint/rules/empty_lines.rb
+- lib/yamlint/rules/empty_values.rb
+- lib/yamlint/rules/float_values.rb
+- lib/yamlint/rules/hyphens.rb
+- lib/yamlint/rules/indentation.rb
+- lib/yamlint/rules/key_duplicates.rb
+- lib/yamlint/rules/key_ordering.rb
+- lib/yamlint/rules/line_length.rb
+- lib/yamlint/rules/new_line_at_end_of_file.rb
+- lib/yamlint/rules/new_lines.rb
+- lib/yamlint/rules/octal_values.rb
+- lib/yamlint/rules/quoted_strings.rb
+- lib/yamlint/rules/registry.rb
+- lib/yamlint/rules/trailing_spaces.rb
+- lib/yamlint/rules/truthy.rb
+- lib/yamlint/runner.rb
 - lib/yamlint/version.rb
-- sig/yamlint.rbs
 homepage: https://github.com/ydah/yamlint
 licenses:
 - MIT
@@ -35,7 +156,7 @@ metadata:
   homepage_uri: https://github.com/ydah/yamlint
   source_code_uri: https://github.com/ydah/yamlint
   changelog_uri: https://github.com/ydah/yamlint/releases
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -43,15 +164,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.25
-signing_key:
+rubygems_version: 4.0.4
 specification_version: 4
 summary: A YAML file linter and formatter.
 test_files: []

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at 13041216+ydah@users.noreply.github.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.