Skip to content

feat(package): Export executeAction to enable library to run the same way as CLI #354

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
yamadashy merged 1 commit into from
Feb 13, 2025
Merged

feat(package): Export executeAction to enable library to run the same way as CLI #354

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ export type { CliOptions } from './cli/types.js';
// Config
export type { RepomixConfigFile as RepomixConfig } from './config/configSchema.js';

// Execute action
export { executeAction } from './cli/cliRun.js';
Comment on lines +8 to +9
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Feb 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

❓ Verification inconclusive

Consider exporting type information for executeAction.

Since this is a TypeScript project, it would be beneficial to export the type definition for executeAction to ensure type safety for library consumers.

Let's check if type definitions exist:

🏁 Script executed:

#!/bin/bash
# Search for type definitions of executeAction
ast-grep --pattern 'export type $name = $$$' ./cli/cliRun.ts
ast-grep --pattern 'type $name = $$$' ./cli/cliRun.ts
ast-grep --pattern 'interface $name { $$$}' ./cli/cliRun.ts

Length of output: 369

Action Required: Export Type Information for executeAction

The current export in src/index.ts re-exports executeAction from ./cli/cliRun.js, but our investigation did not locate any corresponding type definitions—our search for definitions in ./cli/cliRun.ts returned file not found errors. To improve type safety for consumers of this library, please consider one of the following:

  • Create and export a dedicated type definition (for example, in a cliRun.d.ts file),
  • Or add inline JSDoc/type annotations for executeAction in cliRun.js and update the exports accordingly.

Please verify that the consumers will receive accurate type information once these changes are applied.


// Init action
export { runInitAction } from './cli/actions/initAction.js';

Expand Down