Sign upLogin

gwcuva/gwc-website

View on GitHub
Star

Showing 372 of 372 total issues

Function About has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

function About() {
  const [description, setDescription] = useState([{'id': '', 'ghhDescription': '', 'gwcDescription': ''}]);
  let ghhDescription: string[] = [];
  let gwcDescription: string[] = [];
Severity: Minor
Found in src/components/GirlsHooHack2023/About/About.tsx - About 35 mins to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Avoid too many return statements within this function.
Open

      return (parseInt(atime)-parseInt(btime));
Severity: Major
Found in src/components/GirlsHooHack2023/Schedule/Schedule.tsx - About 30 mins to fix

    Avoid too many return statements within this function.
    Open

          return (parseInt(atime)-parseInt(btime));
    Severity: Major
    Found in src/components/GirlsHooHack2022/Schedule/Schedule.tsx - About 30 mins to fix

      Function Podcast has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

      function Podcast(props: Props) {
    return (
        <div id={props.id} className="pb-5">
            <Row className="justify-content-center">
                <Col lg={6} md={8} sm={10} xs={11}>
      Severity: Minor
      Found in src/components/Main/Podcast/Podcast.tsx - About 25 mins to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Trailing punctuation in header
      Open

      ### If you already know JavaScript too!
      Severity: Info
      Found in INTRO-WEB-DEV.md by markdownlint

      MD026 - Trailing punctuation in header

      Tags: headers

      Aliases: no-trailing-punctuation

      Parameters: punctuation (string; default ".,;:!?")

      This rule is triggered on any header that has a punctuation character as the last character in the line:

      # This is a header.

      To fix this, remove any trailing punctuation:

      # This is a header

      Note: The punctuation parameter can be used to specify what characters class as punctuation at the end of the header. For example, you can set it to '.,;:!' to allow headers with question marks in them, such as might be used in an FAQ.

      Lists should be surrounded by blank lines
      Open

      * Make headers and paragraphs
      Severity: Info
      Found in INTRO-WEB-DEV.md by markdownlint

      MD032 - Lists should be surrounded by blank lines

      Tags: bullet, ul, ol, blank_lines

      Aliases: blanks-around-lists

      This rule is triggered when lists (of any kind) are either not preceded or not followed by a blank line:

      Some text
* Some
* List

1. Some
2. List
Some text

      To fix this, ensure that all lists have a blank line both before and after (except where the block is at the beginning or end of the document):

      Some text

* Some
* List

1. Some
2. List

Some text

      Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will not parse lists that don't have blank lines before and after them.

      Note: List items without hanging indents are a violation of this rule; list items with hanging indents are okay:

      * This is
not okay

* This is
  okay

      Line length
      Open

      1. Look at [Issues](https://github.com/gwcuva/gwc-website/issues) to find an unassigned task, if not being directed by an executive member.
      Severity: Info
      Found in README.md by markdownlint

      MD013 - Line length

      Tags: line_length

      Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

      This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

      This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

      You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

      Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

      Headers should be surrounded by blank lines
      Open

      ## Additional Steps
      Severity: Info
      Found in README.md by markdownlint

      MD022 - Headers should be surrounded by blank lines

      Tags: headers, blank_lines

      Aliases: blanks-around-headers

      This rule is triggered when headers (any style) are either not preceded or not followed by a blank line:

      # Header 1
Some text

Some more text
## Header 2

      To fix this, ensure that all headers have a blank line both before and after (except where the header is at the beginning or end of the document):

      # Header 1

Some text

Some more text

## Header 2

      Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will not parse headers that don't have a blank line before, and will parse them as regular text.

      Lists should be surrounded by blank lines
      Open

      * If you are on the web development committee, make sure to join the [website team](https://github.com/orgs/gwcuva/teams/website) on our organization
      Severity: Info
      Found in README.md by markdownlint

      MD032 - Lists should be surrounded by blank lines

      Tags: bullet, ul, ol, blank_lines

      Aliases: blanks-around-lists

      This rule is triggered when lists (of any kind) are either not preceded or not followed by a blank line:

      Some text
* Some
* List

1. Some
2. List
Some text

      To fix this, ensure that all lists have a blank line both before and after (except where the block is at the beginning or end of the document):

      Some text

* Some
* List

1. Some
2. List

Some text

      Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will not parse lists that don't have blank lines before and after them.

      Note: List items without hanging indents are a violation of this rule; list items with hanging indents are okay:

      * This is
not okay

* This is
  okay

      Lists should be surrounded by blank lines
      Open

      * **fonts**
      Severity: Info
      Found in README.md by markdownlint

      MD032 - Lists should be surrounded by blank lines

      Tags: bullet, ul, ol, blank_lines

      Aliases: blanks-around-lists

      This rule is triggered when lists (of any kind) are either not preceded or not followed by a blank line:

      Some text
* Some
* List

1. Some
2. List
Some text

      To fix this, ensure that all lists have a blank line both before and after (except where the block is at the beginning or end of the document):

      Some text

* Some
* List

1. Some
2. List

Some text

      Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will not parse lists that don't have blank lines before and after them.

      Note: List items without hanging indents are a violation of this rule; list items with hanging indents are okay:

      * This is
not okay

* This is
  okay

      Trailing punctuation in header
      Open

      ### If you're new to web development...
      Severity: Info
      Found in INTRO-WEB-DEV.md by markdownlint

      MD026 - Trailing punctuation in header

      Tags: headers

      Aliases: no-trailing-punctuation

      Parameters: punctuation (string; default ".,;:!?")

      This rule is triggered on any header that has a punctuation character as the last character in the line:

      # This is a header.

      To fix this, remove any trailing punctuation:

      # This is a header

      Note: The punctuation parameter can be used to specify what characters class as punctuation at the end of the header. For example, you can set it to '.,;:!' to allow headers with question marks in them, such as might be used in an FAQ.

      Line length
      Open

      [Website Wireframe]([https://www.figma.com/file/3oCYmtWALN20gRkSa5Ew7V/GWC-General-Site?node-id=0%3A1](https://www.figma.com/file/5zzNZ9RQp82X1p3HqdWrWg/gwc-figma?node-id=0-1&t=QMSpTXhvpL6sXgjn-0)) | [GHH Wireframe](https://www.figma.com/file/fTEjRE0zxWO1uZAVK3QOn1/GWC-Mockups-2?node-id=32%3A1122) | [Brand Identity Guide](https://www.figma.com/file/eb9ExHXT0yGgo4RkK8FG65/Brand-Manual-Identity-Iterations?node-id=251%3A92)
      Severity: Info
      Found in README.md by markdownlint

      MD013 - Line length

      Tags: line_length

      Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

      This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

      This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

      You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

      Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

      Line length
      Open

      This is an important time to get started with Javascript! [W3Schools](https://www.w3schools.com/js/DEFAULT.asp) has a tutorial on it, but honestly, if you know Java and Python, you can probably just skip to the React section and google anything you need to know in JavaScript.
      Severity: Info
      Found in INTRO-WEB-DEV.md by markdownlint

      MD013 - Line length

      Tags: line_length

      Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

      This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

      This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

      You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

      Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

      Line length
      Open

      4. Create a pull request for your branch as soon as possible and make sure it's in the `In Progress` column of the appropriate [project](https://github.com/gwcuva/gwc-website/projects)
      Severity: Info
      Found in README.md by markdownlint

      MD013 - Line length

      Tags: line_length

      Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

      This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

      This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

      You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

      Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

      Headers should be surrounded by blank lines
      Open

      # Introduction to Web Development
      Severity: Info
      Found in INTRO-WEB-DEV.md by markdownlint

      MD022 - Headers should be surrounded by blank lines

      Tags: headers, blank_lines

      Aliases: blanks-around-headers

      This rule is triggered when headers (any style) are either not preceded or not followed by a blank line:

      # Header 1
Some text

Some more text
## Header 2

      To fix this, ensure that all headers have a blank line both before and after (except where the header is at the beginning or end of the document):

      # Header 1

Some text

Some more text

## Header 2

      Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will not parse headers that don't have a blank line before, and will parse them as regular text.

      Ordered list item prefix
      Open

      8. Once your PR has been approved, go ahead and merge!
      Severity: Info
      Found in README.md by markdownlint

      MD029 - Ordered list item prefix

      Tags: ol

      Aliases: ol-prefix

      Parameters: style ("one", "ordered"; default "one")

      This rule is triggered on ordered lists that do not either start with '1.' or do not have a prefix that increases in numerical order (depending on the configured style, which defaults to 'one').

      Example valid list if the style is configured as 'one':

      1. Do this.
1. Do that.
1. Done.

      Example valid list if the style is configured as 'ordered':

      1. Do this.
2. Do that.
3. Done.

      Multiple consecutive blank lines
      Open
      Severity: Info
      Found in README.md by markdownlint

      MD012 - Multiple consecutive blank lines

      Tags: whitespace, blank_lines

      Aliases: no-multiple-blanks

      This rule is triggered when there are multiple consecutive blank lines in the document:

      Some text here


Some more text here

      To fix this, delete the offending lines:

      Some text here

Some more text here

      Note: this rule will not be triggered if there are multiple consecutive blank lines inside code blocks.

      Headers should be surrounded by blank lines
      Open

      ### If you know HTML + CSS
      Severity: Info
      Found in INTRO-WEB-DEV.md by markdownlint

      MD022 - Headers should be surrounded by blank lines

      Tags: headers, blank_lines

      Aliases: blanks-around-headers

      This rule is triggered when headers (any style) are either not preceded or not followed by a blank line:

      # Header 1
Some text

Some more text
## Header 2

      To fix this, ensure that all headers have a blank line both before and after (except where the header is at the beginning or end of the document):

      # Header 1

Some text

Some more text

## Header 2

      Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will not parse headers that don't have a blank line before, and will parse them as regular text.

      Headers should be surrounded by blank lines
      Open

      ### src
      Severity: Info
      Found in README.md by markdownlint

      MD022 - Headers should be surrounded by blank lines

      Tags: headers, blank_lines

      Aliases: blanks-around-headers

      This rule is triggered when headers (any style) are either not preceded or not followed by a blank line:

      # Header 1
Some text

Some more text
## Header 2

      To fix this, ensure that all headers have a blank line both before and after (except where the header is at the beginning or end of the document):

      # Header 1

Some text

Some more text

## Header 2

      Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will not parse headers that don't have a blank line before, and will parse them as regular text.

      Header levels should only increment by one level at a time
      Open

      ### If you're new to web development...
      Severity: Info
      Found in INTRO-WEB-DEV.md by markdownlint

      MD001 - Header levels should only increment by one level at a time

      Tags: headers

      Aliases: header-increment

      This rule is triggered when you skip header levels in a markdown document, for example:

      # Header 1

### Header 3

We skipped out a 2nd level header in this document

      When using multiple header levels, nested headers should increase by only one level at a time:

      # Header 1

## Header 2

### Header 3

#### Header 4

## Another Header 2

### Another Header 3
      Severity
      Category
      Status
      Source
      Language