https://github.com/lissy93/remove-words
:newspaper: A node module that returns all words from a string in a custom defined list. By default will remove all pronouns and conjunctions.
https://github.com/lissy93/remove-words
Last synced: about 1 year ago
JSON representation
:newspaper: A node module that returns all words from a string in a custom defined list. By default will remove all pronouns and conjunctions.
- Host: GitHub
- URL: https://github.com/lissy93/remove-words
- Owner: Lissy93
- License: other
- Created: 2015-09-25T22:03:04.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-12-30T21:45:54.000Z (over 8 years ago)
- Last Synced: 2025-04-17T02:02:19.909Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 33.2 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.MD
Awesome Lists containing this project
README
# remove-words
[](https://greenkeeper.io/)
[](https://travis-ci.org/Lissy93/remove-words)
[](https://david-dm.org/lissy93/remove-words)
[](https://david-dm.org/lissy93/remove-words#info=devDependencies)
[](https://codeclimate.com/github/Lissy93/remove-words)
[](https://github.com/Lissy93)
>A node module that returns an array of all words in a string that are not a pronoun or generic words.
This 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.
## Installation
```yarn add remove-words --save```
## Example
```javascript
var removeWords = require('remove-words');
removeWords("Today is sunny so we are going to go swimming at the seaside");
// Will return: ['today', 'sunny', 'swimming', 'seaside']
```
## Removing duplicates
By default all duplicates will be removed. The second (optional) parameter is a
boolean, specifiying weather of not to remove duplicates.
```javascript
removeWords("Hello world hello hello", true); // ["hello", "world"]
removeWords("Hello world hello hello", false); // ["hello", "world", "hello", "hello"]
```
## Using a custom word list
```javascript
var names = ['jack', 'john', 'joe', 'james', 'jim']
removeWords("The winners are: Jack, John and Jim!!!", true, names)
// Will remove just all names
```
## Features
- Case insensitive
- Handles special characters, URL's and other non standard strings
- By default doesn't return any duplicates, but can be specified in 2nd parameter
- Doesn't return blanks or special characters
- Thoroughly unit tested
- Words list is customisable, optionally pass in your own array as the third parameter
## Tests
Run ```npm test```
## Building
- `gulp build` - Lints and compiles CoffeeScript
- `gulp test` - Runs tests
- `gulp` - Watches for changes, cleans working directory, builds and tests
## Contributing
If you find an issue:
- Feel free to raise it as an issue [here](https://github.com/Lissy93/remove-words/issues)
(give as much detail about your scenario as possible) and I'll look into it
- Or better yet submit a pull request with your feature or fix. Ensure all tests still pass
and give a short sentence of why it should be merged in the PR description.
## Development
- Clone the repo and cd into it. `git clone https://github.com/Lissy93/remove-words.git && cd $(basename $_ .git)`
- Install dev dependencies `yarn install --production=false`
- Build and/or watch `npm run build`/ `npm run watch`
- Make changes, then run `npm test`
## License
MIT © [Alicia Sykes](http://aliciasykes.com) 2017. [View licence](LICENSE.MD).