Merge pull request #133 from alphagov/deprecation-notice

Add deprecation notice to repository and CLI

CHANGELOG.md

@@ -1,3 +1,8 @@
+# 4.3.0
+
+* Deprecate govuk-ruby-lint
+* Deprecate govuk-scss-lint
+
 # 4.2.0
 
 * Disable the Style/FormatStringToken cop.

README.md

@@ -1,3 +1,13 @@
+# DEPRECATED
+
+This repository and Gem has been deprecated and is no longer supported.
+
+To lint Ruby and RSpec projects please consider using [rubocop][rubocop] with [rubocop-govuk][rubocop-govuk].
+
+To lint SASS projects please consider using [scss-lint][scss-lint] with [scss-lint-govuk][scss-lint-govuk].
+
+For guidance on upgrading to these tools see the [migrate from govuk-lint][migrate-guide] page in the developer docs.
+
 # GOV.UK Lint
 
 This repo configures various linters to comply with our [style guides][guides].
@@ -60,4 +70,8 @@ default.
 Auto-correction and `--diff` mode are unavailable.
 
 [guides]: https://github.com/alphagov/styleguides
+[migrate-guide]: https://docs.publishing.service.gov.uk/manual/migrate-from-govuk-lint.html
 [rubocop]: https://github.com/bbatsov/rubocop
+[rubocop-govuk]: https://github.com/alphagov/rubocop-govuk
+[scss-lint]: https://github.com/sds/scss-lint
+[scss-lint-govuk]: https://github.com/alphagov/scss-lint-govuk

lib/govuk/lint/cli.rb

@@ -8,6 +8,7 @@ module Govuk
   module Lint
     class CLI < RuboCop::CLI
       def run(args = ARGV)
+        warn "[DEPRECATION] `govuk-lint-ruby` is deprecated.  Please use `rubocop` with `rubocop-govuk` instead."
         config = ConfigFile.new
 
         args += [

lib/govuk/lint/sass_cli.rb

@@ -6,6 +6,7 @@ module Govuk
   module Lint
     class SassCLI < SCSSLint::CLI
       def run(args = ARGV)
+        warn "[DEPRECATION] `govuk-scss-lint` is deprecated.  Please use `scss-lint` with `scss-lint-govuk` instead."
         args += [
                   "--config",
                   File.join(Govuk::Lint::CONFIG_PATH, "scss_lint/gds-sass-styleguide.yml"),

lib/govuk/lint/version.rb

@@ -1,5 +1,5 @@
 module Govuk
   module Lint
-    VERSION = "4.2.0".freeze
+    VERSION = "4.3.0".freeze
   end
 end