Squelette PDS par exemple: une norme pour la structure des fichiers et du dossier

Cet article explore le php-pds/skeleton et l'utilise pour construire un petit package Laravel qui mappe les pages FAQ aux exceptions. Le squelette PDS (normes de développement des paquets) favorise un fichier et une structure de dossiers cohérents pour les packages PHP, améliorant l'organisation et la maintenabilité.

Concepts clés:

• Squelette PDS: Une norme pour organiser les fichiers et dossiers de projet PHP, améliorer la lisibilité au code et la maintenabilité. Il fournit une structure cohérente comprenant des répertoires pour le code source, les tests, la documentation et la configuration. Il est conçu pour être flexible et adaptable aux besoins individuels du projet.
• Normes PSR: Bien que PDS se concentre sur la structure des fichiers, les normes PSR se concentrent sur le style de codage et les conventions. Ils sont complémentaires et souvent utilisés ensemble.

Fonctionnalité du package:

L'exemple Package Maps Exceptions Exceptions dans une application Laravel aux pages FAQ pertinentes, fournissant aux utilisateurs des informations utiles lorsque des erreurs se produisent. Le code final est disponible sur github.

Construire le package:

Le processus implique:

1. Téléchargement du squelette: Le package php-pds/skeleton est téléchargé et extrait. Alternativement, il peut être généré à l'aide du compositeur: composer require --dev pds/skeleton && ./vendor/bin/pds-skeleton generate.

2. Mise à jour composer.json: Le fichier composer.json est modifié pour définir le nom du package, la description, les dépendances et la mise en scène. Le pds/skeleton est inclus en tant que dépendance require-dev pour les outils de suivi et de ligne de commande.

3. GIT Initialisation: Le projet est initialisé sous forme de référentiel GIT, engagé et poussé vers un référentiel distant sur github.

4. Structure du répertoire: Le package adhère à la structure du squelette PDS, y compris src/, tests/, config/, resources/, public/, docs/, et d'autres répertoires pertinents .

5. Implémentation du code: La logique principale implique la création de modèles (src/Models/Faq.php), un fournisseur de services (src/Providers/FaqProvider.php), un référentiel (src/Repositories/FaqRepository.php) et des rendus pour les réponses Web et API. Une migration de base de données (resources/migrations/2014_10_12_000000_create_faq_table.php) et une vue (resources/views/faq.blade.php) sont également créées.

6. Tests: Les tests unitaires sont écrits dans le répertoire tests/.

7. Documentation: A README.md Le fichier fournit un aperçu, tandis que la documentation plus détaillée réside dans le répertoire docs/. Un fichier LICENSE Spécifie la licence (par exemple, MIT). A CONTRIBUTING.md Le fichier décrit les directives de contribution. A CHANGELOG.md suit les changements entre les versions.

8. Validation: La commande pds-skeleton validate vérifie l'adhésion aux normes PDS.

Conclusion:

L'utilisation d'un squelette standardisé comme php-pds/skeleton améliore considérablement l'organisation et la collaboration du code. Bien qu'il existe d'autres squelettes, PDS fournit une structure largement applicable et vérifiable pour le développement de packages PHP. L'article encourage la discussion sur l'importance des structures de dossier standardisées dans le développement de logiciels.

Questions fréquemment posées (FAQ): (Celles-ci sont déjà bien couvertes dans le texte d'origine, donc je ne les répéterai pas ici pour éviter la redondance. Les FAQ d'origine sont complètes et bien écrites. )

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!