Unconditionally generate C# classes with nullable reference types

[0xced]

Fixes #3944

[baywet]

holding until we get to a consensus on the issue

[petriashev]

Waiting for this in kiota.
Too much noise

[dersia]

what is this still waiting for?

[Odonno]

I am not sure what consensus is needed. Not wanted to look particularly disrespectful but having a strongly typed generated client should be common sense. Can we accelerate on this issue?

[Cyberzim]

@baywet
It's been over a year now. Why has this not reached a verdict yet? I really like the Kiota tool for C#, but the conditional code is making the generated code hard to read.

For now, I have created this bash script for cleaning up the output of Kiota in case anyone else needs it.

#!/bin/bash
# Script for cleaning up .cs files generated by Kiota.
# Basically, this is a workaround for https://github.com/microsoft/kiota/pull/3945 to make the code a bit more readable.

target_dir="${1:-.}"
echo "Processing .cs files in: $target_dir"

# Counters for reporting
total_files=0
modified_files=0

# Process all .cs files recursively
while read -r file; do
    total_files=$((total_files + 1))

    # Create a temporary file for processing
    temp_file=$(mktemp)

    # State variables for tracking position in the file
    has_nullable_directive=0
    in_if_block=0
    in_nullable_code=0
    in_else_block=0
    line_count=0
    in_using_section=0

    # Process the file line by line
    while IFS= read -r line || [[ -n "$line" ]]; do
        line_count=$((line_count + 1))

        if [[ $line =~ ^[[:space:]]*using[[:space:]]+ ]]; then
            # Using section
            in_using_section=1
            echo "$line" >> "$temp_file"
            continue
        elif [[ $in_using_section -eq 1 && has_nullable_directive -eq 0 ]]; then
            # Add nullable directive after using section
            echo "#nullable enable" >> "$temp_file"
            has_nullable_directive=1
            echo "$line" >> "$temp_file"
            continue
        elif [[ $in_if_block -eq 0 && $line =~ ^[[:space:]]*#if[[:space:]]+NETSTANDARD2_1_OR_GREATER[[:space:]]+\|\|[[:space:]]+NETCOREAPP3_1_OR_GREATER ]]; then
            # Found the start of a conditional block
            in_if_block=1
            continue
        elif [[ $in_if_block -eq 1 && $line =~ ^[[:space:]]*#nullable[[:space:]]+enable ]]; then
            # Found the nullable enable directive
            in_nullable_code=1
            continue
        elif [[ $in_nullable_code -eq 1 && $line =~ ^[[:space:]]*#nullable[[:space:]]+restore ]]; then
            # End of nullable code section
            in_nullable_code=0
            continue
        elif [[ $in_if_block -eq 1 && $in_nullable_code -eq 0 && $line =~ ^[[:space:]]*#else ]]; then
            # Found the else block - skip everything until endif
            in_else_block=1
            continue
        elif [[ ($in_if_block -eq 1 || $in_else_block -eq 1) && $line =~ ^[[:space:]]*#endif ]]; then
            # End of conditional block
            in_if_block=0
            in_else_block=0
            continue
        elif [[ $in_nullable_code -eq 1 ]]; then
            # Inside nullable code - keep this line
            echo "$line" >> "$temp_file"
        elif [[ $in_else_block -eq 1 ]]; then
            # Inside else block - skip this line
            continue
        else
            # Regular line - write to temp file
            echo "$line" >> "$temp_file"
        fi
    done < "$file"

    # Check if file was modified
    if ! cmp -s "$file" "$temp_file"; then
        modified_files=$((modified_files + 1))
        mv "$temp_file" "$file"
        echo "Modified: $file"
    else
        rm "$temp_file"
    fi
done < <(find "$target_dir" -type f -name "*.cs")

echo "Completed processing $total_files files. Modified $modified_files files."

Note: Use at your own risk. I have tested it on the Keycloak Admin REST API client generated by Kiota, and it seems to work well.

[Odonno]

@baywet It's been over a year now. Why has this not reached a verdict yet? I really like the Kiota tool for C#, but the conditional code is making the generated code hard to read.

For now, I have created this bash script for cleaning up the output of Kiota in case anyone else needs it.

#!/bin/bash
# Script for cleaning up .cs files generated by Kiota.
# Basically, this is a workaround for https://github.com/microsoft/kiota/pull/3945 to make the code a bit more readable.

target_dir="${1:-.}"
echo "Processing .cs files in: $target_dir"

# Counters for reporting
total_files=0
modified_files=0

# Process all .cs files recursively
while read -r file; do
    total_files=$((total_files + 1))

    # Create a temporary file for processing
    temp_file=$(mktemp)

    # State variables for tracking position in the file
    has_nullable_directive=0
    in_if_block=0
    in_nullable_code=0
    in_else_block=0
    line_count=0
    in_using_section=0

    # Process the file line by line
    while IFS= read -r line || [[ -n "$line" ]]; do
        line_count=$((line_count + 1))

        if [[ $line =~ ^[[:space:]]*using[[:space:]]+ ]]; then
            # Using section
            in_using_section=1
            echo "$line" >> "$temp_file"
            continue
        elif [[ $in_using_section -eq 1 && has_nullable_directive -eq 0 ]]; then
            # Add nullable directive after using section
            echo "#nullable enable" >> "$temp_file"
            has_nullable_directive=1
            echo "$line" >> "$temp_file"
            continue
        elif [[ $in_if_block -eq 0 && $line =~ ^[[:space:]]*#if[[:space:]]+NETSTANDARD2_1_OR_GREATER[[:space:]]+\|\|[[:space:]]+NETCOREAPP3_1_OR_GREATER ]]; then
            # Found the start of a conditional block
            in_if_block=1
            continue
        elif [[ $in_if_block -eq 1 && $line =~ ^[[:space:]]*#nullable[[:space:]]+enable ]]; then
            # Found the nullable enable directive
            in_nullable_code=1
            continue
        elif [[ $in_nullable_code -eq 1 && $line =~ ^[[:space:]]*#nullable[[:space:]]+restore ]]; then
            # End of nullable code section
            in_nullable_code=0
            continue
        elif [[ $in_if_block -eq 1 && $in_nullable_code -eq 0 && $line =~ ^[[:space:]]*#else ]]; then
            # Found the else block - skip everything until endif
            in_else_block=1
            continue
        elif [[ ($in_if_block -eq 1 || $in_else_block -eq 1) && $line =~ ^[[:space:]]*#endif ]]; then
            # End of conditional block
            in_if_block=0
            in_else_block=0
            continue
        elif [[ $in_nullable_code -eq 1 ]]; then
            # Inside nullable code - keep this line
            echo "$line" >> "$temp_file"
        elif [[ $in_else_block -eq 1 ]]; then
            # Inside else block - skip this line
            continue
        else
            # Regular line - write to temp file
            echo "$line" >> "$temp_file"
        fi
    done < "$file"

    # Check if file was modified
    if ! cmp -s "$file" "$temp_file"; then
        modified_files=$((modified_files + 1))
        mv "$temp_file" "$file"
        echo "Modified: $file"
    else
        rm "$temp_file"
    fi
done < <(find "$target_dir" -type f -name "*.cs")

echo "Completed processing $total_files files. Modified $modified_files files."

Note: Use at your own risk. I have tested it on the Keycloak Admin REST API client generated by Kiota, and it seems to work well.

Got to write a dumbed .csx script too. Guess I could move to dotnet shebang now.