lincc-frameworks / lincc-frameworks/jump-starter

Handle code indenting

Open
#9 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Currently indenting needs to be done by the user, where each snipped must be correctly indented for where it is placed. This can lead to both confusion on the user forgetting what indent level the snippet they are writing is at, and the user needs to do their own indenting in the yaml file which is annoying and very hard to edit (manually adding spaces on each line). It also means a snippet cannot be used at different indents, e.g. if different branches of the tree lead to different indent levels.

It would be good to handle indents automatically, some kind of keeping track of the current indent level and adding it to the lines in the snippet inserted.

Contributor guide

No contributing guide indexed for this repository

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

No file or test entry point is named. Start by locating where snippets are inserted into the YAML file and how the current tree indent level is available; done means the same snippet is automatically indented correctly at different branch depths without manual spacing.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.