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.

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

Add documentation of verbose output on README #101

Merged
merged 10 commits into from
Nov 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,21 @@ CSV files that correspond to each of the tables inside of the database.
You can learn more about the `integrate` sub-command by typing `chasten
integrate --help`.

## 💠 Verbose Output

When utilizing the `chasten` command, appending this `--verbose` flag can significantly enhance your troubleshooting experience and provide a detailed understanding of the tool's functionality. Here is an example with `chasten analyze lazytracker`:

```shell
chasten analyze lazytracker \
--config <path to the chasten-configuration/ directory> \
--search-path <path to the lazytracker/ directory> \
--save-directory <path to the subject-data/lazytracker/ directory> \
--save
--verbose
```

Upon executing this command, you can expect the output to contain informative messages such as `✨ Matching source code:` indicating that the tool is actively comparing the source code against the specified patterns. Additionally, you will receive detailed match results, providing insights into the identified checks.

## 🌄 Results

If you want to create an interactive analysis dashboard that uses 📦
Expand Down
2 changes: 2 additions & 0 deletions chasten/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -451,6 +451,7 @@ def analyze( # noqa: PLR0913, PLR0915
)
# extract the current version of the program
chasten_version = util.get_chasten_version()
output.logger.debug(f"Current version of chasten: {chasten_version}")
# create the include and exclude criteria
include = results.CheckCriterion(
attribute=str(checks.fix_check_criterion(check_include[0])),
Expand Down Expand Up @@ -537,6 +538,7 @@ def analyze( # noqa: PLR0913, PLR0915
# extract details about the check to display in the header
# of the syntax box for this specific check
check_id = current_check[constants.checks.Check_Id] # type: ignore
output.logger.debug(f"check id: {check_id}")
check_name = current_check[constants.checks.Check_Name] # type: ignore
check_description = checks.extract_description(current_check)
# search for the XML contents of an AST that match the provided
Expand Down
Loading