Add nikic/php-parser to make counter reliable, make use of lines-of-c…

…ode (#26)
TomasVotruba · Aug 4, 2023 · 015dfa1 · 015dfa1
1 parent 4f57905
commit 015dfa1
Show file tree

Hide file tree

Showing 8 changed files with 271 additions and 388 deletions.
diff --git a/README.md b/README.md
@@ -25,8 +25,101 @@ composer require tomasvotruba/lines --dev
 vendor/bin/lines measure src
 ```
 
+For short output:
+
+```bash
+vendor/bin/lines measure src --short
+```
+
 For json output, just add `--json`:
 
 ```bash
 vendor/bin/lines measure src --json
 ```
+
+## The Measured Items
+
+For the text output, you'll get data like these:
+
+```bash
+ ------------------------------ ---------------------
+  Metric                                       Count
+ ------------------------------ ---------------------
+  Directories                                      9
+  Files                                           14
+ ------------------------------ ---------------------
+
+ ------------------------------ ---------- ----------
+  Lines of code                     Count   Relative
+ ------------------------------ ---------- ----------
+  Code                              1 059     95.8 %
+  Comments                             46      4.2 %
+  Total                             1 105      100 %
+ ------------------------------ ---------- ----------
+
+ ------------------------------ ---------------------
+  Structure                                    Count
+ ------------------------------ ---------------------
+  Namespaces                                      10
+  Classes                                         13
+   * Constants                                     0
+   * Methods                                      78
+  Interfaces                                       1
+  Traits                                           0
+  Enums                                            0
+  Functions                                        3
+  Global constants                                 3
+ ------------------------------ ---------------------
+
+ ------------------------------ ---------- ----------
+  Methods                           Count   Relative
+ ------------------------------ ---------- ----------
+  Non-static                           74     94.9 %
+  Static                                4      5.1 %
+ ------------------------------ ---------- ----------
+  Public                               60     76.9 %
+  Protected                             4      5.1 %
+  Private                              14     17.9 %
+ ------------------------------ ---------- ----------
+```
+
+Or in a json format:
+
+```json
+{
+    "filesystem": {
+        "directories": 9,
+        "files": 14
+    },
+    "lines_of_code": {
+        "code": 1059,
+        "code_relative": 95.8,
+        "comments": 46,
+        "comments_relative": 4.2,
+        "total": 1105
+    },
+    "structure": {
+        "namespaces": 10,
+        "classes": 13,
+        "class_methods": 78,
+        "class_constants": 0,
+        "interfaces": 1,
+        "traits": 0,
+        "enums": 0,
+        "functions": 3,
+        "global_constants": 3
+    },
+    "methods": {
+        "non_static": 74,
+        "non_static_relative": 94.9,
+        "static": 4,
+        "static_relative": 5.1,
+        "public": 60,
+        "public_relative": 76.9,
+        "protected": 4,
+        "protected_relative": 5.1,
+        "private": 14,
+        "private_relative": 17.9
+    }
+}
+```
diff --git a/composer.json b/composer.json
@@ -14,7 +14,8 @@
         "symfony/finder": "^6.3",
         "illuminate/container": "^10.16",
         "webmozart/assert": "^1.11",
-        "nikic/php-parser": "^4.16"
+        "nikic/php-parser": "^4.16",
+        "sebastian/lines-of-code": "^2.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^10.2",