oracle/opengrok

Can opengrok provide a code snippet function

Open

#3.015 geöffnet am 8. Jan. 2020

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Java (4.060 Stars) (747 Forks)batch import
UIenhancementhelp wanted

Beschreibung

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.

Contributor Guide

Tech Stack
java
Domain
full stack
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
3-5 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
JavaOpenGrok architectureServlet programming
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
30
Research-Richtung
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.