Enhance LLM integration and improve documentation and functionality#20
Open
roshansamantaray wants to merge 42 commits intoCROSSINGTUD:mainfrom
Open
Enhance LLM integration and improve documentation and functionality#20roshansamantaray wants to merge 42 commits intoCROSSINGTUD:mainfrom
roshansamantaray wants to merge 42 commits intoCROSSINGTUD:mainfrom
Conversation
…M explanations, and add CLI toggle for generated content
…into feature/rag‐template‐processor
…essor Feature/rag‐template‐processor
…d/collapse functionality for tree views
…provement Feature/predicate tree improvement
…tual environment paths in LLMService
…ts for cache management
… README and environment configurations, and remove deprecated files
…steps for LLM features and API key configuration
…d references in README
…n example generation, update README, and implement rate limiting for gateway requests.
…M features, update documentation, and add tests for cache directory resolution
…model in code, and improve cache file deletion script to handle disabled explanations.
Feat/gateway backend
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This pull request introduces several improvements to project configuration, documentation, and LLM integration. The most significant changes include upgrading the Java version and enabling advanced null analysis, expanding IDE and build tool configuration for better compatibility, providing a comprehensive new README, and adding support for insecure Java code example generation via LLM. The changes are grouped below by theme.
Project configuration and build improvements:
.classpathand.settings/org.eclipse.jdt.core.prefs, enabling modern language features and stricter null analysis. [1] [2].classpathentries for generated sources, test resources, and annotation processing..projectto ignorenode_modules,.git, and Java language server artifacts, reducing IDE clutter..vscode/settings.jsonfor automatic null analysis and Python environment configuration, improving cross-language development experience.Documentation and developer experience:
README.mdwith a comprehensive guide covering project structure, prerequisites, build/run instructions, CLI usage, LLM setup, output directories, and test commands..env.examplefor LLM API key and backend configuration, clarifying required environment variables for OpenAI and Gateway integration.LLM integration and code generation:
llm/llm_code_writer_insecure.py, a Python script for generating insecure Java code examples from CrySL rules using OpenAI or Gateway LLM backends, including robust prompt construction and backend selection logic..run/CrySLDoc Generation.run.xmlfor IDE-based execution of the documentation generator with LLM and template paths preconfigured.Project configuration upgrades:
.classpathand.settings/org.eclipse.jdt.core.prefs. [1] [2].classpathfor generated sources and test resources..projectto ignore common folders likenode_modulesand.git..vscode/settings.jsonfor Java null analysis and Python environment configuration.Documentation improvements:
README.mdwith a detailed setup, usage, and troubleshooting guide for Java and Python components, LLM integration, and CLI options..env.examplefor LLM API key and backend configuration.LLM and code generation enhancements:
llm/llm_code_writer_insecure.pyfor generating insecure Java code examples via LLM, with backend selection and prompt logic..run/CrySLDoc Generation.run.xmlfor IDE run configuration with LLM and template paths.