docopslab-dev 0.1.0

data/assets/config-packs/actionlint/base.yml

@@ -0,0 +1,13 @@
+# actionlint configuration for DocOps Lab projects
+# This file is synced from docopslab-dev gem
+
+# Disable overly strict rules for common patterns
+ignore:
+  # Allow commonly used but deprecated actions (we'll upgrade gradually)  
+  - 'SC2086:'  # shellcheck rule about double quotes
+  - 'the runner of "ubuntu-latest" is deprecated'
+  
+# Custom shell for shellcheck integration
+shellcheck:
+  enable: true
+  shell-options: "-e SC2086"  # Allow some globbing patterns

data/assets/config-packs/actionlint/project.yml

@@ -0,0 +1,13 @@
+# actionlint configuration for this project
+# References DocOps Lab base configuration
+
+# Project-specific ignores (add as needed):
+ignore:
+  # Example: Ignore specific workflow patterns
+  # - 'workflow "deploy.yml"'
+  # - '"ubuntu-20.04" is deprecated'
+  
+# Project-specific overrides:
+shellcheck:
+  enable: true
+  # shell-options: "-e SC2016"  # Add project-specific ShellCheck exclusions

data/assets/config-packs/htmlproofer/base.yml

@@ -0,0 +1,27 @@
+---
+# DocOps Lab HTML-Proofer Base Configuration
+# This provides sensible defaults for DocOps Lab projects
+
+# URL checking options
+check_external_hash: false    # Skip checking external URL fragments (can be slow)
+check_img_http: false         # Allow HTTP images for now
+enforce_https: false          # Don't enforce HTTPS for all links
+
+# URLs to ignore (patterns and strings)
+ignore_urls:
+  - /localhost/               # Skip local development URLs
+  - /127\.0\.0\.1/           # Skip local IPs  
+  - /example\.com/           # Skip example URLs
+  - /foo\.bar/               # Skip placeholder URLs
+  - /fonts.googleapis.com/   # Skip Google Fonts
+  - /fonts.gstatic.com/      # Skip Google Fonts static
+
+# Files to ignore (patterns)
+ignore_files:
+  - slides/                  # Skip slides directories
+
+# Other options
+check_favicon: false         # Don't require favicon
+check_html: true            # Check HTML structure
+check_opengraph: false      # Skip OpenGraph validation
+disable_external: false     # Check external links (can be disabled for speed)

data/assets/config-packs/htmlproofer/project.yml

@@ -0,0 +1,25 @@
+# DocOps Lab HTML-Proofer Configuration
+# Combined base and project configuration for consistent HTML validation
+# URL checking options
+check_external_hash: false    # Skip checking external URL fragments (can be slow)
+check_img_http: false         # Allow HTTP images for now
+enforce_https: false          # Don't enforce HTTPS for all links
+check_favicon: false         # Don't require favicon
+check_html: true            # Check HTML structure
+check_opengraph: false      # Skip OpenGraph validation
+disable_external: false     # Check external links (can be disabled for speed)
+
+# URLs to ignore (patterns and strings)
+ignore_urls:
+  - /localhost/               # Skip local development URLs
+  - /127\.0\.0\.1/           # Skip local IPs  
+  - /example\.com/           # Skip example URLs
+  - /foo\.bar/               # Skip placeholder URLs
+  - /fonts\.googleapis\.com/ # Skip Google Fonts
+  - /fonts\.gstatic\.com/    # Skip Google Fonts static
+  # Add project-specific URL ignores below:
+
+# Files to ignore (patterns)
+ignore_files:
+  - slides/                  # Skip slides directories
+  # Add project-specific file ignores below:

data/assets/config-packs/rubocop/base.yml

@@ -0,0 +1,130 @@
+# RuboCop configuration for DocOps Lab projects
+# This is the baseline configuration distributed via docopslab-dev
+
+plugins:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  
+Style/MethodDefParentheses:
+  EnforcedStyle: require_no_parentheses
+
+Style/MethodCallWithArgsParentheses:
+  EnforcedStyle: require_parentheses
+  AllowParenthesesInMultilineCall: true
+  AllowParenthesesInChaining: true
+
+# Allow longer lines for documentation
+Layout/LineLength:
+  Max: 120
+  AllowedPatterns:
+    - '\A\s*#.*\z'   # Comments
+    - '\A\s*\*.*\z'  # Rdoc comments
+
+Metrics/MethodLength:
+  Max: 25
+
+# Allow longer blocks for Rake tasks and RSpec
+Metrics/BlockLength:
+  AllowedMethods:
+    - describe
+    - context
+    - feature
+    - scenario
+    - let
+    - let!
+    - subject
+    - task
+    - namespace
+  Max: 50
+
+# Documentation not required for internal tooling
+Style/Documentation:
+  Enabled: false
+
+# Allow TODO comments
+Style/CommentAnnotation:
+  Keywords:
+    - TODO
+    - FIXME
+    - OPTIMIZE
+    - HACK
+    - REVIEW
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
+Layout/FirstParameterIndentation:
+  EnforcedStyle: consistent
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/MultilineMethodCallBraceLayout:
+  EnforcedStyle: same_line
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: aligned
+
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: true
+
+Layout/TrailingWhitespace:
+  Enabled: true
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: true
+
+Layout/HashAlignment:
+  Enabled: false
+
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+  EnforcedStyle: no_space
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: true
+
+Lint/UselessAssignment:
+  Enabled: true
+
+Lint/IneffectiveAccessModifier:
+  Enabled: true
+
+Security/YAMLLoad:
+  Enabled: false # Projects may intentionally use unsafe YAML loading
+
+Security/Eval:
+  Enabled: true # Catch and replace with safer alternatives
+
+# Disable Naming/PredicateMethod - we use generate_, run_, sync_, etc for actions
+Naming/PredicateMethod:
+  Enabled: false

data/assets/config-packs/rubocop/project.yml

@@ -0,0 +1,8 @@
+# DocOps Lab RuboCop Configuration
+
+inherit_from: .vendor/docopslab/rubocop.yml
+
+# Add project-specific overrides below:
+# AllCops:
+#   Exclude:
+#     - scripts/**

data/assets/config-packs/shellcheck/base.shellcheckrc

@@ -0,0 +1,14 @@
+# ShellCheck configuration for DocOps Lab projects
+# This file is synced from docopslab-dev gem
+
+# Disable some overly strict rules for our use cases
+disable=SC2034 # Variable appears unused (common in sourced scripts)
+disable=SC2086 # Double quote to prevent globbing (sometimes we want globbing)
+disable=SC2181 # Check exit code directly with e.g. 'if mycmd;', not indirectly with $?
+
+# Set default shell to bash (most of our scripts are bash)
+shell=bash
+
+# Enable additional optional checks
+enable=quote-safe-variables
+enable=require-variable-braces

data/assets/config-packs/subtxt/ai-asciidoc-antipatterns.sub.txt

@@ -0,0 +1,11 @@
+^\* \*\*(.+)\*\*:\s
+\1::\n
+
+(^=+\s[\W\w].+)\n([\W\w].*)
+\1\n\n\\2
+
+([^\s])\n\n==\s([\w\w])
+\1\n\n\n== \2
+
+^\* (.*) - (.*)
+\1::\n\2\n

data/assets/config-packs/vale/asciidoc/ExplicitSectionIDs.yml

@@ -0,0 +1,8 @@
+---
+extends: script
+scope: raw
+level: warning
+message: "Section heading must be preceded by an explicit ID in format [[section-id]] on the line above."
+link: https://docs.asciidoctor.org/asciidoc/latest/sections/custom-ids/
+description: "Ensures all section headings have explicit IDs for better cross-referencing and stable links."
+script: ExplicitSectionIDs.tengo

data/assets/config-packs/vale/asciidoc/ExtraLineBeforeLevel1.yml

@@ -0,0 +1,7 @@
+---
+extends: script
+scope: raw
+level: warning
+message: "Level-1 (==) headings must be preceded by two blank lines and an explicit [[section-id]] line."
+description: "Enforces: blank, blank, [[id]], then '== Heading'."
+script: ExtraLineBeforeLevel1.tengo

data/assets/config-packs/vale/asciidoc/OneSentencePerLine.yml

@@ -0,0 +1,8 @@
+---
+extends: script
+scope: raw
+level: warning
+message: "Each sentence should be on its own line for better version control diffs and readability."
+link: https://docs.asciidoctor.org/asciidoc/latest/writing/style/#one-sentence-per-line
+description: "Encourages writing one sentence per line to improve readability and version control diffs."
+script: OneSentencePerLine.tengo

data/assets/config-packs/vale/asciidoc/PreferSourceBlocks.yml

@@ -0,0 +1,8 @@
+---
+extends: existence
+scope: raw
+level: error
+message: "Use '[source,lang]' with '----' delimiters instead of markdown-style code blocks with '```'."
+link: https://docs.asciidoctor.org/asciidoc/latest/verbatim/source-blocks/
+raw:
+  - '```\w*\n[\s\S]*?\n```'

data/assets/config-packs/vale/asciidoc/ProperAdmonitions.yml

@@ -0,0 +1,8 @@
+---
+extends: existence
+scope: raw
+level: error
+message: "Use proper AsciiDoc admonition blocks instead of manual formatting."
+link: https://docs.asciidoctor.org/asciidoc/latest/blocks/admonitions/
+raw:
+  - '^\*\*NOTE:\*\*|^\*\*TIP:\*\*|^\*\*IMPORTANT:\*\*|^\*\*CAUTION:\*\*|^\*\*WARNING:\*\*'

data/assets/config-packs/vale/asciidoc/ProperDLs.yml

@@ -0,0 +1,7 @@
+extends: existence
+message: "Use AsciiDoc definition list syntax (term:: definition) instead of bold/italic text followed by a colon."
+link: https://docs.asciidoctor.org/asciidoc/latest/lists/description/
+level: error
+scope: raw
+raw:
+  - (?m)^(\* )?\*\*?(.+)(:\*\*?|\*\*?:)[\s\n]+(.+)$

data/assets/config-packs/vale/asciidoc/UncleanListStart.yml

@@ -0,0 +1,8 @@
+extends: existence
+message: |
+  Add a blank line before starting a list after a sentence ending in a colon.
+level: warning
+scope: raw
+raw:
+  - '(?m)^.*(?<!:):[ \t]*$(?=\n[\*\.]\s)'
+link: "Tip: run sed -E '/^[^:]+:[^:]*$/ { N; s/:\n([*.])/:\\n\\1/ }' -i yourfile.adoc"

data/assets/config-packs/vale/authoring/ButParagraph.yml

@@ -0,0 +1,8 @@
+extends: existence
+message: "Do not start a paragraph with a 'but'."
+level: error
+scope: paragraph
+action:
+  name: remove
+tokens:
+  - '\n\nBut '

data/assets/config-packs/vale/authoring/ExNotEg.yml

@@ -0,0 +1,8 @@
+# style for replacing /\se\.g\.,?\s/ with `ex: `
+extends: substitution
+scope: text
+level: error
+message: "Use 'ex: ' instead of 'e.g., '."
+link: https://developers.google.com/style/word-list#e.g
+swap:
+  '([Ee])\.g\.,?\s': '\1x: '

data/assets/config-packs/vale/authoring/LiteralTerms.yml

@@ -0,0 +1,20 @@
+---
+extends: substitution
+scope: text
+level: suggestion 
+message: "Consider using monospace formatting for '%s'."
+link: https://docs.asciidoctor.org/asciidoc/latest/text/monospace/
+# Technical terms that should typically be in monospace
+swap:
+  '(?i)\bREADME\b': '`README.adoc`'
+  '(?i)\bGemfile\b': '`Gemfile`'
+  '(?i)\bRakefile\b': '`Rakefile`'
+  '(?i)\bDockerfile\b': '`Dockerfile`'
+  '(?i)\b\.env\b': '`.env`'
+  '(?i)\b\.gitignore\b': '`.gitignore`'
+  '(?i)\b\.yml\b': '`.yml`'
+  '(?i)\b\.yaml\b': '`.yaml`'
+  '(?i)\b\.json\b': '`.json`'
+  '(?i)\b\.rb\b': '`.rb`'
+  '(?i)\b\.md\b': '`.md`'
+  '(?i)\b\.adoc\b': '`.adoc`'