Troubleshooting of Sonar issue

This article "Troubleshooting of Sonar issue" is still being written. If there are any incomplete parts, you are welcome to directly edit them. 這篇文章「Troubleshooting of Sonar issue」內容還在撰寫中，如果有不完整的部分，歡迎你直接動手修改。

How to resolve "Add a new line at the end of this file."

Error message: Files should contain an empty newline at the end

Solution:

• Add new line at the end of this file

Another solution:

• Add an new file add_newline_to_php_files.sh with the following content

#!/bin/bash

# Check if a directory path argument has been provided
if [ "$#" -ne 1 ]; then
    echo "Usage: ./add_newline_to_php_files.sh [Directory Path]"
    exit 1
fi

# Retrieve the directory path argument
dir_path="$1"

# Initialize a counter for modified files
modified_count=0

# Iterate through all .php files in the specified directory
for file in "$dir_path"/*.php; do
    # Check if the file exists
    if [ -f "$file" ]; then
        # Read the last line of the file
        last_line=$(tail -n 1 "$file")
        
        # Check if the last line is empty
        if [ "$last_line" != "" ]; then
            # If it's not empty, append a newline character
            echo "" >> "$file"
            # Increment the modified files counter
            ((modified_count++))
        fi
    fi
done

# Display the number of modified files
echo "Number of modified files: $modified_count"

• Grant the execution permission chmod +x add_newline_to_php_files.sh
• Usage ./add_newline_to_php_files.sh /path/to/php/directory_of_scripts

How to resolve "Define and throw a dedicated exception instead of using a generic one"

Error condition which met "Define and throw a dedicated exception instead of using a generic one"

if(is_null($some_variable)){
            $error = 'The variable $some_variable is not defined.';
            throw new Exception($error);
        }

Possible solution

if(!is_null($some_variable)){
            $error = 'The variable $some_variable is not defined.';
            throw new InvalidArgumentException($error);
        }

How to resolve "Method visibility should be explicitly declared"

Possible solution

• Use a text editor that supports regular expressions
• Find: ^(\s+)(function)(\s)
• Replace with: $1public function$3

How to resolve "replace all tab characters in this file by sequences of white-spaces (Tabulation characters should not be used)"

Solution: Using the editor which supports regular expression

• Replace \t
• with (four whitespaces)

How to resolve "Refactor this function to reduce its Cognitive Complexity from XX to the 15 allowed."

Possible solution

• Created smaller, more specific functions (following Single Responsibility Principle) to handle specific parts of the logic. Use these secondary functions to make the main function easier to read and understand.
• Avoid nested conditionals
• Simplify boolean expressions

Unresolved issues

• SonarLint: Replace "require_once" with namespace import mechanism through the "use" keyword.

Further reading

• PHP: Exceptions - Manual
• PHP Exceptions 種類與使用情境說明 | Asika Lab 飛鳥實驗室
• Single-responsibility principle - Wikipedia
• Clean Code - SonarLint for IntelliJ

References

Troubleshooting of ...

• Troubleshooting of Excel errors

• PHP, cUrl, Python, selenium, HTTP status code errors

• Database: SQL syntax debug, MySQL errors, MySQLTuner errors or PostgreSQL errors

• Troubleshooting of regular expression

• HTML/Javascript: Troubleshooting of javascript, XPath

• Software: Mediawiki, Docker, FTP problems, online conference software

• Test connectivity for the web service, Web Ping, Network problem, Web user behavior, Web scrape troubleshooting

Template

• Bug report template