{"id":19901304,"url":"https://github.com/lissy93/remove-words","last_synced_at":"2025-05-02T23:31:38.730Z","repository":{"id":57142235,"uuid":"43177586","full_name":"Lissy93/remove-words","owner":"Lissy93","description":":newspaper: A node module that returns all words from a string in a custom defined list. By default will remove all pronouns and conjunctions.","archived":false,"fork":false,"pushed_at":"2017-12-30T21:45:54.000Z","size":34,"stargazers_count":6,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-17T02:02:19.909Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Lissy93.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.MD","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-09-25T22:03:04.000Z","updated_at":"2023-09-08T17:02:02.000Z","dependencies_parsed_at":"2022-09-05T18:51:40.930Z","dependency_job_id":null,"html_url":"https://github.com/Lissy93/remove-words","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lissy93%2Fremove-words","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lissy93%2Fremove-words/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lissy93%2Fremove-words/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lissy93%2Fremove-words/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Lissy93","download_url":"https://codeload.github.com/Lissy93/remove-words/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252122273,"owners_count":21698305,"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":[],"created_at":"2024-11-12T20:14:37.389Z","updated_at":"2025-05-02T23:31:38.451Z","avatar_url":"https://github.com/Lissy93.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# remove-words\n\n[![Greenkeeper badge](https://badges.greenkeeper.io/Lissy93/remove-words.svg)](https://greenkeeper.io/)\n\n[![Build Status](https://travis-ci.org/Lissy93/remove-words.svg?branch=dev)](https://travis-ci.org/Lissy93/remove-words)\n[![Dependency Status](https://david-dm.org/lissy93/remove-words.svg)](https://david-dm.org/lissy93/remove-words)\n[![devDependency Status](https://david-dm.org/lissy93/remove-words/dev-status.svg)](https://david-dm.org/lissy93/remove-words#info=devDependencies)\n[![Code Climate](https://codeclimate.com/github/Lissy93/remove-words/badges/gpa.svg)](https://codeclimate.com/github/Lissy93/remove-words)\n[![Maintenance](https://img.shields.io/maintenance/yes/2018.svg)](https://github.com/Lissy93)\n\n\n\u003eA node module that returns an array of all words in a string that are not a pronoun or generic words.\n\nThis can be used for storing just the keywords of a string in a database and not wasting space with words like 'and', 'to', 'the'... which are unlikely to be searched for in a query.\n\n\n## Installation\n```yarn add remove-words --save```\n\n\n## Example\n```javascript\nvar removeWords =  require('remove-words');\n\nremoveWords(\"Today is sunny so we are going to go swimming at the seaside\");\n// Will return: ['today', 'sunny', 'swimming', 'seaside']\n\n\n```\n\n## Removing duplicates\nBy default all duplicates will be removed. The second (optional) parameter is a\nboolean, specifiying weather of not to remove duplicates.\n\n```javascript\nremoveWords(\"Hello world hello hello\", true); // [\"hello\", \"world\"]\nremoveWords(\"Hello world hello hello\", false); // [\"hello\", \"world\", \"hello\", \"hello\"]\n```\n\n## Using a custom word list\n```javascript\n\nvar names = ['jack', 'john', 'joe', 'james', 'jim']\nremoveWords(\"The winners are: Jack, John and Jim!!!\", true, names)\n// Will remove just all names\n```\n\n## Features\n- Case insensitive\n- Handles special characters, URL's and other non standard strings\n- By default doesn't return any duplicates, but can be specified in 2nd parameter\n- Doesn't return blanks or special characters\n- Thoroughly unit tested\n- Words list is customisable, optionally pass in your own array as the third parameter\n\n\n## Tests\nRun ```npm test```\n\n\n## Building\n- `gulp build` - Lints and compiles CoffeeScript\n- `gulp test` - Runs tests\n- `gulp` - Watches for changes, cleans working directory, builds and tests\n\n\n## Contributing\nIf you find an issue:\n - Feel free to raise it as an issue [here](https://github.com/Lissy93/remove-words/issues)\n (give as much detail about your scenario as possible) and I'll look into it\n - Or better yet submit a pull request with your feature or fix. Ensure all tests still pass\n and give a short sentence of why it should be merged in the PR description.\n\n## Development\n- Clone the repo and cd into it. `git clone https://github.com/Lissy93/remove-words.git \u0026\u0026 cd $(basename $_ .git)`\n- Install dev dependencies `yarn install --production=false`\n- Build and/or watch `npm run build`/ `npm run watch`\n- Make changes, then run `npm test`\n\n## License\nMIT © [Alicia Sykes](http://aliciasykes.com) 2017. [View licence](LICENSE.MD).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flissy93%2Fremove-words","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flissy93%2Fremove-words","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flissy93%2Fremove-words/lists"}