Skip to content

Commit 9ea550b

Browse files
authored
Update README.md
1 parent 0941b1a commit 9ea550b

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ Inspired by the book of Robert C. Martin, _Clean Architecture_, the software wil
99
- the overall number of concrete classes and interfaces
1010
- the _instability_ and _abstractness_ of the framework
1111
- the _distance from the main sequence_
12+
In addition, several common code metrics in the software industries are provided as part of the analysis, such as:
13+
- LOC (Lines Of Code)
14+
- NOC (Numbers Of Comments)
15+
- NBM (Number of Methods)
16+
- Number of concretes (Number of classes and structs)
1217

1318
## Requirements
1419

@@ -18,10 +23,10 @@ This is a _python3_ script that depends on _matplotlib_ (`pip3 install matplotli
1823

1924
The syntax is:
2025

21-
`python3 swift-code-analyzer.py <path-to-swift-project> --exclude <excluded-folders> --artefacts <output-directory>`
26+
`python3 swift-code-analyzer.py <path-to-swift-project> --exclude <excluded-folders> --artifacts <output-directory>`
2227

2328
- `<path-to-swift-project>` is the path to the folder that contains the main Xcode project or Workspace
24-
- `<excluded-folders>` (optional) list of subdirectories to exclude from analysis (e.g. `ThirdParty`, `Carthage` checkouts, `Pods` etc..)
29+
- `<excluded-folders>` (optional) list of subdirectories to exclude from analysis (e.g. `ThirdParty Carthage Pods`)
2530
- `<output-directory>` (optional) path to the folder that will contain the generated textual analysis and graphs; if empty, the software will show the images to the user
2631

2732
## Current limitations
@@ -30,9 +35,12 @@ This tool is designed for medium/large codebases composed by different framework
3035

3136
Libraries built with `spm` are not supported.
3237

33-
## Current state
38+
## TODOs
3439

35-
Work in progress
40+
- Percentage of comments
41+
- Output results to external file once the artifacts folder is provided
42+
- Return the global result for the code (total LOC, NOC, NBM and Number of concretes)
43+
- Other (open to suggestions)
3644

3745
## Contact
3846

0 commit comments

Comments
 (0)