You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I am working on integrating the repurposed fprime-fpp-format PIP package with fprime-util format though this alias is conflicting with the other fpp-format executable in the new PIP package.
@bocchino You mentioned updating the user's guide to point to this tool as well, would you like to do that in this PR? I think I'll need an alpha to validate the full pipeline doesn't break before we merge this.
Update August 14, 2026: This PR will now address issue #1073.
You mentioned updating the user's guide to point to this tool as well, would you like to do that in this PR?
This needs some more thought. The existing fpp-format tool is used for internal testing of the FPP tools and the F Prime Python model. So we can't just abandon that tool. We should consider renaming it. I'm concerned that if we make fpp-format mean one thing in the user-facing tools and another thing in the developer-facing tools, it will be confusing.
@Kronos3 I believe you suggested fpp-to-fpp as an alternate name. I think this is reasonable. I'm also seeing a use case for this in the F Prime Python model testing, where to generate reference output we need to introduce the auto-generated syntax for state machine enums. This tool is also useful for showing what the source files look like after expanding include specifiers. And, if this isn't already done, we can extend it to expanding templates.
My current thinking is that we should (1) rename fpp-format in this repo and in the exported tools to fpp-to-fpp and (2) update the User's Guide to match. Then formatting FPP won't be handled by this repo at all. It can be handled by the fpp-tools repo. I don't think we need to document fpp-tools in the FPP User's Guide. I think fpp-tools can have its own docs. However, we should point users to fpp-tools and its docs in the README of this repo and in the User's Guide. The README already points to the VS Code plugin. We could also refer to the plugin in the User's Guide. Is there any more we need to do to point users to the tools?
Kronos3
changed the title
Remove fpp-format alias for 'fpp format'
Rename fpp-format to fpp-to-fpp
Aug 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I am working on integrating the repurposed
fprime-fpp-formatPIP package withfprime-util formatthough this alias is conflicting with the otherfpp-formatexecutable in the new PIP package.@bocchino You mentioned updating the user's guide to point to this tool as well, would you like to do that in this PR? I think I'll need an alpha to validate the full pipeline doesn't break before we merge this.
Update August 14, 2026: This PR will now address issue #1073.