oracle/opengrok

Can opengrok provide a code snippet function

Open

Aperta il 8 gen 2020

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Java (4060 star) (747 fork)batch import
UIenhancementhelp wanted

Descrizione

Is your feature request related to a problem? Please describe. I want to add code snippet in Wiki and Confluence page, but it always add a whole file.

like: url is https://jcat-opengrok/opengrok/snippet/p1/path/Cat.java#10-20 the output only include lines from 10 to 20. No other things. no head.

Describe the solution you'd like add a function: snippet.

Describe alternatives you've considered https://jcat-opengrok/opengrok/xref/p1/path/Cat.java#10-20

Additional context Used in the other tools. or use in Html file, for example in iFrame.

Guida contributor

Tech stack
java
Dominio
full stack
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
3-5 days
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
JavaOpenGrok architectureServlet programming
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
30
Direzione di ricerca
Investigate the existing xref servlet (e.g., XrefServlet.java) in the OpenGrok codebase to understand how it handles file display and line numbers. Look for any existing support for line range snippets. Then propose adding a new endpoint or modifying the existing one to return only the specified lines, ensuring it works with the existing URL pattern and supports iframe embedding. Review any linked issues or pull requests for prior attempts.