docs(readme): expand project details, features, and configuration #2
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| // This is a placeholder file to create the __tests__ directory. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,22 @@ | ||||||
| const { program } = require('../src/cli'); | ||||||
|
|
||||||
| describe('CLI Program', () => { | ||||||
| test('should have the correct name', () => { | ||||||
| expect(program.name()).toBe('repo-describer'); | ||||||
| }); | ||||||
|
|
||||||
| test('should have the correct version', () => { | ||||||
| expect(program.version()).toBe('1.0.0'); | ||||||
|
There was a problem hiding this comment. The version number is hardcoded. To avoid it getting out of sync with your project's version, it's better to import it directly from
Suggested change
|
||||||
| }); | ||||||
|
|
||||||
| test.skip('should execute the action correctly for local repo', async () => { | ||||||
| // This test would require mocking fs, child_process, and the imported functions | ||||||
| // from index.js (describeRepo, saveOutput, updateMarkdownMagicConfig). | ||||||
| // It would also involve simulating command-line arguments. | ||||||
| // For now, it's skipped. | ||||||
| }); | ||||||
|
|
||||||
| test.skip('should execute the action correctly for remote repo', async () => { | ||||||
| // Similar to the local repo test, but also involves mocking git clone. | ||||||
| }); | ||||||
| }); | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -207,4 +207,7 @@ module.exports = { | |
| describeRepo, | ||
| updateMarkdownMagicConfig, | ||
| saveOutput, | ||
| getAllFiles, | ||
| queryGroq, | ||
| sleep, | ||
| }; | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
:::notesyntax is not standard GitHub Flavored Markdown and will not render as a special admonition block. It will likely be displayed as a plain code block. For better compatibility and readability on GitHub, consider using a blockquote (>) for important notes.