`nufmt` roadmap

[AucaCoyan]

We have the repo in the nushell org 🍾 . Now we need more structure to keep moving forward.
As we work in issues and features, we can edit the list.

⚠️ restructure the project

Because of the new-nu-parser coming, and the issue with DeclIds we need to restructure a lot of the parser as it is today.
I don't know how long this is going to be, but we have to have some patience. Let me investigate until I can plan what to do and when 📆

❗ TODO

• ⚠ resolve all the FlatShapes in Checklist of format #13 (see above)
  • Cover flatshapes #35
  • there are still some missing shapes
• with the file formatted as (--minified), we need to add the indentation
• make configurable with Config struct
• limit the max characters to Config
• and endings of ;, if they are relevant to nushell logic (delete them if they are unnecessary, like python)
• option to write the files in place or output another file
• Format reports are nice. Add them!
• public the cargo package
• add the nixpkg auto-publish workflow
• Make it available as a GitHub Action
• add some ignore comment (# nufmt ignore)

✅ Done:

• make clippy happy
  • make clippy happy and add a github workflow #12
• accept to format a string, not just files.
  • CLI now accepts strings as stdin #15
• clean /examples/ folder and move them into tests. Add benchmarks
  • ✅ restore testing, add CI workflow and README.md #16
• adjust README.md
  • add the supported nu version
  • add badges
  • ✅ restore testing, add CI workflow and README.md #16
• Make the formatter keep comments #17
  • make nufmt keep the comments #18
• check if the last line is a new line and, if false, add one.
  • ✨ add check if its missing a newline at EOF #28
• examine the input path: Is it a file? format it. Is it a directory? format the .nu files and skip the other files
  • Format directory #47

[ItsHarper]

Given the slow progress of nufmt, does it make sense to adopt topiary-nushell as nufmt for now? Once it's ready, this codebase could replace it down the line (similar to the plan for https://github.com/nushell/new-nu-parser), as using the real nu engine is undoubtedly more powerful.

See also blindFS/topiary-nushell#37

[fdncred]

I recommend topiary-nushell frequently because it's so good right now. However, I'm not sure I'd adopt it as the official one because it does not use the nushell parser. It uses tree-sitter which nushell does not use. So, there's a chance these two parsers could/do diverge. I'm sure there are already things that are implemented in either parser that the other doesn't really support right now.

What we need is more contributors to nufmt.

[blindFS]

What we need is more contributors to nufmt.

Agreed, but new-nu-parser is of higher priority IMHO.

[fdncred]

Agreed, but new-nu-parser is of higher priority IMHO.

Ya, you're probably right since nushell's parser isn't lossless. All it takes is a dedicated few to finish it and start implementing it.

[trymeouteh]

I have 2 questions on nufmt

1. Will it indent using tabs or will there be an option to use tabs instead of spaces?
2. Will nufmt also format .nuon files?