E-Sivana - Filtre de Grossièretés en Malgache

E-Sivana est une bibliothèque Node.js légère conçue pour filtrer et censurer les gros mots en malgache. Utilisez-la pour garantir un langage approprié dans vos applications.

Fonctionnalités

• Détection de Profanités : Identifie les mots offensants dans une chaîne de texte.
• Censure : Remplace les mots offensants par des étoiles (****).
• Personnalisation : Ajoutez ou retirez des mots de la liste des gros mots.

Installation

Pour installer la bibliothèque, exécutez la commande suivante :

npm install Esivana

Utilisation

Exemple de Censure

const Filter = require('Esivana');

const filter = new Filter();

const text = "Masosopory ianareo jiaby";
const censoredText = filter.censor(text);

console.log(censoredText); // ******** ianareo jiaby

Ajouter ou Retirer des Mots

// Ajouter des mots à la liste des gros mots
filter.addWords('tay');
console.log(filter.censor('Hoano ny tay')); //Hoano ny ***

// Retirer des mots de la liste des gros mots
filter.removeWords('kindy');
console.log(filter.censor('Raha kindy ny olona')); // Raha kindy ny olona

Collaboration

Installation du projet en local

• Installer les dépendances :

npm install

Conventions de développement

• Branches Git : Utiliser la convention feature/nom-de-la-feature, fix/description-du-fix, etc.

• Commits Git : Structurer les messages de commit selon le format suivant :

  <type>: <description courte>
  
  [Description optionnelle, plus détaillée]
  

  Types possibles :

  • feat: Ajout d'une nouvelle fonctionnalité
  • fix: Correction de bug
  • refactor: Réorganisation ou amélioration du code sans ajout de fonctionnalités
  • docs: Modifications de la documentation
  • test: Ajout ou modification de tests
  • chore: Autres tâches (par exemple, mise à jour des dépendances)

Tests

• Tous les nouveaux modules et fonctionnalités doivent inclure des tests unitaires.

• Les tests peuvent être exécutés localement avec la commande suivante :

  npm run test