{"id":26280718,"url":"https://github.com/commonality/common-vocabulary","last_synced_at":"2025-03-14T15:17:28.494Z","repository":{"id":57213334,"uuid":"119491371","full_name":"commonality/common-vocabulary","owner":"commonality","description":"䷇ Generate and share dictionaries on your repositories to facilitate communication and avoid confusion with canonical terms: share a common vocabulary.","archived":false,"fork":false,"pushed_at":"2020-06-03T10:50:21.000Z","size":8839,"stargazers_count":2,"open_issues_count":33,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-28T19:01:28.218Z","etag":null,"topics":["controlled-vocabularies","reporting"],"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/commonality.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-01-30T06:14:58.000Z","updated_at":"2024-07-21T00:31:12.000Z","dependencies_parsed_at":"2022-08-24T21:41:58.190Z","dependency_job_id":null,"html_url":"https://github.com/commonality/common-vocabulary","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commonality%2Fcommon-vocabulary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commonality%2Fcommon-vocabulary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commonality%2Fcommon-vocabulary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commonality%2Fcommon-vocabulary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/commonality","download_url":"https://codeload.github.com/commonality/common-vocabulary/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242993527,"owners_count":20218598,"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":["controlled-vocabularies","reporting"],"created_at":"2025-03-14T15:17:27.807Z","updated_at":"2025-03-14T15:17:28.485Z","avatar_url":"https://github.com/commonality.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![commonality/common-vocabulary logo][product-repo-logo-image]][product-repo-url]\n\n# `common-vocabulary`\n\n\u003e Facilitate communication and avoid confusion with canonical terms: share a common vocabulary.\n\n[![License][license-badge-image]][license-url]\n[![NPM version][npm-image]][npm-url]\n[![FOSSA Status][fossa-image]][fossa-url]\n[![NSP Status][nsp-image]][nsp-url]\u003cbr\u003e\n[![Dependency drift][bithound-image]][bithound-url]\n[![Dev dependency drift][bithound-dev-image]][bithound-dev-url]\u003cbr\u003e\n[![macOS Build Status][travis-image]][travis-url]\n[![AppVeyor Windows build status][appveyor-image]][appveyor-url]\n[![Coverage percentage][coveralls-image]][coveralls-url]\n[![Codacy Badge][codacy-image]][codacy-url]\n[![PRs Welcome][makeapullrequest-image]][makeapullrequest-url]\n\n## Table of contents\n\n\u003c!-- ⛔️ AUTO-GENERATED-CONTENT:START (TOC:excludeText=Table of contents) --\u003e\n- [Installation](#installation)\n- [Usage](#usage)\n- [API](#api)\n- [Semantic version and `CHANGELOG`](#semantic-version-and-changelog)\n- [Contributing](#contributing)\n- [License](#license)\n\u003c!-- ⛔️ AUTO-GENERATED-CONTENT:END --\u003e\n\n## Installation\n\n**Prerequisite software**\n\n`common-vocabulary` is written for [Node.js][nodejs-url], which must be installed prior to use. Unspecified requires [npm][npmjs-url], which is used for installing dependencies.\n\n```bash\n# Install with Unspecified\n$ npm i common-vocabulary -g\n```\n\n## Usage\n\nYou can add, edit, and remove entries directly from a Terminal.\n\n```bash\ncommon-vocabulary\n# =\u003e Creates docs/common-vocabulary.md\n```\n\n## API\n\n```js\nconst CommonVocabulary = require('common-vocabulary')\n\nconst cv = new CommonVocabulary()\ncv.toHtml()\n```\n\n## Semantic version and `CHANGELOG`\n\nThe latest version of `common-vocabulary` is `1.1.0`. View the [`CHANGELOG`][changelog-url] for details.\n\n## Contributing\n\n[![Learn how to make a Pull Request with free training][prs-welcome-badge-image]][prs-welcome-url] We welcome contributions with [Pull Requests (PRs)][prs-welcome-url]!\n\n---\n\n[![Request a feature][issues-new-feat-image]][issues-new-feat-url]\n[![Report a defect][issues-new-defect-image]][issues-new-defect-url]\n\n[![Read the CONTRIBUTING guidelines][contributing-image]][contributing-url]\n\n---\n\nContributions in the form of GitHub pull requests are welcome. Before embarking on a significant change, please adhere to the following guidelines:\n\n  1. **[Create an issue][issues-url]**\u0026mdash;e.g., a [defect (\"bug\") report][issues-new-defect-url] or a [feature request][issues-new-feat-url]\u0026mdash;to propose changes.\n\n     _Exceptions:_\n\n     \u003e If you're working on documentation and fixing something simple like a typo or an easy bug, go ahead and make a pull request.\n\n  1. **[Follow the CONTRIBUTING guidelines][contributing-url].**\n\n     _Why:_\n\n     \u003e Standards and guidelines make communication easier. If you're willing and able to program\u0026mdash;or want to learn how\u0026mdash; following the guidelines will increase the likelihood of adding your changes to the software product.\n\n  1. **[Read the Code of Conduct][code-of-conduct-url].**\n\n     _Why:_\n\n     \u003e It's more fun when everybody's friendly and respectful.\n\n  1. **[Make a pull request][pulls-url]** when you're ready for other to review your changes (or you get stuck somewhere).\n\n     _PR novices:_\n\n     \u003e **:raising_hand: Never created a pull request?** No problem. [:free: Take this free online training][prs-welcome-url]. (It even covers most of the conventions in the [CONTRIBUTING guidelines][contributing-url]!)\n\n## License\n\n[MIT][license-url] © [commonality][author-url].\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fcommonality%2Fcommon-vocabulary.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fcommonality%2Fcommon-vocabulary?ref=badge_large)\n\n---\n\n[![Greenkeeper badge](https://badges.greenkeeper.io/commonality/common-vocabulary.svg?style=flat-square)](https://greenkeeper.io/)\n[![README doc score][readme-score-img]][readme-score-url]\n\nGraphic art by [icons8](https://icons8.com/).\n\n\u003c!-- ⛔️ 📝 NOTE: PLEASE ALPHABETIZE LINK REFERENCES. 📝 ⛔️ --\u003e\n\n[appveyor-image]: https://img.shields.io/appveyor/ci/gregswindle/common-vocabulary.svg?style=flat-square\u0026logo=appveyor\n[appveyor-url]: https://ci.appveyor.com/project/gregswindle/common-vocabulary\n[author-url]: https://github.com/commonality\n[bithound-dev-image]: https://img.shields.io/bithound/devDependencies/github/commonality/common-vocabulary.svg?style=flat-square\n[bithound-dev-url]: https://www.bithound.io/github/commonality/common-vocabulary/master/dependencies/npm\n[bithound-image]: https://img.shields.io/bithound/dependencies/github/commonality/common-vocabulary.svg?style=flat-square\n[bithound-url]: https://www.bithound.io/github/commonality/common-vocabulary/master/dependencies/npm\n[changelog-url]: ./CHANGELOG.md\n[codacy-image]: https://img.shields.io/codacy/grade/58a7e841538a49cc8a5d35eba00e6c07.svg?style=flat-square\n[codacy-url]: https://www.codacy.com/app/commonality/common-vocabulary?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=commonality/common-vocabulary\u0026amp;utm_campaign=Badge_Grade\n[code-of-conduct-url]: ./CODE_OF_CONDUCT.md\n[code-of-conduct-url]: https://github.com/commonality/common-vocabulary/blob/master/.github/CODE_OF_CONDUCT.md\n[contributing-image]: https://img.shields.io/badge/read---CONTRIBUTING%20Guidelines---yellow.svg?style=for-the-badge\u0026label=read+the\n[contributing-url]: ./CONTRIBUTING.md\n[coveralls-image]: https://img.shields.io/coveralls/github/commonality/common-vocabulary.svg?style=flat-square\n[coveralls-url]: https://coveralls.io/r/commonality/common-vocabulary\n[fossa-image]: https://app.fossa.io/api/projects/git%2Bgithub.com%2Fcommonality%2Fcommon-vocabulary.svg?type=shield\u0026style=flat-square\n[fossa-url]: https://app.fossa.io/projects/git%2Bgithub.com%2Fcommonality%2Fcommon-vocabulary?ref=badge_shield\n[issues-new-defect-image]: https://img.shields.io/badge/report---defect---lightgrey.svg?style=for-the-badge\u0026label=report+a\n[issues-new-defect-url]: https://github.com/commonality/common-vocabulary/issues/new?title=defect%28scope%29%3A+summary-of-problem\u0026labels=priority%3A+medium%2Cstatus%3A+review+needed%2Ctype%3A+defect\u0026body=%2A%2A%F0%9F%92%A1+TIP%3A%2A%2A+Select+the+%E2%86%96%EF%B8%8E%E2%8E%BE+Preview+%E2%8F%8B+Tab+above+help+read+these+instructions.%0D%0A%0D%0A%23%23+1.+Issue+type%0D%0A%3E%E2%8C%A6+Type+the+letter+%22x%22+in+the+%22checkbox%22+the+best+describe+this+issue.%0D%0A%0D%0A-+%5Bx%5D+**Feature%3A**+I%27m+requesting+a+product+enhancement.%0D%0A%0D%0A%23%23+2.+User+story+summary%0D%0A%3E%E2%8C%A6+Describe+what+you+want+to+accomplish%2C+in+what+role%2Fcapacity%2C+and+why+it%27s+important+to+you.%0D%0A%0D%0A%3E+**EXAMPLE%3A**%0D%0A%3E+As+a+Applicant%2C%0D%0A%3E+I+want+to+submit+my+resume%0D%0A%3E+In+order+to+be+considered+for+a+job+opening.%0D%0A%0D%0AAs+a+%7Brole%7D%2C%0D%0AI+must%2Fneed%2Fwant%2Fshould+%7Bdo+something%7D%0D%0AIn+order+to+%7Bachieve+value%7D.%0D%0A%0D%0A%23%23+3.+Acceptance+criteria%0D%0A%3E%E2%8C%A6+Replace+the+examples+below+with+your+own+imperative%2C+%22true%2Ffalse%22+statements+for+the+**behavior+you+expect**+to+see%2C+or+the+behavior+that+**would**+be+true+if+there+were+no+errors+%28for+defects%29.%0D%0A%0D%0A-+%5B+%5D+1.+Job+Applicants+receive+a+confirmation+email+after+they+submit+their+resumes.%0D%0A-+%5B+%5D+2.+An+Applicant%27s+resume+information+isn%27t+lost+when+errors+occur.%0D%0A-+%5B+%5D+3.+%7Bcriterion-three%7D%0D%0A-+%5B+%5D+4.+%7Bcriterion-four%7D%0D%0A%0D%0A%3C%21--+%E2%9B%94%EF%B8%8F++Do+not+remove+anything+below+this+comment.+%E2%9B%94%EF%B8%8F++--%3E%0D%0A%5Bicon-info-image%5D%3A+..%2Fdocs%2Fimg%2Ficons8%2Ficon-info-50.png%0D%0A\n[issues-new-feat-image]: https://img.shields.io/badge/request---feature---blue.svg?style=for-the-badge\u0026label=request+a\n[issues-new-feat-url]: https://github.com/commonality/common-vocabulary/issues/new?title=feat%28scope%29%3A+summary-of-change\u0026labels=priority%3A+medium%2Cstatus%3A+review+needed%2Ctype%3A+feature\u0026body=%2A%2A%F0%9F%92%A1+TIP%3A%2A%2A+Select+the+%E2%86%96%EF%B8%8E%E2%8E%BE+Preview+%E2%8F%8B+Tab+above+help+read+these+instructions.%0D%0A%0D%0A%23%23+1.+Issue+type%0D%0A%3E%E2%8C%A6+Type+the+letter+%22x%22+in+the+%22checkbox%22+the+best+describe+this+issue.%0D%0A%0D%0A-+%5Bx%5D+**Feature%3A**+I%27m+requesting+a+product+enhancement.%0D%0A%0D%0A%23%23+2.+User+story+summary%0D%0A%3E%E2%8C%A6+Describe+what+you+want+to+accomplish%2C+in+what+role%2Fcapacity%2C+and+why+it%27s+important+to+you.%0D%0A%0D%0A%3E+**EXAMPLE%3A**%0D%0A%3E+As+a+Applicant%2C%0D%0A%3E+I+want+to+submit+my+resume%0D%0A%3E+In+order+to+be+considered+for+a+job+opening.%0D%0A%0D%0AAs+a+%7Brole%7D%2C%0D%0AI+must%2Fneed%2Fwant%2Fshould+%7Bdo+something%7D%0D%0AIn+order+to+%7Bachieve+value%7D.%0D%0A%0D%0A%23%23+3.+Acceptance+criteria%0D%0A%3E%E2%8C%A6+Replace+the+examples+below+with+your+own+imperative%2C+%22true%2Ffalse%22+statements+for+the+**behavior+you+expect**+to+see%2C+or+the+behavior+that+**would**+be+true+if+there+were+no+errors+%28for+defects%29.%0D%0A%0D%0A-+%5B+%5D+1.+Job+Applicants+receive+a+confirmation+email+after+they+submit+their+resumes.%0D%0A-+%5B+%5D+2.+An+Applicant%27s+resume+information+isn%27t+lost+when+errors+occur.%0D%0A-+%5B+%5D+3.+%7Bcriterion-three%7D%0D%0A-+%5B+%5D+4.+%7Bcriterion-four%7D%0D%0A%0D%0A%3C%21--+%E2%9B%94%EF%B8%8F++Do+not+remove+anything+below+this+comment.+%E2%9B%94%EF%B8%8F++--%3E%0D%0A%5Bicon-info-image%5D%3A+..%2Fdocs%2Fimg%2Ficons8%2Ficon-info-50.png%0D%0A\n[issues-url]: /commonality/common-vocabulary/issues\n[license-badge-image]: https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square\n[license-choose-url]: https://choosealicense.com/\n[license-no-license-url]: https://choosealicense.com/no-license/\n[license-unlicense-url]: https://choosealicense.com/licenses/#unlicense\n[license-url]: ./LICENSE\n[makeapullrequest-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square\n[makeapullrequest-url]: http://makeapullrequest.com/\n[nodejs-url]: https://nodejs.org\n[npm-image]: https://img.shields.io/npm/v/common-vocabulary.svg?style=flat-square\n[npm-url]: https://npmjs.org/package/common-vocabulary\n[npmjs-url]: https://www.npmjs.com/\n[nsp-image]: https://nodesecurity.io/orgs/gregswindle/projects/da7e6d96-620d-4acb-8559-85c06c66921a/badge?style=flat-square\n[nsp-url]: https://nodesecurity.io/orgs/gregswindle/projects/da7e6d96-620d-4acb-8559-85c06c66921a\n[pr-url]: https://github.com/commonality/common-vocabulary/pulls\n[product-repo-logo-image]:./docs/img/logo-commonalaxy.png\n[product-repo-url]:  https://github.com/commonality/common-vocabulary\n[prs-welcome-badge-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square\n[prs-welcome-url]: http://makeapullrequest.com\n[pulls-url]: /commonality/common-vocabulary.git/pulls\n[readme-score-img]: http://readme-score-api.herokuapp.com/score.svg?url=https://github.com/commonality/common-vocabulary\n[readme-score-url]: http://clayallsopp.github.io/readme-score?url=https://github.com/commonality/common-vocabulary\u0026style=flat-square\n[refactoring-url]: https://github.com/commonality/common-vocabulary/wiki/Refactorings-by-category\n[scoreme-url]: http://clayallsopp.github.io/readme-score/?url=https://github.com/commonality/common-vocabulary/blob/master/README.md\n[travis-image]: https://img.shields.io/travis/commonality/common-vocabulary/master.svg?style=flat-square\n[travis-image]: https://img.shields.io/travis/commonality/common-vocabulary/master.svg?style=flat-square\n[travis-url]: https://travis-ci.org/commonality/common-vocabulary\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommonality%2Fcommon-vocabulary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcommonality%2Fcommon-vocabulary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommonality%2Fcommon-vocabulary/lists"}