Add formatting command and "format on save" #21
Conversation
| { | ||
| "title": "Format Elm", | ||
| "command": "elm.format", | ||
| "shortcut": "opt-shift-f", |
There was a problem hiding this comment.
I've seen this used by a couple of extensions now. Happy to change it.
| @@ -34,6 +34,7 @@ | |||
| "@types/nova-editor-node": "^4.1.3", | |||
| "@typescript-eslint/eslint-plugin": "^4.28.5", | |||
| "@typescript-eslint/parser": "^4.28.5", | |||
| "elm-format": "^0.8.5", | |||
There was a problem hiding this comment.
To test formatting locally.
| const config = nova.workspace.config; | ||
| const defaultProcess = new Process("elm-format"); | ||
|
|
||
| const configPath = config.get(`${identifier}.elmFormatPath`, "string"); | ||
| if (!configPath || configPath.trim() === "") { | ||
| const message = | ||
| "Please provide an elm-format executable in Project Settings to enable formatting."; | ||
| reject(message); | ||
| return defaultProcess; | ||
| } | ||
| const elmFormatPath = nova.path.expanduser(configPath); |
There was a problem hiding this comment.
There's definitely a more robust version of this which we could switch to if you want more automatic path finding (based on the node-modules path, for example) but I started here first.
| return new Promise<string>((resolve, reject) => { | ||
| try { | ||
| const process = setUpProcess(reject); | ||
| let buffer: Buffer = { stdout: "", stderr: "" }; |
There was a problem hiding this comment.
Two string arrays would also be fine if this feels to weird.
| const config = nova.workspace.config; | ||
| const formatOnSave = config.get(`${identifier}.formatOnSave`, "boolean"); | ||
| if (formatOnSave === true) { |
There was a problem hiding this comment.
Again, I'm assuming some things here for convenience.
| }; | ||
|
|
||
| const writeToStdin = (process: Process, inputText: string) => { | ||
| const writer = (process.stdin as any).getWriter(); |
There was a problem hiding this comment.
I could not, for the life of me, get around this. A WriteableStream is typed as unknown so I had to just convert it to any 😞
There was a problem hiding this comment.
Yeah I've been stuck on these crappy *Stream types exported by Nova. On my Nix extension, I had to format the file on disk rather than in-memory. Less than ideal but I figured something now is better than nothing given that it could easily be updated later.
There was a problem hiding this comment.
Ah gotcha. When I tried that it moved the cursor to the end of the document which was frustrating. Hopefully that's avoidable.
|
@edwardloveall Thanks a ton for this! I'll take a look later tonight. I've been in the middle of a branch getting ElmLS setup so hopefully that will land soon. |
|
@edwardloveall I'll take the code as-is. You'll need to run |
|
Thanks @hansjhoffman! I pushed the build files. |
|
@edwardloveall Before I merge this, I just want to double check that is isn't introducing the problem where the Nova editor shows the document as dirty after the |
|
Funny you should ask because this is what got me onto this pattern (with the returning promises) in the first place. It does not because if you return a Promise to I wrote up more about that here |
Awesome. I missed that part of the type signature Thank you so much for your contribution and teaching me! I will merge your code and push a new release which should be available tomorrow morning at the latest. If you find any bugs or have any feature requests please let me know. Also, should you ever need help on any of your extension work and would like a second set of eyes, just ping me. |
I'm fresh off adding a formatter to my crystal-lang extension so I figured I'd take a try at adding a formatter for this.