{"id":26483680,"url":"https://github.com/raymondjavaxx/swearjar-node","last_synced_at":"2025-06-17T10:42:37.006Z","repository":{"id":16223281,"uuid":"18970585","full_name":"raymondjavaxx/swearjar-node","owner":"raymondjavaxx","description":"Profanity detection and filtering library.","archived":false,"fork":false,"pushed_at":"2019-04-10T22:59:22.000Z","size":12,"stargazers_count":74,"open_issues_count":11,"forks_count":32,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-13T17:11:54.230Z","etag":null,"topics":["filtering-library","javascript","profanity","profanity-detection"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/raymondjavaxx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-04-20T18:15:17.000Z","updated_at":"2025-03-06T08:49:14.000Z","dependencies_parsed_at":"2022-07-25T03:32:14.140Z","dependency_job_id":null,"html_url":"https://github.com/raymondjavaxx/swearjar-node","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raymondjavaxx%2Fswearjar-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raymondjavaxx%2Fswearjar-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raymondjavaxx%2Fswearjar-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raymondjavaxx%2Fswearjar-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/raymondjavaxx","download_url":"https://codeload.github.com/raymondjavaxx/swearjar-node/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244241477,"owners_count":20421682,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["filtering-library","javascript","profanity","profanity-detection"],"created_at":"2025-03-20T04:57:38.170Z","updated_at":"2025-03-20T04:57:38.698Z","avatar_url":"https://github.com/raymondjavaxx.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# swearjar-node\n\nProfanity detection and filtering library.\n\n[![Build Status](https://travis-ci.org/raymondjavaxx/swearjar-node.svg?branch=master)](https://travis-ci.org/raymondjavaxx/swearjar-node)\n\n## Installation\n\n    npm install --save swearjar\n\n## Usage\n\n### swearjar.profane(text)\n\nReturns true if the given string contains profanity.\n\n    var swearjar = require('swearjar');\n    swearjar.profane(\"hello there\"); // false\n    swearjar.profane(\"hello mother f-bomb\"); // true\n\n### swearjar.censor(text)\n\nReplaces profanity with asterisks.\n\n    var clean = swearjar.censor(\"f-bomb you\"); // **** you\n\n### swearjar.scorecard(text)\n\nGenerates a report from the given text.\n\n    swearjar.scorecard(\"f-bomb you\"); // {sexual: 1, inappropriate: 1}\n\n### swearjar.loadBadWords(path)\n\nLoads a dictionary of words to be used as filter.\n\nNOTE: A US English default list located in the config directory is included and loaded by default.\n\n    swearjar.loadBadWords('./config/profanity.json');\n\nA dictionary is just a plain JSON file containing an object where its keys are the words to check for and the values are arrays of categories where the words fall in.\n\n\t{\n\t\t\"word1\": [\"category1\", \"category2\"],\n\t\t\"word2\": [\"category1\"],\n\t\t\"word3\": [\"category2\"]\n\t}\n\n## Acknowledgements\n\n`swearjar-node` is based on [Swearjar](https://github.com/joshbuddy/swearjar) (Ruby) and [Swearjar PHP](https://github.com/raymondjavaxx/swearjar-php).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraymondjavaxx%2Fswearjar-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fraymondjavaxx%2Fswearjar-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraymondjavaxx%2Fswearjar-node/lists"}