Skip to content
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.

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

Implement File Reference in Assertions #6

Open
kdunee opened this issue Nov 4, 2024 · 0 comments
Open

Implement File Reference in Assertions #6

kdunee opened this issue Nov 4, 2024 · 0 comments
Labels
enhancement New feature or request
Milestone

Comments

@kdunee
Copy link
Owner

kdunee commented Nov 4, 2024

Why:

  • Currently, IntentGuard only supports Python code objects (methods, classes, etc.) as the target of assertions.
  • Users need a way to apply assertions to entire files, especially for broader code quality checks or when analyzing non-Python files.
  • This feature will make IntentGuard more versatile and applicable to a wider range of use cases.

What:

  • Extend the assert_code function to accept a file path as an argument.
  • Modify the prompt engineering logic to handle file-level analysis, considering different file types (e.g., Python, JSON, YAML) and potentially large file sizes.
  • Update documentation and examples to include file reference usage.
  • Add unit tests to cover the new functionality, including tests for various file types and sizes.

Acceptance Criteria:

  • Users can provide a file path to the assert_code function.
  • IntentGuard can successfully analyze the provided file and apply the assertion.
  • The system handles different file types (e.g., Python, JSON, YAML) appropriately.
  • Documentation and examples are updated to reflect the new feature.
  • Unit tests cover the file reference functionality and ensure correctness for various file types and sizes.
@kdunee kdunee added the enhancement New feature or request label Nov 4, 2024
@kdunee kdunee added this to the v1.4.0 milestone Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant