Guia do Trae IDE: configuração fácil de regras de IA personalizadas (regras do Trae)

Com o crescente uso da IA na programação, muitos desenvolvedores, depois de experimentar a conveniência da programação assistida por IA, esperam ter um "engenheiro de IA dedicado" que entenda melhor suas necessidades. No centro dessa demanda está a capacidade da IA de seguir com precisão as instruções personalizadas do desenvolvedor e as especificações específicas do projeto. Para atender a essa necessidade, a Trae O IDE apresenta a configuração de regras de IA (Trae Rules), que permite aos usuários personalizar comportamentos para que a IA automatize a execução de tarefas personalizadas.

I. O que são regras

O Trae Rules é um recurso avançado que permite que equipes de desenvolvimento ou desenvolvedores individuais personalizem e apliquem a IA para seguir estilos de código específicos e práticas recomendadas quando o código é gerado, interpretado ou modificado.

Imagine um cenário comum em que um desenvolvedor que usa uma IA para assistência à programação pode precisar repetir as mesmas instruções para a IA, como o estilo de linguagem do código, as restrições de estrutura que o projeto deve seguir, o nível de detalhes e a formatação dos comentários ou as normas de conformidade de segurança que precisam ser cumpridas etc. O recurso Trae Rules predefine esses comportamentos para que a IA "leia" e siga automaticamente toda vez que responder. O Trae Rules predefine essas normas de comportamento para a IA, de modo que ela possa "ler" e seguir automaticamente essas regras predefinidas toda vez que responder. Dessa forma, os desenvolvedores não precisam ser lembrados repetidamente, e a IA poderá produzir de forma constante conteúdo que atenda às expectativas. E o mais importante é que, ao lidar com diferentes tarefas de desenvolvimento ou mudar de projeto, as Trae Rules correspondentes podem ajudar a IA a se adaptar com precisão aos requisitos técnicos do trabalho atual, melhorando significativamente a eficiência do desenvolvimento. Esses arquivos de regras geralmente são apresentados em um formato de texto ou Markdown fácil de ler e editar (por exemplo user_rules.md responder cantando project_rules.md) existe para facilitar o controle de versões e o compartilhamento de equipes pelos desenvolvedores.

II Instruções de uso

Depois de atualizar o Trae IDE para a versão 0.5.1 e superior, os usuários podem configurar dois tipos de regras:

01 Regras pessoais

As regras pessoais são regras personalizadas para a IA com base nos hábitos e preferências pessoais do desenvolvedor, com o objetivo de tornar o resultado da IA mais alinhado com as necessidades individuais do usuário. Quando uma regra pessoal é definida, ela entra em vigor em todos os projetos do usuário. Por exemplo:

• idiomaIA: Especifique se a IA responde de forma concisa, rigorosa ou bem-humorada.
• Preferências do sistema operacionalExigir que a IA forneça uma solução ou um exemplo de código para um sistema operacional específico, como o Windows ou o macOS.
• Profundidade do conteúdoIA: Defina se a IA precisa fornecer explicações detalhadas, exemplos de código ou apenas as conclusões principais.
• método de interaçãoPor exemplo, os usuários podem preferir respostas diretas a perguntas retóricas.

02 Regras do projeto

Uma regra de projeto é um conjunto de regras que a IA deve seguir para o projeto específico em questão. Essas regras só têm efeito no projeto em que estão configuradas. Exemplo:

• estilo de codificaçãoEspecificar o recuo do código (por exemplo, se deve usar espaços ou tabulações e quantas), convenções de nomenclatura (por exemplo, nomenclatura de cruzamento de camelo) camelCase ou nomenclatura de sublinhado snake_case), etc.
• Restrições de idioma e estruturaEspecifique a linguagem de programação preferida a ser usada no projeto (por exemplo, Python ou JavaScript) ou a estrutura obrigatória (por exemplo, Python ou JavaScript). Reagir (ou Django).
• Limitações de uso da APIIA: a IA é explicitamente proibida de usar determinadas APIs desatualizadas ou não recomendadas no código gerado.

Normalmente, se houver um conflito de conteúdo entre as regras pessoais e as regras do projeto, as regras do projeto terão precedência e substituirão as disposições correspondentes nas regras pessoais para garantir que as especificações do projeto sejam seguidas.

As seções a seguir demonstram como configurar cada uma dessas duas regras de IA:

Criação de regras pessoais

1. No canto superior direito da janela de diálogo AI no Trae IDE, clique no ícone "Settings" (Configurações) e selecione a opção "Rules" (Regras).
    
   Após a operação, a interface exibirá a janela de configuração "Rules" (Regras).
2. Na área Personal Rules (Regras pessoais), clique em + 创建 user_rules.md Botão.
   O sistema cria automaticamente user_rules.md e abra o arquivo no editor.
   
3. aberto user_rules.md insira as regras que você deseja que a IA siga em linguagem natural. Por exemplo, você pode especificar: "Use chinês para todos os comentários de código e explique a função principal e os significados dos parâmetros de cada função".
4. Salve o arquivo. Essas regras entram em vigor para todos os comportamentos de IA do projeto.
   

Criação de regras de projeto

1. Primeiro, abra um projeto no Trae IDE.
2. No canto superior direito da janela de diálogo do AI, clique no ícone Settings (Configurações) e selecione Rules (Regras).
   Após a operação, a interface exibirá a janela de configuração "Rules" (Regras).
3. Na área Regras do projeto, clique no botão + 创建 project_rules.md Botão.
   
   O sistema cria automaticamente o diretório raiz do projeto atual no diretório .trae/rules (se ainda não existir) e gerar a pasta project_rules.md Documentação.
   
4. aberto project_rules.md Insira as regras que a IA precisa seguir para esse projeto no arquivo.
5. Salve o arquivo. Essas regras só se aplicarão ao comportamento de IA do projeto atual.
   

Regras administrativas

Na janela de configuração "Rules" (Regras), os usuários podem modificar facilmente as regras pessoais e as regras do projeto existentes e também podem excluir diretamente os arquivos de regras que não são mais necessários.

• Modificar regras: após editar e salvar o conteúdo do arquivo de regras, a IA seguirá as regras atualizadas.
• Exclusão de arquivos de regras: Excluir user_rules.md talvez project_rules.md todas as regras definidas anteriormente nesse arquivo serão invalidadas.

III Demonstração prática

Em seguida, apresentaremos um exemplo concreto e real de como usar o Trae Rules para aumentar a eficiência do desenvolvimento.

Suponha que uma equipe de desenvolvimento esteja trabalhando em um projeto da Web e decida usar a estrutura Chakra UI para otimizar seus estilos CSS. Para garantir que a IA siga essa decisão no trabalho subsequente, você pode adicionar as regras do projeto (project_rules.md), adicione a seguinte diretriz:

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

Quando essa regra de projeto é configurada, a IA (que pode ser chamada de Builder ou de um nome semelhante no Trae IDE) fará referência automaticamente a essa regra quando um desenvolvedor a solicitar para tarefas de desenvolvimento relacionadas a CSS.

Por exemplo, se outra regra pessoal for configurada, como "As explicações do código devem ser completas e explicar as principais etapas", a IA não só usará a estrutura ao executar a tarefa de modificação da IU do Chakra descrita acima, mas também fornecerá informações mais detalhadas ao explicar sua operação.

IV. cenários de aplicativos

O Trae Rules pode ser usado em uma ampla gama de cenários para ajudar as equipes de desenvolvimento e os desenvolvedores individuais a manter a consistência do código, melhorar a capacidade de manutenção do código e reduzir a ocorrência de erros de baixo nível em diversas situações. Veja abaixo uma lista de alguns dos principais cenários:

Cenário 1: trabalho em equipe e revisão de código

• efeitoUnifique estilos de código, reduza disputas de revisão e melhore a eficiência da colaboração.
• instruçõesOs novos membros da equipe geralmente precisam de tempo para se adaptar ao estilo de código estabelecido pela equipe. Ao definir as regras do projeto que especificam coisas como convenções de nomenclatura de variáveis, ordem de importação de módulos e padrões de arquitetura de código defendidos pela equipe, a IA seguirá essas regras ao auxiliar na programação, garantindo que os novos membros da equipe enviem códigos consistentes com o estilo da equipe. Além disso, o Trae Rules pode ajudar os membros da equipe a formatar o código, corrigir automaticamente trechos de código fora de conformidade e aplicar especificações de comentários (por exemplo, exigir comentários no estilo JSDoc para todas as funções disponíveis publicamente), reduzindo assim o custo de comunicação de problemas de estilo durante a fase de revisão do código.

Cenário 2: manutenção do projeto e qualidade do código

• efeitoAuxílio na detecção de possíveis erros de código, melhoria incremental do código antigo e melhoria da capacidade de manutenção geral do projeto.
• instruçõesPara alguns projetos legados com um longo histórico e um estilo de código mais caótico, o código antigo pode ser corrigido em fases, introduzindo e refinando gradualmente as Trae Rules e combinando-as com comandos de diálogo da IA, que pode identificar o código que não está em conformidade com a nova especificação com base nas regras e fornecer sugestões de refatoração. Ao mesmo tempo, para evitar a introdução de novos erros de baixo nível durante o desenvolvimento, podem ser estabelecidas regras, como a obrigatoriedade de operações assíncronas await deve try-catch Envoltório estrutural, detecção de não utilizados import declarações ou variáveis, proibindo o uso de declarações propensas a erros == e impor o uso de === Fazer comparações. Essas regras ajudam a reduzir possíveis problemas de tempo de execução e melhoram a robustez e a capacidade de manutenção de longo prazo do código.

Cenário 3: otimização do conjunto de tecnologias específicas

• efeitoAprimore a aplicação das práticas recomendadas para pilhas de tecnologia específicas (por exemplo, React, Vue, Node.js).
• instruçõesEm projetos front-end, as inconsistências na forma como os componentes são escritos podem dificultar a compreensão e a manutenção. Você pode impor uma maneira consistente de escrever componentes configurando Regras de Trae, por exemplo, promovendo o uso de componentes funcionais em projetos React (proibindo o uso de class uso indevido de componentes), exigindo que todos os componentes do props deve ser verificado quanto ao tipo (seja usando TypeScript ou PropTypes), e a variável obrigatória useEffect As dependências de hooks devem ser declaradas por completo. Para projetos de back-end do Node.js com estilos de interface de API inconsistentes, as regras podem ser passadas para impor a conformidade com a especificação de formato de caminho para APIs RESTful, exigir que o processo de tratamento de erros seja padronizado e proibir o uso da tag console.logA mudança para o uso obrigatório de um repositório de registro unificado.

Cenário 4: segurança e conformidade

• efeitoAjuda a evitar violações de segurança comuns e a atender aos requisitos de conformidade específicos do setor.
• instruçõesA segurança do código é a pedra angular do sucesso do projeto. Para riscos de segurança comuns, como injeção de SQL, ataques de script entre sites (XSS), etc., o Trae Rules pode definir regras para ajudar a evitá-los. Por exemplo, proibir a emenda de strings de consulta SQL diretamente no código (forçando o uso de consultas parametrizadas ou ORM), detectar a saída direta para HTML sem escapar suficientemente da entrada do usuário (para evitar ataques XSS) e proibir o uso de eval() talvez new Function() O Trae Rules pode ajudar a detectar a inclusão de informações confidenciais em texto simples (por exemplo, senhas e chaves) no código. Para os setores com requisitos rigorosos de proteção de dados e auditoria de conformidade, como o financeiro e o de saúde, o Trae Rules pode ajudar a detectar se informações confidenciais (por exemplo, senhas, chaves) estão contidas em texto simples no código, forçando o armazenamento criptografado de dados confidenciais, como senhas, e garantindo que o registro não contenha informações de identificação pessoal (PII), ajudando assim os projetos a atender às necessidades das verificações de conformidade.

Cenário 5: Otimização dos hábitos de desenvolvimento pessoal

• efeitoAjuda os desenvolvedores a manter a consistência em seu estilo pessoal de codificação e a aprender e aplicar os recursos de novas linguagens de programação com mais eficiência.
• instruçõesMesmo em projetos pessoais, manter um estilo de código consistente pode ajudar a melhorar a eficiência do desenvolvimento e a legibilidade do código. Os desenvolvedores podem fazer isso definindo regras pessoais. Além disso, ao aprender uma nova linguagem de programação (por exemplo, Rust, Go, Python), é fácil para os iniciantes escreverem códigos que não estejam em conformidade com os paradigmas usuais ou as práticas recomendadas da linguagem. Ao definir as Trae Rules, por exemplo, no desenvolvimento do Rust, que impõem o uso do Result Os tipos são tratados adequadamente (chamadas diretas são proibidas) unwrap() (ignorando erros), forçando a verificação e o tratamento de retornos de função no desenvolvimento em Go, o err (que proíbe ignorar erros), ou forçar o uso de anotações de tipo no desenvolvimento do Python e garantir que elas sejam consistentes com o mypy As ferramentas de verificação de tipos, como a compatibilidade, podem ajudar efetivamente os desenvolvedores a desenvolver bons hábitos de codificação e a compreender mais rapidamente a essência da nova linguagem.

Ao definir e aplicar cuidadosamente as Regras do Trae, a IA pode ser adaptada com mais precisão às necessidades específicas e aos hábitos de trabalho dos desenvolvedores e integrada com mais facilidade aos fluxos de trabalho de desenvolvimento diários, permitindo uma colaboração humano-computador realmente eficiente. Os desenvolvedores interessados devem fazer o download da versão mais recente do Trae IDE no canal oficial do Trae IDE para experimentar esse recurso por conta própria.