build(release): bump to v1.1.0 (#7)

* chore(package): update dependencies

* docs(readme): add Greenkeeper badge

* feat(report): add linked index of terms

#1

* ci(dependencies): enable greenkeeper

Automate dependency drift updates.

#1,#5

* style(lint): fix eslint errors in tests

#1,#5

* style(lexicon): format file to fix rendering

* style(template): add collapsing details by default

* build(release): fix semantic-release config

Prune unused template files.
Output CLI stuff to the console.

Author: gregswindle

.travis.yml

@@ -20,5 +20,4 @@ deploy:
   provider: script
   skip_cleanup: true
   script:
-    - npm run release
     - npx travis-deploy-once "npx semantic-release"

CODE_OF_CONDUCT.md

@@ -1,74 +1,72 @@
+[![Generator Community Repo][product-repo-logo-image]][product-repo-url]
+
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
+![Pledge][icon-pledge-image] In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and
 orientation.
 
 ## Our Standards
 
-Examples of behavior that contributes to creating a positive environment
-include:
+![Equality][icon-equality-image] Contributing to open source software should be gratifying, rewarding, and fun. Open source software depends on a transparent and respectful community of people. Therefore, problematic behavior will be addressed swiftly, politely, and publicly, in order to send a signal to potential contributors that such behavior isn't typical or tolerated.
+
+### Positive behavior
+
+![Good decisions][icon-good-decision-image] Examples of behavior that contribute to creating a positive environment include:
 
 * Using welcoming and inclusive language
 * Being respectful of differing viewpoints and experiences
 * Gracefully accepting constructive criticism
 * Focusing on what is best for the community
 * Showing empathy towards other community members
 
-Examples of unacceptable behavior by participants include:
+### Unacceptable behavior
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-  advances
+![Bad decisions][icon-bad-decision-image] Examples of unacceptable participant behavior include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
 * Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
+* Doxing, i.e., publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable
+![Investigation][icon-justice-image] Project maintainers are responsible for clarifying the standards of acceptable
 behavior and are expected to take appropriate and fair corrective action in
 response to any instances of unacceptable behavior.
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
+![Scope][icon-globe-image] This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by [contacting the project team][email]. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+![Enforcement][icon-badge-image] Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by **[contacting the team][team-email-mailto]**. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
-
-[email]: greg@swindle.net
-[homepage]: https://www.contributor-covenant.org
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version].
+
+---
+
+Graphic art by [icons8](https://icons8.com/).
+
+[homepage]: http://contributor-covenant.org
+[icon-bad-decision-image]: ./docs/img/icons8/icon-bad-decision-50.png
+[icon-badge-image]: ./docs/img/icons8/icon-badge-50.png
+[icon-equality-image]: ./docs/img/icons8/icon-equality-50.png
+[icon-globe-image]: ./docs/img/icons8/icon-globe-50.png
+[icon-good-decision-image]: ./docs/img/icons8/icon-good-decision-50.png
+[icon-justice-image]: ./docs/img/icons8/icon-justice-50.png
+[icon-pledge-image]: ./docs/img/icons8/icon-pledge-50.png
+[product-repo-logo-image]: ./docs/img/logo-commonalaxy.png
+[product-repo-url]: https://github.com/commonality/common-vocabulary
+[team-email-mailto]: mailto:greg@swindle.net?Subject=%5Bcommon-vocabulary%5D%20Code%20of%20conduct%20concern
+[team-issues-url]: https://github.com/commonality/common-vocabulary/issues/new
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -1257,7 +1257,7 @@
 [conventional-commits-url]: https://conventionalcommits.org
 [coolors-palette-url]: https://coolors.co/cfdbd5-e8eddf-f5cb5c-242423-333533
 [eslint-logo-image]: ./docs/img/logo-eslint.png
-[eslint-rules-table-url]: ./ESLINT_RULES.md
+[eslint-rules-table-url]: .github/eslint-rules-table.md
 [eslint-url]: https://eslint.org
 [force-with-lease-url]: https://developer.atlassian.com/blog/2015/04/force-with-lease/
 [fossa-image-large]: https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Forganization%2Frepo-name.svg?type=large

README.md

@@ -110,11 +110,17 @@ Contributions in the form of GitHub pull requests are welcome. Before embarking
 [![Greenkeeper badge](https://badges.greenkeeper.io/commonality/common-vocabulary.svg?style=flat-square)](https://greenkeeper.io/)
 [![README doc score][readme-score-img]][readme-score-url]
 
+Graphic art by [icons8](https://icons8.com/).
+
 <!-- ⛔️ 📝 NOTE: PLEASE ALPHABETIZE LINK REFERENCES. 📝 ⛔️ -->
 
 [appveyor-image]: https://img.shields.io/appveyor/ci/gregswindle/common-vocabulary.svg?style=flat-square&logo=appveyor
 [appveyor-url]: https://ci.appveyor.com/project/gregswindle/common-vocabulary
 [author-url]: https://github.com/commonality
+[bithound-dev-image]: https://img.shields.io/bithound/devDependencies/github/commonality/common-vocabulary.svg?style=flat-square
+[bithound-dev-url]: https://www.bithound.io/github/commonality/common-vocabulary/master/dependencies/npm
+[bithound-image]: https://img.shields.io/bithound/dependencies/github/commonality/common-vocabulary.svg?style=flat-square
+[bithound-url]: https://www.bithound.io/github/commonality/common-vocabulary/master/dependencies/npm
 [changelog-url]: ./CHANGELOG.md
 [codacy-image]: https://img.shields.io/codacy/grade/58a7e841538a49cc8a5d35eba00e6c07.svg?style=flat-square
 [codacy-url]: https://www.codacy.com/app/commonality/common-vocabulary?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=commonality/common-vocabulary&amp;utm_campaign=Badge_Grade
@@ -124,10 +130,6 @@ Contributions in the form of GitHub pull requests are welcome. Before embarking
 [contributing-url]: ./CONTRIBUTING.md
 [coveralls-image]: https://img.shields.io/coveralls/github/commonality/common-vocabulary.svg?style=flat-square
 [coveralls-url]: https://coveralls.io/r/commonality/common-vocabulary
-[bithound-image]: https://img.shields.io/bithound/dependencies/github/commonality/common-vocabulary.svg?style=flat-square
-[bithound-url]: https://www.bithound.io/github/commonality/common-vocabulary/master/dependencies/npm
-[bithound-dev-image]: https://img.shields.io/bithound/devDependencies/github/commonality/common-vocabulary.svg?style=flat-square
-[bithound-dev-url]: https://www.bithound.io/github/commonality/common-vocabulary/master/dependencies/npm
 [fossa-image]: https://app.fossa.io/api/projects/git%2Bgithub.com%2Fcommonality%2Fcommon-vocabulary.svg?type=shield&style=flat-square
 [fossa-url]: https://app.fossa.io/projects/git%2Bgithub.com%2Fcommonality%2Fcommon-vocabulary?ref=badge_shield
 [issues-new-defect-image]: https://img.shields.io/badge/report---defect---lightgrey.svg?style=for-the-badge&label=report+a

docs/common-vocabulary.md

@@ -1,6 +1,6 @@
 # Common Vocabulary
 
-> Generated on Thu Feb 08 2018.
+> Generated on Fri Feb 09 2018.
 
 ## Index of terms
 

lib/adaptor/conventional-commits-adaptor.js

@@ -4,6 +4,10 @@ const LexicalEntry = require('../lexical-entry')
 class ConventionalCommitsAdaptor {
   constructor () {
     this.types = conventionalCommitTypes.types
+    this.uri =
+      'https://raw.githubusercontent.com' +
+      '/commitizen/conventional-commit-types/master' +
+      '/index.json#types'
   }
 
   adapt () {
@@ -12,7 +16,7 @@ class ConventionalCommitsAdaptor {
       'dd': this.types[type].description,
       'dt': type,
       'meta': {
-        '$ref': `https://raw.githubusercontent.com/commitizen/conventional-commit-types/master/index.json#types.${type}`
+        '$ref': `${this.uri}/${type}`
       },
       'title': this.types[type].title
     }))

lib/cli/index.js

@@ -7,16 +7,16 @@ const path = require('path')
 
 const msg = `
 Usage
-  $ common-vocabulary [input]
-
-Synopsis
-  add <term> <definition> [<category>]
-    Appends a new lexical entry with the given
-    definition to the lexicon object. Returns the lexicon object.
+  $ common-vocabulary [command]
 
+Commands
   clear
     Removes all lexical entrys from the lexicon object.
 
+  define <term> <definition> [<category>]
+    Appends a new lexical entry with the given
+    definition to the lexicon object. Returns the lexicon object.
+
   definitions
     Returns a new Iterator object that contains the lexical
     entries for all terms.
@@ -34,16 +34,24 @@ Synopsis
     Sets the name of the lexicon. If the name is omitted, it
     returns the Common Vocabulary's name.
 
+  report
+    Serializes the lexicon as GitHub-flavored Markdown as
+    saves it to --output.
+
   terms
     Is the same function as the definitions.
 
+  toString
+    Serialize the lexicon as JSON and send to stdout.
+
 Options
-  --output, -o      Path to definition file. [Default: false]
+  --output, -o      Path to definition file.
+                    [Default: ./docs/common-vocabulary.md]
 
 Examples
   $ common-vocabulary
-  unicorns
-  $ common-vocabulary add fo "bario"
+  # => generates ./docs/common-vocabulary.md
+  $ common-vocabulary has foo-bar
   unicorns & rainbows
 `
 
@@ -57,14 +65,30 @@ const options = {
   }
 }
 
-const main = () => {
-  const commonVocabulary = new CommonVocabulary()
+const decorator = {
+  forReports (cli, commonVocabulary) {
+    commonVocabulary.report = () => {
+      const destination = cli.flags.output || options.flags.output.default
+
+      const lexicon = commonVocabulary.toHtml()
+      const lexiconFactory = new LexiconFactory()
+      lexiconFactory.report(destination, lexicon)
+    }
+  },
+
+  forStdout (cli, commonVocabulary) {
+    const method = cli.input.shift() || 'report'
+    // eslint-disable-next-line no-console
+    console.log(commonVocabulary[method](cli.input))
+  }
+}
+
+const init = () => {
   const cli = meow(msg, options)
-  const method = cli.input.shift() || 'toHtml'
-  const report = commonVocabulary[method](cli.input)
-  const destination = cli.flags.output || options.flags.output.default
-  const lexiconFactory = new LexiconFactory()
-  lexiconFactory.report(destination, report)
+  const commonVocabulary = new CommonVocabulary()
+
+  decorator.forReports(cli, commonVocabulary)
+  decorator.forStdout(cli, commonVocabulary)
 }
 
-main()
+init()

lib/cli/prep-dirs.js

@@ -1,4 +1,5 @@
-const ConventionalCommitsAdaptor = require('./adaptor/conventional-commits-adaptor')
+const ConventionalCommitsAdaptor =
+  require('./adaptor/conventional-commits-adaptor')
 const LexicalEntry = require('./lexical-entry')
 const ejs = require('ejs')
 const fs = require('fs-extra')