ITensor / ITensor/ITensorFormatter.jl

Add option to print formatted text to `stdout`.

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

Nobody has claimed this yet.

enhancement
Dominant language
Julia
Stars
0
Forks
1
Avg merge
23m
Merged PRs (30d)
1

Description

Some IDE formatting plugins expect a given CLI formatter to output the formatted text to stdout. This allows one to skip creating a temporary file when e.g. formatting on save when using these plugins. Therefore, it would be useful to have a mode for itfmt that reads from stdin, formats the text, and then prints to stdout. Runic can be used this way by executing runic without any arguments, for example.

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

Start by locating the itfmt CLI entry point and inspect how it currently accepts input files. Compare the no-argument stdin/stdout behavior of Runic, then define the equivalent formatted-text flow for itfmt. Done means text piped into itfmt is formatted and emitted on stdout without requiring a temporary file.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.