CLOC

CLOC
Name	CLOC
Developer	Open-source community
Released	2003
Latest release	1.90
Programming language	Perl
Operating system	Cross-platform
Genre	Software metric
License	MIT License

CLOC CLOC is a command-line tool for counting lines of source code across repositories, used to measure codebase size and composition. It reports totals for code, comments, and blank lines and supports numerous programming languages, file formats, and version control exports. Widely adopted by developers, auditors, and project managers, the tool integrates with continuous integration systems and reporting dashboards.

Overview

CLOC analyzes file contents and metadata to produce per-language and aggregate counts of code lines, comment lines, and blank lines. It recognizes hundreds of file extensions and language syntaxes to attribute lines accurately to languages such as C (programming language), Java (programming language), Python (programming language), JavaScript, Ruby (programming language), Go (programming language), Rust (programming language), PHP, C#, and TypeScript. Its output formats include plain text, CSV, JSON, and XML for downstream processing. Users include individual contributors, teams at Google, Microsoft, Facebook, and research groups at MIT, Stanford University, and Carnegie Mellon University.

History

Originally created in the early 2000s by a software developer responding to needs for simple source metrics, the project gained traction through distribution on code-hosting sites and packaging for distributions such as Debian and Ubuntu. Over time, maintainers accepted contributions from developers affiliated with companies like Oracle Corporation, Red Hat, and Canonical (company), expanding language detection and performance. The project has evolved alongside version control platforms including Subversion, Git, and Mercurial, and was referenced in academic studies from institutions like Harvard University and University of California, Berkeley comparing static code metrics.

Design and Features

CLOC is implemented primarily in Perl, emphasizing portability and minimal dependencies. It performs recursive directory traversal, pattern-based file selection, and per-language lexer rules to distinguish code from comments and blanks; languages employ single-line and multi-line comment patterns drawn from language specifications like those of ISO/IEC JTC 1/SC 22 standards. Key features include support for archive formats used by Apache Software Foundation projects, selective path exclusion, and language overrides via command-line switches. Output can be integrated into continuous integration systems used by Jenkins, Travis CI, and GitHub Actions.

File Count Methodology

The tool classifies files by extension and header heuristics, mapping extensions to language profiles similar to mappings curated by communities around GitHub, GitLab, and Bitbucket. For each file, it tokenizes lines and applies language-specific comment delimiters—e.g., /* */ and // for languages influenced by Bjarne Stroustrup's C++ family, and # for languages in the tradition of Perl (programming language) and Python (programming language). Binary files and generated artifacts from build systems like Make (software) and CMake are typically excluded via configurable filters. When counting files from version-control exports, the tool accounts for historical snapshots produced by clients such as git and svn.

Usage and Applications

Practitioners use the tool for release reporting, technical debt estimation, productivity analysis, and as an input to software visualization tools. Large-scale analyses by consultancy firms and research labs at IBM Research, Microsoft Research, and Bell Labs have used aggregated line counts to compare language adoption trends and project growth over time. Project managers integrate counts into dashboards provided by Atlassian products and reporting suites used in enterprises like Amazon (company) and Salesforce. Educators at universities such as University of Cambridge and University of Oxford have used it for classroom assignments assessing code submissions.

Integration and Ecosystem

The ecosystem around the tool includes wrappers and ports in languages such as Python (programming language), Go (programming language), and Java (programming language), as well as plugins for integrated development environments like Visual Studio Code, JetBrains IntelliJ IDEA, and Eclipse. Continuous integration integration points have been contributed by maintainers and community members for platforms including CircleCI and Azure DevOps. Third-party services for codebase analytics and security scanning, including offerings from SonarQube vendors and firms like Snyk, often ingest or reproduce similar metrics in combined reports.

Reception and Criticism

The tool is praised for simplicity, speed, and broad language coverage by contributors from Stack Overflow communities and open-source advocates at The Linux Foundation. Criticisms focus on limitations inherent to line-count metrics: inability to reflect complexity, function points, or code quality; misclassification with polyglot files used in projects by organizations like Mozilla; and false positives from generated code produced by frameworks such as Angular (application framework) and React (JavaScript library). Methodological debates cite academic critiques from conferences like International Conference on Software Engineering and publications from ACM arguing for caution when using raw line counts for productivity or value judgments.

Category:Software metrics