bcgov/document-generation-showcase

View on GitHub

Showing 140 of 140 total issues

Function init has 60 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function init(config, watch, options) {
  const ctor = sanitizeConfig(config);
  const keycloak = new Keycloak(ctor);

  watch.$once('ready', function (cb) {
Severity: Major
Found in app/frontend/src/plugins/keycloak.js - About 2 hrs to fix

    Function install has 55 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      install: function (Vue, params = {}) {
        if (installed) return;
        installed = true;
    
        const defaultParams = {
    Severity: Major
    Found in app/frontend/src/plugins/keycloak.js - About 2 hrs to fix

      Function authenticate has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
      Open

        authenticate: (req, res, next) => {
      
          const authorization = req.get('Authorization');
          if (!authorization || !authorization.startsWith('Bearer ')) {
            return new Problem(401, {
      Severity: Minor
      Found in app/src/middleware/authentication.js - About 1 hr 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

      Function authenticate has 39 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        authenticate: (req, res, next) => {
      
          const authorization = req.get('Authorization');
          if (!authorization || !authorization.startsWith('Bearer ')) {
            return new Problem(401, {
      Severity: Minor
      Found in app/src/middleware/authentication.js - About 1 hr to fix

        Function data has 31 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

              data() {
                return {
                  ready: false,
                  authenticated: false,
                  userName: null,
        Severity: Minor
        Found in app/frontend/src/plugins/keycloak.js - About 1 hr to fix

          Function constructor has 31 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

            constructor({ tokenUrl, clientId, clientSecret }) {
              log.verbose(
                'ClientConnection',
                `Constructed with ${tokenUrl}, ${clientId}, clientSecret`
              );
          Severity: Minor
          Found in app/src/cdogsService/clientConnection.js - About 1 hr to fix

            Function updateWatchVariables has 29 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

              function updateWatchVariables(isAuthenticated = false) {
                watch.authenticated = isAuthenticated;
                watch.loginFn = keycloak.login;
                watch.login = keycloak.login;
                watch.createLoginUrl = keycloak.createLoginUrl;
            Severity: Minor
            Found in app/frontend/src/plugins/keycloak.js - About 1 hr to fix

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

              function assertOptions(options) {
                const { config, init, onReady, onInitError } = options;
                if (typeof config !== 'string' && !_isObject(config)) {
                  return { hasError: true, error: `'config' option must be a string or an object. Found: '${config}'` };
                }
              Severity: Minor
              Found in app/frontend/src/plugins/keycloak.js - 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 {
                  hasError: false,
                  error: null
                };
              Severity: Major
              Found in app/frontend/src/plugins/keycloak.js - About 30 mins to fix

                Headers should be surrounded by blank lines
                Open

                # Configuration
                Severity: Info
                Found in app/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.

                Fenced code blocks should be surrounded by blank lines
                Open

                ```
                Severity: Info
                Found in app/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.

                Trailing spaces
                Open

                - [DGEN](https://dgen.pathfinder.gov.bc.ca) - A showcase app for DGEN (coming soon). Here you can try out the DGEN capabilities   
                Severity: Info
                Found in docs/overview.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.

                Trailing spaces
                Open

                ## How It Works
                Severity: Info
                Found in docs/developer-guide.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.

                Trailing spaces
                Open

                Severity: Info
                Found in docs/developer-guide.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.

                Trailing spaces
                Open

                ## Limitations of the DGEN-API
                Severity: Info
                Found in docs/developer-guide.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.

                Trailing spaces
                Open

                Severity: Info
                Found in docs/developer-guide.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.

                Trailing spaces
                Open

                4. Any user who will be developing templates will require the DGEN_TEMPLATE_DESIGNER role in WebADE.
                Severity: Info
                Found in docs/developer-guide.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.

                Trailing spaces
                Open

                Template designers create document templates using [Windward Report Designer](https://www.windwardstudios.com/solution/windward-designer)r, a plug-in to Microsoft Office. Template designers will use the plug-in to design, format, edit, and configure reusable document templates. Template designers have the capability to generate test documents. When a user submits a request to generate a test document, the template document and resource files must reside in the DMS repository.
                Severity: Info
                Found in docs/developer-guide.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.

                Trailing spaces
                Open

                Severity: Info
                Found in docs/developer-guide.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.

                Trailing spaces
                Open

                3. A DGEN templates folder has been created for business area files. The folder name, metadata and security has been specified. The folder has been created and access has been granted through WebADE.
                Severity: Info
                Found in docs/developer-guide.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.

                Severity
                Category
                Status
                Source
                Language