Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ jobs:
bundler-cache: true
- name: Display Ruby environment
run: bundle env
- name: Run rake rubocop
run: bundle exec rake rubocop
- name: Validate code
run: bundle exec rake generate
env:
Expand Down
20 changes: 20 additions & 0 deletions .rubocop.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
inherit_from: .rubocop_todo.yml
inherit_gem:
voxpupuli-rubocop: rubocop.yml

# Exclude externalsources also
AllCops:
Exclude:
- vendor/**/*
- .vendor/**/*
- spec/fixtures/**/*
- externalsources/**/*
- output/**/*

Style/StringConcatenation:
Details: See https://github.com/rubocop/rubocop/issues/9144
Mode: conservative

Style/MultilineBlockChain:
Enabled: false
49 changes: 49 additions & 0 deletions .rubocop_todo.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# This configuration was generated by
# `rubocop --auto-gen-config`
# on 2026-02-11 01:56:56 UTC using RuboCop version 1.81.7.
# The point is for the user to remove these configuration records
# one by one as the offenses are removed from the code base.
# Note that changes in the inspected code, or installation of new
# versions of RuboCop, may require this file to be generated again.

# Offense count: 1
# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches, IgnoreDuplicateElseBranch.
Lint/DuplicateBranch:
Exclude:
- 'source/_plugins/check_links_hook.rb'

# Offense count: 1
Lint/MixedRegexpCaptureTypes:
Exclude:
- 'source/_plugins/partial.rb'

# Offense count: 5
Naming/AccessorMethodName:
Exclude:
- 'lib/puppet_references/puppet/man.rb'
- 'lib/puppet_references/puppet/type.rb'
- 'lib/puppet_references/puppet/type_strings.rb'
- 'lib/puppet_references/version_tables/data/agent.rb'

# Offense count: 11
# This cop supports safe autocorrection (--autocorrect).
Rake/Desc:
Exclude:
- 'Rakefile'

# Offense count: 43
# Configuration parameters: AllowedConstants.
Style/Documentation:
Enabled: false

# Offense count: 1
Style/MixinUsage:
Exclude:
- 'lib/puppet_references/quarantine/get_typedocs.rb'

# Offense count: 42
# This cop supports safe autocorrection (--autocorrect).
# Configuration parameters: AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
# URISchemes: http, https
Layout/LineLength:
Max: 433
31 changes: 18 additions & 13 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,35 +1,40 @@
# frozen_string_literal: true

source 'https://rubygems.org/'
gemspec :name => 'puppet_docs'
gemspec name: 'puppet_docs'

gem 'versionomy', '~> 0.5.0'
gem 'rake', '~> 13.0', '>= 13.0.1'
gem 'rack', '>= 2.2.14'
gem 'git', '~> 4.0'
gem 'json', '~> 2.5'
gem 'rack', '>= 2.2.14'
gem 'rake', '~> 13.0', '>= 13.0.1'
gem 'versionomy', '~> 0.5.0'

group(:build_site) do
gem 'jekyll', '~> 4.1'
gem 'kramdown', '~> 2.3'
gem 'vlad', '~> 2.7'
gem 'vlad-git', '~> 2.1'
gem 'listen', '~> 3.10.0' # Preserve ability to run on Ruby 2.0, since listen 3.1 requires Ruby ~> 2.2.
end

group(:generate_references) do
gem 'yard', '~> 0.9'
gem 'rdoc', '~> 7.1'
gem 'rgen', '~> 0.8'
gem 'pandoc-ruby'
gem 'openvox-strings'
gem 'openvox', '~> 8'
gem 'nokogiri', '>= 1.18.9'
gem 'openvox', '~> 8'
gem 'openvox-strings'
gem 'pandoc-ruby'
gem 'pragmatic_segmenter', '~> 0.3'
gem 'punkt-segmenter', '~> 0.9'
gem 'rdoc', '~> 7.1'
gem 'rgen', '~> 0.8'
gem 'yard', '~> 0.9'
end

group(:unknown) do
gem 'maruku', '~> 0.7'
gem 'activerecord', '>= 7.1.5.2'
gem 'maruku', '~> 0.7'
end

group(:development) do
gem 'rubocop-rake', require: false
gem 'voxpupuli-rubocop', '~> 5.1.0'
end

# group(:debug) do
Expand Down
Loading