Browse Source

phploc: add page (#2011)

Owen Voke 7 years ago
parent
commit
64b2d40c0e
1 changed files with 31 additions and 0 deletions
  1. 31 0
      pages/common/phploc.md

+ 31 - 0
pages/common/phploc.md

@@ -0,0 +1,31 @@
+# phploc
+
+> A tool for quickly measuring the size and analyzing the structure of a PHP project.
+
+- Analyse a directory and print the result:
+
+`phploc {{path/to/directory}}`
+
+- Include only specific files from a comma-separated list (globs are allowed):
+
+`phploc {{path/to/directory}} --names {{files}}`
+
+- Exclude specific files from a comma-separated list (globs are allowed):
+
+`phploc {{path/to/directory}} --names-exclude {{files}}`
+
+- Exclude a specific directory from analysis:
+
+`phploc {{path/to/directory}} --exclude {{path/to/exclude_directory}}`
+
+- Log the results to a specific CSV file:
+
+`phploc {{path/to/directory}} --log-csv {{path/to/file}}`
+
+- Log the results to a specific XML file:
+
+`phploc {{path/to/directory}} --log-xml {{path/to/file}}`
+
+- Count PHPUnit test case classes and test methods:
+
+`phploc {{path/to/directory}} --count-tests`