Skip to content

Add Support for MarkDown Format #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kilo52 merged 2 commits into from
Jan 28, 2026
Merged

Add Support for MarkDown Format #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec346f0
Added support for MarkDown format.
kilo52 Jan 27, 2026
f5fef00
Improved wording.
kilo52 Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/lib/c/factories.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@ SourceFormatDetection detectSourceFormat(const RcnSourceFile* file) {
detection.isSupportedFormat = true;
detection.isProgrammingLanguage = true;
detection.format = RCN_LANG_JAVA;
} else if (strcmp(extension, "md") == 0) {
detection.isSupportedFormat = true;
detection.format = RCN_TEXT_MARKDOWN;
} else if (strcmp(extension, "txt") == 0) {
detection.isSupportedFormat = true;
detection.format = RCN_TEXT_UNFORMATTED;
Expand Down
11 changes: 8 additions & 3 deletions src/lib/include/reckon/reckon.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ extern "C" {
* The total number of supported text formats, including
* supported programming languages.
*/
#define RECKON_NUM_SUPPORTED_FORMATS 3
#define RECKON_NUM_SUPPORTED_FORMATS 4

/**
* Macro to create a format option bitmask.
Expand Down Expand Up @@ -140,15 +140,20 @@ typedef enum RcnTextFormat {
*/
RCN_TEXT_UNFORMATTED = 0,

/**
* Text formatted in Markdown, as found in files with a '.md' extension.
*/
RCN_TEXT_MARKDOWN = 1,

/**
* Source files for the C programming language.
*/
RCN_LANG_C = 1,
RCN_LANG_C = 2,

/**
* Source files for the Java programming language.
*/
RCN_LANG_JAVA = 2
RCN_LANG_JAVA = 3

} RcnTextFormat;

Expand Down
10 changes: 10 additions & 0 deletions src/lib/tests/res/mixed/text2.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

36 changes: 27 additions & 9 deletions src/lib/tests/unit/c/test_count_options.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ void testCountStatisticsOnlyJavaSources(void) {
TEST_ASSERT_EQUAL_INT(0, stats->sourceSize[RCN_TEXT_UNFORMATTED]);
TEST_ASSERT_EQUAL_INT(450, stats->sourceSize[RCN_LANG_JAVA]);
TEST_ASSERT_EQUAL_INT(0, stats->sourceSize[RCN_LANG_C]);
TEST_ASSERT_EQUAL_INT(3, stats->count.size);
TEST_ASSERT_EQUAL_INT(4, stats->count.size);
TEST_ASSERT_EQUAL_INT(1, stats->count.sizeProcessed);
RcnSourceFile* file = &stats->count.files[0];
TEST_ASSERT_EQUAL_STRING("Source.java", file->name);
Expand Down Expand Up @@ -272,7 +272,7 @@ void testCountStatisticsOnlyUnformattedTextSources(void) {
TEST_ASSERT_EQUAL_INT(122, stats->sourceSize[RCN_TEXT_UNFORMATTED]);
TEST_ASSERT_EQUAL_INT(0, stats->sourceSize[RCN_LANG_JAVA]);
TEST_ASSERT_EQUAL_INT(0, stats->sourceSize[RCN_LANG_C]);
TEST_ASSERT_EQUAL_INT(3, stats->count.size);
TEST_ASSERT_EQUAL_INT(4, stats->count.size);
TEST_ASSERT_EQUAL_INT(1, stats->count.sizeProcessed);
RcnSourceFile* file = &stats->count.files[2];
TEST_ASSERT_EQUAL_STRING("text.txt", file->name);
Expand Down Expand Up @@ -303,27 +303,32 @@ void testCountStatisticsAllOperationsWithAllDefaultOptions(void) {
TEST_ASSERT_EQUAL_INT(RCN_ERR_NONE, stats->state.errorCode);
TEST_ASSERT_NULL(stats->state.errorMessage);
TEST_ASSERT_EQUAL_INT(34, stats->totalLogicalLines);
TEST_ASSERT_EQUAL_INT(50, stats->totalPhysicalLines);
TEST_ASSERT_EQUAL_INT(104, stats->totalWords);
TEST_ASSERT_EQUAL_INT(941, stats->totalCharacters);
TEST_ASSERT_EQUAL_INT(941, stats->totalSourceSize);
TEST_ASSERT_EQUAL_INT(60, stats->totalPhysicalLines);
TEST_ASSERT_EQUAL_INT(129, stats->totalWords);
TEST_ASSERT_EQUAL_INT(1079, stats->totalCharacters);
TEST_ASSERT_EQUAL_INT(1079, stats->totalSourceSize);
TEST_ASSERT_EQUAL_INT(0, stats->logicalLines[RCN_TEXT_UNFORMATTED]);
TEST_ASSERT_EQUAL_INT(0, stats->logicalLines[RCN_TEXT_MARKDOWN]);
TEST_ASSERT_EQUAL_INT(16, stats->logicalLines[RCN_LANG_JAVA]);
TEST_ASSERT_EQUAL_INT(18, stats->logicalLines[RCN_LANG_C]);
TEST_ASSERT_EQUAL_INT(8, stats->physicalLines[RCN_TEXT_UNFORMATTED]);
TEST_ASSERT_EQUAL_INT(10, stats->physicalLines[RCN_TEXT_MARKDOWN]);
TEST_ASSERT_EQUAL_INT(21, stats->physicalLines[RCN_LANG_JAVA]);
TEST_ASSERT_EQUAL_INT(21, stats->physicalLines[RCN_LANG_C]);
TEST_ASSERT_EQUAL_INT(22, stats->words[RCN_TEXT_UNFORMATTED]);
TEST_ASSERT_EQUAL_INT(25, stats->words[RCN_TEXT_MARKDOWN]);
TEST_ASSERT_EQUAL_INT(39, stats->words[RCN_LANG_JAVA]);
TEST_ASSERT_EQUAL_INT(43, stats->words[RCN_LANG_C]);
TEST_ASSERT_EQUAL_INT(122, stats->characters[RCN_TEXT_UNFORMATTED]);
TEST_ASSERT_EQUAL_INT(138, stats->characters[RCN_TEXT_MARKDOWN]);
TEST_ASSERT_EQUAL_INT(450, stats->characters[RCN_LANG_JAVA]);
TEST_ASSERT_EQUAL_INT(369, stats->characters[RCN_LANG_C]);
TEST_ASSERT_EQUAL_INT(122, stats->sourceSize[RCN_TEXT_UNFORMATTED]);
TEST_ASSERT_EQUAL_INT(138, stats->sourceSize[RCN_TEXT_MARKDOWN]);
TEST_ASSERT_EQUAL_INT(450, stats->sourceSize[RCN_LANG_JAVA]);
TEST_ASSERT_EQUAL_INT(369, stats->sourceSize[RCN_LANG_C]);
TEST_ASSERT_EQUAL_INT(3, stats->count.size);
TEST_ASSERT_EQUAL_INT(3, stats->count.sizeProcessed);
TEST_ASSERT_EQUAL_INT(4, stats->count.size);
TEST_ASSERT_EQUAL_INT(4, stats->count.sizeProcessed);
RcnSourceFile* javaFile = &stats->count.files[0];
TEST_ASSERT_EQUAL_STRING("Source.java", javaFile->name);
TEST_ASSERT_EQUAL_INT(RCN_FILE_OP_OK, javaFile->status);
Expand All @@ -333,6 +338,9 @@ void testCountStatisticsAllOperationsWithAllDefaultOptions(void) {
RcnSourceFile* textFile = &stats->count.files[2];
TEST_ASSERT_EQUAL_STRING("text.txt", textFile->name);
TEST_ASSERT_EQUAL_INT(RCN_FILE_OP_OK, textFile->status);
RcnSourceFile* mdFile = &stats->count.files[3];
TEST_ASSERT_EQUAL_STRING("text2.md", mdFile->name);
TEST_ASSERT_EQUAL_INT(RCN_FILE_OP_OK, mdFile->status);
RcnCountResultGroup* javaResult = &stats->count.results[0];
TEST_ASSERT_TRUE(javaResult->isProcessed);
TEST_ASSERT_EQUAL_INT(16, javaResult->logicalLines);
Expand Down Expand Up @@ -363,6 +371,16 @@ void testCountStatisticsAllOperationsWithAllDefaultOptions(void) {
TEST_ASSERT_TRUE(textResult->state.ok);
TEST_ASSERT_EQUAL_INT(RCN_ERR_NONE, textResult->state.errorCode);
TEST_ASSERT_NULL(textResult->state.errorMessage);
RcnCountResultGroup* mdResult = &stats->count.results[3];
TEST_ASSERT_TRUE(mdResult->isProcessed);
TEST_ASSERT_EQUAL_INT(0, mdResult->logicalLines);
TEST_ASSERT_EQUAL_INT(10, mdResult->physicalLines);
TEST_ASSERT_EQUAL_INT(25, mdResult->words);
TEST_ASSERT_EQUAL_INT(138, mdResult->characters);
TEST_ASSERT_EQUAL_INT(138, mdResult->sourceSize);
TEST_ASSERT_TRUE(mdResult->state.ok);
TEST_ASSERT_EQUAL_INT(RCN_ERR_NONE, mdResult->state.errorCode);
TEST_ASSERT_NULL(mdResult->state.errorMessage);
rcnFreeCountStatistics(stats);
}

Expand Down Expand Up @@ -402,7 +420,7 @@ void testCountStatisticsOperationsWithExplicitOptions(void) {
TEST_ASSERT_EQUAL_INT(122, stats->sourceSize[RCN_TEXT_UNFORMATTED]);
TEST_ASSERT_EQUAL_INT(450, stats->sourceSize[RCN_LANG_JAVA]);
TEST_ASSERT_EQUAL_INT(0, stats->sourceSize[RCN_LANG_C]);
TEST_ASSERT_EQUAL_INT(3, stats->count.size);
TEST_ASSERT_EQUAL_INT(4, stats->count.size);
TEST_ASSERT_EQUAL_INT(2, stats->count.sizeProcessed);
RcnSourceFile* javaFile = &stats->count.files[0];
TEST_ASSERT_EQUAL_STRING("Source.java", javaFile->name);
Expand Down
3 changes: 3 additions & 0 deletions src/scount/c/print.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -447,6 +447,9 @@ static void prSummaryRows(
case RCN_TEXT_UNFORMATTED:
label = "Plain Text";
break;
case RCN_TEXT_MARKDOWN:
label = "Markdown";
break;
case RCN_LANG_C:
label = "C";
break;
Expand Down
7 changes: 5 additions & 2 deletions src/scount/tests/functionality/res/expected/mixed.txt
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions src/scount/tests/functionality/res/mixed/sample1.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions src/scount/tests/functionality/res/mixed/sample2.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.