Sign upLogin

INTO-CPS-Association/DTaaS

View on GitHub
Star

Showing 34 of 88 total issues

Similar blocks of code found in 3 locations. Consider refactoring.
Open

  beforeEach(() => {
    storeConfig = setupStore();

    React.act(() => {
      render(
Severity: Major
Found in client/test/preview/integration/route/digitaltwins/manage/ConfigDialog.test.tsx and 2 other locations - About 2 hrs to fix
client/test/preview/integration/route/digitaltwins/manage/DeleteDialog.test.tsx on lines 13..23
client/test/preview/integration/route/digitaltwins/manage/DetailsDialog.test.tsx on lines 16..26

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 83.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 3 locations. Consider refactoring.
Open

  beforeEach(() => {
    storeDetails = setupStore();

    React.act(() => {
      render(
Severity: Major
Found in client/test/preview/integration/route/digitaltwins/manage/DetailsDialog.test.tsx and 2 other locations - About 2 hrs to fix
client/test/preview/integration/route/digitaltwins/manage/ConfigDialog.test.tsx on lines 17..27
client/test/preview/integration/route/digitaltwins/manage/DeleteDialog.test.tsx on lines 13..23

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 83.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 3 locations. Consider refactoring.
Open

  beforeEach(() => {
    storeDelete = setupStore();

    React.act(() => {
      render(
Severity: Major
Found in client/test/preview/integration/route/digitaltwins/manage/DeleteDialog.test.tsx and 2 other locations - About 2 hrs to fix
client/test/preview/integration/route/digitaltwins/manage/ConfigDialog.test.tsx on lines 17..27
client/test/preview/integration/route/digitaltwins/manage/DetailsDialog.test.tsx on lines 16..26

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 83.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Function SignIn has 53 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function SignIn() {
  const auth = useAuth();

  const startAuthProcess = () => {
    auth.signinRedirect();
Severity: Major
Found in client/src/route/auth/Signin.tsx - About 2 hrs to fix

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

    export default async function bootstrap(options?: BootstrapOptions) {
  const configFile = dotenv.config({
    path: options?.config ?? '.env',
    override: true,
  });
    Severity: Minor
    Found in servers/lib/src/bootstrap.ts - 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

    Code block style
    Open

        1. DTaaS as such won't help you to install DTs that you get from elsewhere.
    Severity: Info
    Found in docs/FAQ.md by markdownlint

    Code block style
    Open

        Yes via platform services.
    Severity: Info
    Found in docs/FAQ.md by markdownlint

    Bare URL used
    Open

    [HTTPie](https://github.com/httpie/desktop/releases)
    Severity: Info
    Found in servers/lib/DOCKER.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`

    Trailing spaces
    Open

      title={Digital Twin as a Service (DTaaS): A Platform for Digital Twin Developers and Users},
    Severity: Info
    Found in README.md by markdownlint

    MD009 - Trailing spaces

    Tags: whitespace

    Aliases: no-trailing-spaces

    Parameters: br_spaces (number; default: 0)

    This rule is triggered on any lines that end with whitespace. To fix this, find the line that is triggered and remove any trailing spaces from the end.

    The brspaces parameter allows an exception to this rule for a specific amount of trailing spaces used to insert an explicit line break/br element. For example, set brspaces to 2 to allow exactly 2 spaces at the end of a line.

    Note: you have to set brspaces to 2 or higher for this exception to take effect - you can't insert a br element with just a single trailing space, so if you set brspaces to 1, the exception will be disabled, just as if it was set to the default of 0.

    Code block style
    Open

        Commercial DT platforms like _Ansys Twin Builder_ provide tight integration
    Severity: Info
    Found in docs/FAQ.md by markdownlint

    Line length
    Open

       "query":"query {\n  listDirectory(path: \".\") {\n    repository {\n      tree {\n        blobs {\n          edges {\n            node {\n              name\n              type\n            }\n          }\n        }\n        trees {\n          edges {\n            node {\n              name\n              type\n            }\n          }\n        }\n      }\n    }\n  }\n}"
    Severity: Info
    Found in servers/lib/DOCKER.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.

    Code block style
    Open

        These optional requirements are not needed for
    Severity: Info
    Found in docs/admin/requirements.md by markdownlint

    Code block style
    Open

        1. The path examples given here are for Linux OS.
    Severity: Info
    Found in docs/admin/localhost.md by markdownlint

    Line length
    Open

       "query":"query {\n  readFile(path: \"user2/data/welcome.txt\") {\n    repository {\n      blobs {\n        nodes {\n          name\n          rawBlob\n          rawTextBlob\n        }\n      }\n    }\n  }\n}"
    Severity: Info
    Found in servers/lib/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.

    Code block style
    Open

        Proprietary and commercially licensed software is not
    Severity: Info
    Found in docs/FAQ.md by markdownlint

    Code block style
    Open

        The [localhost](localhost.md) installation is easy for
    Severity: Info
    Found in docs/admin/overview.md by markdownlint

    Fenced code blocks should be surrounded by blank lines
    Open

    ```txt
    Severity: Info
    Found in docs/user/examples/drobotti-rmqfmu/README.md by markdownlint

    MD031 - Fenced code blocks should be surrounded by blank lines

    Tags: code, blank_lines

    Aliases: blanks-around-fences

    This rule is triggered when fenced code blocks are either not preceded or not followed by a blank line:

    Some text
```
Code block
```

```
Another code block
```
Some more text

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

    Some text

```
Code block
```

```
Another code block
```

Some more text

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

    Code block style
    Open

        1. DTaaS is a web based interface to allow you to invoke various tools
    Severity: Info
    Found in docs/FAQ.md by markdownlint

    Fenced code blocks should be surrounded by blank lines
    Open

    ```bash
    Severity: Info
    Found in docs/user/examples/drobotti-rmqfmu/README.md by markdownlint

    MD031 - Fenced code blocks should be surrounded by blank lines

    Tags: code, blank_lines

    Aliases: blanks-around-fences

    This rule is triggered when fenced code blocks are either not preceded or not followed by a blank line:

    Some text
```
Code block
```

```
Another code block
```
Some more text

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

    Some text

```
Code block
```

```
Another code block
```

Some more text

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

    Line length
    Open

    | GitLab Variable Name | Variable Name in .env of docker compose file | Default Value |
    Severity: Info
    Found in docs/admin/servers/auth.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.

    Severity
    Category
    Status
    Source
    Language