{"id":28092675,"url":"https://github.com/yoonheyjung/badwords-ko","last_synced_at":"2026-03-07T21:02:08.566Z","repository":{"id":40409191,"uuid":"452368193","full_name":"yoonheyjung/badwords-ko","owner":"yoonheyjung","description":"이 npm 은 한국어 비속어를 필터링하기 위해 만들어졌습니다.  (This npm was created to filter out Korean profanity.)","archived":false,"fork":false,"pushed_at":"2023-09-14T02:59:35.000Z","size":108,"stargazers_count":22,"open_issues_count":2,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-24T22:39:02.088Z","etag":null,"topics":["badwords","filter","javascript"],"latest_commit_sha":null,"homepage":"","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/yoonheyjung.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-26T17:14:15.000Z","updated_at":"2025-09-18T01:23:28.000Z","dependencies_parsed_at":"2024-06-21T19:02:04.354Z","dependency_job_id":"f04a9a08-4aad-429b-8b73-2de304022ba0","html_url":"https://github.com/yoonheyjung/badwords-ko","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/yoonheyjung/badwords-ko","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoonheyjung%2Fbadwords-ko","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoonheyjung%2Fbadwords-ko/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoonheyjung%2Fbadwords-ko/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoonheyjung%2Fbadwords-ko/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yoonheyjung","download_url":"https://codeload.github.com/yoonheyjung/badwords-ko/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoonheyjung%2Fbadwords-ko/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30231490,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T19:01:10.287Z","status":"ssl_error","status_checked_at":"2026-03-07T18:59:58.103Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["badwords","filter","javascript"],"created_at":"2025-05-13T13:34:36.244Z","updated_at":"2026-03-07T21:02:08.561Z","avatar_url":"https://github.com/yoonheyjung.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# badwords-ko\n\nA javascript filter for badwords\n\n[![Build Status](https://travis-ci.org/web-mech/badwords.svg?branch=master)](https://travis-ci.org/web-mech/badwords)\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)\n\n## Description\n\n이 npm 은 한국어 비속어를 필터링하기 위해 만들어졌습니다.\n(This npm was created to filter out Korean profanity.)  \n It was built using npm filtering the profanity below.\n\n[Reference](https://www.npmjs.com/package/bad-words)\n\n## Requirements\n\nRequires you either have an environment that understands ES2016 and beyond or a transpiler like Babel.\n\n## Installation\n\n    npm install badwords-ko --save\n\n\u003c/br\u003e\n\n---\n\n\u003c/br\u003e\n\n## Usage\n\n```js\nimport Filter from \"badwords-ko\";\n\nconst filter = new Filter();\n\nconsole.log(filter.clean(\"욕을 합니다 개새끼\")); // 욕을 합니다 ***\n```\n\n### Placeholder Overrides\n\n```js\nimport Filter from \"badwords-ko\";\nconst customFilter = new Filter({ placeHolder: \"x\" });\n\ncustomFilter.clean(\"욕을 합니다 개새끼\"); // 욕을 합니다 xxx\n```\n\n### Regex Overrides\n\n```js\nconst filter = new Filter({ regex: /\\*|\\.|$/gi });\n\nconst filter = new Filter({ replaceRegex: /[A-Za-z0-9가-힣_]/g });\n//multilingual support for word filtering\n```\n\n### Add words to the blacklist\n\n```js\nconst filter = new Filter();\n\nfilter.addWords(\"무진장\", \"나쁜\", \"말\");\n\nfilter.clean(\"무진장 나쁜 말!\"); //**** *** ****!\n\n//or use an array using the spread operator\n\nconst newBadWords = [\"무진장\", \"나쁜\", \"말\"];\n\nfilter.addWords(...newBadWords);\n\nfilter.clean(\"무진장 나쁜 말!\"); //**** *** ****!\n\n//or\n\nconst filter = new Filter({ list: [\"무진장\", \"나쁜\", \"말\"] });\n\nfilter.clean(\"무진장 나쁜 말!\"); //**** *** ****!\n```\n\n### Instantiate with an empty list\n\n```js\nconst filter = new Filter({ emptyList: true });\nfilter.clean(\"아무것도 지워지지 않습니다. \"); //hell this wont clean anything\n```\n\n### Remove words from the blacklist\n\n```js\nlet filter = new Filter();\n\nfilter.removeWords(\"시발\", \"에라이퉷\");\n\nfilter.clean(\"some 시발 에이라이퉷!\"); //some 시발 에이라이퉷!\n\n//or use an array using the spread operator\n\nlet removeWords = [\"시발\", \"에라이퉷\"];\n\nfilter.removeWords(...removeWords);\n\nfilter.clean(\"some 에라이퉷 시발 에이라이퉷!\"); //some 에라이퉷 시발 에라이퉷!\n```\n\n### API\n\n\u003c!-- Generated by documentation.js. Update this documentation by updating the source code. --\u003e\n\n#### constructor\n\nFilter constructor.\n\n**Parameters**\n\n- `options` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Filter instance options (optional, default `{}`)\n  - `options.emptyList` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Instantiate filter with no blacklist\n  - `options.list` **[array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** Instantiate filter with custom list\n  - `options.placeHolder` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Character used to replace profane words.\n  - `options.regex` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Regular expression used to sanitize words before comparing them to blacklist.\n  - `options.replaceRegex` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Regular expression used to replace profane words with placeHolder.\n\n#### isProfane\n\nDetermine if a string contains profane language.\n\n**Parameters**\n\n- `string` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** String to evaluate for profanity.\n\n#### replaceWord\n\nReplace a word with placeHolder characters;\n\n**Parameters**\n\n- `string` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** String to replace.\n\n#### clean\n\nEvaluate a string for profanity and return an edited version.\n\n**Parameters**\n\n- `string` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Sentence to filter.\n\n#### addWords\n\nAdd word(s) to blacklist filter / remove words from whitelist filter\n\n**Parameters**\n\n- `word` **...[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Word(s) to add to blacklist\n\n#### removeWords\n\nAdd words to whitelist filter\n\n**Parameters**\n\n- `word` **...[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Word(s) to add to whitelist.\n\n## Testing\n\n    npm test\n\n## License\n\nThe MIT License (MIT)\n\nCopyright (c) 2015 Michael Price\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\nIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoonheyjung%2Fbadwords-ko","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyoonheyjung%2Fbadwords-ko","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoonheyjung%2Fbadwords-ko/lists"}