Como personalizar seu ambiente usando configurações específicas por projeto

As preferências pessoais do editor de texto de cada desenvolvedor são sagradas. Não há nada como trabalhar em um projeto codificando do jeitinho que a gente gosta, concorda?

No entanto, muitas vezes o código do projeto é compartilhado por mais de uma pessoa da equipe. Por isso, nem sempre é possível utilizar nossas preferências pessoais sem interferir no padrão de organização de código que foi convencionado. Para estes casos, entra em cena a capacidade do Sublime Text de manter um arquivo de configuração específico para cada projeto.

Os arquivos de projeto são escritos no formato JSON e possuem a extensão .sublime-project. Neles, podemos configurar quais pastas devem fazer parte do projeto, inclusive filtrando os arquivos que devem ou não aparecer na barra lateral. Também é possível sobrepor as preferências de usuário, bem como o sistema de build utilizado.

Estrutura de um arquivo de projeto

Um arquivo de projeto pode ter as seguintes seções:

• folders
• settings
• build_systems

folders

A seção folders contém um ou mais caminhos para as pastas que fazem parte do projeto. Seus atributos são:

• path: indica o caminho para uma pasta que deve fazer parte do projeto
• name: especifica o nome que será exibido na barra lateral no lugar do nome do diretório
• file_exclude_patterns: indica quais arquivos devem ser ocultados na barra lateral
• folder_exclude_patterns: indica quais pastas devem ser ocultadas na barra lateral
• follow_symlinks: indica se o projeto deve considerar links simbólicos (atalhos) para arquivos que estejam em outras pastas [apenas ST3]

Exemplo 1

{
    "folders":
    [
        {
            "path": "src",
            "folder_exclude_patterns": ["imagens"],
            "follow_symlinks": true
        },
        {
            "path": "docs",
            "name": "Documentação",
            "file_exclude_patterns": ["*.css", "*.png"]
        }
    ]
}

No exemplo acima, a pasta src foi incluída como parte do projeto, sendo que a pasta imagens que está dentro dela não será exibida na barra lateral. Do mesmo modo, a pasta docs também fará parte do mesmo projeto, sendo que seu nome será exibido como Documentação na barra lateral e os arquivos com extensão .css e .png não serão exibidos.

Vale lembrar que no exemplo acima os caminhos das pastas são relativos à localização do arquivo de projeto, mas também é possível informar um caminho absoluto.

settings

A seção settings permite que você coloque qualquer configuração de preferências válida em um arquivo do tipo .sublime-settings. Fazendo isso, essas preferências irão sobrepor as que estão definidas no arquivo de preferências do usuário (Preferences | Settings – User).

build_systems

A seção build_systems permite definir sistemas de build específicos para o projeto. Para saber mais, veja o artigo “Entenda como funcionam os sistemas de build do Sublime Text“.

Abaixo um exemplo de arquivo de projeto com todas as seções que falamos aqui.

Exemplo 2

{
    "folders":
    [
        {
            "path": "src",
            "folder_exclude_patterns": ["imagens"],
            "follow_symlinks": true
        },
        {
            "path": "docs",
            "name": "Documentação",
            "file_exclude_patterns": ["*.css", "*.png"]
        }
    ],
    "settings":
        {
            "tab_size": 4,
            "font_size": 14,
            "line_numbers": true
        },
    "build_systems":
    [
        {                
            "cmd": ["make"]
        }
    ]
}

Conclusão

As configurações específicas por projeto são um poderoso recurso para ajudar equipes a compartilhar preferências ou convenções para um determinado projeto. Modificar os arquivos de projeto (.sublime-project) para personalizá-lo é uma maneira prática de não precisar se preocupar em perder suas configuraçoes preferidas quando estiver trabalhando em equipe.

Dúvidas? Sugestões? Compartilhe com a gente nos comentários!

Foto: nehavish via Compfight cc