SWAMPy

✎ CARVE FLESH

EDITING: default.yml

---
CopyrightLinter:
  Severity: "warn" # TODO: change to severe once autocorrect is implemented
  Precondition:
    # TODO: add "modified" once the initial autocorrect sweep is complete
    Statuses:
      - added
    Include:
      - "*.js"
      - "*.rb"
      # TODO: add the following once the initial autocorrect sweep is complete
#      - "*.css"
#      - "*.scss"
#      - "*.erb"
#      - "*.handlebars"
#      - "*.hbs"
    Allowlist:
      - "**/bower/**"
      - "**/mediaelement/**"
      - "**/shims/**"
      - "**/vendor/**"
      - "gems/tatl_tael/spec/lib/tatl_tael/linters/fixtures/**"
      - "gems/plugins/**"
  Regexes:
    FirstLineExceptions:
      - !ruby/regexp '/^#!/' # e.g. "#!/usr/bin/env ruby"
      - !ruby/regexp '/coding:/' # encodings
      - !ruby/regexp '/frozen_string_literal:/'
    CommentPrefixRegex: !ruby/regexp '/^( *)?(#|\/\/|\/?\*+|<%|\{\{\!)( *)?/'
  CopyrightYearPlaceholder: "CURRENT_YEAR"
  Copyright: |-
    Copyright (C) CURRENT_YEAR - present Instructure, Inc.

This file is part of Canvas.

Canvas is free software: you can redistribute it and/or modify it under
    the terms of the GNU Affero General Public License as published by the Free
    Software Foundation, version 3 of the License.

Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
    A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
    details.

You should have received a copy of the GNU Affero General Public License along
    with this program. If not, see <http://www.gnu.org/licenses/>.
  CopyrightEndingToken: "<http://www.gnu.org/licenses/>."
  CommentSymbols:
    Js:
      Block: true
      BlockStart: "/*"
      Line: " *"
      BlockEnd: " */"
    Rb:
      Block: false
      BlockStart: "#" # empty first line
      Line: "#"
  Message: |-
    Please prefix source files with our COPYRIGHT header. i.e.:
    Copyright (C) CURRENT_YEAR - present Instructure, Inc.

This file is part of Canvas... (rest of copyright found in ./COPYRIGHT)
    Tired of seeing this? Install the pre-commit auto-correct script in bin/lint.
  AutoCorrect:
    Message: "Corrected missing copyright header."
    RaiseIfTwoLinesWith: "Copyright (C)" # after auto correct

RubySpecsLinter:
  Severity: "warn"
  Globs:
    Ruby:
      # TODO: gems, plugins, etc?
      - "app/**.rb"
      - "lib/**.rb"
    RubySpec: # excludes SeleniumSpec globs
      # canvas proper
      - "spec/**.rb"
      - "spec_canvas/**.rb"
      - "test/**.rb"
      # gems, plugins, etc.
      - "**/spec/**.rb"
      - "**/spec_canvas/**.rb"
      - "**/test/**.rb"
    SeleniumSpec:
      # canvas proper
      - "spec/selenium/**"
      - "spec_canvas/selenium/**"
      - "test/selenium/**"
      # gems, plugins, etc.
      - "**/spec/selenium/**"
      - "**/spec_canvas/selenium/**"
      - "**/test/selenium/**"
  Messages:
    RubyChangesWithOnlySelenium: Your commit includes ruby changes, but does not include
      non-selenium specs (model, controller, etc). Please add some to verify your changes.
    RubyChangesWithNoRubySpecs: Your commit includes ruby changes, but does not include ruby specs.
      Please add some to verify your changes.

SeleniumSpecsLinter:
  Severity: "warn"
  Globs:
    Ruby:
      # TODO: gems, plugins, etc?
      - "app/**.rb"
      - "lib/**.rb"
    RubySpec: # excludes SeleniumSpec globs
      # canvas proper
      - "spec/**.rb"
      - "spec_canvas/**.rb"
      - "test/**.rb"
      # gems, plugins, etc.
      - "**/spec/**.rb"
      - "**/spec_canvas/**.rb"
      - "**/test/**.rb"
    SeleniumSpec:
      # canvas proper
      - "spec/selenium/**"
      - "spec_canvas/selenium/**"
      - "test/selenium/**"
      # gems, plugins, etc.
      - "**/spec/selenium/**"
      - "**/spec_canvas/selenium/**"
      - "**/test/selenium/**"
    # the following globs are used to determine if there are unnecessary selenium specs.
    # i.e., the code changes could/should be tested at a lower level.
    PublicJs:
      - "public/javascripts/**.js"
    PublicJsAllowlist:
      - "**/bower/**"
      - "**/mediaelement/**"
      - "**/shims/**"
      - "**/vendor/**"
    PublicJsSpec:
      - "spec/coffeescripts/**"
      - "spec/javascripts/**"
    Jsx:
      - "app/jsx/**.js"
    JsxSpec:
      - "spec/coffeescripts/jsx/**"
      - "spec/javascripts/jsx/**"
  Message: Your commit modifies selenium specs, when your changes might be more appropriately
      tested at a lower level. Please limit your selenium specs to happy-path scenarios.

Simple/JsxSpecsLinter:
  Severity: "warn"
  Precondition:
    Include:
    - "app/jsx/**.js"
  Requirement:
    Include:
    - "app/jsx/**/__tests__/**"
    - "spec/javascripts/jsx/**"
  Message: Your commit includes JavaScript changes, but does not include
    specs. Please add some to verify your changes.

Simple/PublicJsSpecsLinter:
  Severity: "warn"
  Precondition:
    Include:
    - "public/javascripts/**.js"
    Allowlist:
    - "**/bower/**"
    - "**/mediaelement/**"
    - "**/vendor/**"
  Requirement:
    Include:
    - "app/jsx/**/__tests__/**"
    - "public/javascripts/**/__tests__/**"
    - "spec/javascripts/**"
  Message: Your commit includes changes to public/javascripts, but does not include
    specs. Please add some to verify your changes. Even $.fn.crazyMethods
    can and should be tested (and not via selenium).

Simple/NewErbLinter:
  Severity: "warn"
  Precondition:
    Include:
    - "app/views/**.erb"
    Statuses:
    - added
  Message: |-
    Your commit includes new ERB files but you may be able to accomplish
    everything you need by doing something like this in your controller instead:

@page_title = t('Your Page Title')
        add_body_class 'whatever-classes you-want-to-add-to-body'
        js_bundle :your_js_bundle
        css_bundle :any_css_bundles_you_want
        js_env({whatever: 'you need to put in window.ENV'})
        render :html => "".html_safe, :layout => true

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 default.yml	YML	5.9 KB	2023-09-24 03:39	EDIT