REditorSupport / REditorSupport/vscode-R

Highlight "do not edit by hand" in scripts

Open
#924 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature-request stale
Dominant language
TypeScript
Stars
1.2k
Forks
139
Avg merge
2h 46m
Merged PRs (30d)
5

Description

I was wondering if it could be possible to add a banner or at least highlight text "do not edit by hand" that appears on top of R/Rmd files so that the user can identify files in Read-only mode.

That would be useful for NAMESPACE file for instance when developing packages, that gets this lines automatically with {roxygen2}

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how the VS Code extension handles R and Rmd files, with the generated NAMESPACE file as the concrete example. Decide whether a banner or highlighted warning is appropriate, then verify that files containing “do not edit by hand” are visibly identified as read-only.

Written by the indexing model from the issue text.

Assessment

Tech stack
r, vscode
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.