Package com.fnc314.gradle.plugins.settings.projectcollectionsgradlesettingsplugin

Class ProjectCollectionsGradleSettingsExtension

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract Property<Spec<File>> getFileSpec() An optional Spec operating on a File acting as eligibility criteria for File.isDirectory instances to adhere to before passing to org.gradle.api.initialization.Settings.include(java.lang.String...
      final Unit registerProjectCollection(String topLevelDir) Register a collection of 1-level-deep projects
      projectCollections {
    registerProjectCollection(topLevelDir = "some-dir")
    // implies "some-dir/first", "some-dir/second", etc...
}
      abstract Unit registerProjectCollection(String topLevelDir, Integer depth) Register a collection of nested projects
      projectCollections {
    registerProjectCollection(topLevelDir = "some-dir", depth = 3)
    // implies "some-dir/first/second/desired", "some-dir/other/layer/target", etc...
}
      abstract Unit toDepthOf(String $self, Integer depth) A friendly-syntax approach to including collections of projects
      projectCollections {
    "apps" toDepthOf 1
    "components" toDepthOf 1
    "design-system" toDepthOf 1
    "features" toDepthOf 2
    // means "features/first/project-a", "features/first/project-b", "features/second/project-a", etc...
}
      abstract Unit registerNestedProjectCollection(String topLevelDir, Integer depth) Register a collection of nested projects
      projectCollections {
    registerNestedProjectCollection(topLevelDir = "some-dir", depth = 3)
    // implies "some-dir/first/second/desired", "some-dir/other/layer/target", etc...
}

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ProjectCollectionsGradleSettingsExtension

        ProjectCollectionsGradleSettingsExtension()

    • Method Detail

      • getFileSpec

         abstract Property<Spec<File>> getFileSpec()

        An optional Spec operating on a File acting as eligibility criteria for File.isDirectory instances to adhere to before passing to org.gradle.api.initialization.Settings.include(java.lang.String...)

        projectCollections {
    fileSpec.set { file -> false }
}

      • registerProjectCollection

         final Unit registerProjectCollection(String topLevelDir)

        Register a collection of 1-level-deep projects

        projectCollections {
    registerProjectCollection(topLevelDir = "some-dir")
    // implies "some-dir/first", "some-dir/second", etc...
}
        Parameters:
        topLevelDir - The collection name/top-level directory

      • registerProjectCollection

         abstract Unit registerProjectCollection(String topLevelDir, Integer depth)

        Register a collection of nested projects

        projectCollections {
    registerProjectCollection(topLevelDir = "some-dir", depth = 3)
    // implies "some-dir/first/second/desired", "some-dir/other/layer/target", etc...
}
        Parameters:
        topLevelDir - The collection name/top-level directory
        depth - The depth within topLevelDir which must be traversed to find a desired project

      • toDepthOf

         abstract Unit toDepthOf(String $self, Integer depth)

        A friendly-syntax approach to including collections of projects

        projectCollections {
    "apps" toDepthOf 1
    "components" toDepthOf 1
    "design-system" toDepthOf 1
    "features" toDepthOf 2
    // means "features/first/project-a", "features/first/project-b", "features/second/project-a", etc...
}
        Parameters:
        depth - An Int indicating how deep into the top-level directory members we are required to traverse

      • registerNestedProjectCollection

         abstract Unit registerNestedProjectCollection(String topLevelDir, Integer depth)

        Register a collection of nested projects

        projectCollections {
    registerNestedProjectCollection(topLevelDir = "some-dir", depth = 3)
    // implies "some-dir/first/second/desired", "some-dir/other/layer/target", etc...
}
        Parameters:
        topLevelDir - The collection name/top-level directory
        depth - The depth within topLevelDir which must be traversed to find a desired project