Ce document détaille la structure du projet Quilt Standard Libraries (QSL) et ses fichiers de configuraton clés.

1. Structure du projet et description des répertoires

Le projet Quilt Standard Libraries (QSL) est organisé comme suit :

quilt-standard-libraries/
├── build-logic/
├── gradle/
│   └── wrapper/
├── library/
│   ├── src/
│   │   └── testmod/
│   │       └── resources/
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .gitmodules
├── CONTRIBUTING.md
├── DEVELOPER_CERTIFICATE_OF_ORIGIN.md
├── LICENSE
├── README.md
├── UPDATING.md
├── build.gradle
├── gradle.properties
├── gradlew
├── gradlew.bat
└── settings.gradle

Description des répertoires et fichiers :

• build-logic/ : Contient les scripts de build Gradle centraux pour la logique de construction des bibliothèques.
• gradle/wrapper/ : Contient les fichiers du Gradle Wrapper pour assurer une version cohérente de Gradle.
• library/ : Abrite le code source principal et les ressources de QSL.
  • src/testmod/resources/ : Contient les ressources pour les modules de test.
• .editorconfig : Définit les conventions de style de code pour maintenir la cohérence.
• .gitattributes : Configure les attributs Git pour les fichiers.
• .gitignore : Spécifie les fichiers et répertoires à ignorer par Git.
• .gitmodules : Gère les sous-modules Git du projet.
• CONTRIBUTING.md : Fournit des directives pour contribuer au projet.
• DEVELOPER_CERTIFICATE_OF_ORIGIN.md : Déclaration d'origine du développeur.
• LICENSE : Le fichier de licence du projet (Apache-2.0).
• README.md : Introduction générale et instructions d'utilisation du projet.
• UPDATING.md : Journal des modifications et des mises à jour.
• build.gradle : Le script de build principal de Gradle, définissant les tâches, les dépendances et les plugins.
• gradle.properties : Propriétés de conifguration pour le build Gradle.
• gradlew : Script exécutable du Gradle Wrapper pour les systèmes Unix.
• gradlew.bat : Script exécutable du Gradle Wrapper pour Windows.
• settings.gradle : Fichier de configuration Gradle définissant les modules et les dépôts du projet.

2. Fichiers de démarrage du projet

Les fichiers clés qui initient le processus de build pour Quilt Standard Libraries sont build.gradle et settings.gradle.

build.gradle

Ce fichier orchestre le processus de construction, y compris la définition des tâches, la gestion des dépendances et l'application des plugins.

plugins {
    // Définitions des plugins
}

repositories {
    // Définitions des dépôts
}

dependencies {
    // Définitions des dépendances
}

// Autres tâches et configurations de build

settings.gradle

Ce fichier configure le projet Gradle, en spécifiant les modules inclus et les dépôts à utiliser.

rootProject.name = 'quilt-standard-libraries'

// Inclusion des sous-projets
include 'build-logic'
include 'library'

3. Configuration du projet

Les configurations essentielles pour le projet se trouvent dans gradle.properties et .editorconfig.

gradle.properties

Ce fichier contient les propriétés spécifiques à la configuration de Gradle, telles que les arguments JVM et l'activation du parallélisme.

# Configuration des propriétés Gradle
org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
org.gradle.parallel=true

.editorconfig

Ce fichier assure la cohérence du style de code sur différents éditeurs et IDE.

# Configuration EditorConfig
root = true

[*]
charset = utf-8
indent_style = space
indent_size = 4
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

Ces fichiers de configuration contribuent à maintenir un environnement de développement cohérent et à optimiser les performances de build.