Create a new command databricks labs ucx lint-local-code

[jimidle]

A new command is created within the ucx cli that allows linting of local python files and local notebooks.

databricks labs ucx lint-local-code

Will prompt to ask if all files in the current directory and child directories should be linted. Upon confirmation, the
local python files and notebooks will be discovered and advisories will be raised for any issues identified.

Changes

Linked issues

Resolves #1541

Functionality

• added relevant user documentation
• added new CLI command
• modified existing command: databricks labs ucx ...
• added a new workflow
• modified existing workflow: ...
• added a new table
• modified existing table: ...

Tests

• manually tested
• added unit tests
• added integration tests
• verified on staging environment (screenshot attached)

[codecov]

Codecov Report

Attention: Patch coverage is 43.75000% with 27 lines in your changes are missing coverage. Please review.

Project coverage is 89.38%. Comparing base (ad1e2d9) to head (5a77bc7).

❗ Current head 5a77bc7 differs from pull request most recent head 386ee97. Consider uploading reports for the commit 386ee97 to get more accurate results

Files	Patch %	Lines
src/databricks/labs/ucx/source_code/files.py	33.33%	24 Missing and 2 partials ⚠️
src/databricks/labs/ucx/contexts/cli_command.py	75.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##           main    #1594       +/-   ##
=========================================
+ Coverage      0   89.38%   +89.38%     
=========================================
  Files         0       79       +79     
  Lines         0    10296    +10296     
  Branches      0     1820     +1820     
=========================================
+ Hits          0     9203     +9203     
- Misses        0      722      +722     
- Partials      0      371      +371     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[nfx]

@ericvergnaud do it based on

ucx/src/databricks/labs/ucx/source_code/notebooks/sources.py

Lines 111 to 154 in 1ae345a

	class FileLinter:
	_EXT = {
	'.py': Language.PYTHON,
	'.sql': Language.SQL,
	}
	def __init__(self, langs: Languages, path: Path):
	self._languages: Languages = langs
	self._path: Path = path
	@cached_property
	def _content(self) -> str:
	return self._path.read_text()
	def _file_language(self):
	return self._EXT.get(self._path.suffix)
	def _is_notebook(self):
	language = self._file_language()
	if not language:
	return False
	cell_language = CellLanguage.of_language(language)
	return self._content.startswith(cell_language.file_magic_header)
	def lint(self) -> Iterable[Advice]:
	if self._is_notebook():
	yield from self._lint_notebook()
	else:
	yield from self._lint_file()
	def _lint_file(self):
	language = self._file_language()
	if not language:
	yield Failure("unsupported-language", f"Cannot detect language for {self._path}", 0, 0, 1, 1)
	try:
	linter = self._languages.linter(language)
	yield from linter.lint(self._content)
	except ValueError as err:
	yield Failure("unsupported-language", str(err), 0, 0, 1, 1)
	def _lint_notebook(self):
	notebook = Notebook.parse(self._path, self._content, self._file_language())
	notebook_linter = NotebookLinter(self._languages, notebook)
	yield from notebook_linter.lint()

[ericvergnaud]

superseded by #1710 because the source branch is jim's and needs massive rebase

[nfx]

closing as per last comment