Utilisation de linter de contenu

À propos de linter de contenu pour GitHub Docs

Notre linter de contenu applique des règles de guide de style dans notre contenu Markdown.

Le linter utilise markdownlint comme infrastructure pour effectuer des vérifications, signaler des défauts et corriger automatiquement le contenu, dans la mesure du possible. Cette infrastructure exécute de manière flexible des règles spécifiques, fournit des messages d’erreur descriptifs et corrige les erreurs. Le linter de contenu GitHub Docs utilise plusieurs règles existantes markdownlint et des règles personnalisées supplémentaires pour vérifier le contenu Markdown dans nos répertoires content etdata. Nos règles personnalisées implémentent des vérifications qui ne sont pas encore disponibles dans l’infrastructure markdownlint ou qui sont spécifiques au contenu GitHub Docs. Les règles vérifient la syntaxe pour Markdown et Liquid.

Exécution du linter de contenu GitHub Docs

Le linter de contenu GitHub Docs s’exécute automatiquement lors de la pré-validation, mais vous pouvez également l’exécuter manuellement.

Exécuter automatiquement linter lors de la pré-validation

Quand vous écrivez du contenu localement et que vous validez des fichiers à l’aide de la ligne de commande, ces fichiers mis en scène sont automatiquement lintés par le linter de contenu. Les avertissements et les erreurs sont signalés, mais seules les erreurs empêchent la fin de votre validation.

Si des erreurs sont signalées, votre validation ne se terminera pas. Vous devrez corriger les erreurs signalées, rajouter les fichiers modifiés et valider de nouveau vos modifications. Toutes les erreurs signalées doivent être corrigées pour empêcher l’introduction d’erreurs qui ne respectent pas le guide de style GitHub Docs dans le contenu. Si des avertissements sont signalés, vous pouvez éventuellement choisir de les corriger ou non.

Quand vous écrivez du contenu localement, il existe plusieurs règles que vous pouvez corriger automatiquement à l’aide de la ligne de commande. Si vous souhaitez corriger automatiquement les erreurs qui peuvent être corrigées, consultez « Corriger automatiquement les erreurs qui peuvent être corrigées ».

Si vous modifiez un fichier dans l’interface utilisateur GitHub, vous ne pourrez pas corriger automatiquement les erreurs ou exécuter le linter sur un engagement, mais vous obtiendrez un échec de CI si le contenu enfreint des règles avec une gravité de error.

Exécuter manuellement le linter

Exécuter le linter sur des fichiers intermédiaires et modifiés

Utilisez la commande suivante pour exécuter le linter localement sur vos fichiers intermédiaires et modifiés. Il génère les deux défauts graves, warning et error.

npm run lint-content

Exécuter le linter sur les fichiers intermédiaires et modifiés et signaler uniquement les erreurs

Utilisez la commande suivante pour exécuter le linter localement sur vos fichiers intermédiaires et modifiés et signalez uniquement les défauts graves error.

npm run lint-content -- --errors

Exécuter le linter sur des fichiers ou des répertoires spécifiques

Utilisez la commande suivante pour exécuter le linter localement sur des fichiers ou des répertoires spécifiques. Séparez plusieurs filtres par un espace. Vous pouvez inclure des fichiers et des répertoires dans la même commande.

npm run lint-content -- \
  --paths content/FILENAME.md content/DIRECTORY

npm run lint-content -- \
  --paths content/FILENAME.md content/DIRECTORY

Corriger automatiquement les erreurs qui peuvent être corrigées

Si une erreur a fixable: true dans sa description, vous pouvez utiliser les commandes suivantes pour les corriger automatiquement.

Exécutez cette commande pour corriger uniquement les fichiers intermédiaires et modifiés :

npm run lint-content -- --fix

Exécutez cette commande pour corriger des fichiers ou des répertoires spécifiques :

npm run lint-content -- \
  --fix --paths content/FILENAME.md content/DIRECTORY

Exécuter un ensemble spécifique de règles linter

Utilisez la commande suivante pour exécuter une ou plusieurs règles linter spécifiques. Ces exemples exécutent les règles heading-increment et code-fence-line-length. Remplacez heading-increment code-fence-line-length par un ou plusieurs alias linter que vous souhaitez exécuter. Pour afficher la liste des règles linter que vous pouvez passer à cette option, exécutez npm run lint-content -- --help. Vous pouvez utiliser le nom court (par exemple, MD001) ou le nom long (par exemple, heading-increment) d’une règle linter.

Exécutez les règles linter spécifiées sur tous les fichiers intermédiaires et modifiés :

npm run lint-content -- \
  --rules heading-increment code-fence-line-length

Exécutez les règles linter spécifiées sur des fichiers ou des répertoires spécifiques :

npm run lint-content -- \
  --rules heading-increment code-fence-line-length \
  --path content/FILENAME.md content/DIRECTORY

Contourner le hook de validation

Si le linter détecte des erreurs que vous n'avez pas introduites, vous pouvez contourner le hook de validation de git en utilisant l'--no-verifyoption lors de la validation de vos modifications.

git commit -m 'MESSAGE' --no-verify

Afficher le menu d’aide pour le script linter de contenu

npm run lint-content -- --help

Règles de linting

Chaque règle est configurée dans un fichier dans src/content-linter/style, où les gravités des règles sont définies.

Les erreurs doivent être traitées avant de fusionner vos modifications dans la branche main. Les avertissements doivent être traités, mais n’empêchent pas la fusion d’une modification dans la branche main. La plupart des règles seront finalement promues en erreurs, quand le contenu n’a plus de violations d’avertissement.

Syntaxe des règles de linting

Certaines règles de linting retournent des avertissements ou des erreurs basés sur des commentaires HTML que vous pouvez ajouter à des articles.

Syntaxe pour l’expiration et l’expiration du contenu

Les règles GHD038 et GHD039 vérifient le contenu auquel une date d'expiration a été attribuée manuellement. Quatorze jours avant la date spécifiée, le linter de contenu renvoie un avertissement indiquant que le contenu expire bientôt. À compter de la date spécifiée, le linter de contenu retourne une erreur et signale le contenu pour la correction.

Vous pouvez ajouter une date d'expiration au contenu en l’encapsulant dans des balises HTML qui contiennent une date d'expiration au format :

<!-- expires yyyy-mm-dd --> <!-- end expires yyyy-mm-dd -->

Utiliser :

This content does not expire. <!-- expires 2022-01-28 -->This content expires on January 28, 2022. <!-- end expires 2022-01-28 -->This content also does not expire.

Suppression des règles de linter

Rarement, vous devrez peut-être documenter quelque chose qui enfreint une ou plusieurs règles de linter. Dans ces cas, vous pouvez supprimer des règles en ajoutant un commentaire au fichier Markdown. Vous pouvez désactiver toutes les règles ou règles spécifiques. Essayez toujours de limiter autant de règles que possible. Vous pouvez désactiver une règle pour un fichier entier, pour une section d’un fichier Markdown, une ligne spécifique ou la ligne suivante.

Par exemple, si vous écrivez un article qui inclut l’expression régulière (^|/)[Cc]+odespace/ qui examine la syntaxe des liens inversés, il déclenche la règle MD011 qui examine les liens inversés. Vous pouvez désactiver la règle MD011 sur cette ligne spécifique en ajoutant le commentaire suivant.

(^|/)[Cc]+odespace/ <!-- markdownlint-disable-line MD011 -->

Si la ligne que vous essayez d’ignorer se trouve dans un bloc de code, vous pouvez ignorer ce bloc de code en l’entourant des commentaires suivants.

<!-- markdownlint-disable MD011 -->
```
(^|/)[Cc]+odespace/
```
<!-- markdownlint-enable MD011 -->

Vous pouvez utiliser ces commentaires pour activer ou désactiver des règles.

<!-- markdownlint-disable -->

<!-- markdownlint-enable -->

<!-- markdownlint-disable-line -->

<!-- markdownlint-disable-next-line -->

<!-- markdownlint-disable RULE-ONE RULE-TWO -->

<!-- markdownlint-enable RULE-ONE RULE-TWO -->

<!-- markdownlint-disable-line RULE-NAME -->

<!-- markdownlint-disable-next-line RULE-NAME -->