From 35794b69af581f7ef3d73dc951cd5590d499028e Mon Sep 17 00:00:00 2001 From: Kate Higa <16447748+khiga8@users.noreply.github.com> Date: Thu, 8 Jun 2023 20:15:53 -0400 Subject: [PATCH 1/3] Move under config --- README.md | 43 +++++++--------------------------------- config/accessibility.yml | 32 ++++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+), 36 deletions(-) create mode 100644 config/accessibility.yml diff --git a/README.md b/README.md index 597f023..181a24a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # erblint-github + Template style checking for GitHub's Ruby projects ## Setup @@ -10,49 +11,19 @@ gem "erb_lint", require: false gem "erblint-github" ``` -2. Require the linters within the `.erb-linters` folder. This could be done by adding a file `.erb-linters/erblint-github.rb` with the following line. +2. Require the lint rules from this library. Currently, the only supported way is to add a new file in `.erb-linters/erblint-github.rb` with the line: ```ruby require "erblint-github/linters" ``` -3. Update the `erb-lint.yml` to configure the rule. - -### .erb-lint.yml +3. Update your `erb-lint.yml` to pull in our recommended configs. This will ensure you are up-to-date with our recommendations. -```yaml +```yaml --- -linters: - GitHub::Accessibility::AriaLabelIsWellFormatted: - enabled: true - GitHub::Accessibility::AvoidBothDisabledAndAriaDisabled: - enabled: true - GitHub::Accessibility::AvoidGenericLinkText: - enabled: true - GitHub::Accessibility::DisabledAttribute: - enabled: true - GitHub::Accessibility::IframeHasTitle: - enabled: true - GitHub::Accessibility::ImageHasAlt: - enabled: true - GitHub::Accessibility::NavigationHasLabel: - enabled: true - GitHub::Accessibility::LinkHasHref: - enabled: true - GitHub::Accessibility::NestedInteractiveElements: - enabled: true - GitHub::Accessibility::NoAriaHiddenOnFocusable: - enabled: true - GitHub::Accessibility::NoAriaLabelMisuse: - enabled: true - GitHub::Accessibility::NoPositiveTabIndex: - enabled: true - GitHub::Accessibility::NoRedundantImageAlt: - enabled: true - GitHub::Accessibility::NoTitleAttribute: - enabled: true - GitHub::Accessibility::SvgHasAccessibleText: - enabled: true +inherit_gem: + erblint-github: + - config/accessibility.yml ``` ## Rules diff --git a/config/accessibility.yml b/config/accessibility.yml new file mode 100644 index 0000000..90baf53 --- /dev/null +++ b/config/accessibility.yml @@ -0,0 +1,32 @@ +--- +linters: + GitHub::Accessibility::AriaLabelIsWellFormatted: + enabled: true + GitHub::Accessibility::AvoidBothDisabledAndAriaDisabled: + enabled: true + GitHub::Accessibility::AvoidGenericLinkText: + enabled: true + GitHub::Accessibility::DisabledAttribute: + enabled: true + GitHub::Accessibility::IframeHasTitle: + enabled: true + GitHub::Accessibility::ImageHasAlt: + enabled: true + GitHub::Accessibility::NavigationHasLabel: + enabled: true + GitHub::Accessibility::LinkHasHref: + enabled: true + GitHub::Accessibility::NestedInteractiveElements: + enabled: true + GitHub::Accessibility::NoAriaHiddenOnFocusable: + enabled: true + GitHub::Accessibility::NoAriaLabelMisuse: + enabled: true + GitHub::Accessibility::NoPositiveTabIndex: + enabled: true + GitHub::Accessibility::NoRedundantImageAlt: + enabled: true + GitHub::Accessibility::NoTitleAttribute: + enabled: true + GitHub::Accessibility::SvgHasAccessibleText: + enabled: true \ No newline at end of file From c8bd59037408fbd21c5f588d4f6ba11d98a85e21 Mon Sep 17 00:00:00 2001 From: Kate Higa <16447748+khiga8@users.noreply.github.com> Date: Thu, 8 Jun 2023 20:19:04 -0400 Subject: [PATCH 2/3] Add new line --- config/accessibility.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config/accessibility.yml b/config/accessibility.yml index 90baf53..e55a2cb 100644 --- a/config/accessibility.yml +++ b/config/accessibility.yml @@ -29,4 +29,4 @@ linters: GitHub::Accessibility::NoTitleAttribute: enabled: true GitHub::Accessibility::SvgHasAccessibleText: - enabled: true \ No newline at end of file + enabled: true From 7918872d4dff28f7f5fd607b65c0c528f0fc142a Mon Sep 17 00:00:00 2001 From: Kate Higa <16447748+khiga8@users.noreply.github.com> Date: Thu, 8 Jun 2023 21:04:24 -0400 Subject: [PATCH 3/3] Require config in the gemspec --- erblint-github.gemspec | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/erblint-github.gemspec b/erblint-github.gemspec index 9732296..fd69949 100644 --- a/erblint-github.gemspec +++ b/erblint-github.gemspec @@ -8,7 +8,7 @@ Gem::Specification.new do |s| s.homepage = "https://github.com/github/erblint-github" s.license = "MIT" - s.files = Dir["README.md", "LICENSE", "lib/**/*"] + s.files = Dir["README.md", "LICENSE", "lib/**/*", "config/**/*"] s.require_paths = ["lib"] s.required_ruby_version = ">= 2.7.0"