yamlint 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ba199cae535ca4513781fcfbcc290cf199f4470d6c95468fd0121b5dc8b41ec
-  data.tar.gz: 922d412334c7b62e4f02f6cdfa2c778d7133fd27db603b8b2e6b524c6b3d2e08
+  metadata.gz: 30f54142723326b9a7faf55cbe53f35c515f9f1465ab237bb172594abf1dff83
+  data.tar.gz: 8ef8637b0a0d7f92f1782d6be1afc96be22fd5009f0cba0066a835566e75f332
 SHA512:
-  metadata.gz: 61038214855e6ec9e8656efd4c8c199b471c946b417e4284292eac875e76c0d38537915cae4ef658e971fb0fa688eee263d0771d0171ba035c5a130d9cf7674d
-  data.tar.gz: 134057a5a2293d500c22d9c595f2c09f5ef07e60f55c4a87ee5ffbd9277f9b53711f6e647eb852ab17acfef7436d33568588a6e1f5c7d6f521f8b5343fe359e3
+  metadata.gz: 265a6207b6254d8f996564887f86d40a66f51a34437e6c7971e7bfedeedd971b93cd1c9297cb753ccecda7fadf10cb9234b1bc9fef78d88a8354bc3c1d852c7f
+  data.tar.gz: dc1d831da8b73704d3f3afaae658d8599c140060751d683e6a25168dc265cc7f882f7d2464559b2b04f85240761a8b09dddfc78580e237a11731adc45006ecf2

data/.rubocop.yml

@@ -1,13 +1,35 @@
+plugins:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
-  TargetRubyVersion: 2.6
+  NewCops: enable
+  TargetRubyVersion: 3.1
+
+Metrics:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/ImplicitSubject:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
 
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
+RSpec/MultipleExpectations:
+  Max: 2
 
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
+RSpec/NestedGroups:
+  Max: 4
 
-Layout/LineLength:
-  Max: 120
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - '**/spec/routing/**/*'
+    - 'spec/yamlint/parser/comment_extractor_spec.rb'
+    - 'spec/yamlint/rules/base_spec.rb'

data/.serena/.gitignore

@@ -0,0 +1 @@
+/cache

data/.serena/memories/project_overview.md

@@ -0,0 +1,25 @@
+# yamlint project overview
+
+## Purpose
+- Pure-Ruby YAML linter and formatter, inspired by Python's `adrienverge/yamllint`.
+- Provides CLI linting and auto-fix formatting with yamllint-compatible config intent.
+
+## Tech stack
+- Ruby gem (Ruby >= 3.1; `.ruby-version` is 3.4.8).
+- Testing: RSpec.
+- Linting: RuboCop (+ performance/rake/rspec plugins).
+
+## Rough structure
+- `lib/yamlint/`: core implementation
+  - `cli.rb`, `runner.rb`: CLI entry logic
+  - `linter.rb`, `formatter.rb`, `config.rb`
+  - `parser/`, `rules/`, `models/`, `output/`, `presets/`
+- `exe/yamlint`: gem executable entrypoint
+- `bin/`: developer scripts (`setup`, `console`, `checker`)
+- `spec/`: RSpec test suite
+- `docs/`: generated documentation
+- `yamlint.gemspec`, `Gemfile`, `Rakefile`: gem/build config
+
+## Architecture notes
+Design doc (`ruby_yamllint_design_and_instructions.md`) describes layered architecture:
+CLI -> core (linter/formatter/config) -> rules registry -> parser -> models.

data/.serena/memories/style_and_conventions.md

@@ -0,0 +1,7 @@
+# Style and conventions
+
+- Ruby codebase with `# frozen_string_literal: true` headers.
+- RuboCop enabled (plugins: performance, rake, rspec); metrics cops disabled; documentation cop disabled.
+- RSpec used for tests; no strict example length/subject cops.
+- Target Ruby version in RuboCop: 3.1; project `.ruby-version` is 3.4.8.
+- Standard Ruby gem layout and naming under `lib/yamlint`.

data/.serena/memories/suggested_commands.md

@@ -0,0 +1,17 @@
+# Suggested commands
+
+## Setup
+- `bin/setup` (install dependencies)
+
+## Tests
+- `bundle exec rake spec`
+- `bundle exec rake` (default runs `spec` and `rubocop`)
+
+## Linting
+- `bundle exec rubocop`
+- `bundle exec rake rubocop`
+
+## Run CLI / console
+- `bundle exec exe/yamlint ...` (gem executable)
+- `bin/console` (interactive)
+- `bin/checker <files...>` (simple YAML load checker)

data/.serena/memories/task_completion.md

@@ -0,0 +1,5 @@
+# Task completion checklist
+
+- Run `bundle exec rake` (or at least `bundle exec rake spec` + `bundle exec rubocop`).
+- Update/add RSpec coverage for behavior changes.
+- If altering CLI or config behavior, consider updating docs or README as needed.

data/.serena/project.yml

@@ -0,0 +1,89 @@
+# list of languages for which language servers are started; choose from:
+#   al                  bash                clojure             cpp                 csharp
+#   csharp_omnisharp    dart                elixir              elm                 erlang
+#   fortran             fsharp              go                  groovy              haskell
+#   java                julia               kotlin              lua                 markdown
+#   matlab              nix                 pascal              perl                php
+#   powershell          python              python_jedi         r                   rego
+#   ruby                ruby_solargraph     rust                scala               swift
+#   terraform           toml                typescript          typescript_vts      vue
+#   yaml                zig
+#   (This list may be outdated. For the current list, see values of Language enum here:
+#   https://github.com/oraios/serena/blob/main/src/solidlsp/ls_config.py
+#   For some languages, there are alternative language servers, e.g. csharp_omnisharp, ruby_solargraph.)
+# Note:
+#   - For C, use cpp
+#   - For JavaScript, use typescript
+#   - For Free Pascal/Lazarus, use pascal
+# Special requirements:
+#   - csharp: Requires the presence of a .sln file in the project folder.
+#   - pascal: Requires Free Pascal Compiler (fpc) and optionally Lazarus.
+# When using multiple languages, the first language server that supports a given file will be used for that file.
+# The first language is the default language and the respective language server will be used as a fallback.
+# Note that when using the JetBrains backend, language servers are not used and this list is correspondingly ignored.
+languages:
+- ruby
+
+# the encoding used by text files in the project
+# For a list of possible encodings, see https://docs.python.org/3.11/library/codecs.html#standard-encodings
+encoding: "utf-8"
+
+# whether to use project's .gitignore files to ignore files
+ignore_all_files_in_gitignore: true
+
+# list of additional paths to ignore in all projects
+# same syntax as gitignore, so you can use * and **
+ignored_paths: []
+
+# whether the project is in read-only mode
+# If set to true, all editing tools will be disabled and attempts to use them will result in an error
+# Added on 2025-04-18
+read_only: false
+
+# list of tool names to exclude. We recommend not excluding any tools, see the readme for more details.
+# Below is the complete list of tools for convenience.
+# To make sure you have the latest list of tools, and to view their descriptions, 
+# execute `uv run scripts/print_tool_overview.py`.
+#
+#  * `activate_project`: Activates a project by name.
+#  * `check_onboarding_performed`: Checks whether project onboarding was already performed.
+#  * `create_text_file`: Creates/overwrites a file in the project directory.
+#  * `delete_lines`: Deletes a range of lines within a file.
+#  * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
+#  * `execute_shell_command`: Executes a shell command.
+#  * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
+#  * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
+#  * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
+#  * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
+#  * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file.
+#  * `initial_instructions`: Gets the initial instructions for the current project.
+#     Should only be used in settings where the system prompt cannot be set,
+#     e.g. in clients you have no control over, like Claude Desktop.
+#  * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
+#  * `insert_at_line`: Inserts content at a given line in a file.
+#  * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
+#  * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
+#  * `list_memories`: Lists memories in Serena's project-specific memory store.
+#  * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
+#  * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
+#  * `read_file`: Reads a file within the project directory.
+#  * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
+#  * `remove_project`: Removes a project from the Serena configuration.
+#  * `replace_lines`: Replaces a range of lines within a file with new content.
+#  * `replace_symbol_body`: Replaces the full definition of a symbol.
+#  * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
+#  * `search_for_pattern`: Performs a search for a pattern in the project.
+#  * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
+#  * `switch_modes`: Activates modes by providing a list of their names
+#  * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
+#  * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
+#  * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
+#  * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
+excluded_tools: []
+
+# initial prompt for the project. It will always be given to the LLM upon activating the project
+# (contrary to the memories, which are loaded on demand).
+initial_prompt: ""
+
+project_name: "yamlint"
+included_optional_tools: []

data/CHANGELOG.md

@@ -1,5 +1,9 @@
-## [Unreleased]
+## Unreleased
 
-## [0.1.0] - 2022-11-16
+## 1.0.0 - 2026-01-25
+
+- Re-implemented core functions
+
+## 0.1.0 - 2022-11-16
 
 - Initial release

data/Gemfile

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-# Specify your gem's dependencies in yamlint.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.21"
+gem 'rake'
+gem 'rdoc'
+gem 'rspec'
+gem 'rubocop'
+gem 'rubocop-performance'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'
+gem 'yard'

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 ydah
+Copyright (c) 2022 Yudai Takada
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,37 +1,175 @@
-# Yamlint
+<h1 align="center">yamlint</h1>
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yamlint`. To experiment with that code, run `bin/console` for an interactive prompt.
+<p align="center">
+  <img src="https://img.shields.io/badge/ruby-%3E%3D%203.1-ruby.svg" alt="Ruby Version"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"><a href="https://github.com/ydah/yamlint/actions/workflows/test.yml"><img src="https://github.com/ydah/yamlint/actions/workflows/test.yml/badge.svg?branch=main" alt="test"></a><a href="https://badge.fury.io/rb/yamlint"><img src="https://badge.fury.io/rb/yamlint.svg" alt="Gem Version"></a>
+</p>
 
-TODO: Delete this and the text above, and describe your gem
+<p align="center">
+  A Ruby CLI for linting and formatting YAML files
+</p>
+
+<p align="center">
+  <a href="#features">Features</a> •
+  <a href="#quickstart">Quickstart</a> •
+  <a href="#installation">Installation</a> •
+  <a href="#usage">Usage</a> •
+  <a href="#configuration">Configuration</a> •
+  <a href="#rules">Rules</a>
+</p>
+
+## Features
+
+- Rule-based linting and auto-formatting
+- Configuration via `.yamllint(.yml/.yaml)` with preset `extends`
+- CI-friendly output formats (standard/parsable/colored/github)
+- YAML file patterns and ignore support
+
+## Quickstart
+
+```bash
+gem install yamlint
+
+# lint
+yamlint .
+
+# format (dry-run)
+yamlint format --dry-run .
+```
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+With Bundler:
 
-    $ bundle add yamlint
+```bash
+bundle add yamlint
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Without Bundler:
 
-    $ gem install yamlint
+```bash
+gem install yamlint
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+Basic:
 
-## Development
+```bash
+yamlint .
+yamlint path/to/file.yml
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Formatting:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```bash
+yamlint format .
+yamlint format --dry-run .
+```
 
-## Contributing
+CI output:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yamlint. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/yamlint/blob/main/CODE_OF_CONDUCT.md).
+```bash
+yamlint -f github .
+```
 
-## License
+Help:
+
+```bash
+yamlint --help
+```
+
+## Configuration
+
+Default config file names:
+
+- `.yamllint`
+- `.yamllint.yml`
+- `.yamllint.yaml`
+
+Configuration options:
+
+| Option | Type | Default | Behavior |
+| --- | --- | --- | --- |
+| `extends` | string | none | Inherit a preset (`default` or `relaxed`). Values from the current file override the preset. |
+| `yaml-files` | list of glob strings | `["*.yaml", "*.yml"]` | Glob patterns used when discovering YAML files in directories. |
+| `ignore` | list of strings | `[]` | List of paths to skip. Parsed by the config loader but not currently applied to file discovery. |
+| `rules` | map | `{}` | Per-rule configuration. Set a rule to `disable` or `false` to turn it off, or provide a map of options. |
+
+Notes:
+
+- Rule option keys accept either `snake_case` or `kebab-case` and are normalized internally.
+- Rule option defaults come from the rule implementation and are merged with your overrides.
+
+Example:
+
+```yaml
+extends: default
+
+yaml-files:
+  - "*.yml"
+  - "*.yaml"
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+ignore:
+  - vendor
+  - node_modules
 
-## Code of Conduct
+rules:
+  line-length:
+    max: 120
+  document-start: disable
+  truthy:
+    allowed-values: ["true", "false"]
+```
+
+## Presets
+
+Available presets:
+
+- `default`
+- `relaxed`
+
+```yaml
+extends: relaxed
+```
+
+## Rules
+
+Key rules:
+
+- anchors, braces, brackets, colons, commas, comments, comments-indentation
+- document-start, document-end, empty-lines, empty-values, float-values
+- hyphens, indentation, key-duplicates, key-ordering, line-length
+- new-lines, new-line-at-end-of-file, octal-values, quoted-strings
+- trailing-spaces, truthy
+
+## Output formats
+
+Use `-f`/`--format` to select an output format:
+
+- `standard`
+- `parsable`
+- `colored`
+- `github`
+
+## Development
+
+```bash
+bin/setup
+rake spec
+```
+
+Install locally:
+
+```bash
+bundle exec rake install
+```
+
+Release:
+
+```bash
+bundle exec rake release
+```
+
+## License
 
-Everyone interacting in the Yamlint project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/yamlint/blob/main/CODE_OF_CONDUCT.md).
+MIT License. See `LICENSE.txt` for details.

data/Rakefile

@@ -1,12 +1,19 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+require 'yard/rake/yardoc_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 
+YARD::Rake::YardocTask.new do |task|
+  task.files = ['lib/**/*.rb']
+  task.options = ['--output-dir', 'docs']
+end
+
 task default: %i[spec rubocop]