Skip to content

Commit

Permalink
Remove old logo, fix some language and facts in the readme (#99)
Browse files Browse the repository at this point in the history
  • Loading branch information
sgb-io authored Oct 5, 2021
1 parent cdb3fd4 commit d3a5c32
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Codehawk is a static analysis tool for JavaScript projects. It is intended as a

## Scope

*JavaScript, TypeScript and Flow* projects are supported for analysis. The CLI tool supports unix and windows filesystems (there is a reasonable amount of Windows compatibility code).
JavaScript (including TypeScript and Flow) projects are supported for analysis. The CLI tool supports unix and windows filesystems (there is a reasonable amount of Windows compatibility code).

It works by traversing a directory and discovering all supported filetypes, runs a static analysis routine on each file, then performs project-wide analysis such as inter-dependency counting and test coverage mapping.

Expand Down Expand Up @@ -152,7 +152,7 @@ Codehawk gathers various complexity metrics, including:
- Will not run quickly on large projects, so use caution and common sense when applying it to a workflow or pipeline.
- Recursively traverses directory trees, so if one activates the process inside a node_modules or C drive directory (unintended usage), you are likely to experience problems.
- Opinionated: the formula for calculating overall file "scores" is arbitrary and based on original, unpublished research. Users are free to interpret the numbers differently and generate their own scorings.
- Internal quality needs improvement: I envision moving the source to TypeScript if there is user interest. The tests are also rudimentary and difficult to maintain.
- Internal quality needs improvement: at present, the tests are rudimentary and it can be awkward to compare before/after states when changes are made to codehawk itself
- `codehawk.json` configuration files are currently required. However, they can be empty.

## Testing and Samples
Expand All @@ -161,7 +161,7 @@ Codehawk gathers various complexity metrics, including:

Sweetalert in this directory is a static export (carried out in 2019) of that library.

Each sample conatins an empty `codehawk.json` configuration file (at present, this config)
Each sample contains an empty `codehawk.json` configuration file (at present, this config)

## Known Issues

Expand Down
Binary file removed codehawk-logo.png
Binary file not shown.

0 comments on commit d3a5c32

Please sign in to comment.