Guide IDE Trae : Configuration facile des règles d'IA personnalisées (Règles Trae)

Tutoriels pratiques sur l'IAMise à jour il y a 3 mois Cercle de partage de l'IA

Avec l'utilisation croissante de l'IA dans la programmation, de nombreux développeurs, après avoir expérimenté la commodité de la programmation assistée par l'IA, s'attendent à avoir un "ingénieur IA dédié" qui comprenne mieux leurs besoins. Au cœur de cette demande se trouve la capacité de l'IA à suivre précisément les instructions personnalisées du développeur et les spécifications spécifiques du projet. Pour répondre à ce besoin, l Trae IDE Introduction de la fonction de configuration des règles d'IA (Trae Rules), qui permet aux utilisateurs de personnaliser les comportements de l'IA afin d'automatiser l'exécution de tâches personnalisées.

I. Qu'est-ce qu'une règle ?

Trae Les règles sont une fonctionnalité puissante qui permet aux équipes de développement ou aux développeurs individuels de personnaliser et d'imposer à l'IA le respect de styles de code spécifiques et de bonnes pratiques lorsque le code est généré, interprété ou modifié.

Imaginez un scénario courant dans lequel un développeur utilisant une IA pour l'aider à programmer peut avoir besoin de répéter les mêmes instructions à l'IA, telles que le style de langage du code, les contraintes du cadre que le projet doit suivre, le niveau de détail et le formatage des commentaires, ou les règles de conformité en matière de sécurité qui doivent être respectées, etc. Trae Rules prédéfinit ces normes comportementales pour l'IA afin que celle-ci puisse automatiquement "lire" et suivre ces règles prédéfinies à chaque fois qu'elle réagit. Ainsi, les développeurs n'ont pas besoin d'être rappelés à plusieurs reprises, et l'IA sera en mesure de produire régulièrement un contenu qui répond aux attentes. Plus important encore, lorsqu'il s'agit de traiter différentes tâches de développement ou de changer de projet, les règles Trae correspondantes peuvent aider l'IA à s'adapter avec précision aux exigences techniques du travail en cours, améliorant ainsi de manière significative l'efficacité du développement. Ces fichiers de règles sont généralement présentés dans un format texte ou Markdown facile à lire et à modifier (par ex. user_rules.md répondre en chantant project_rules.md) existe pour faciliter le contrôle des versions et le partage des équipes par les développeurs.

II. mode d'emploi

Après la mise à jour de Trae IDE vers la version 0.5.1 et plus, les utilisateurs peuvent configurer deux types de règles :

01 Règles personnelles

Les règles personnelles sont des règles personnalisées pour l'IA, basées sur les habitudes et les préférences personnelles du développeur, dans le but de rendre les résultats de l'IA plus conformes aux besoins individuels de l'utilisateur. Une fois qu'une règle personnelle est définie, elle prend effet dans tous les projets de l'utilisateur. En voici un exemple :

langue: Précisez si l'IA répond de manière concise, rigoureuse ou humoristique.
Préférences du système d'exploitationL'IA est invitée à fournir des solutions ou des exemples de code pour un système d'exploitation spécifique, tel que Windows ou macOS.
Profondeur du contenuL'IA doit fournir des explications détaillées, des exemples de code ou seulement les conclusions essentielles.
mode d'interactionLes utilisateurs peuvent, par exemple, préférer des réponses directes à des questions rhétoriques suggestives.

02 Règles du projet

Une règle de projet est un ensemble de règles que l'IA doit suivre pour le projet en question. Ces règles ne prennent effet que dans le projet où elles sont configurées. Exemple de règle de projet :

style de codageSpécifier l'indentation du code (par exemple, l'utilisation d'espaces ou de tabulations et leur nombre), les conventions d'appellation (par exemple, la nomenclature des croisements de chameaux). camelCase ou la nomenclature des tirets bas snake_case), etc.
Contraintes liées à la langue et au cadreSpécifiez le langage de programmation préféré à utiliser dans le projet (par exemple, Python ou JavaScript) ou le cadre de travail obligatoire (par exemple, le système de gestion de l'information). Réagir (ou Django).
Limites d'utilisation de l'APIL'IA n'a pas le droit d'utiliser certaines API obsolètes ou non recommandées dans le code généré.

En règle générale, en cas de conflit de contenu entre les règles personnelles et les règles du projet, ce sont les règles du projet qui priment et qui annulent les dispositions correspondantes des règles personnelles afin de garantir le respect des spécifications du projet.

Les sections suivantes expliquent comment configurer chacune de ces deux règles d'IA :

Créer des règles personnelles

Dans le coin supérieur droit de la fenêtre de dialogue AI dans Trae IDE, cliquez sur l'icône "Paramètres" et sélectionnez l'option "Règles".

Après l'opération, l'interface affiche la fenêtre de configuration "Règles".
Dans la zone Règles personnelles, cliquez sur + 创建 user_rules.md Bouton.
Le système crée automatiquement user_rules.md et ouvrez le fichier dans l'éditeur.
ouvert user_rules.md entrez les règles que vous souhaitez que l'IA suive en langage naturel. Par exemple, vous pouvez spécifier : "Veuillez utiliser le chinois pour tous les commentaires de code et expliquer la fonction principale et la signification des paramètres de chaque fonction".
Enregistrez le fichier. Ces règles prennent alors effet pour tous les comportements de l'IA du projet.

Création de règles de projet

Tout d'abord, ouvrez un projet dans l'IDE Trae.
Dans le coin supérieur droit de la fenêtre de dialogue AI, cliquez sur l'icône Paramètres et sélectionnez Règles.
Après l'opération, l'interface affiche la fenêtre de configuration "Règles".
Dans la zone Règles du projet, cliquez sur le bouton + 创建 project_rules.md Bouton.

Le système crée automatiquement le répertoire racine du projet en cours dans le répertoire .trae/rules (s'il n'existe pas déjà) et générer le fichier project_rules.md Documentation.
ouvert project_rules.md Saisissez dans le fichier les règles que l'IA doit suivre pour ce projet.
Enregistrer le fichier. Ces règles ne s'appliquent qu'au comportement de l'IA dans le projet en cours.

Règles administratives

Dans la fenêtre de configuration "Règles", les utilisateurs peuvent facilement modifier les règles personnelles et les règles de projet existantes, et peuvent également supprimer directement les fichiers de règles qui ne sont plus nécessaires.

Modifier les règles : après avoir modifié et enregistré le contenu du fichier de règles, l'IA suivra les règles mises à jour.
Suppression des fichiers de règles : Supprimer user_rules.md peut-être project_rules.md toutes les règles précédemment définies dans ce fichier seront invalidées.

III. démonstration pratique

Ensuite, nous vous présenterons un exemple concret et réel de l'utilisation des règles Trae pour améliorer l'efficacité de votre développement.

Supposons qu'une équipe de développement travaille sur un projet web et décide d'utiliser le cadre Chakra UI pour optimiser ses styles CSS. Pour s'assurer que l'IA respecte cette décision dans ses travaux ultérieurs, vous pouvez ajouter les règles de projet (project_rules.md), ajoutez la directive suivante :

请使用 Chakra UI 框架对本项目中的所有前端页面进行 CSS 相关的优化和重构。确保生成的组件符合 Chakra UI 的设计规范和最佳实践。

Lorsque cette règle de projet est configurée, elle est automatiquement référencée par l'IA (qui peut être appelée Builder ou un nom similaire dans l'IDE Trae) lorsqu'un développeur demande à l'IA d'effectuer des tâches de développement liées à CSS.

Par exemple, si une autre règle personnelle est configurée, telle que "Les explications du code doivent être complètes et expliquer les étapes clés", l'IA utilisera non seulement le cadre lors de l'exécution de la tâche de modification de l'interface utilisateur Chakra décrite ci-dessus, mais fournira également des informations plus détaillées lors de l'explication de son fonctionnement.

Scénarios d'application

Les règles Trae peuvent être utilisées dans un large éventail de scénarios pour aider les équipes de développement et les développeurs individuels à maintenir la cohérence du code, à améliorer la maintenabilité du code et à réduire l'apparition d'erreurs de bas niveau dans une variété de situations. Vous trouverez ci-dessous une liste des principaux scénarios :

Scénario 1 : Travail d'équipe et examen du code

effetUnifier les styles de code, réduire les conflits de révision et améliorer l'efficacité de la collaboration.
instructionsLes nouveaux membres de l'équipe ont souvent besoin de temps pour s'adapter au style de code établi par l'équipe. En définissant des règles de projet qui spécifient des éléments tels que les conventions de dénomination des variables, l'ordre d'importation des modules et les modèles architecturaux de code préconisés par l'équipe, l'IA suivra ces règles lors de l'assistance à la programmation, garantissant ainsi que les nouveaux membres de l'équipe soumettent un code cohérent avec le style de l'équipe. En outre, les règles Trae peuvent aider les membres de l'équipe à formater le code, à corriger automatiquement les extraits de code non conformes et à appliquer les spécifications des commentaires (par exemple, exiger que toutes les fonctions publiques aient des commentaires de type JSDoc), réduisant ainsi le coût de la communication des problèmes de style au cours de la phase de révision du code.

Scénario 2 : Maintenance du projet et qualité du code

effetLes tâches de l'équipe sont les suivantes : aider à détecter les erreurs de code potentielles, améliorer progressivement l'ancien code et améliorer la maintenabilité du projet dans son ensemble ; aider à la mise en place d'un système de gestion de l'information.
instructionsPour certains projets anciens ayant une longue histoire et un style de code plus chaotique, l'ancien code peut être corrigé par phases en introduisant et en affinant progressivement les règles Trae et en les combinant avec des commandes de dialogue de l'IA, qui peut identifier le code qui n'est pas conforme à la nouvelle spécification sur la base des règles et fournir des suggestions de remaniement. Parallèlement, pour éviter l'introduction de nouvelles erreurs de bas niveau au cours du développement, des règles peuvent être établies, telles que l'obligation d'effectuer des opérations asynchrones await doit try-catch Enveloppe structurelle, détection de l'inutilisation import ou des variables, en interdisant l'utilisation d'instructions ou de variables sujettes à des erreurs. == et faire respecter l'utilisation des === Effectuer des comparaisons. Ces règles permettent de réduire les problèmes d'exécution potentiels et d'améliorer la robustesse et la maintenabilité à long terme du code.

Scénario 3 : Optimisation d'un ensemble de technologies spécifiques

effetLes projets de développement de l'entreprise : Améliorer l'application des meilleures pratiques pour des piles technologiques spécifiques (par exemple React, Vue, Node.js).
instructionsDans les projets frontaux, les incohérences dans la façon dont les composants sont écrits peuvent les rendre plus difficiles à comprendre et à maintenir. Vous pouvez imposer une manière cohérente d'écrire les composants en mettant en place des règles de Trae, par exemple en encourageant l'utilisation de composants fonctionnels dans les projets React (en interdisant l'utilisation de class l'utilisation abusive d'un composant), exigeant que tous les composants de la props doit faire l'objet d'une vérification de type (que ce soit en utilisant TypeScript ou PropTypes), et l'élément obligatoire useEffect Les dépendances des crochets doivent être déclarées dans leur intégralité. Pour les projets Node.js back-end dont les styles d'interface API ne sont pas cohérents, des règles peuvent être passées pour imposer la conformité avec la spécification du format de chemin pour les API RESTful, exiger que le processus de gestion des erreurs soit normalisé et interdire l'utilisation de l'option console.logLe projet de loi sur la protection des données, qui prévoit l'utilisation obligatoire d'un référentiel de journalisation unifié, est en cours d'élaboration.

Scénario 4 : Sécurité et conformité

effetLe système d'information sur la sécurité : il aide à prévenir les failles de sécurité les plus courantes et à répondre aux exigences de conformité propres à chaque secteur d'activité.
instructionsLa sécurité du code est la pierre angulaire de la réussite d'un projet. Pour les risques de sécurité courants, tels que l'injection SQL, les attaques de scripts intersites (XSS), etc., Trae Rules peut établir des règles pour aider à les prévenir. Par exemple, il est possible d'interdire l'insertion de chaînes de requêtes SQL directement dans le code (ce qui oblige à utiliser des requêtes paramétrées ou des ORM), de détecter les sorties directes vers HTML sans escamoter suffisamment les entrées utilisateur (pour prévenir les attaques XSS), et d'interdire l'utilisation de la technologie eval() peut-être new Function() Trae Rules peut aider à détecter l'inclusion d'informations sensibles en clair (par exemple, des mots de passe et des clés) dans le code. Pour les secteurs soumis à des exigences strictes en matière de protection des données et d'audit de conformité, tels que la finance et la santé, Trae Rules peut aider à détecter si des informations sensibles (mots de passe, clés, etc.) sont contenues en clair dans le code, à forcer le stockage crypté des données sensibles telles que les mots de passe et à s'assurer que la journalisation ne contient pas d'informations personnelles identifiables (PII), aidant ainsi les projets à répondre aux besoins des contrôles de conformité.

Scénario 5 : Optimiser les habitudes de développement personnel

effetLes langages de programmation : ils aident les développeurs à maintenir la cohérence de leur style de codage personnel et à apprendre et appliquer plus efficacement les fonctionnalités des nouveaux langages de programmation.
instructionsLe style de code : Même pour les projets personnels, le maintien d'un style de code cohérent peut contribuer à améliorer l'efficacité du développement et la lisibilité du code. Les développeurs peuvent le faire en établissant des règles personnelles. En outre, lors de l'apprentissage d'un nouveau langage de programmation (par exemple, Rust, Go, Python), il est facile pour les débutants d'écrire du code qui n'est pas conforme aux paradigmes habituels du langage ou aux meilleures pratiques. En définissant des règles d'apprentissage, par exemple dans le cadre du développement de Rust, qui imposent l'utilisation de l'attribut Result Les types sont traités correctement (les appels directs sont interdits) unwrap() (ignorer les erreurs), forcer la vérification et le traitement des retours de fonction dans le développement Go, la fonction err (ce qui interdit d'ignorer les erreurs), ou de forcer l'utilisation d'annotations de type dans le développement de Python et de s'assurer qu'elles sont cohérentes avec la norme mypy et d'autres outils de vérification de type sont compatibles, ce qui peut aider efficacement les développeurs à développer de bonnes habitudes de codage et à saisir plus rapidement l'essence du nouveau langage.

En définissant et en appliquant soigneusement les règles de Trae, l'IA peut être adaptée plus précisément aux besoins spécifiques et aux habitudes de travail des développeurs, et intégrée de manière plus transparente dans les flux de développement quotidiens, ce qui permet une collaboration homme-machine vraiment efficace. Les développeurs intéressés peuvent télécharger la dernière version de Trae IDE sur le canal officiel de Trae IDE pour découvrir cette fonctionnalité par eux-mêmes.