-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"presets": ["es2015"], | ||
"plugins": ["lodash"] | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
|
||
root = true | ||
|
||
[*] | ||
indent_style = space | ||
indent_size = 2 | ||
end_of_line = lf | ||
charset = utf-8 | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true | ||
|
||
[*.md] | ||
trim_trailing_whitespace = false | ||
|
||
[*.noon] | ||
trim_trailing_whitespace = false |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
bin/**/* | ||
build/**/* |
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
logs | ||
*.log | ||
coverage | ||
node_modules | ||
|
||
# Project specific | ||
.sync | ||
docs | ||
scripts | ||
staging | ||
wiki | ||
TODO.md | ||
jsdoc.conf.json |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
{ | ||
"babelMapsPath": "bin", | ||
"babelMapsAddUrl": true, | ||
"babelSourcePath": "src", | ||
"babelTranspilePath": "bin", | ||
"createMap": false, | ||
"createTargetDirectories": true, | ||
"createTranspiledCode": true, | ||
"disableWhenNoBabelrcFileInPath": true, | ||
"suppressSourcePathMessages": true, | ||
"suppressTranspileOnSaveMessages": true, | ||
"transpileOnSave": false | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
{ | ||
"ecmaVersion": 6, | ||
"libs": [], | ||
"plugins": { | ||
"doc_comment": { | ||
"fullDocs": true | ||
}, | ||
"complete_strings": {}, | ||
"modules": {}, | ||
"es_modules": {}, | ||
"eslint": { | ||
"config": { | ||
"env": { | ||
"browser": false | ||
}, | ||
"rules": { | ||
"no-unused-vars": 2 | ||
} | ||
} | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
language: node_js | ||
node_js: | ||
- '6' | ||
- '5' | ||
- '4' | ||
- iojs | ||
before_script: | ||
- npm install -g gulp | ||
script: gulp | ||
env: | ||
matrix: | ||
secure: vsrlqxfxmG1ZBAfhGGXqQH3rUwVuIHqSaUSreTVG+WZgODKX2wXTfgin+LjngkQ2onLrigW7bcSbro4ijyn7MSX+Kpt+McIQsNJ7lbe4J8rejGh/j79SFtec7k42CHG/RqVySe+2DQGwe0LqU7ENrGkDy9qYDtSH5j1r92Xd5cezwgWwoZr5tGQdJfuGcIhfG7yoXMIeNHcTiXZtBP1eela1p2CsoQSa1NvnuHyTJt6JFAGkXNhQtNsK+b13hPXYDS/fauZ0c09fYo4e+kvqPx5+UOsF5GTVxzaSrAgpJlXFfP9U0yFgjFmBp46llkLmqjFOeZLDvbNRr3HHNdnCA7fCs/4uaJcO/SCEH8lH8KMJ4LEc4HgHDAv2JJZKV2B1Yszu6K2THAuvE6s8X2OsaxcvQUR0yTlDSwdJuj3xSXvqyM/d1TLk0VqIkUSvfZFbfXLlKgVJLBTPdH4KxTRAeDaZFokQKMEyTiFRDWFVE1bJhC5mUrhl4JI4G7x4csMmjeS7Hfov0ERcFzyhy8N4eJ43Nn7l3jcq1UlFJZvlslCT76l6xJPuL1OriJ8oAUKYnFP0vkoHtOzrwGhHh3jyB8qSkK7xpkZ3MTK6wVyVU24XvcPWoUK26GsW2d7lb0+YPqrj13kipuVtU8XElmMCFyG2MmQEwy1p7ITseXIB0dE= | ||
after_success: | ||
- './node_modules/.bin/nyc report --reporter=text-lcov | ./node_modules/.bin/coveralls' |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
## Contributing | ||
|
||
As of right now, I am the only one contributing to this project. I welcome you to open issues and submit pull requests so that Leximaven can be even better. | ||
|
||
### Build process | ||
|
||
- Managed with [Gulp](http://gulpjs.com) plugins. | ||
- The **build** task transpiles all ES6 code to ES5 using [Babel](http://babeljs.io) and pipes to the build folder. Sourcemaps are inlined for code coverage. | ||
- The **min** task minifies the ES5 code and pipes to the bin folder. | ||
|
||
### Changelog & Versioning | ||
|
||
- Leximaven uses the [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) format. [commitizen](http://commitizen.github.io/cz-cli/) automates this formatting. | ||
- There is no development branch on top of master, so the workflow is clean and simple. [git town](http://www.git-town.com/) helps automate this workflow. | ||
- [standard-version](https://github.com/conventional-changelog/standard-version) automates [semantic versioning](http://semver.org/) and changelog generation. | ||
- See the [CHANGELOG](https://github.com/drawnepicenter/leximaven/blob/master/CHANGELOG.md) for progress. | ||
|
||
### Coding Style & Linting | ||
|
||
Code is linted with [ESLint](http://eslint.org). If you want to contribute code please consider using the provided .eslintrc as a styleguide. It's based on [Airbnb's styleguide](https://github.com/airbnb/javascript), and customized to my liking. | ||
|
||
### Testing | ||
|
||
- Test runner - [Lab](https://github.com/hapijs/lab) | ||
- Assertions - [Code](https://github.com/hapijs/code) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
**Copyright (c) 2016 Andrew Prentice** | ||
|
||
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.** |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
## leximaven | ||
|
||
Skip to [Introduction](#introduction)... | ||
|
||
### Prose | ||
|
||
``` | ||
April 20th, 1620 hours. | ||
It was suck a budiful day I decided to take a walk iff the plarnk. | ||
A flvagrant sat on a bench feeding pidgins and creoles. | ||
Even though he looked a bit seedy, I tapped my hit to him and said, | ||
"High how are you?" | ||
He shrugged and said, "So-sober." | ||
I looked down at his feathery friends. | ||
"Ah, to bee a bird, I mean, to see a seed." | ||
He squinted at me and said, "A seed easy?" | ||
I replied, "No, 'eh bee seedy." | ||
A young couple was approaching us. My companion owlgled the lady and said, "See that bird with the feather in her cap? She let me touch her titmouse." The young man turned cardinal red and said, "I should pfinch your face in!" The homeless man flipped him the bird and shouted, "You're too scared to try it, you yellow-bellied sapsucker!" As they hurried away, the young man muttered, "He's raven mad." | ||
I dodon't know what to say. The indignent just sat there puffin on his halfpipe. | ||
"What are you stoking there friend?" | ||
"Crackpot." | ||
"You can slow-cock a rooster hen one of those, just chickadee timer often." | ||
"Yeah, but my brownies always come out hash-baked." | ||
"Well, maybe you just need some potluck. Here's a five-leaf clover." | ||
"What kind bud?" | ||
"This strainge? Blueberrdy." | ||
He took the nice nugget from me and said, "Dank." He rolled a joint and bluntly said, "I'll spliff this with you, fifty-fifty." | ||
After hemping and hawking for a bit, I said, "Sure, what the flock." I sat on the bench and shared the marywanna sugarette with him. | ||
After awhile he asked me, "How high are you?" | ||
I just said, "Birds I view." | ||
``` | ||
|
||
### Analysis | ||
|
||
``` | ||
420, suck|such, bud|beautiful, walk in the park|walk off the plank | ||
Flagrant|vagrant, pidgins|Pigeons, creoles|Orioles | ||
So-so|sober | ||
Down, feathery | ||
A seed easy|AC/DC | ||
'Eh bee seedy|ABCD | ||
Owl|ogled, Titmouse, Cardinal, punch|Finch, Yellow-bellied sapsucker | ||
Dodo|didn't, indignant|indigent, Puffin|puffing, half|hashpipe | ||
Stoking|smoking, crack/pot|crockpot | ||
Slow cook|cock roast|rooster in|hen, Chickadee|check the | ||
Hash|half-baked | ||
Potluck, pot leaf | ||
Kind bud | ||
Strain|strange, blueberry|Bluebird | ||
Dank|Thanks | ||
Joint, blunt, spliff|split | ||
Hemp|hemming, Hawk|hawing, flock|fuck, mary wanna|marijuana sugar|cigarette | ||
Hi how are you|How high are you | ||
Bird's eye view|Birds I view | ||
``` | ||
|
||
### Analysis of analysis | ||
|
||
I started with `feeding pidgins and creoles`, and it just snowballed from there. It's packed with bird and stoner references. Imagine what Beethoven could have done with a MIDI keyboard and sequencing software. Now imagine what James Joyce could have written with a tool like this. | ||
|
||
### Introduction | ||
|
||
Leximaven is powerful. It can fetch acronyms, anagrams, bi-gram phrases, definitions, etymologies, example uses, hyphenation, offensive word flags, portmanteaus, pronunciations (ARPABET & IPA), related words, rhymes, slang, and syllable stress and count. See the [wiki](https://github.com/drawnepicenter/leximaven/wiki) for more info. | ||
|
||
### Installation | ||
|
||
[Get a Wordnik API key](http://developer.wordnik.com/) and put it in an environment variable WORDNIK. Add it to .bashrc, .zshrc, Windows env, etc. | ||
Then run: | ||
|
||
npm install -g leximaven | ||
leximaven config init | ||
|
||
### Usage | ||
|
||
Leximaven has a built-in help system for CLI parameters and options. Access it with `leximaven -h|--help [command] [subcommand]`. There is also the [wiki](https://github.com/drawnepicenter/leximaven/wiki). | ||
|
||
Here are some examples: | ||
|
||
``` | ||
// Get antonyms for 'noise' | ||
leximaven wordnik relate --canon --type antonym noises | ||
// Get anagrams with at least 2 letters in each word and a maximum of 3 words per anagram using short form flags and exporting to JSON | ||
leximaven anagram -n2 -w3 -o anagrams.json toomanysecrets | ||
// Get a wordmap for 'ubiquity' | ||
leximaven map ubiquity | ||
``` | ||
|
||
### Resources | ||
|
||
The following links can help you use Leximaven or perform related tasks. | ||
|
||
- ISO 639-1 [Language Codes](http://www.loc.gov/standards/iso639-2/php/English_list.php) for Rhymebrain functions | ||
- The [ARPABET](http://en.wikipedia.org/wiki/Arpabet) phoneme list and [IPA](http://en.wikipedia.org/wiki/Help:IPA_for_English) equivalents | ||
- [Dewey Decimal Classes](http://en.wikipedia.org/wiki/List_of_Dewey_Decimal_classes) for acronyms | ||
- Browse Datamuse's Onelook [dictionaries](http://www.onelook.com/?d=all_gen), use its [dictionary lookup](http://www.onelook.com/), [thesaurus/reverse lookup](http://www.onelook.com/thesaurus/), and [RhymeZone](http://www.rhymezone.com/) | ||
- [proselint](https://github.com/amperser/proselint) checks your writing style and has plugins for multiple editors | ||
|
||
### Contributing | ||
|
||
See [CONTRIBUTING](https://github.com/drawnepicenter/leximaven/blob/master/CONTRIBUTING.md). | ||
|
||
### Gratitude | ||
|
||
Many thanks to all contributors to the libraries used in this project! And thanks to the creators and maintainers of the APIs that this tool consumes. Acronym Server, Datamuse, Onelook, Rhymebrain, Urban Dictionary, Wordnik, and Wordsmith are awesome! |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.