Language composition report

org.openrewrite.LanguageComposition

Counts the number of lines of the various kinds of source code and data formats parsed by OpenRewrite. Comments are not included in line counts. This recipe emits its results as two data tables, making no changes to any source file. One data table is per-file, the other is per-repository.

Recipe source

GitHub, Issue Tracker, Maven Central

License

This recipe is available under the Apache License Version 2.0.

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-all in your build file or by running a shell command (in which case no build changes are needed):

Gradle

1. Add the following to your build.gradle file:

build.gradle

plugins {
    id("org.openrewrite.rewrite") version("7.4.1")
}

rewrite {
    activeRecipe("org.openrewrite.LanguageComposition")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-all:1.14.2")
}

2. Run gradle rewriteRun to run the recipe.

Gradle init script

1. Create a file named init.gradle in the root of your project.

init.gradle

initscript {
    repositories {
        maven { url "https://plugins.gradle.org/m2" }
    }
    dependencies { classpath("org.openrewrite:plugin:7.4.1") }
}
rootProject {
    plugins.apply(org.openrewrite.gradle.RewritePlugin)
    dependencies {
        rewrite("org.openrewrite.recipe:rewrite-all:1.14.2")
    }
    rewrite {
        activeRecipe("org.openrewrite.LanguageComposition")
        setExportDatatables(true)
    }
    afterEvaluate {
        if (repositories.isEmpty()) {
            repositories {
                mavenCentral()
            }
        }
    }
}

2. Run the recipe.

shell

gradle --init-script init.gradle rewriteRun

Maven POM

1. Add the following to your pom.xml file:

pom.xml

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>6.6.1</version>
        <configuration>
          <exportDatatables>true</exportDatatables>
          <activeRecipes>
            <recipe>org.openrewrite.LanguageComposition</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-all</artifactId>
            <version>1.14.2</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

Maven Command Line

You will need to have Maven installed on your machine before you can run the following command.

shell

mvn -U org.openrewrite.maven:rewrite-maven-plugin:run -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-all:RELEASE -Drewrite.activeRecipes=org.openrewrite.LanguageComposition -Drewrite.exportDatatables=true

Moderne CLI

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe LanguageComposition

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite.recipe:rewrite-all:1.14.2

See how this recipe works across multiple open-source repositories

Run this recipe on OSS repos at scale with the Moderne SaaS.

Run this recipe here

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables

Language composition report

org.openrewrite.table.LanguageCompositionPerRepository

Counts the number of files and lines of source code in the various formats OpenRewrite knows how to parse.

Column Name	Description
Language	Language of the source file.
File count	Count of files of this language.
Line count	Count of lines of this language.

Per-folder language composition report

org.openrewrite.table.LanguageCompositionPerFolder

A list of folders and the language composition and line counts of their contents.

Column Name	Description
Folder path	The path to the folder relative to repository root.
Language	Language of the source file.
File count	Count of files of this language.
Line count	Count of lines of this language.

Per-file language composition report

org.openrewrite.table.LanguageCompositionPerFile

A list of individual files and their language composition.

Column Name	Description
Source path	The path to the source file.
Language	The language of the source file.
LST type	The Lossless Semantic Tree type of this source file.
Lines of text	The number of lines of text in the source file. No language-specific knowledge to skip comments, blank lines, or any other non-code line.
Has parse failures	True if the file failed to parse, otherwise false.

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column Name	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column Name	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column Name	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time	The total time spent across the scanning phase of this recipe.
99th percentile scanning time	99 out of 100 scans completed in this amount of time.
Max scanning time	The max time scanning any one source file.
Cumulative edit time	The total time spent across the editing phase of this recipe.
99th percentile edit time	99 out of 100 edits completed in this amount of time.
Max edit time	The max time editing any one source file.