@sideid/id-profanity-filter 1.11.0 → 1.11.6

package/.eslintrc.js

@@ -1,44 +1,44 @@
-module.exports = {
-  parser: '@typescript-eslint/parser',
-  parserOptions: {
-    ecmaVersion: 2020,
-    sourceType: 'module',
-    project: './tsconfig.json',
-  },
-  extends: [
-    'eslint:recommended',
-    'plugin:@typescript-eslint/recommended',
-    'prettier', // Disables ESLint rules that might conflict with Prettier
-  ],
-  plugins: ['@typescript-eslint'],
-  env: {
-    node: true,
-    jest: true,
-  },
-  rules: {
-    // Enforce consistent code style
-    '@typescript-eslint/explicit-function-return-type': 'off',
-    '@typescript-eslint/no-explicit-any': 'warn',
-    '@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
-
-    // Allow certain TypeScript patterns
-    '@typescript-eslint/no-non-null-assertion': 'off',
-
-    // General ESLint rules
-    'no-console': ['warn', { allow: ['warn', 'error'] }],
-    'prefer-const': 'warn',
-    'no-var': 'error',
-
-    // Make sure imports are properly sorted
-    'sort-imports': [
-      'off',
-      {
-        ignoreCase: false,
-        ignoreDeclarationSort: true,
-        ignoreMemberSort: false,
-        memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single'],
-      },
-    ],
-  },
-  ignorePatterns: ['dist/', 'node_modules/', '*.js', '*.d.ts'],
-};
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
+    project: './tsconfig.json',
+  },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'prettier', // Disables ESLint rules that might conflict with Prettier
+  ],
+  plugins: ['@typescript-eslint'],
+  env: {
+    node: true,
+    jest: true,
+  },
+  rules: {
+    // Enforce consistent code style
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/no-explicit-any': 'warn',
+    '@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
+
+    // Allow certain TypeScript patterns
+    '@typescript-eslint/no-non-null-assertion': 'off',
+
+    // General ESLint rules
+    'no-console': ['warn', { allow: ['warn', 'error'] }],
+    'prefer-const': 'warn',
+    'no-var': 'error',
+
+    // Make sure imports are properly sorted
+    'sort-imports': [
+      'off',
+      {
+        ignoreCase: false,
+        ignoreDeclarationSort: true,
+        ignoreMemberSort: false,
+        memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single'],
+      },
+    ],
+  },
+  ignorePatterns: ['dist/', 'node_modules/', '*.js', '*.d.ts'],
+};

package/.github/workflows/release.yml

@@ -0,0 +1,62 @@
+name: Create Release
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'package.json'
+jobs:
+  check-version-and-release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+          token: ${{ secrets.GH_PAT }}
+       
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+         
+      - name: Check if version changed
+        id: check_version
+        run: |
+          git diff HEAD^ HEAD -- package.json | grep '"version"' || echo "No version change"
+          NEW_VERSION=$(node -p "require('./package.json').version")
+          echo "VERSION=$NEW_VERSION" >> $GITHUB_OUTPUT
+          echo "Version changed to $NEW_VERSION"
+       
+      - name: Create Git Tag
+        if: contains(steps.check_version.outputs.VERSION, '.')
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git tag -a "v${{ steps.check_version.outputs.VERSION }}" -m "Release v${{ steps.check_version.outputs.VERSION }}"
+          git push https://${{ secrets.GH_PAT }}@github.com/${{ github.repository }}.git --tags
+        
+      - name: Install dependencies
+        run: npm ci
+       
+      - name: Build
+        run: npm run build
+       
+      - name: Create GitHub Release
+        if: contains(steps.check_version.outputs.VERSION, '.')
+        uses: softprops/action-gh-release@v1
+        with:
+          tag_name: v${{ steps.check_version.outputs.VERSION }}
+          name: v${{ steps.check_version.outputs.VERSION }}
+          draft: false
+          prerelease: false
+          generate_release_notes: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_PAT }}
+         
+      - name: Publish to npm
+        if: contains(steps.check_version.outputs.VERSION, '.')
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/CONTRIBUTING.md

@@ -1,151 +1,151 @@
-# Panduan Kontribusi untuk ID-Profanity-Filter
-
-Terima kasih telah mempertimbangkan untuk berkontribusi pada proyek ID-Profanity-Filter! Panduan ini akan menjelaskan proses kontribusi, terutama untuk menambahkan kata kotor baru ke dalam database.
-
-## Cara Berkontribusi
-
-### 1. Fork & Clone Repositori
-
-- Fork repositori ini ke akun GitHub Anda
-- Clone repositori fork Anda ke komputer lokal:
-  ```bash
-  git clone https://github.com/username/id-profanity-filter.git
-  cd id-profanity-filter
-  ```
-
-### 2. Install Dependensi
-
-```bash
-npm install
-```
-
-### 3. Buat Branch Baru
-
-```bash
-git switch -c add-kata-kotor-daerah
-```
-
-## Struktur Kata Kotor
-
-Kata-kata kotor dalam proyek ini dikelompokkan berdasarkan dua dimensi:
-
-### Berdasarkan Daerah Asal
-
-Lokasi file: `src/constants/regions/`
-
-Kata-kata dikelompokkan berdasarkan daerah asalnya di Indonesia, seperti:
-- `general.ts` - Kata-kata umum di Indonesia
-- `jawa.ts` - Kata-kata dari Jawa
-- `sunda.ts` - Kata-kata dari Sunda
-- `betawi.ts` - Kata-kata dari Betawi
-- `batak.ts` - Kata-kata dari Batak
-- ... dan daerah lainnya
-
-### Berdasarkan Kategori
-
-Lokasi file: `src/constants/categories/`
-
-Kata-kata juga dikelompokkan berdasarkan jenisnya:
-- `sexual.ts` - Kata-kata berbau seksual
-- `insult.ts` - Kata-kata penghinaan
-- `profanity.ts` - Umpatan umum
-- `slur.ts` - Kata-kata merendahkan berdasarkan identitas
-- `drugs.ts` - Kata-kata terkait narkoba
-- `disgusting.ts` - Kata-kata menjijikkan
-- `blasphemy.ts` - Kata-kata penistaan agama
-
-## Cara Menambahkan Kata Kotor Baru
-
-### 1. Menambahkan ke File Daerah
-
-Pilih file daerah yang sesuai di `src/constants/regions/` atau buat file baru jika daerah tersebut belum ada. Format entri kata kotor harus mengikuti interface `ProfanityWord`:
-
-```typescript
-{
-  word: 'kata_kotor',        // Kata kotor dalam bentuk dasarnya
-  category: 'insult',        // Kategori kata (sexual, insult, profanity, slur, drugs, disgusting, blasphemy)
-  region: 'nama_daerah',     // Daerah asal kata
-  severity: 0.7,             // Tingkat keparahan (0-1)
-  aliases: ['alias1', 'alias2'], // Variasi atau alias kata (opsional)
-  description: 'Deskripsi kata', // Penjelasan singkat tentang kata (opsional)
-  context: 'Konteks penggunaan' // Informasi konteks penggunaan (opsional)
-}
-```
-
-Contoh menambahkan kata ke file daerah (misalnya `bali.ts`):
-
-```typescript
-import { ProfanityWord } from '../../types';
-
-export const bali: ProfanityWord[] = [
-  // ... kata-kata yang sudah ada
-  {
-    word: 'cicing',
-    category: 'profanity',
-    region: 'bali',
-    severity: 0.6,
-    aliases: ['cicying'],
-    description: 'Secara harfiah berarti anjing dalam Bahasa Bali',
-    context: 'Umpatan umum dalam Bahasa Bali'
-  },
-  // ... tambahkan kata lainnya
-];
-
-export const baliWords = bali.map(item => item.word);
-
-export default bali;
-```
-
-### 2. Menambahkan ke File Kategori (Opsional)
-
-Jika Anda menambahkan kata baru, perbarui juga file kategori yang sesuai (`src/constants/categories/`). Kata-kata tersebut akan otomatis terambil saat library dibuild, tetapi terkadang kategori perlu diperbarui.
-
-### 3. Update File indeks Daerah/Kategori (jika ada daerah baru)
-
-Jika Anda menambahkan daerah baru, pastikan untuk memperbarui file indeks:
-- `src/constants/regions/index.ts`
-- `src/constants/wordList.ts`
-
-### 4. Jalankan Tes (jika ada)
-
-```bash
-npm test
-```
-
-### 5. Build Library
-
-```bash
-npm run build
-```
-
-### 6. Commit dan Push Perubahan Anda
-
-```bash
-git add .
-git commit -m "Menambahkan kata kotor daerah X"
-git push origin add-kata-kotor-daerah
-```
-
-### 7. Buat Pull Request
-
-Buat Pull Request dari branch Anda ke repositori utama.
-
-## Pedoman Penambahan Kata
-
-1. **Validasi Kata**: Pastikan kata tersebut benar-benar dianggap kasar di daerah yang dimaksud.
-2. **Metadata**: Tambahkan metadata yang cukup, terutama tingkat keparahan dan kategori.
-3. **Konteks**: Tambahkan komentar konteks jika diperlukan untuk menjelaskan kata tersebut.
-4. **Bentuk Dasar**: Tambahkan kata dalam bentuk dasarnya, variasi dapat ditambahkan dalam `aliases`.
-5. **Kategorisasi**: Kategorikan kata dengan benar (seksual, hinaan, umpatan, dll).
-6. **Hindari Duplikasi**: Periksa apakah kata tersebut sudah ada sebelum menambahkannya.
-
-## Format Commit
-
-Gunakan format commit yang konsisten:
-- `Add: Menambahkan kata X dari daerah Y`
-- `Update: Memperbaiki metadata kata X`
-- `Fix: Memperbaiki bug pada ...`
-
-## Informasi Tambahan
-
+# Panduan Kontribusi untuk ID-Profanity-Filter
+
+Terima kasih telah mempertimbangkan untuk berkontribusi pada proyek ID-Profanity-Filter! Panduan ini akan menjelaskan proses kontribusi, terutama untuk menambahkan kata kotor baru ke dalam database.
+
+## Cara Berkontribusi
+
+### 1. Fork & Clone Repositori
+
+- Fork repositori ini ke akun GitHub Anda
+- Clone repositori fork Anda ke komputer lokal:
+  ```bash
+  git clone https://github.com/username/id-profanity-filter.git
+  cd id-profanity-filter
+  ```
+
+### 2. Install Dependensi
+
+```bash
+npm install
+```
+
+### 3. Buat Branch Baru
+
+```bash
+git switch -c add-kata-kotor-daerah
+```
+
+## Struktur Kata Kotor
+
+Kata-kata kotor dalam proyek ini dikelompokkan berdasarkan dua dimensi:
+
+### Berdasarkan Daerah Asal
+
+Lokasi file: `src/constants/regions/`
+
+Kata-kata dikelompokkan berdasarkan daerah asalnya di Indonesia, seperti:
+- `general.ts` - Kata-kata umum di Indonesia
+- `jawa.ts` - Kata-kata dari Jawa
+- `sunda.ts` - Kata-kata dari Sunda
+- `betawi.ts` - Kata-kata dari Betawi
+- `batak.ts` - Kata-kata dari Batak
+- ... dan daerah lainnya
+
+### Berdasarkan Kategori
+
+Lokasi file: `src/constants/categories/`
+
+Kata-kata juga dikelompokkan berdasarkan jenisnya:
+- `sexual.ts` - Kata-kata berbau seksual
+- `insult.ts` - Kata-kata penghinaan
+- `profanity.ts` - Umpatan umum
+- `slur.ts` - Kata-kata merendahkan berdasarkan identitas
+- `drugs.ts` - Kata-kata terkait narkoba
+- `disgusting.ts` - Kata-kata menjijikkan
+- `blasphemy.ts` - Kata-kata penistaan agama
+
+## Cara Menambahkan Kata Kotor Baru
+
+### 1. Menambahkan ke File Daerah
+
+Pilih file daerah yang sesuai di `src/constants/regions/` atau buat file baru jika daerah tersebut belum ada. Format entri kata kotor harus mengikuti interface `ProfanityWord`:
+
+```typescript
+{
+  word: 'kata_kotor',        // Kata kotor dalam bentuk dasarnya
+  category: 'insult',        // Kategori kata (sexual, insult, profanity, slur, drugs, disgusting, blasphemy)
+  region: 'nama_daerah',     // Daerah asal kata
+  severity: 0.7,             // Tingkat keparahan (0-1)
+  aliases: ['alias1', 'alias2'], // Variasi atau alias kata (opsional)
+  description: 'Deskripsi kata', // Penjelasan singkat tentang kata (opsional)
+  context: 'Konteks penggunaan' // Informasi konteks penggunaan (opsional)
+}
+```
+
+Contoh menambahkan kata ke file daerah (misalnya `bali.ts`):
+
+```typescript
+import { ProfanityWord } from '../../types';
+
+export const bali: ProfanityWord[] = [
+  // ... kata-kata yang sudah ada
+  {
+    word: 'cicing',
+    category: 'profanity',
+    region: 'bali',
+    severity: 0.6,
+    aliases: ['cicying'],
+    description: 'Secara harfiah berarti anjing dalam Bahasa Bali',
+    context: 'Umpatan umum dalam Bahasa Bali'
+  },
+  // ... tambahkan kata lainnya
+];
+
+export const baliWords = bali.map(item => item.word);
+
+export default bali;
+```
+
+### 2. Menambahkan ke File Kategori (Opsional)
+
+Jika Anda menambahkan kata baru, perbarui juga file kategori yang sesuai (`src/constants/categories/`). Kata-kata tersebut akan otomatis terambil saat library dibuild, tetapi terkadang kategori perlu diperbarui.
+
+### 3. Update File indeks Daerah/Kategori (jika ada daerah baru)
+
+Jika Anda menambahkan daerah baru, pastikan untuk memperbarui file indeks:
+- `src/constants/regions/index.ts`
+- `src/constants/wordList.ts`
+
+### 4. Jalankan Tes (jika ada)
+
+```bash
+npm test
+```
+
+### 5. Build Library
+
+```bash
+npm run build
+```
+
+### 6. Commit dan Push Perubahan Anda
+
+```bash
+git add .
+git commit -m "Menambahkan kata kotor daerah X"
+git push origin add-kata-kotor-daerah
+```
+
+### 7. Buat Pull Request
+
+Buat Pull Request dari branch Anda ke repositori utama.
+
+## Pedoman Penambahan Kata
+
+1. **Validasi Kata**: Pastikan kata tersebut benar-benar dianggap kasar di daerah yang dimaksud.
+2. **Metadata**: Tambahkan metadata yang cukup, terutama tingkat keparahan dan kategori.
+3. **Konteks**: Tambahkan komentar konteks jika diperlukan untuk menjelaskan kata tersebut.
+4. **Bentuk Dasar**: Tambahkan kata dalam bentuk dasarnya, variasi dapat ditambahkan dalam `aliases`.
+5. **Kategorisasi**: Kategorikan kata dengan benar (seksual, hinaan, umpatan, dll).
+6. **Hindari Duplikasi**: Periksa apakah kata tersebut sudah ada sebelum menambahkannya.
+
+## Format Commit
+
+Gunakan format commit yang konsisten:
+- `Add: Menambahkan kata X dari daerah Y`
+- `Update: Memperbaiki metadata kata X`
+- `Fix: Memperbaiki bug pada ...`
+
+## Informasi Tambahan
+
 Untuk pertanyaan atau diskusi, silakan buat issue di GitHub atau hubungi maintainer proyek. Terima kasih atas kontribusi Anda!

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Side ID ~
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 Side ID ~
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.