@sideid/id-profanity-filter 1.9.4 → 1.9.6

package/examples/basic.ts

@@ -1,52 +1,71 @@
+import { IDProfanityFilter, idFilter } from '../src/index';
+
 /**
- * Contoh penggunaan dasar ID-Profanity-Filter
+ * Contoh Penggunaan Dasar ID-Profanity-Filter
+ * ==========================================
+ * File ini menunjukkan fungsi dasar dari library.
  */
-import IDProfanityFilter from '../src/index';
 
-// Contoh penggunaan sederhana
+console.log('=== Contoh Penggunaan Dasar ID-Profanity-Filter ===\n');
 
-// 1. Buat instance filter
+// ===== Contoh 1: Inisialisasi dasar =====
 const filter = new IDProfanityFilter();
 
-// 2. Contoh teks dengan kata kasar
-const text = 'Dasar anjing kamu, jangan banyak bacot!';
-
-// 3. Cek apakah teks mengandung kata kotor
-const hasProfanity = filter.isProfane(text);
-console.log('Teks mengandung kata kotor:', hasProfanity);
-
-// 4. Filter kata kotor
-const filteredResult = filter.filter(text);
-console.log('Teks asli:', text);
-console.log('Teks tersensor:', filteredResult.filtered);
-console.log('Jumlah kata yang disensor:', filteredResult.censored);
-console.log('Kata-kata yang disensor:', filteredResult.replacements);
-
-// 5. Analisis teks
-const analysis = filter.analyze(text);
-console.log('\nHasil Analisis:');
-console.log('- Mengandung kata kotor:', analysis.hasProfanity);
-console.log('- Kata kotor yang ditemukan:', analysis.matches);
-console.log('- Kategori kata kotor:', analysis.categories);
-console.log('- Daerah asal kata kotor:', analysis.regions);
-console.log('- Skor keparahan:', analysis.severityScore);
-
-// 6. Gunakan opsi kustom
+const teks = 'Dasar anjing kamu, jangan banyak bacot!';
+console.log('Teks asli:', teks);
+
+// Cek apakah teks mengandung kata kotor
+const hasProfanity = filter.isProfane(teks);
+console.log('Mengandung kata kotor?', hasProfanity);
+
+// Filter kata kotor (sensorisasi)
+const hasil = filter.filter(teks);
+console.log('Teks disensor:', hasil.filtered);
+console.log('Jumlah kata disensor:', hasil.censored);
+console.log('Detail penggantian:', hasil.replacements);
+
+console.log('\n=== Contoh Analisis Dasar ===\n');
+
+// Analisis konten
+const analisis = filter.analyze(teks);
+console.log('Mengandung kata kotor?', analisis.hasProfanity);
+console.log('Kata-kata kotor yang ditemukan:', analisis.matches);
+console.log('Kategori kata kotor:', analisis.categories);
+console.log('Daerah asal kata:', analisis.regions);
+console.log('Tingkat keparahan:', analisis.severityScore.toFixed(2));
+
+console.log('\n=== Contoh Fungsi Statis ===\n');
+
+// Menggunakan fungsi statis
+const staticResult = idFilter.filter(teks);
+console.log('Teks disensor (fungsi statis):', staticResult.filtered);
+
+// ===== Contoh 2: Mengubah karakter pengganti =====
+filter.setOptions({ replaceWith: '#' });
+console.log('\nTeks disensor dengan #:', filter.filter(teks).filtered);
+
+// ===== Contoh 3: Hanya menyensor sebagian kata =====
 filter.setOptions({
-  replaceWith: '#',
+  replaceWith: '*',
   fullWordCensor: false,
+  keepFirstAndLast: true,
 });
+console.log(
+  '\nTeks disensor sebagian (first & last):',
+  filter.filter(teks).filtered,
+);
 
-console.log('\nHasil filter dengan opsi kustom:');
-console.log(filter.filter(text).filtered);
+// ===== Contoh 4: Metode analisis lain =====
+const kalimat =
+  'Saya sangat suka filmnya. Tapi pemainnya seperti anjing, aktingnya buruk.';
+console.log('\nContoh kalimat untuk analisis per-kalimat:', kalimat);
 
-// 7. Tambahkan kata ke whitelist (pengecualian)
-filter.addToWhitelist('anjing');
-console.log('\nHasil filter setelah "anjing" di-whitelist:');
-console.log(filter.filter(text).filtered);
-
-// 8. Gunakan fungsi utilitas langsung
-import { idFilter } from '../src/index';
-
-console.log('\nPenggunaan utilitas langsung:');
-console.log(idFilter.filter(text, { replaceWith: '@' }).filtered);
+const kalimatAnalisis = filter.analyzeBySentence(kalimat);
+console.log('\nAnalisis per-kalimat:');
+kalimatAnalisis.forEach((hasil, index) => {
+  console.log(`Kalimat ${index + 1}: ${hasil.sentence}`);
+  console.log(`- Mengandung kata kotor: ${hasil.hasProfanity}`);
+  if (hasil.hasProfanity) {
+    console.log(`- Kata kotor: ${hasil.matches.join(', ')}`);
+  }
+});

package/examples/custom-list.ts

@@ -0,0 +1,140 @@
+import { IDProfanityFilter, idFilter, FilterOptions } from '../src/index';
+
+/**
+ * Contoh Penggunaan ID-Profanity-Filter dengan Daftar Kustom
+ * =======================================================
+ * File ini menunjukkan cara menggunakan library dengan daftar kata kustom.
+ */
+
+console.log('=== Contoh Penggunaan dengan Daftar Kata Kustom ===\n');
+
+// ===== Contoh 1: Menggunakan daftar kata kustom =====
+// Daftar kata kotor kustom
+const customBadWords = ['jelek', 'buruk', 'sampah', 'payah', 'lemah', 'amatir'];
+
+// Buat instance dengan daftar kata kustom
+const filter = new IDProfanityFilter({
+  wordList: customBadWords,
+  replaceWith: '#',
+});
+
+const teks1 = 'Film itu sangat jelek dan payah, sepertinya dibuat oleh amatir.';
+console.log('Teks asli:', teks1);
+console.log('Hasil filter kustom:', filter.filter(teks1).filtered);
+
+// ===== Contoh 2: Menggabungkan daftar kata kustom dengan daftar bawaan =====
+console.log('\n=== Menggabungkan Daftar Kata ===\n');
+
+// Reset filter ke pengaturan default
+filter.setOptions({});
+
+// Tambahkan kata-kata kustom tapi tetap deteksi kata-kata bawaan
+const teks2 = 'Film itu sangat jelek dan payah, dibuat oleh anjing amatir.';
+console.log('Teks asli:', teks2);
+
+// Analisis hanya dengan kata bawaan
+console.log('Analisis standar:');
+const standarAnalisis = filter.analyze(teks2);
+console.log('- Kata terdeteksi:', standarAnalisis.matches);
+
+// Tambahkan kata kustom
+filter.setWordList([...customBadWords]);
+console.log('\nAnalisis dengan kata kustom ditambahkan:');
+const customAnalisis = filter.analyze(teks2);
+console.log('- Kata terdeteksi:', customAnalisis.matches);
+
+// ===== Contoh 3: Whitelist untuk pengecualian kontekstual =====
+console.log('\n=== Penggunaan Whitelist ===\n');
+
+// Kita ingin kata "anjing" diperbolehkan jika dalam konteks binatang
+filter.setOptions({});
+filter.addToWhitelist('anjing');
+
+const teks3a = 'Anjing adalah hewan peliharaan yang setia.';
+const teks3b = 'Dasar anjing kamu, tidak punya perasaan!';
+
+console.log('Teks dengan konteks binatang:', teks3a);
+console.log('Terdeteksi sebagai kata kotor?', filter.isProfane(teks3a));
+
+// Tambahkan kembali "anjing" ke daftar kata kotor
+filter.removeFromWhitelist('anjing');
+console.log('\nSetelah dihapus dari whitelist:');
+console.log('Terdeteksi sebagai kata kotor?', filter.isProfane(teks3a));
+
+// ===== Contoh 4: Membuat preset kustom =====
+console.log('\n=== Membuat Preset Kustom ===\n');
+
+// Kita bisa membuat preset filter kustom
+const myCustomPreset: FilterOptions = {
+  replaceWith: '●', // Karakter pengganti
+  fullWordCensor: false,
+  keepFirstAndLast: true,
+  detectLeetSpeak: true,
+  indonesianVariation: true,
+  detectSplit: false,
+  useRandomGrawlix: false,
+  categories: ['insult', 'profanity'],
+  severityThreshold: 0.3,
+  whitelist: ['anjing'], // Untuk konteks binatang
+};
+
+const teks4 = 'Anjing itu lucu, tidak seperti si goblok dan bego itu.';
+console.log('Teks asli:', teks4);
+
+// Gunakan preset kustom
+filter.setOptions(myCustomPreset);
+console.log('Hasil preset kustom:', filter.filter(teks4).filtered);
+
+// ===== Contoh 5: Filter berdasarkan kategori atau daerah saja =====
+console.log('\n=== Filter Berdasarkan Kategori atau Daerah ===\n');
+
+// Filter hanya kata dari kategori "sexual"
+filter.setOptions({
+  categories: ['sexual'],
+  wordList: [], // Reset daftar kata kustom
+});
+
+const teks5 =
+  'Ngewe dan bokep itu kata kotor, bego dan anjing tidak terfilter.';
+console.log('Teks asli:', teks5);
+console.log('Filter hanya kategori sexual:', filter.filter(teks5).filtered);
+
+// Filter hanya kata dari daerah "jawa"
+filter.setOptions({
+  categories: [],
+  regions: ['jawa'],
+});
+
+const teks5b = 'Kata jancuk dan cuk dari Jawa, anjing adalah kata umum.';
+console.log('\nTeks asli:', teks5b);
+console.log('Filter hanya daerah jawa:', filter.filter(teks5b).filtered);
+
+// ===== Contoh 6: Custom wordList dengan metadata =====
+console.log('\n=== Custom wordList dengan Metadata ===\n');
+
+// Ini contoh jika Anda ingin membuat daftar kata lengkap dengan metadata
+const customWordsWithMetadata = [
+  {
+    word: 'jelek',
+    category: 'insult' as any,
+    region: 'general' as any,
+    severity: 0.4,
+    aliases: ['jelex', 'jlk'],
+  },
+  {
+    word: 'payah',
+    category: 'insult' as any,
+    region: 'general' as any,
+    severity: 0.3,
+    aliases: ['pyh', 'payaah'],
+  },
+];
+
+// Namun untuk filter sederhana, cukup gunakan kata-kata saja
+filter.setOptions({
+  wordList: customWordsWithMetadata.map((w) => w.word),
+});
+
+const teks6 = 'Performanya sangat jelek dan payah sekali.';
+console.log('Teks asli:', teks6);
+console.log('Filter dengan wordList kustom:', filter.filter(teks6).filtered);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sideid/id-profanity-filter",
-  "version": "1.9.4",
+  "version": "1.9.6",
   "description": "Library filter kata kotor dalam Bahasa Indonesia",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",

package/src/constants/categories/index.ts

@@ -1,31 +1,31 @@
-// import { sexual } from './sexual';
-// import { insult } from './insult';
+import { sexual } from './sexual';
+import { insult } from './insult';
 // import { profanity } from './profanity';
 // import { slur } from './slur';
 // import { drugs } from './drugs';
 // import { disgusting } from './disgusting';
 // import { blasphemy } from './blasphemy';
 
-// export const categories = {
-//   sexual, // Kata-kata berbau seksual
-//   insult, // Kata-kata penghinaan
-//   profanity, // Umpatan umum
-//   slur, // Perkataan merendahkan berdasarkan identitas
-//   drugs, // Terkait narkoba
-//   disgusting, // Kata-kata menjijikkan
-//   blasphemy, // Penistaan agama
-// };
+export const categories = {
+  sexual, // Kata-kata berbau seksual
+  insult, // Kata-kata penghinaan
+  // profanity, // Umpatan umum
+  // slur, // Perkataan merendahkan berdasarkan identitas
+  // drugs, // Terkait narkoba
+  // disgusting, // Kata-kata menjijikkan
+  // blasphemy, // Penistaan agama
+};
 
-// export { sexual, insult, profanity, slur, drugs, disgusting, blasphemy };
+export { sexual, insult };
 
-// export const allCategoryWords = [
-//   ...sexual,
-//   ...insult,
-//   ...profanity,
-//   ...slur,
-//   ...drugs,
-//   ...disgusting,
-//   ...blasphemy,
-// ];
+export const allCategoryWords = [
+  ...sexual,
+  ...insult,
+  // ...profanity,
+  // ...slur,
+  // ...drugs,
+  // ...disgusting,
+  // ...blasphemy,
+];
 
-// export default allCategoryWords;
+export default allCategoryWords;

package/src/constants/regions/index.ts

@@ -1,8 +1,8 @@
-// import { general } from './general';
-// import { jawa } from './jawa';
-// import { sunda } from './sunda';
-// import { betawi } from './betawi';
-// import { batak } from './batak';
+import { general } from './general';
+import { jawa } from './jawa';
+import { sunda } from './sunda';
+import { betawi } from './betawi';
+import { batak } from './batak';
 // import { minang } from './minang';
 // import { bali } from './bali';
 // import { madura } from './madura';
@@ -17,46 +17,46 @@
 // import { ntt } from './ntt';
 // import { ntb } from './ntb';
 
-// export {
-//   general,
-//   jawa,
-//   sunda,
-//   betawi,
-//   batak,
-//   minang,
-//   bali,
-//   madura,
-//   bugis,
-//   aceh,
-//   ambon,
-//   papua,
-//   manado,
-//   banjar,
-//   palembang,
-//   lampung,
-//   ntt,
-//   ntb,
-// };
+export {
+  general,
+  jawa,
+  sunda,
+  betawi,
+  batak,
+  // minang,
+  // bali,
+  // madura,
+  // bugis,
+  // aceh,
+  // ambon,
+  // papua,
+  // manado,
+  // banjar,
+  // palembang,
+  // lampung,
+  // ntt,
+  // ntb,
+};
 
-// export const allRegionWords = [
-//   ...general,
-//   ...jawa,
-//   ...sunda,
-//   ...betawi,
-//   ...batak,
-//   ...minang,
-//   ...bali,
-//   ...madura,
-//   ...bugis,
-//   ...aceh,
-//   ...ambon,
-//   ...papua,
-//   ...manado,
-//   ...banjar,
-//   ...palembang,
-//   ...lampung,
-//   ...ntt,
-//   ...ntb,
-// ];
+export const allRegionWords = [
+  ...general,
+  ...jawa,
+  ...sunda,
+  ...betawi,
+  ...batak,
+  // ...minang,
+  // ...bali,
+  // ...madura,
+  // ...bugis,
+  // ...aceh,
+  // ...ambon,
+  // ...papua,
+  // ...manado,
+  // ...banjar,
+  // ...palembang,
+  // ...lampung,
+  // ...ntt,
+  // ...ntb,
+];
 
-// export default allRegionWords;
+export default allRegionWords;