scelint 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a057d6c2d1fea9e9d5ff8cc067236685a6c5fa1458091535c8b64e7e7faddf1
-  data.tar.gz: c520052501d0af91fd1b031cdf41e6c8e1185b4475d4b51385d2c45cc326a12f
+  metadata.gz: cbcb49e907f0804f22a550c9507f56a6849ba26f2ba67f1893df0d41a289ea43
+  data.tar.gz: f4c83fa4d9e8cea6dec15625475904e7cf84f05b69de57657ad2a06b70fff5eb
 SHA512:
-  metadata.gz: e9ff311ea144f952f84f3215bfec4833370216e4fb89b10fcf03a1577b391e55ea66d75f6ca887c86214ad09a7b0a9f91c3237c9e1645af13f1a359cd069ed10
-  data.tar.gz: 575be45fdf396183fe5dee7e19d6b990b21f8a17e55f7f8620a7441945a82796ce159fe2986f7d5a01a62f3865e8a191383b7c7f7a49a664d7ef00e363af9d92
+  metadata.gz: 2661057050cc3819c58818bb726a429d5e47260c2505bd08c6a084c494b24b0a359bc8a2cfa7618ef8012f71899e54ce8ef0dbb5c68d02ad74958de16edde55a
+  data.tar.gz: e2362ae54fc4107861bd76244699386489b50efefebf09211bb38b7ff44d7fd7dc4ef3df4a77a49ce25a34cecd10e4598862a841bd7a322ef408008b02ee6643

data/.github/workflows/pr_tests.yml

@@ -17,7 +17,7 @@ jobs:
       - name: "Install Ruby"
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 4.0.0
+          ruby-version: 4.0.1
           bundler-cache: true
       - run: bundle exec rake rubocop
 

data/.github/workflows/tag_deploy_rubygem.yml

@@ -92,7 +92,7 @@ jobs:
           echo "release_command=$GEM_RELEASE_COMMAND" | tee -a "$GITHUB_OUTPUT"
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 4.0.0
+          ruby-version: 4.0.1
           bundler-cache: true
       - name: Test build the package
         run: "${{ steps.commands.outputs.build_command }}"
@@ -187,7 +187,7 @@ jobs:
           clean: true
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 4.0.0
+          ruby-version: 4.0.1
           bundler-cache: true
       - name: Build RubyGem
         run: |

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 0.6.0 / 2026-03-11
+* Add `.scelint` defaults file support (rspec-style CLI argument defaults)
+* Add `--allow-reserved-words` option to skip reserved word checks on parameter names
+
+### 0.5.0 / 2026-03-11
+* Validate parameter names
+* Fix command-line argument processing
+
 ### 0.4.1 / 2026-01-26
 * Support compliance_engine 0.2.x
 * Test with Ruby 4.0

data/Gemfile

@@ -7,7 +7,7 @@ gem 'rake', '~> 13.3.0'
 
 group :tests do
   gem 'rspec', '~> 3.13.1'
-  gem 'rubocop', '~> 1.81.0'
+  gem 'rubocop', '~> 1.85.0'
   gem 'rubocop-performance', '~> 1.26.0'
   gem 'rubocop-rake', '~> 0.7.1'
   gem 'rubocop-rspec', '~> 3.9.0'
@@ -16,5 +16,5 @@ end
 group :development do
   gem 'pry', '~> 0.16.0'
   gem 'pry-byebug', '~> 3.12.0'
-  gem 'rdoc', '~> 7.1.0'
+  gem 'rdoc', '~> 7.2.0'
 end

data/exe/scelint

@@ -3,4 +3,4 @@
 
 require 'scelint/cli'
 
-Scelint::CLI.start(['lint'] + ARGV)
+Scelint::CLI.start

data/lib/scelint/cli.rb

@@ -6,15 +6,41 @@ require 'logger'
 
 # SCELint CLI
 class Scelint::CLI < Thor
+  def self.exit_on_failure?
+    true
+  end
+
+  DEFAULTS_FILE = '.scelint'
+
+  # Load default arguments from .scelint in the current directory.
+  # Each non-blank, non-comment line may contain one or more arguments.
+  def self.load_defaults
+    return [] unless File.exist?(DEFAULTS_FILE)
+    File.readlines(DEFAULTS_FILE, chomp: true)
+        .reject { |line| line.strip.empty? || line.strip.start_with?('#') }
+        .flat_map(&:split)
+  end
+
+  # When the first argument is not a known subcommand or an option flag,
+  # treat all arguments as paths for the default `lint` command.
+  def self.start(given_args = ARGV, config = {})
+    args = load_defaults + given_args
+    if args.first && !args.first.start_with?('-') && !all_commands.key?(args.first)
+      args = ['lint'] + args
+    end
+    super(args, config)
+  end
+
   class_option :quiet, type: :boolean, aliases: '-q', default: false
   class_option :verbose, type: :boolean, aliases: '-v', default: false
   class_option :debug, type: :boolean, aliases: '-d', default: false
 
   desc 'lint PATH', 'Lint all files in PATH'
   option :strict, type: :boolean, aliases: '-s', default: false
+  option :allow_reserved_words, type: :boolean, default: false
   def lint(*paths)
     paths = ['.'] if paths.nil? || paths.empty?
-    lint = Scelint::Lint.new(paths, logger: logger)
+    lint = Scelint::Lint.new(paths, logger: logger, allow_reserved_words: options[:allow_reserved_words])
 
     count = lint.files.count
 

data/lib/scelint/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Scelint
-  VERSION = '0.4.1'
+  VERSION = '0.6.0'
 end

data/lib/scelint.rb

@@ -134,8 +134,9 @@ module Scelint
     #
     # @param paths [Array<String>] Paths to look for SCE data in. Defaults to ['.']
     # @param logger [Logger] A logger to send messages to. Defaults to an instance of Logger with the log level set to INFO.
-    def initialize(paths = ['.'], logger: Logger.new(STDOUT, level: Logger::INFO))
+    def initialize(paths = ['.'], logger: Logger.new(STDOUT, level: Logger::INFO), allow_reserved_words: false)
       @log = logger
+      @allow_reserved_words = allow_reserved_words
       @errors = []
       @warnings = []
       @notes = []
@@ -396,7 +397,35 @@ module Scelint
     # @param check [String] The name of the check
     # @param parameter [String] The parameter to validate
     def check_parameter(file, check, parameter)
-      errors << "#{file} (check '#{check}'): invalid parameter '#{parameter}'" unless parameter.is_a?(String) && !parameter.empty?
+      # Regular expression to match valid Puppet class parameter names
+      valid_parameter = %r{\A([a-z][a-z0-9_]*::)+[a-z][a-z0-9_]*\z}
+      # From https://www.puppet.com/docs/puppet/7/lang_reserved.html
+      reserved_words = ['and', 'application', 'attr', 'case', 'component', 'consumes', 'default', 'define', 'elsif',
+                        'environment', 'false', 'function', 'if', 'import', 'in', 'inherits', 'node',
+                        'or', 'private', 'produces', 'regexp', 'site', 'true', 'type', 'undef', 'unit', 'unless',
+                        'main', 'settings', 'init', 'any', 'array', 'binary', 'boolean', 'catalogentry', 'class',
+                        'collection', 'callable', 'data', 'default', 'deferred', 'enum', 'float', 'hash', 'integer',
+                        'notundef', 'numeric', 'optional', 'pattern', 'resource', 'regexp', 'runtime', 'scalar',
+                        'semver', 'semVerRange', 'sensitive', 'string', 'struct', 'timespan', 'timestamp', 'tuple',
+                        'type', 'undef', 'variant', 'facts', 'trusted', 'server_facts', 'title', 'name'].freeze
+
+      unless parameter.is_a?(String) && !parameter.empty?
+        errors << "#{file} (check '#{check}'): invalid parameter '#{parameter}'"
+        return
+      end
+
+      unless parameter.match?(valid_parameter)
+        errors << "#{file} (check '#{check}'): invalid parameter name '#{parameter}'"
+        return
+      end
+
+      return if @allow_reserved_words
+
+      parameter.split('::').each do |part|
+        if reserved_words.include?(part)
+          errors << "#{file} (check '#{check}'): parameter name '#{parameter}' contains reserved word '#{part}'"
+        end
+      end
     end
 
     # Check remediation

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scelint
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Steven Pritchard