cloc

Generates a Code Count that can be read by Jenkins (xml format)

This action will run cloc to generate a SLOC report that the Jenkins SLOCCount plugin can read.
See https://wiki.jenkins-ci.org/display/JENKINS/SLOCCount+Plugin and https://github.com/AlDanial/cloc for more information.

cloc
Supported platforms ios, mac
Author @intere

1 Example

cloc(
   exclude_dir: "ThirdParty,Resources",
   output_directory: "reports",
   source_directory: "MyCoolApp"
)

Parameters

Key Description Default
binary_path Where the cloc binary lives on your system (full path including 'cloc') /usr/local/bin/cloc
exclude_dir Comma separated list of directories to exclude
output_directory Where to put the generated report file build
source_directory Where to look for the source code (relative to the project root folder) ''
xml Should we generate an XML File (if false, it will generate a plain text file)? true

* = default value is dependent on the user's system


Documentation

To show the documentation in your terminal, run

fastlane action cloc

CLI

It is recommended to add the above action into your Fastfile, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal

fastlane run cloc

To pass parameters, make use of the : symbol, for example

fastlane run cloc parameter1:"value1" parameter2:"value2"

It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. param:"1,2,3"). Hashes are not currently supported.

It is recommended to add all fastlane actions you use to your Fastfile.


Source code

This action, just like the rest of fastlane, is fully open source, view the source code on GitHub


Back to actions