Génération d'un projet de plug-in pour une règle personnalisée écrite par l'utilisateur

Pour générer un projet de plug-in pour une règle personnalisée écrite par l'utilisateur, utilisez la page Modèle de règle COBOL de l'assistant Nouveau projet de plug-in.

Génération du projet

Procédure

  1. Ouvrez la perspective de développement de plug-in.
  2. Dans le menu principal du plan de travail, cliquez sur Fichier > Nouveau > Projet > Développement de plug-in > Projet de plug-in et cliquez sur Suivant. L'assistant Nouveau projet de plug-in s'ouvre.
  3. Dans la zone Nom du projet de la page Projet de plug-in, entrez un nom pour le nouveau projet et cliquez sur Suivant.
  4. Dans la zone ID de la page Contenu, entrez un ID pour le nouveau projet et cliquez sur Suivant.
  5. Dans la page Modèles, sélectionnez Create a plug-in using one of the templates (Créer un plug-in à l'aide d'un des modèles), puis sélectionnez Custom COBOL Code Review Rule (Règle personnalisée COBOL Code Review) et cliquez sur Suivant.
  6. Dans la page Modèle de règle COBOL, complétez les zones suivantes :
    Classe de règle
    Entrez un nom de classe Java qualifié complet. L'assistant attribue ce nom à la classe qu'il crée en vue de l'implémentation de la nouvelle règle. La valeur par défaut de cette zone est l'ID de projet suivi de la chaîne de caractères CobolRule.
    Conseil : L'ID de projet est la chaîne de caractères que vous avez indiquée dans la zone ID de la page Contenu de l'assistant.
    Libellé de règle
    Entrez un nom pour la nouvelle règle. Ce nom est ajouté à la liste des règles disponibles qui sont affichées dans l'éditeur de configuration d'analyse. La valeur par défaut de cette zone est "My custom COBOL rule".
    Remarque : Ce nom est traduisible. Pour plus d'informations sur l'internationalisation des chaînes dans un plug-in, voir Internationalisation d'un libellé de règle ou d'un nom de catégorie.
    Catégorie
    Vous pouvez créer une catégorie de règle pour la nouvelle règle ou ajouter la nouvelle règle à une catégorie de règle personnalisée ou intégrée existante.
    • Pour placer la nouvelle règle dans une nouvelle catégorie de règle, cliquez sur Créer une nouvelle catégorie et entrez un ID de catégorie et un nom de catégorie pour la nouvelle catégorie.
    • Pour ajouter la règle à une catégorie existante, cliquez sur Sélectionner une catégorie existante, puis développez la liste et sélectionnez la catégorie à laquelle vous souhaitez ajouter la nouvelle règle.
    ID de catégorie
    Entrez un ID Eclipse valide pour la catégorie dans laquelle la règle personnalisée écrite par l'utilisateur s'affiche dans l'éditeur de configuration d'analyse. La valeur par défaut est l'ID de projet suivi du mot custom.
    Conseil : L'ID de projet est la chaîne de caractères que vous avez indiquée dans la zone ID de la page Contenu de l'assistant.
    Nom de catégorie
    Entrez un nom pour la catégorie dans laquelle la règle personnalisée écrite par l'utilisateur s'affiche dans l'éditeur de configuration d'analyse. La valeur par défaut est Custom.
    Remarque : Ce nom est traduisible. Pour plus d'informations sur l'internationalisation des chaînes dans un plug-in, voir Internationalisation d'un libellé de règle ou d'un nom de catégorie.
  7. Développez l'arborescence Programme et sélectionnez le ou les éléments de langage COBOL dans lesquels le code d'implémentation de la nouvelle règle doit rechercher des violations. La valeur par défaut consiste à ne sélectionner aucun élément. Pour obtenir un exemple du code Java généré pour les éléments sélectionnés, voir Fichiers générés : Code d'implémentation.
  8. Cliquez sur Terminer. L'assistant crée un projet de plug-in pour la nouvelle règle personnalisée écrite par l'utilisateur, ajoute le projet à la vue Explorateur de packages et ouvre le fichier manifeste dans l'éditeur de manifeste de plug-in.
  9. Si vous n'avez pas encore ouvert la perspective Développement de plug-in, ouvrez-la lorsque vous y êtes invité.
  10. Fermez l'éditeur de manifeste de plug-in.

Résultats

L'assistant Modèle de règle COBOL ajoute les extensions de règle et de catégorie au fichier plugin.xml qui est généré pour le projet de plug-in de règle personnalisée. Pour plus d'informations sur ces extensions, voir Fichiers générés : extensions de règle et de catégorie.

L'assistant génère aussi une classe Java en vue de l'implémentation d'une règle personnalisée écrite par l'utilisateur. Pour plus d'informations sur cette classe, voir Fichiers générés : Code d'implémentation.

Internationalisation d'un libellé de règle ou d'un nom de catégorie

Pourquoi et quand exécuter cette tâche

Si vous devez faire en sorte que le plug-in puisse être traduit dans différentes langues, vous pouvez internationaliser les chaînes traduisibles. La méthode d'internationalisation d'une chaîne telle qu'une étiquette de règle ou un nom de catégorie est décrite dans Internationalize plug-in manifest. La procédure suivante décrit les étapes principales.

Procédure

  1. Dans l'extension de règle créée dans le fichier plugin.xml, utilisez un élément %variable au lieu d'une chaîne de caractères. Par exemple, pour le libellé de règle, vous pouvez effectuer un remplacement par la variable %myRuleLabel :
    <analysisRule
          category="category_id"
          class="rule_class"
          id="rule_class"
          label="%myRuleLabel"
          severity="1">
    </analysisRule>
  2. Définissez la variable dans le fichier plugin.properties. Par exemple : %myRuleLabel="Mon libellé de règle".
  3. Générez le projet de la manière habituelle.

Commentaires en retour