openvox-lint 1.0.0

data/lib/openvox-lint/plugins/checks/unquoted_file_mode.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# File modes should be quoted strings.
+OpenvoxLint.new_check(:unquoted_file_mode) do
+  def check
+    tokens.each_with_index do |tok, i|
+      next unless tok.type == :NAME && tok.value == 'mode'
+      arrow = next_non_ws(i + 1)
+      next unless arrow && arrow.type == :FARROW
+      val = next_non_ws(tokens.index(arrow) + 1)
+      next unless val && val.type == :NUMBER
+      notify :warning,
+        message: 'unquoted file mode',
+        line: val.line, column: val.column
+    end
+  end
+
+  private
+
+  def next_non_ws(start)
+    (start...tokens.length).each { |j| return tokens[j] unless tokens[j].formatting? }
+    nil
+  end
+end

data/lib/openvox-lint/plugins/checks/unquoted_resource_title.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Resource titles should be quoted.
+OpenvoxLint.new_check(:unquoted_resource_title) do
+  def check
+    title_tokens.each do |tok|
+      next unless tok.type == :NAME
+      notify :warning,
+        message: "unquoted resource title '#{tok.value}'",
+        line: tok.line, column: tok.column
+    end
+  end
+end

data/lib/openvox-lint/plugins/checks/variable_contains_dash.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Variable names should not contain dashes.
+OpenvoxLint.new_check(:variable_contains_dash) do
+  def check
+    tokens.each do |tok|
+      next unless tok.type == :VARIABLE
+      next unless tok.value.include?('-')
+      notify :warning,
+        message: "variable '#{tok.value}' contains a dash",
+        line: tok.line,
+        column: tok.column
+    end
+  end
+end

data/lib/openvox-lint/plugins/checks/variable_is_lowercase.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# All variable names must be lowercase.
+OpenvoxLint.new_check(:variable_is_lowercase) do
+  def check
+    tokens.each do |tok|
+      next unless tok.type == :VARIABLE
+      name = tok.value.sub(/^\$/, '')
+      next if name =~ /\A[a-z_][a-z0-9_:]*\z/ || name.empty?
+      notify :warning,
+        message: "variable '#{tok.value}' contains uppercase characters",
+        line: tok.line,
+        column: tok.column
+    end
+  end
+end

data/lib/openvox-lint/plugins/checks/variables_not_enclosed.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Variables in double-quoted strings should be enclosed in braces.
+# e.g. "$foo" should be "${foo}"
+OpenvoxLint.new_check(:variables_not_enclosed) do
+  def check
+    tokens.each do |tok|
+      next unless tok.type == :DQSTRING || tok.type == :STRING
+      val = tok.value
+      # Look for $var not followed by { inside double-quoted strings
+      next unless val =~ /\$([a-zA-Z_][a-zA-Z0-9_:]*)/
+      next if val =~ /\$\{/  # already enclosed
+      notify :warning,
+        message: 'variable not enclosed in braces within string',
+        line: tok.line,
+        column: tok.column
+    end
+  end
+end

data/lib/openvox-lint/report.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module OpenvoxLint
+  # Formats and outputs lint problems in the requested format.
+  class Report
+    SEVERITIES = { warning: 'WARNING', error: 'ERROR' }.freeze
+
+    def initialize(configuration)
+      @config = configuration
+    end
+
+    def format(problems, io: $stdout)
+      case @config.log_format
+      when 'json'        then format_json(problems, io)
+      when 'csv'         then format_csv(problems, io)
+      when 'github'      then format_github(problems, io)
+      when 'codeclimate' then format_codeclimate(problems, io)
+      when 'custom'      then format_custom(problems, io)
+      else                    format_text(problems, io)
+      end
+    end
+
+    private
+
+    def format_text(problems, io)
+      problems.each do |p|
+        severity = SEVERITIES[p[:kind]] || p[:kind].to_s.upcase
+        parts = []
+        parts << p[:path] if @config.with_filename
+        parts << p[:line].to_s
+        parts << p[:column].to_s if @config.column && p[:column]
+        io.puts "#{parts.join(':')}: #{severity}: #{p[:check]}: #{p[:message]}"
+      end
+    end
+
+    def format_json(problems, io)
+      io.puts JSON.pretty_generate(problems.map { |p| serialise(p) })
+    end
+
+    def format_csv(problems, io)
+      io.puts 'path,line,column,kind,check,message'
+      problems.each do |p|
+        io.puts [p[:path], p[:line], p[:column], p[:kind], p[:check],
+                 %("#{p[:message]}")].join(',')
+      end
+    end
+
+    def format_github(problems, io)
+      problems.each do |p|
+        kind = p[:kind] == :error ? 'error' : 'warning'
+        io.puts "::#{kind} file=#{p[:path]},line=#{p[:line]},col=#{p[:column]}::#{p[:check]}: #{p[:message]}"
+      end
+    end
+
+    def format_codeclimate(problems, io)
+      issues = problems.map do |p|
+        {
+          type: 'issue', check_name: p[:check].to_s,
+          description: p[:message], categories: ['Style'],
+          severity: p[:kind] == :error ? 'major' : 'minor',
+          location: { path: p[:path], lines: { begin: p[:line], end: p[:line] } },
+        }
+      end
+      io.puts JSON.pretty_generate(issues)
+    end
+
+    def format_custom(problems, io)
+      fmt = @config.custom_log_format
+      problems.each do |p|
+        line = fmt.dup
+        { '%{path}' => p[:path], '%{line}' => p[:line], '%{column}' => p[:column],
+          '%{KIND}' => SEVERITIES[p[:kind]] || p[:kind].to_s.upcase,
+          '%{kind}' => p[:kind], '%{check}' => p[:check],
+          '%{message}' => p[:message] }.each { |k, v| line.gsub!(k, v.to_s) }
+        io.puts line
+      end
+    end
+
+    def serialise(p)
+      { path: p[:path], line: p[:line], column: p[:column],
+        kind: p[:kind].to_s, check: p[:check].to_s, message: p[:message] }
+    end
+  end
+end

data/lib/openvox-lint/token.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OpenvoxLint
+  # Represents a single token produced by the lexer.
+  #
+  # Each token has a type (Symbol), a raw value (String), and positional
+  # metadata (line, column).  Tokens are linked together in a doubly-linked
+  # list via +prev_token+ / +next_token+ so that check plugins can easily
+  # navigate the stream.
+  class Token
+    attr_accessor :type, :value, :line, :column,
+                  :prev_token, :next_token
+
+    def initialize(type, value, line, column)
+      @type   = type
+      @value  = value
+      @line   = line
+      @column = column
+    end
+
+    def to_s
+      "#{type}(#{value.inspect}) @ #{line}:#{column}"
+    end
+
+    def inspect
+      "#<OpenvoxLint::Token #{self}>"
+    end
+
+    # Convenience: is this token a formatting/whitespace token?
+    def formatting?
+      FORMATTING_TYPES.include?(type)
+    end
+
+    FORMATTING_TYPES = %i[
+      WHITESPACE INDENT NEWLINE COMMENT MLCOMMENT SLASH_COMMENT
+    ].freeze
+  end
+end

data/lib/openvox-lint/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OpenvoxLint
+  VERSION = '1.0.0'
+end

data/lib/openvox-lint.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative 'openvox-lint/version'
+require_relative 'openvox-lint/configuration'
+require_relative 'openvox-lint/token'
+require_relative 'openvox-lint/lexer'
+require_relative 'openvox-lint/check_plugin'
+require_relative 'openvox-lint/checks'
+require_relative 'openvox-lint/report'
+require_relative 'openvox-lint/linter'
+require_relative 'openvox-lint/cli'
+
+# OpenvoxLint – a style-guide linter for OpenVox / Puppet manifests.
+#
+# Compatible with:
+#   - OpenVox 8.x (community fork of Puppet)
+#   - Puppet 8.x
+#   - Legacy Puppet 7.x manifests (with deprecation warnings)
+module OpenvoxLint
+  class Error < StandardError; end
+  class NoFix < StandardError; end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def checks
+      @checks ||= {}
+    end
+
+    def new_check(name, &block)
+      klass = Class.new(CheckPlugin, &block)
+      klass.instance_variable_set(:@check_name, name)
+      checks[name] = klass
+    end
+  end
+end
+
+# Auto-load every built-in check plugin.
+Dir[File.join(__dir__, 'openvox-lint', 'plugins', 'checks', '*.rb')].sort.each do |f|
+  require f
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: openvox-lint
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Johnny Sheets
+bindir: bin
+cert_chain: []
+date: 2026-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+description: |
+  openvox-lint is a linter for OpenVox and Puppet manifests. It checks your
+  code against the Puppet style guide and catches common errors including
+  deprecated patterns, legacy facts, strict mode violations, and Puppet 8+
+  language issues. Fully compatible with OpenVox 8.x and Puppet 8.x.
+email:
+- jsheets@xai.com
+executables:
+- openvox-lint
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- DOCUMENTATION.md
+- LICENSE
+- README.md
+- bin/openvox-lint
+- lib/openvox-lint.rb
+- lib/openvox-lint/check_plugin.rb
+- lib/openvox-lint/checks.rb
+- lib/openvox-lint/cli.rb
+- lib/openvox-lint/configuration.rb
+- lib/openvox-lint/lexer.rb
+- lib/openvox-lint/linter.rb
+- lib/openvox-lint/plugins/checks/arrow_alignment.rb
+- lib/openvox-lint/plugins/checks/autoloader_layout.rb
+- lib/openvox-lint/plugins/checks/case_without_default.rb
+- lib/openvox-lint/plugins/checks/class_inherits_params.rb
+- lib/openvox-lint/plugins/checks/documentation.rb
+- lib/openvox-lint/plugins/checks/double_quoted_strings.rb
+- lib/openvox-lint/plugins/checks/duplicate_params.rb
+- lib/openvox-lint/plugins/checks/ensure_first_param.rb
+- lib/openvox-lint/plugins/checks/ensure_not_symlink_target.rb
+- lib/openvox-lint/plugins/checks/file_mode.rb
+- lib/openvox-lint/plugins/checks/hard_tabs.rb
+- lib/openvox-lint/plugins/checks/hiera3_function.rb
+- lib/openvox-lint/plugins/checks/import_statement.rb
+- lib/openvox-lint/plugins/checks/inherits_across_namespaces.rb
+- lib/openvox-lint/plugins/checks/leading_zero.rb
+- lib/openvox-lint/plugins/checks/legacy_facts.rb
+- lib/openvox-lint/plugins/checks/line_length.rb
+- lib/openvox-lint/plugins/checks/nested_classes_or_defines.rb
+- lib/openvox-lint/plugins/checks/node_name_unquoted.rb
+- lib/openvox-lint/plugins/checks/only_variable_string.rb
+- lib/openvox-lint/plugins/checks/parameter_order.rb
+- lib/openvox-lint/plugins/checks/puppet_url_without_modules.rb
+- lib/openvox-lint/plugins/checks/quoted_booleans.rb
+- lib/openvox-lint/plugins/checks/relative_classname_inclusion.rb
+- lib/openvox-lint/plugins/checks/resource_reference_without_title_capital.rb
+- lib/openvox-lint/plugins/checks/selector_inside_resource.rb
+- lib/openvox-lint/plugins/checks/single_quote_string_with_variables.rb
+- lib/openvox-lint/plugins/checks/space_before_arrow.rb
+- lib/openvox-lint/plugins/checks/star_comments.rb
+- lib/openvox-lint/plugins/checks/strict_indent.rb
+- lib/openvox-lint/plugins/checks/top_scope_facts.rb
+- lib/openvox-lint/plugins/checks/trailing_comma.rb
+- lib/openvox-lint/plugins/checks/trailing_whitespace.rb
+- lib/openvox-lint/plugins/checks/unquoted_file_mode.rb
+- lib/openvox-lint/plugins/checks/unquoted_resource_title.rb
+- lib/openvox-lint/plugins/checks/variable_contains_dash.rb
+- lib/openvox-lint/plugins/checks/variable_is_lowercase.rb
+- lib/openvox-lint/plugins/checks/variables_not_enclosed.rb
+- lib/openvox-lint/report.rb
+- lib/openvox-lint/token.rb
+- lib/openvox-lint/version.rb
+homepage: https://github.com/cvquesty/openvox-lint
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/cvquesty/openvox-lint
+  source_code_uri: https://github.com/cvquesty/openvox-lint
+  bug_tracker_uri: https://github.com/cvquesty/openvox-lint/issues
+  changelog_uri: https://github.com/cvquesty/openvox-lint/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: Check OpenVox/Puppet manifests against the style guide
+test_files: []