Support "Format Selection" now that Black 23.11.0 adds a --line-ranges= CLI option.

[yilei]

psf/black#4020 added a --line-ranges= option to Black and is now released in 23.11.0. See https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#line-ranges

VS Code should now be able to properly support the "Format Selection" command.

Previously related: #176

[karthiknadig]

@yilei If you are interested in providing a PR we are open for this. This code here needs to be updated to pass in the line range.

vscode-black-formatter/bundled/tool/lsp_server.py

Lines 105 to 111 in b4c4735

	@LSP_SERVER.feature(lsp.TEXT_DOCUMENT_RANGE_FORMATTING)
	def range_formatting(params: lsp.DocumentFormattingParams) -> list[lsp.TextEdit] | None:
	"""LSP handler for textDocument/formatting request."""
	log_warning("Black does not support range formatting. Formatting entire document.")
	document = LSP_SERVER.workspace.get_text_document(params.text_document.uri)
	return _formatting_helper(document)

There is also proposed support for multiple line ranges via format ranges. That support is still not in pygls, that will allow us to add the multi-range support as well.

[yilei]

Thanks for the pointer. Any pointers how to build my local version of the extension and have VS Code use it? The Contributing Guide doesn't mention this.

[karthiknadig]

You can run this to build it locally:

> npm run package

[karthiknadig]

I also update the contributing guide. The requirements were a bit out dated.

[yilei]

@karthiknadig Thanks for updating. But I think the correct command to build the vsix package is npm run vsce-package, took me a while to poke around the source since I'm not familiar with npm.

[karthiknadig]

@yilei Were you able to add this support?

[yilei]

@karthiknadig I'm able to make it work, but I had a hard time writing tests and make the tests run. Should I still send the PR without tests?

[karthiknadig]

Yes. I can help with tests.