Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve error when commands need an initialized workspace #1193

Merged
merged 3 commits into from
Nov 21, 2024
Merged

Improve error when commands need an initialized workspace #1193

merged 3 commits into from
Nov 21, 2024

Conversation

brynary
Copy link
Member

@brynary brynary commented Nov 20, 2024

No description provided.

@qltysh qltysh
Copy link
Contributor

qltysh bot commented Nov 20, 2024 •
edited
Loading

The code coverage on the diff in this pull request is 16.1%

Drilldown
Path File Coverage Δ
qlty-smells/src/metrics/metrics/lcom.rs 99.6
qlty-analysis/src/workspace_entries/diff_source.rs 0.0
qlty-analysis/src/workspace_entries/matchers.rs 64.3
qlty-analysis/src/lang/rust.rs 81.2
qlty-analysis/src/lang.rs 75.4
qlty-coverage/src/parser/cobertura.rs 100.0
qlty-check/src/patcher.rs 91.4
qlty-smells/src/duplication/visitor.rs 89.7
qlty-cli/src/commands/smells.rs 0.0
qlty-check/src/executor/invocation_result.rs 0.0
qlty-analysis/src/lang/typescript_common.rs 89.9
qlty-check/src/tool/github.rs 24.0
qlty-config/src/library.rs 57.1
qlty-cli/src/commands/coverage/publish.rs 0.0
qlty-analysis/src/lang/typescript.rs 98.0
qlty-check/src/parser/trivy_sarif.rs 99.3
qlty-coverage/src/formats.rs 0.0
qlty-cli/src/shell/bash.rs 0.0
qlty-cli/src/commands/docs.rs 0.0
qlty-cli/src/telemetry/sanitize.rs 98.3
qlty-coverage/src/parser/simplecov.rs 96.5
qlty-analysis/src/lang/javascript.rs 85.2
qlty-cli/src/arguments.rs 0.0
qlty-config/src/user.rs 0.0
qlty-config/src/migration/classic.rs 0.0
qlty-check/src/tool/php.rs 52.4
qlty-cli/src/initializer/scanner/gemfile.rs 96.9
qlty-cli/src/commands/init.rs 0.0
qlty-check/src/ui.rs 66.2
qlty-smells/src/metrics/planner.rs 0.0
qlty-check/src/planner/invocation_plan.rs 0.0
qlty-cli/src/commands/metrics.rs 0.0
qlty-check/src/planner/driver.rs 0.0
qlty-check/src/tool/php/composer.rs 95.5
qlty-check/src/tool/runnable_archive.rs 0.0
qlty-cli/src/telemetry/segment.rs 0.0
qlty-analysis/src/walker.rs 100.0
qlty-config/src/migration/prepare.rs 0.0
qlty-coverage/src/git.rs 0.0
qlty-coverage/src/ci/codefresh.rs 96.7
qlty-check/src/executor/staging_area.rs 48.0
qlty-coverage/src/transformer.rs 0.0
qlty-smells/src/duplication/format.rs 0.0
qlty-check/src/planner/invocation_directory.rs 95.8
qlty-cli/src/logging.rs 0.0
qlty-cli/src/commands/auth/login.rs 0.0
qlty-config/src/migration.rs 0.0
qlty-analysis/src/utils.rs 100.0
qlty-check/src/planner/document_url_generator.rs 54.8
qlty-check/src/executor.rs 0.0
qlty-check/src/tool.rs 83.6
qlty-check/src/settings.rs 47.9
qlty-cli/src/commands/auth.rs 0.0
qlty-cli/src/commands/validate.rs 0.0
qlty-cli/src/ui/steps.rs 0.0
qlty-smells/src/duplication/transformers.rs 0.0
qlty-cloud/src/format/protos.rs 0.0
qlty-cli/src/initializer/sources.rs 36.4
qlty-check/src/tool/node/package_json.rs 99.0
qlty-check/src/planner/level_filter.rs 0.0
qlty-coverage/src/ci/circleci.rs 96.3
qlty-analysis/src/cache.rs 70.4
qlty-cli/src/errors.rs 0.0
qlty-analysis/src/code/query.rs 79.7
qlty-check/src/parser/taplo.rs 0.0
qlty-analysis/src/code/filter.rs 95.1
qlty-cli/src/commands/upgrade.rs 0.0
qlty-cli/src/shell/zsh.rs 0.0
qlty-check/src/tool/ruby/sys/windows.rs 0.0
qlty-check/src/report.rs 0.0
qlty-check/src/patch_builder.rs 98.1
qlty-check/src/parser/radarlint.rs 98.5
qlty-check/src/planner/source_extractor.rs 77.9
qlty-config/src/workspace.rs 42.1
qlty-cli/src/shell.rs 0.0
qlty-analysis/src/git/upstream.rs 0.0
qlty-cli/src/commands/auth/whoami.rs 0.0
qlty-coverage/src/parser/qlty.rs 100.0
qlty-cli/src/commands/plugins/list.rs 0.0
qlty-coverage/src/transform/settings.rs 0.0
qlty-smells/src/structure/checks/parameters.rs 100.0
qlty-check/src/parser/rubocop.rs 94.2
qlty-coverage/src/ci.rs 0.0
qlty-coverage/src/transform/processor.rs 0.0
qlty-coverage/src/parser/jacoco.rs 90.6
qlty-analysis/src/lang/python.rs 90.4
qlty-check/src/tool/java.rs 0.0
qlty-check/src/tool/ruby/gemfile.rs 97.8
qlty-cli/src/commands/fmt.rs 0.0
qlty-cloud/src/format/gz.rs 0.0
qlty-check/src/planner/check_filters.rs 0.0
qlty-cloud/src/export/analysis.rs 0.0
qlty-smells/src/structure/checks/boolean_logic.rs 92.8
qlty-cli/src/success.rs 0.0
qlty-cli/src/commands/parse.rs 0.0
qlty-analysis/src/lang/go.rs 91.9
qlty-coverage/src/publish/report.rs 0.0
qlty-check/src/parser/pylint.rs 0.0
qlty-coverage/src/env.rs 0.0
qlty-cli/src/upgrade.rs 0.0
qlty-smells/src/structure/checks.rs 92.3
qlty-cli/src/commands/dashboard.rs 0.0
qlty-coverage/src/ci/gitlab.rs 0.0
qlty-smells/src/duplication/settings.rs 0.0
qlty-coverage/src/ci/github.rs 93.9
qlty-check/src/parser/bandit.rs 99.3
qlty-cli/src/commands/panic.rs 0.0
qlty-coverage/src/publish/upload.rs 0.0
qlty-smells/src/metrics/settings.rs 0.0
qlty-cli/src/lib.rs 0.0
qlty-smells/src/structure/checks/file_complexity.rs 100.0
qlty-smells/src/structure/checks/nested_control.rs 97.7
qlty-cloud/src/format/json_each.rs 0.0
qlty-config/src/config.rs 27.9
qlty-cli/src/commands/install.rs 0.0
qlty-check/src/planner/config_files.rs 0.0
qlty-cli/src/commands/plugins/enable.rs 0.0
qlty-check/src/parser/clippy.rs 97.2
qlty-coverage/src/parser/clover.rs 100.0
qlty-cli/src/initializer/scanner/driver_candidate.rs 68.6
qlty-check/src/parser/trufflehog.rs 98.6
qlty-smells/src/metrics/metrics/fields.rs 98.3
qlty-analysis/src/report.rs 0.0
qlty-cli/src/initializer/scanner/package_file.rs 95.5
qlty-cli/src/initializer/scanner.rs 93.9
qlty-analysis/src/version.rs 0.0
qlty-check/src/processor.rs 0.0
qlty-types/src/lib.rs 27.4
qlty-check/src/tool/command_builder.rs 67.0
qlty-cli/src/commands/build.rs 0.0
qlty-cli/src/initializer/initializer.rs 0.0
qlty-cli/src/telemetry.rs 0.0
qlty-cli/src/commands/telemetry.rs 0.0
qlty-cli/src/commands/auth/signup.rs 0.0
qlty-cli/src/initializer/scanner/driver_initializer.rs 66.7
qlty-check/src/tool/null_tool.rs 25.0
qlty-check/src/planner/plan.rs 0.0
qlty-check/src/parser/phpstan.rs 97.2
qlty-cli/src/commands/deinit.rs 0.0
qlty-smells/src/metrics/executor.rs 0.0
qlty-check/src/planner/plugin_workspace_entry_finder_builder.rs 0.0
qlty-smells/src/duplication/plan.rs 100.0
qlty-check/src/tool/ruby.rs 86.4
qlty-analysis/src/workspace_entries/workspace_entry_finder.rs 91.3
qlty-check/src/parser/sqlfluff.rs 99.3
qlty-analysis/src/code/line_index.rs 50.0
qlty-check/src/command.rs 0.0
qlty-check/src/parser/knip.rs 69.3
qlty-smells/src/metrics/metrics/classes.rs 0.0
qlty-smells/src/structure/planner.rs 0.0
qlty-analysis/src/git/diff.rs 77.0
qlty-cli/src/commands/auth/logout.rs 0.0
qlty-cli/src/telemetry/locale.rs 0.0
qlty-smells/src/metrics/metrics/cognitive.rs 98.6
qlty-check/src/tool/tool_builder.rs 0.0
qlty-check/src/planner/target.rs 0.0
qlty-check/src/tool/ruby/sys/macos.rs 93.8
qlty-coverage/src/print.rs 0.0
qlty-smells/src/metrics/processor.rs 0.0
qlty-coverage/src/parser/lcov.rs 100.0
qlty-config/src/sources/sources_list.rs 56.0
qlty-coverage/src/publish/settings.rs 0.0
qlty-analysis/src/lang/java.rs 96.0
qlty-check/src/parser/markdownlint.rs 30.4
qlty-cli/src/commands/coverage.rs 0.0
qlty-cloud/src/format.rs 0.0
qlty-analysis/src/code/node_counter.rs 84.2
qlty-analysis/src/utils/fs.rs 100.0
qlty-cli/src/commands/auth/token.rs 0.0
qlty-cli/src/commands/completions.rs 0.0
qlty-config/src/sources/git_source.rs 54.2
qlty-cloud/src/lib.rs 0.0
qlty-cli/src/initializer/renderer.rs 98.8
qlty-cli/src/main.rs 0.0
qlty-cli/src/commands/cache.rs 0.0
qlty-cli/src/commands/check.rs 0.0
qlty-config/src/sources/source_upgrade.rs 88.8
qlty-smells/src/metrics/metrics/cyclomatic.rs 74.0
qlty-check/src/source_reader.rs 100.0
qlty-analysis/src/lang/ruby.rs 87.2
qlty-check/src/planner.rs 4.2
qlty-config/src/sources/local_source.rs 23.1
qlty-check/src/tool/download.rs 14.0
qlty-smells/src/structure/checks/returns.rs 100.0
qlty-check/src/parser/php_codesniffer.rs 98.7
qlty-cloud/src/format/json.rs 0.0
qlty-analysis/src/lang/kotlin.rs 75.7
qlty-coverage/src/publish/processor.rs 0.0
qlty-coverage/src/utils.rs 0.0
qlty-test-utilities/src/git.rs 46.4
qlty-smells/src/structure/checks/function_complexity.rs 100.0
qlty-analysis/src/code/language_detector.rs 99.0
qlty-cli/src/shell/fish.rs 0.0
qlty-smells/src/structure/plan.rs 0.0
qlty-check/src/tool/go.rs 0.0
qlty-check/src/parser/sarif.rs 98.8
qlty-cli/src/commands/discord.rs 0.0
qlty-analysis/src/code/visitor.rs 82.8
qlty-analysis/src/lang/tsx.rs 93.4
qlty-check/src/planner/plugin.rs 0.0
qlty-cli/src/commands/config.rs 0.0
qlty-cli/src/commands/version.rs 0.0
qlty-config/src/migration/checks.rs 98.9
qlty-check/src/cache.rs 1.4
qlty-check/src/issue_muter.rs 96.6
qlty-analysis/src/lang/php.rs 91.1
qlty-check/src/tool/ruby_source.rs 46.9
qlty-smells/src/structure/executor.rs 0.0
qlty-cli/src/commands/patch.rs 0.0
qlty-analysis/src/workspace_entries/args_source.rs 96.0
qlty-analysis/src/code/file.rs 38.3
qlty-coverage/src/publish/reader.rs 0.0
qlty-coverage/src/parser/coverprofile.rs 94.0
qlty-check/src/planner/config.rs 92.6
qlty-check/src/tool/node.rs 87.7
qlty-check/src/parser/golangci_lint.rs 99.7
qlty-coverage/src/publish/planner.rs 0.0
qlty-check/src/parser/ripgrep.rs 98.8
qlty-smells/src/duplication/planner.rs 18.1
qlty-analysis/src/code/node_ext.rs 87.5
qlty-smells/src/metrics/lines.rs 65.6
qlty-check/src/tool/python.rs 87.1
qlty-check/src/executor/driver.rs 56.8
qlty-cli/src/commands/plugins.rs 0.0
qlty-check/src/executor/invocation_script.rs 77.4
qlty-cli/src/ui/format/errors.rs 0.0
qlty-cli/src/telemetry/git.rs 58.1
qlty-coverage/src/transform/planner.rs 0.0
qlty-check/src/parser/tsc.rs 87.3
qlty-cli/src/ui/format/text.rs 0.0
qlty-check/src/planner/plugin_mode_transformer.rs 0.0
qlty-check/src/tool/ruby/sys/linux.rs 35.3
qlty-cli/src/commands/coverage/transform.rs 0.0
qlty-check/src/parser/coffeelint.rs 98.6
qlty-check/src/parser/stylelint.rs 98.5
qlty-check/src/parser/actionlint.rs 99.0
qlty-analysis/src/workspace_entries/workspace_entry_finder_builder.rs 0.0
qlty-check/src/parser/regex.rs 96.7
qlty-cloud/src/token.rs 0.0
qlty-cli/src/initializer/scanner/package_json.rs 93.2
qlty-cloud/src/export/coverage.rs 0.0
qlty-check/src/results.rs 0.0
qlty-analysis/src/workspace_entries/all_source.rs 89.5
qlty-smells/src/duplication/executor.rs 63.9
qlty-cli/src/commands/check/autofix.rs 0.0
qlty-config/src/sources/source.rs 69.7
qlty-check/src/parser/eslint.rs 98.6
qlty-analysis/src/workspace_entries/workspace_entry.rs 66.7
qlty-check/src/parser/shellcheck.rs 99.6
qlty-check/src/tool/rust.rs 0.0
qlty-check/src/parser/hadolint.rs 0.0
qlty-smells/src/duplication/code.rs 63.6
qlty-check/src/parser/ruff.rs 99.6
qlty-analysis/src/workspace_entries/target_mode.rs 0.0
qlty-cli/src/ui/highlight.rs 0.0
qlty-smells/src/metrics/metrics/functions.rs 0.0
qlty-check/src/parser/mypy.rs 98.7
qlty-coverage/src/parser.rs 0.0
qlty-config/src/toml_merge.rs 93.1
qlty-check/src/planner/target_batcher.rs 99.8
qlty-smells/src/metrics/plan.rs 0.0

@qltysh qltysh
Copy link
Contributor

qltysh bot commented Nov 21, 2024 •
edited
Loading

❌ 1 blocking issue (1 total)

Tool Category Rule Count
clippy Lint unneeded return statement 1 ❌

qlty successfully analyzed this pull request in 3m.

qltysh[bot]
qltysh bot reviewed Nov 21, 2024
View reviewed changes
qlty-config/src/workspace.rs Outdated Show resolved Hide resolved
@brynary brynary changed the title WIP: Improve messaging when commands need an initialized workspace Improve error when commands need an initialized workspace Nov 21, 2024
@brynary brynary marked this pull request as ready for review November 21, 2024 03:35
qltysh[bot]
qltysh bot reviewed Nov 21, 2024
View reviewed changes
qlty-config/src/workspace.rs
current.display()
));
}

Ok(git_repository.unwrap())
}

pub fn assert_within_git_directory() -> Result<PathBuf> {
pub fn assert_within_initialized_project() -> Result<PathBuf> {
let current = Self::current_dir();
let git_repository = Self::closest_git_repository_path(&current);

if git_repository.is_none() {
return Err(anyhow!(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unneeded return statement [clippy/needless_return]

@brynary brynary merged commit 6793766 into main Nov 21, 2024
8 of 10 checks passed
@brynary brynary deleted the bh-workspace-require-initialized branch November 21, 2024 04:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@qltysh qltysh[bot] qltysh[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@brynary