Bundle License Helper pour TextMate

Parce que j’en avais ma claque de chercher le texte des licences à ajouter en en-tête de mes sources¹, voici un bundle TextMate pour palier à cette répétitive perte de temps.

Table des matières

1. Installation
2. Utilisation du bundle
3. Personnaliser le sélecteur des licences
4. Corriger le formatage de la licence
5. Licences supportées
6. Développement

Installation

Depuis les sources, avec Git

cd ~/Library/Application\ Support/TextMate/Bundles
git clone git://github.com/piouPiouM/license-helper.tmbundle.git "License Helper.tmbundle"
osascript -e 'tell app "TextMate" to reload bundles'

Depuis les sources, sans Git

cd ~/Library/Application\ Support/TextMate/Bundles
wget http://github.com/piouPiouM/license-helper.tmbundle/tarball/master
tar zxf license-helper.tmbundle.tar.gz
rm license-helper.tmbundle.tar.gz
mv license-helper.tmbundle "License Helper.tmbundle"
osascript -e 'tell app "TextMate" to reload bundles'

Téléchargement direct

Après récupération, décompressez l’archive, renommez le dossier en License Helper.tmbundle. Acceptez le changement d’extension. Il ne reste plus qu’à installer le bundle d’un double-clic sur le fichier.

Utilisation du bundle

Utilisez le lanceur license⇥ pour sélectionner une licence via la boîte de dialogue qui s’affiche.

Un bloc de licence est inséré en tant que Snippet. Utilisez la touche de tabulation pour vous déplacez sur les différents placeholders.

Liste des variables d’environnement utilisées

Déclarez dans votre projet les variables d’environnement qui suivent pour auto-compléter les blocs de licence à insérer :

• TM_PROJECT_YEAR. L’année de production. Par défaut : l’année courante.
• TM_PROJECT_COPYRIGHT_HOLDERS ou TM_AUTHOR ou TM_ORGANIZATION_NAME. Les détenteurs du copyright.
• TM_ORGANIZATION_EMAIL. Adresse mail de l’organisation détentrice du copyright.
• TM_PROJECT_DESCRIPTION. Description brève du projet.

Notez que les variables sont utilisées en fonction de la licence choisie et qu’il n’est pas nécessaire de toutes les renseigner si vous n’en avez pas l’usage.

Vous pouvez fixer la licence de votre projet en ajoutant la variable d’environnement de projet TM_PROJECT_LICENSE. Ainsi, vous n’aurez plus à la sélectionner.

Personnaliser le sélecteur des licences

La commande accessible depuis le menu License Helper → Edit licenses order lance l’édition du fichier de configuration du bundle.
Modifiez l’ordre des licences déclarées selon vos préférences d’apparition dans le sélecteur de licences.

Corriger le formatage de la licence

Il est possible qu’avec certains langages, le rendu des blocs de licences ne corresponde pas à vos attentes. Si tel est le cas, définissez votre propre format :

1. Bundles → Bundle Editor
2. Dans l’entrée License Helper, créez une nouvelle Preference et donnez-lui le nom du langage.
3. Remplissez le champ Scope Selector avec le scope approprié – i.e. source.java pour les sources java.
4. Définissez les shellVariables TM_LICENSE_HELPER_HEADER (début du bloc de commentaire) et TM_LICENSE_HELPER_FOOTER (fin du bloc de commentaire), comme suit :

{  shellVariables = (
        {   name = 'TM_LICENSE_HELPER_HEADER';
            value = '/*';
        },
        {   name = 'TM_LICENSE_HELPER_FOOTER';
            value = '*/';
        },
    );
}

Note : chacune des lignes de la licence peut être préfixée de la variable TM_LICENSE_HELPER_LINE.

Licences supportées

La liste des licences prises en charge par le plugin n’est pas figée. N’hésitez pas à me soumettre celles qui vous font défaut.

• Affero GNU Public License 3.0
• Apache license 2.0
• CeCILL license
• Do What The Fuck You Want To Public License
• GNU General Public License version 2
• GNU General Public License version 3
• GNU Lesser General Public License version 3
• MIT license
• New and Simplified BSD licenses
• Original BSD license
• PostgreSQL license

Développement

Distribué sous license MIT, le code source du bundle est accessible sur GitHub.

Une suggestion, une amélioration, une critique ou un bug à me soumettre ? Ça se passe du côté du bugtracker associé.