oracle/opengrok

Can opengrok provide a code snippet function

Open

#3,015 opened on Jan 8, 2020

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Java (747 forks)batch import
UIenhancementhelp wanted

Repository metrics

Stars
 (4,060 stars)
PR merge metrics
 (PR metrics pending)

Description

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

Research direction
Investigate how to add a new endpoint that returns a code snippet (specific lines) from a file. Look into the current xref handler to understand how file content is served, then create a new snippet handler that extracts the requested lines and returns them as plain text or HTML.
Tech stack
java
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Javaweb development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50