textlint/textlint : guide éditorial fondé sur le README

Le README décrit textlint/textlint comme « textlint is the pluggable linter for natural language text. ». Cette page reste limitée aux faits vérifiables dans le dépôt. Les étoiles, forks et badges indiquent une attention, pas une preuve de qualité. Sous « textlint », la source indique : > The pluggable linting tool for natural language.. Cela fixe un périmètre déclaré, pas un test en production.

La section « Features » aide à vérifier si le projet répond au besoin : Supports the use of custom formatters and formatter bundles formatter(reporter). Si ce besoin ne correspond pas au vôtre, la popularité ne suffit pas. Les noms, commandes et composants sont conservés pour permettre une comparaison directe avec la source primaire. Le README fournit aussi ce point vérifiable : To use a rule, install a textlint rule via npm.. Il peut guider le premier test, sans remplacer une vérification dans l'environnement prévu.

Le fonctionnement est réparti dans des sections comme « Quick Tour ». La source fournit notamment : For a quick tour of textlint, checkout our Getting Started guide :squirrel:. Les détails absents sur l'architecture, les performances ou la sécurité ne sont pas inventés. Avant une mise en service, vérifiez l'arborescence, la configuration et l'historique des releases.

Commencez l'installation avec l'entrée documentée dans le README. La commande vérifiable est : $ npm install textlint --save-dev Si aucune commande n'est fournie, cette page n'en fabrique pas. Consultez « Website » pour les dépendances, les ports par défaut et l'initialisation du premier lancement.

L'usage quotidien dépend de la documentation du projet. Dans « Installation », le README précise : You can install the textlint command using npm:. Les fichiers de configuration, variables, droits et chemins de données ne sont repris que lorsqu'ils sont explicitement documentés. Les valeurs inconnues doivent être testées isolément avec une sauvegarde réversible. La même source précise aussi : If you have installed textlint globally you must install each reference rule globally as well..