Zerotask/rust-jungle

View on GitHub

Showing 156 of 156 total issues

Function generateLessonsJson has 47 lines of code (exceeds 25 allowed). Consider refactoring.
Open

const generateLessonsJson = async () => {
    const startTime = process.hrtime();
    const pages = await getPages();

    let lessonsData = [];
Severity: Minor
Found in generator.js - About 1 hr to fix

    Line length
    Open

    And you are not alone! [Ferris the crab](https://www.rustacean.net/) will be with you!
    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.

    space indentation expected
    Open

            set: (value: LastLesson) => localStorage.setItem(localStorageKey, JSON.stringify(value)),
    Severity: Minor
    Found in src/stores/lastLesson.ts by tslint

    Rule: indent

    Enforces indentation with tabs or spaces.

    Rationale

    Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

    Notes
    • Has Fix

    Config

    One of the following arguments must be provided:

    • spaces enforces consistent spaces.
    • tabs enforces consistent tabs.

    A second optional argument specifies indentation size:

    • 2 enforces 2 space indentation.
    • 4 enforces 4 space indentation.

    Indentation size is required for auto-fixing, but not for rule checking.

    NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

    Examples
    "indent": true,spaces
    "indent": true,spaces,4
    "indent": true,tabs,2
    Schema
    {
      "type": "array",
      "items": [
        {
          "type": "string",
          "enum": [
            "tabs",
            "spaces"
          ]
        },
        {
          "type": "number",
          "enum": [
            2,
            4
          ]
        }
      ],
      "minLength": 0,
      "maxLength": 5
    }

    For more information see this page.

    space indentation expected
    Open

                const lessons: string | null = localStorage.getItem(cacheKey);
    Severity: Minor
    Found in src/stores/lessons.ts by tslint

    Rule: indent

    Enforces indentation with tabs or spaces.

    Rationale

    Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

    Notes
    • Has Fix

    Config

    One of the following arguments must be provided:

    • spaces enforces consistent spaces.
    • tabs enforces consistent tabs.

    A second optional argument specifies indentation size:

    • 2 enforces 2 space indentation.
    • 4 enforces 4 space indentation.

    Indentation size is required for auto-fixing, but not for rule checking.

    NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

    Examples
    "indent": true,spaces
    "indent": true,spaces,4
    "indent": true,tabs,2
    Schema
    {
      "type": "array",
      "items": [
        {
          "type": "string",
          "enum": [
            "tabs",
            "spaces"
          ]
        },
        {
          "type": "number",
          "enum": [
            2,
            4
          ]
        }
      ],
      "minLength": 0,
      "maxLength": 5
    }

    For more information see this page.

    space indentation expected
    Open

        stages: Stages;
    Severity: Minor
    Found in src/lib/lessonInterfaces.ts by tslint

    Rule: indent

    Enforces indentation with tabs or spaces.

    Rationale

    Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

    Notes
    • Has Fix

    Config

    One of the following arguments must be provided:

    • spaces enforces consistent spaces.
    • tabs enforces consistent tabs.

    A second optional argument specifies indentation size:

    • 2 enforces 2 space indentation.
    • 4 enforces 4 space indentation.

    Indentation size is required for auto-fixing, but not for rule checking.

    NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

    Examples
    "indent": true,spaces
    "indent": true,spaces,4
    "indent": true,tabs,2
    Schema
    {
      "type": "array",
      "items": [
        {
          "type": "string",
          "enum": [
            "tabs",
            "spaces"
          ]
        },
        {
          "type": "number",
          "enum": [
            2,
            4
          ]
        }
      ],
      "minLength": 0,
      "maxLength": 5
    }

    For more information see this page.

    space indentation expected
    Open

        maxRetentionTime: 24 * 60 // Retry for max of 24 Hours (specified in minutes)
    Severity: Minor
    Found in src/service-worker.ts by tslint

    Rule: indent

    Enforces indentation with tabs or spaces.

    Rationale

    Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

    Notes
    • Has Fix

    Config

    One of the following arguments must be provided:

    • spaces enforces consistent spaces.
    • tabs enforces consistent tabs.

    A second optional argument specifies indentation size:

    • 2 enforces 2 space indentation.
    • 4 enforces 4 space indentation.

    Indentation size is required for auto-fixing, but not for rule checking.

    NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

    Examples
    "indent": true,spaces
    "indent": true,spaces,4
    "indent": true,tabs,2
    Schema
    {
      "type": "array",
      "items": [
        {
          "type": "string",
          "enum": [
            "tabs",
            "spaces"
          ]
        },
        {
          "type": "number",
          "enum": [
            2,
            4
          ]
        }
      ],
      "minLength": 0,
      "maxLength": 5
    }

    For more information see this page.

    space indentation expected
    Open

        // Use a Stale While Revalidate caching strategy
    Severity: Minor
    Found in src/service-worker.ts by tslint

    Rule: indent

    Enforces indentation with tabs or spaces.

    Rationale

    Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

    Notes
    • Has Fix

    Config

    One of the following arguments must be provided:

    • spaces enforces consistent spaces.
    • tabs enforces consistent tabs.

    A second optional argument specifies indentation size:

    • 2 enforces 2 space indentation.
    • 4 enforces 4 space indentation.

    Indentation size is required for auto-fixing, but not for rule checking.

    NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

    Examples
    "indent": true,spaces
    "indent": true,spaces,4
    "indent": true,tabs,2
    Schema
    {
      "type": "array",
      "items": [
        {
          "type": "string",
          "enum": [
            "tabs",
            "spaces"
          ]
        },
        {
          "type": "number",
          "enum": [
            2,
            4
          ]
        }
      ],
      "minLength": 0,
      "maxLength": 5
    }

    For more information see this page.

    Ordered list item prefix
    Open

    4. See error

    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.

    space indentation expected
    Open

            plugins: [
    Severity: Minor
    Found in src/service-worker.ts by tslint

    Rule: indent

    Enforces indentation with tabs or spaces.

    Rationale

    Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

    Notes
    • Has Fix

    Config

    One of the following arguments must be provided:

    • spaces enforces consistent spaces.
    • tabs enforces consistent tabs.

    A second optional argument specifies indentation size:

    • 2 enforces 2 space indentation.
    • 4 enforces 4 space indentation.

    Indentation size is required for auto-fixing, but not for rule checking.

    NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

    Examples
    "indent": true,spaces
    "indent": true,spaces,4
    "indent": true,tabs,2
    Schema
    {
      "type": "array",
      "items": [
        {
          "type": "string",
          "enum": [
            "tabs",
            "spaces"
          ]
        },
        {
          "type": "number",
          "enum": [
            2,
            4
          ]
        }
      ],
      "minLength": 0,
      "maxLength": 5
    }

    For more information see this page.

    Line length
    Open

    You're welcome contributing to Rust Jungle. Please read the following instructions before starting.
    Severity: Info
    Found in CONTRIBUTING.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

    The goal of Rust Jungle is to give you an easy start with the Rust programming language with
    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.

    space indentation expected
    Open

            throw new Error('could not fetch lessons.json file.');
    Severity: Minor
    Found in src/stores/lessons.ts by tslint

    Rule: indent

    Enforces indentation with tabs or spaces.

    Rationale

    Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

    Notes
    • Has Fix

    Config

    One of the following arguments must be provided:

    • spaces enforces consistent spaces.
    • tabs enforces consistent tabs.

    A second optional argument specifies indentation size:

    • 2 enforces 2 space indentation.
    • 4 enforces 4 space indentation.

    Indentation size is required for auto-fixing, but not for rule checking.

    NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

    Examples
    "indent": true,spaces
    "indent": true,spaces,4
    "indent": true,tabs,2
    Schema
    {
      "type": "array",
      "items": [
        {
          "type": "string",
          "enum": [
            "tabs",
            "spaces"
          ]
        },
        {
          "type": "number",
          "enum": [
            2,
            4
          ]
        }
      ],
      "minLength": 0,
      "maxLength": 5
    }

    For more information see this page.

    space indentation expected
    Open

        }
    Severity: Minor
    Found in src/stores/lessons.ts by tslint

    Rule: indent

    Enforces indentation with tabs or spaces.

    Rationale

    Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

    Notes
    • Has Fix

    Config

    One of the following arguments must be provided:

    • spaces enforces consistent spaces.
    • tabs enforces consistent tabs.

    A second optional argument specifies indentation size:

    • 2 enforces 2 space indentation.
    • 4 enforces 4 space indentation.

    Indentation size is required for auto-fixing, but not for rule checking.

    NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

    Examples
    "indent": true,spaces
    "indent": true,spaces,4
    "indent": true,tabs,2
    Schema
    {
      "type": "array",
      "items": [
        {
          "type": "string",
          "enum": [
            "tabs",
            "spaces"
          ]
        },
        {
          "type": "number",
          "enum": [
            2,
            4
          ]
        }
      ],
      "minLength": 0,
      "maxLength": 5
    }

    For more information see this page.

    space indentation expected
    Open

        `Stage ${stage}.${index}: ${title}`;
    Severity: Minor
    Found in src/lib/lessons.ts by tslint

    Rule: indent

    Enforces indentation with tabs or spaces.

    Rationale

    Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

    Notes
    • Has Fix

    Config

    One of the following arguments must be provided:

    • spaces enforces consistent spaces.
    • tabs enforces consistent tabs.

    A second optional argument specifies indentation size:

    • 2 enforces 2 space indentation.
    • 4 enforces 4 space indentation.

    Indentation size is required for auto-fixing, but not for rule checking.

    NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

    Examples
    "indent": true,spaces
    "indent": true,spaces,4
    "indent": true,tabs,2
    Schema
    {
      "type": "array",
      "items": [
        {
          "type": "string",
          "enum": [
            "tabs",
            "spaces"
          ]
        },
        {
          "type": "number",
          "enum": [
            2,
            4
          ]
        }
      ],
      "minLength": 0,
      "maxLength": 5
    }

    For more information see this page.

    space indentation expected
    Open

        new StaleWhileRevalidate({
    Severity: Minor
    Found in src/service-worker.ts by tslint

    Rule: indent

    Enforces indentation with tabs or spaces.

    Rationale

    Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

    Notes
    • Has Fix

    Config

    One of the following arguments must be provided:

    • spaces enforces consistent spaces.
    • tabs enforces consistent tabs.

    A second optional argument specifies indentation size:

    • 2 enforces 2 space indentation.
    • 4 enforces 4 space indentation.

    Indentation size is required for auto-fixing, but not for rule checking.

    NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

    Examples
    "indent": true,spaces
    "indent": true,spaces,4
    "indent": true,tabs,2
    Schema
    {
      "type": "array",
      "items": [
        {
          "type": "string",
          "enum": [
            "tabs",
            "spaces"
          ]
        },
        {
          "type": "number",
          "enum": [
            2,
            4
          ]
        }
      ],
      "minLength": 0,
      "maxLength": 5
    }

    For more information see this page.

    space indentation expected
    Open

                // Ensure that only requests that result in a 200 status are cached
    Severity: Minor
    Found in src/service-worker.ts by tslint

    Rule: indent

    Enforces indentation with tabs or spaces.

    Rationale

    Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

    Notes
    • Has Fix

    Config

    One of the following arguments must be provided:

    • spaces enforces consistent spaces.
    • tabs enforces consistent tabs.

    A second optional argument specifies indentation size:

    • 2 enforces 2 space indentation.
    • 4 enforces 4 space indentation.

    Indentation size is required for auto-fixing, but not for rule checking.

    NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

    Examples
    "indent": true,spaces
    "indent": true,spaces,4
    "indent": true,tabs,2
    Schema
    {
      "type": "array",
      "items": [
        {
          "type": "string",
          "enum": [
            "tabs",
            "spaces"
          ]
        },
        {
          "type": "number",
          "enum": [
            2,
            4
          ]
        }
      ],
      "minLength": 0,
      "maxLength": 5
    }

    For more information see this page.

    space indentation expected
    Open

                    statuses: [200]
    Severity: Minor
    Found in src/service-worker.ts by tslint

    Rule: indent

    Enforces indentation with tabs or spaces.

    Rationale

    Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

    Notes
    • Has Fix

    Config

    One of the following arguments must be provided:

    • spaces enforces consistent spaces.
    • tabs enforces consistent tabs.

    A second optional argument specifies indentation size:

    • 2 enforces 2 space indentation.
    • 4 enforces 4 space indentation.

    Indentation size is required for auto-fixing, but not for rule checking.

    NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

    Examples
    "indent": true,spaces
    "indent": true,spaces,4
    "indent": true,tabs,2
    Schema
    {
      "type": "array",
      "items": [
        {
          "type": "string",
          "enum": [
            "tabs",
            "spaces"
          ]
        },
        {
          "type": "number",
          "enum": [
            2,
            4
          ]
        }
      ],
      "minLength": 0,
      "maxLength": 5
    }

    For more information see this page.

    Bare URL used
    Open

    https://www.contributor-covenant.org/translations.
    Severity: Info
    Found in CODE_OF_CONDUCT.md by markdownlint

    MD034 - Bare URL used

    Tags: links, url

    Aliases: no-bare-urls

    This rule is triggered whenever a URL is given that isn't surrounded by angle brackets:

    For more information, see http://www.example.com/.

    To fix this, add angle brackets around the URL:

    For more information, see <http:></http:>.

    Rationale: Without angle brackets, the URL isn't converted into a link in many markdown parsers.

    Note: if you do want a bare URL without it being converted into a link, enclose it in a code block, otherwise in some markdown parsers it will be converted:

    `http://www.example.com`

    Line length
    Open

    In my experience, once you've learned Rust, you will love it. Others share my experience, otherwise
    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.

    space indentation expected
    Open

                    const cachedObject: CachedObject = JSON.parse(lessons);
    Severity: Minor
    Found in src/stores/lessons.ts by tslint

    Rule: indent

    Enforces indentation with tabs or spaces.

    Rationale

    Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

    Notes
    • Has Fix

    Config

    One of the following arguments must be provided:

    • spaces enforces consistent spaces.
    • tabs enforces consistent tabs.

    A second optional argument specifies indentation size:

    • 2 enforces 2 space indentation.
    • 4 enforces 4 space indentation.

    Indentation size is required for auto-fixing, but not for rule checking.

    NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

    Examples
    "indent": true,spaces
    "indent": true,spaces,4
    "indent": true,tabs,2
    Schema
    {
      "type": "array",
      "items": [
        {
          "type": "string",
          "enum": [
            "tabs",
            "spaces"
          ]
        },
        {
          "type": "number",
          "enum": [
            2,
            4
          ]
        }
      ],
      "minLength": 0,
      "maxLength": 5
    }

    For more information see this page.

    Severity
    Category
    Status
    Source
    Language