Set file permission attributes

org.openrewrite.SetFilePermissions

Set a file's read, write and executable permission attributes.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite

• artifactId: rewrite-core

• version: 8.24.0

Options

Type	Name	Description	Example
String	fileMatcher	Permissions will be applied to matching files. This is a glob expression.	**/gradlew.bat
Boolean	isReadable	File read permission.
Boolean	isWritable	File write permission.
Boolean	isExecutable	Files executable permission.

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.SetFilePermissionsExample. Here's how you can define and customize such a recipe within your rewrite.yml:

rewrite.yml

---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.SetFilePermissionsExample
displayName: Set file permission attributes example
recipeList:
  - org.openrewrite.SetFilePermissions:
      fileMatcher: '**/gradlew.bat'
      isReadable: null
      isWritable: null
      isExecutable: null

Now that com.yourorg.SetFilePermissionsExample has been defined activate it in your build file:

Gradle

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

build.gradle

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

rewrite {
    activeRecipe("com.yourorg.SetFilePermissionsExample")
}

repositories {
    mavenCentral()
}

2. Run gradle rewriteRun to run the recipe.

Maven

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>5.29.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.SetFilePermissionsExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

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

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 SetFilePermissionsExample

See how this recipe works across multiple open-source repositories

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.

Contributors

Patrick Way, Jonathan Schneider, Tim te Beek, Sam Snyder