Fix Style/FrozenStringLiteralComment Rubocop offenseseread/fix-frozen-string-literal-comment-rubocop-offenses

31 files changed, 61 insertions, 0 deletions

diff --git a/Gemfile b/Gemfile
index 6cd57916..f0d34195 100644
--- a/Gemfile
+++ b/Gemfile
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gem 'nanoc', '~> 4.12.0'
diff --git a/Rakefile b/Rakefile
index 39c8dbaf..ec93f2c6 100644
--- a/Rakefile
+++ b/Rakefile
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require './lib/task_helpers'
 require 'fileutils'
 require 'pathname'
diff --git a/commands/frontend.rb b/commands/frontend.rb
index fd691f97..0a174d4a 100644
--- a/commands/frontend.rb
+++ b/commands/frontend.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 usage       'frontend [options]'
 aliases     :ds, :stuff
 summary     'uses nanoc cli to execute frontend related tasks'
diff --git a/lib/checks/anchors.rb b/lib/checks/anchors.rb
index 3c775f4f..f7dc5d52 100644
--- a/lib/checks/anchors.rb
+++ b/lib/checks/anchors.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Nanoc::Check.define(:internal_anchors) do
   output_html_filenames.each do |file|
     Gitlab::Docs::Page.new(file).links.each do |link|
diff --git a/lib/filters/admonition.rb b/lib/filters/admonition.rb
index 675fc37a..41c6de40 100644
--- a/lib/filters/admonition.rb
+++ b/lib/filters/admonition.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+#
 # Adapted from the admonition code on http://nanoc.ws/
 class AdmonitionFilter < Nanoc::Filter
   identifier :admonition
diff --git a/lib/filters/icons.rb b/lib/filters/icons.rb
index 7e7df019..39daadcc 100644
--- a/lib/filters/icons.rb
+++ b/lib/filters/icons.rb
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # This allows us to add icons to our documentation using standard Markdown
 #
diff --git a/lib/filters/introduced_in.rb b/lib/filters/introduced_in.rb
index 5108d122..57fca380 100644
--- a/lib/filters/introduced_in.rb
+++ b/lib/filters/introduced_in.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+#
 # Adapted from the admonition code on http://nanoc.ws/
 class IntroducedInFilter < Nanoc::Filter
   identifier :introduced_in
diff --git a/lib/filters/markdown_to_html_ext.rb b/lib/filters/markdown_to_html_ext.rb
index b90dca04..9ab372ba 100644
--- a/lib/filters/markdown_to_html_ext.rb
+++ b/lib/filters/markdown_to_html_ext.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nanoc::Filters
   class MarkdownToHtmlExt < Nanoc::Filter
     identifier :md_to_html_ext
diff --git a/lib/gitlab/docs/document.rb b/lib/gitlab/docs/document.rb
index d4e486b2..efc055ed 100644
--- a/lib/gitlab/docs/document.rb
+++ b/lib/gitlab/docs/document.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Docs
     class Document < Nokogiri::XML::SAX::Document
diff --git a/lib/gitlab/docs/element.rb b/lib/gitlab/docs/element.rb
index 4d58edee..aea7ce76 100644
--- a/lib/gitlab/docs/element.rb
+++ b/lib/gitlab/docs/element.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cgi'
 
 module Gitlab
diff --git a/lib/gitlab/docs/link.rb b/lib/gitlab/docs/link.rb
index 7bc9416f..c35b61b9 100644
--- a/lib/gitlab/docs/link.rb
+++ b/lib/gitlab/docs/link.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Docs
     class Link
diff --git a/lib/gitlab/docs/nanoc.rb b/lib/gitlab/docs/nanoc.rb
index dbda9d40..2ab2e67c 100644
--- a/lib/gitlab/docs/nanoc.rb
+++ b/lib/gitlab/docs/nanoc.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Docs
     module Nanoc
diff --git a/lib/gitlab/docs/page.rb b/lib/gitlab/docs/page.rb
index 55df51e3..aa49d621 100644
--- a/lib/gitlab/docs/page.rb
+++ b/lib/gitlab/docs/page.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Docs
     class Page
diff --git a/lib/gitlab/navigation.rb b/lib/gitlab/navigation.rb
index 9ce79662..87248c04 100644
--- a/lib/gitlab/navigation.rb
+++ b/lib/gitlab/navigation.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../helpers/generic'
 require_relative '../helpers/icons_helper'
 
diff --git a/lib/gitlab/navigation/category.rb b/lib/gitlab/navigation/category.rb
index 75f401fa..81cbf74b 100644
--- a/lib/gitlab/navigation/category.rb
+++ b/lib/gitlab/navigation/category.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class Navigation
     class Category
diff --git a/lib/gitlab/navigation/doc.rb b/lib/gitlab/navigation/doc.rb
index cdb3540c..97aa6775 100644
--- a/lib/gitlab/navigation/doc.rb
+++ b/lib/gitlab/navigation/doc.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class Navigation
     class Doc
diff --git a/lib/gitlab/navigation/section.rb b/lib/gitlab/navigation/section.rb
index 82b19d3e..40ae04a7 100644
--- a/lib/gitlab/navigation/section.rb
+++ b/lib/gitlab/navigation/section.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class Navigation
     class Section
diff --git a/lib/gitlab/symlinks_converter.rb b/lib/gitlab/symlinks_converter.rb
index 6444cc5b..ade5f0f4 100644
--- a/lib/gitlab/symlinks_converter.rb
+++ b/lib/gitlab/symlinks_converter.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class SymlinksConverter
     EXTENSIONS = %w[png jpg gif svg].freeze
diff --git a/lib/helpers/child_parent_better.rb b/lib/helpers/child_parent_better.rb
index f4a647f3..ec34e65d 100644
--- a/lib/helpers/child_parent_better.rb
+++ b/lib/helpers/child_parent_better.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nanoc::Helpers
   module ChildParentBetter
     # Returns an array of ancestor pages for the given page.
diff --git a/lib/helpers/edit_on_gitlab.rb b/lib/helpers/edit_on_gitlab.rb
index 659f207e..7188cd1e 100644
--- a/lib/helpers/edit_on_gitlab.rb
+++ b/lib/helpers/edit_on_gitlab.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nanoc::Helpers
   module EditOnGitLab
     def edit_on_gitlab(item, editor: :simple)
diff --git a/lib/helpers/gitlab_kramdown.rb b/lib/helpers/gitlab_kramdown.rb
index f9235581..c409a579 100644
--- a/lib/helpers/gitlab_kramdown.rb
+++ b/lib/helpers/gitlab_kramdown.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nanoc::Helpers
   module GitLabKramdown
     require 'kramdown'
diff --git a/lib/helpers_.rb b/lib/helpers_.rb
index 99849b77..9d0c42ea 100644
--- a/lib/helpers_.rb
+++ b/lib/helpers_.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 include Nanoc::Helpers::LinkTo
 include Nanoc::Helpers::XMLSitemap
 include Nanoc::Helpers::Rendering
diff --git a/lib/task_helpers.rb b/lib/task_helpers.rb
index 32a1559f..fc7eb5d5 100644
--- a/lib/task_helpers.rb
+++ b/lib/task_helpers.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 PRODUCTS = %w[ee omnibus runner charts operator].freeze
diff --git a/spec/gitlab/content_spec.rb b/spec/gitlab/content_spec.rb
index e83280e5..4f50b43b 100644
--- a/spec/gitlab/content_spec.rb
+++ b/spec/gitlab/content_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 # See: https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/4726#note_459473659
diff --git a/spec/gitlab/docs/link_spec.rb b/spec/gitlab/docs/link_spec.rb
index 1cd9790d..acd7e2eb 100644
--- a/spec/gitlab/docs/link_spec.rb
+++ b/spec/gitlab/docs/link_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 require 'nokogiri'
diff --git a/spec/gitlab/docs/page_spec.rb b/spec/gitlab/docs/page_spec.rb
index 948f6310..84cf581c 100644
--- a/spec/gitlab/docs/page_spec.rb
+++ b/spec/gitlab/docs/page_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 require 'nokogiri'
diff --git a/spec/gitlab/navigation/category_spec.rb b/spec/gitlab/navigation/category_spec.rb
index 63421946..f0424171 100644
--- a/spec/gitlab/navigation/category_spec.rb
+++ b/spec/gitlab/navigation/category_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'gitlab/navigation/category'
 require 'gitlab/navigation/doc'
diff --git a/spec/gitlab/navigation/doc_spec.rb b/spec/gitlab/navigation/doc_spec.rb
index 32198ec2..600edb44 100644
--- a/spec/gitlab/navigation/doc_spec.rb
+++ b/spec/gitlab/navigation/doc_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'gitlab/navigation/doc'
 
diff --git a/spec/gitlab/navigation/section_spec.rb b/spec/gitlab/navigation/section_spec.rb
index 306e4bdd..f71f60f2 100644
--- a/spec/gitlab/navigation/section_spec.rb
+++ b/spec/gitlab/navigation/section_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'gitlab/navigation/section'
 require 'gitlab/navigation/category'
diff --git a/spec/gitlab/navigation_spec.rb b/spec/gitlab/navigation_spec.rb
index 68ac6a3d..892d4486 100644
--- a/spec/gitlab/navigation_spec.rb
+++ b/spec/gitlab/navigation_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'nanoc'
 require 'gitlab/navigation'
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
index 768e37cc..8b1219de 100644
--- a/spec/spec_helper.rb
+++ b/spec/spec_helper.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH << 'lib/'
 
 RSpec.configure do |config|