|
62 | 62 | - [5. **Directory structure**](#5-directory-structure) |
63 | 63 | - [6. **Logging**](#6-logging) |
64 | 64 | - [7. **Dependencies**](#7-dependencies) |
| 65 | + * [7.1. Production](#71-production) |
| 66 | + * [7.2. Development](#72-development) |
| 67 | + * [7.3. Optional](#73-optional) |
65 | 68 | - [8. **APIs**](#8-apis) |
66 | 69 | * [8.1 **API design**](#81-api-design) |
67 | 70 | * [8.2 **API security**](#82-api-security) |
|
710 | 713 |
|
711 | 714 | ## 7. **Dependencies** |
712 | 715 |
|
713 | | -`github-resource-converter` requires the following tech stack to either run, build, test, or deploy: |
| 716 | +### 7.1. Production |
| 717 | + |
| 718 | +`github-resource-converter` requires the following dependencies to operate. |
| 719 | + |
| 720 | +<!-- AUTO-GENERATED-CONTENT:START (DEPENDENCYTABLE:production=true) --> |
| 721 | +| **Dependency** | **Description** | **Version** | **License** | **Type** | |
| 722 | +| -------------- | --------------- | ----------- | ----------- | -------- | |
| 723 | + | [@octokit/rest@15.2.6](https://github.com/octokit/rest.js#readme) | GitHub REST API client for Node.js | 15.2.6 | MIT | production | |
| 724 | + | [bunyan@1.8.12](https://github.com/trentm/node-bunyan#readme) | a JSON logging library for node.js services | 1.8.12 | MIT | production | |
| 725 | + | [bunyan-format@0.2.1](https://github.com/thlorenz/bunyan-format) | Writable stream that formats bunyan records that are piped into it. | 0.2.1 | [object Object] | production | |
| 726 | + | [dotenv@5.0.1](https://github.com/motdotla/dotenv#readme) | Loads environment variables from .env file | 5.0.1 | BSD-2-Clause | production | |
| 727 | + | [fs-extra@5.0.0](https://github.com/jprichardson/node-fs-extra) | fs-extra contains methods that aren't included in the vanilla Node.js fs package. Such as mkdir -p, cp -r, and rm -rf. | 5.0.0 | MIT | production | |
| 728 | + | [insight@0.10.1](https://github.com/yeoman/insight#readme) | Understand how your tool is being used by anonymously reporting usage metrics to Google Analytics or Yandex.Metrica | 0.10.1 | BSD-2-Clause | production | |
| 729 | + | [jsonexport@2.0.11](https://github.com/kauegimenes/jsonexport) | Makes easy to convert JSON to CSV | 2.0.11 | ISC | production | |
| 730 | + | [lodash.isstring@4.0.1](https://lodash.com/) | The lodash method `_.isString` exported as a module. | 4.0.1 | MIT | production | |
| 731 | + | [meow@4.0.0](https://github.com/sindresorhus/meow#readme) | CLI app helper | 4.0.0 | MIT | production | |
| 732 | +<!-- AUTO-GENERATED-CONTENT:END --> |
| 733 | +
|
| 734 | +### 7.2. Development |
| 735 | +
|
| 736 | +`github-resource-converter` uses the the following dependencies to build, test, or deploy: |
714 | 737 |
|
715 | 738 | <!-- AUTO-GENERATED-CONTENT:START (DEPENDENCYTABLE:dev=true) --> |
716 | 739 | | **Dependency** | **Description** | **Version** | **License** | **Type** | |
717 | 740 | | -------------- | --------------- | ----------- | ----------- | -------- | |
718 | | - | [@semantic-release/changelog@2.0.1](https://github.com/semantic-release/changelog#readme) | Set of semantic-release plugins for creating or updating a changelog file | 2.0.1 | MIT | dev | |
719 | 741 | | [@semantic-release/git@4.0.1](https://github.com/semantic-release/git#readme) | Set of semantic-release plugins to publish to a git repository | 4.0.1 | MIT | dev | |
720 | 742 | | [@semantic-release/npm@3.2.4](https://github.com/semantic-release/npm#readme) | Set of semantic-release plugins to publish to a npm registry | 3.2.4 | MIT | dev | |
721 | 743 | | [ajv@6.4.0](https://github.com/epoberezkin/ajv) | Another JSON Schema Validator | 6.4.0 | MIT | dev | |
|
729 | 751 | | [eslint-config-standard@11.0.0](https://github.com/standard/eslint-config-standard) | JavaScript Standard Style - ESLint Shareable Config | 11.0.0 | MIT | dev | |
730 | 752 | | [eslint-config-xo@0.20.1](https://github.com/xojs/eslint-config-xo#readme) | ESLint shareable config for XO | 0.20.1 | MIT | dev | |
731 | 753 | | [eslint-plugin-import@2.10.0](https://github.com/benmosher/eslint-plugin-import) | Import with sanity. | 2.10.0 | MIT | dev | |
732 | | - | [eslint-plugin-jsdoc@3.5.0](https://github.com/gajus/eslint-plugin-jsdoc#readme) | JSDoc linting rules for ESLint. | 3.5.0 | BSD-3-Clause | dev | |
| 754 | + | [eslint-plugin-jsdoc@3.6.2](https://github.com/gajus/eslint-plugin-jsdoc#readme) | JSDoc linting rules for ESLint. | 3.6.2 | BSD-3-Clause | dev | |
733 | 755 | | [eslint-plugin-json@1.2.0](https://github.com/azeemba/eslint-plugin-json#readme) | Lint JSON files | 1.2.0 | ISC | dev | |
734 | 756 | | [eslint-plugin-no-unsafe-innerhtml@1.0.16](https://github.com/mozfreddyb/eslint-plugin-no-unsafe-innerhtml/) | custom ESLint rule to disallows unsafe innerHTML, outerHTML and insertAdjacentHTML | 1.0.16 | MPL-2.0 | dev | |
735 | 757 | | [eslint-plugin-node@6.0.1](https://github.com/mysticatea/eslint-plugin-node#readme) | Additional ESLint's rules for Node.js | 6.0.1 | MIT | dev | |
736 | 758 | | [eslint-plugin-prettier@^2.2.0](https://github.com/prettier/eslint-plugin-prettier#readme) | Runs prettier as an eslint rule | 2.6.0 | MIT | dev | |
737 | 759 | | [eslint-plugin-promise@3.7.0](https://github.com/xjamundx/eslint-plugin-promise#readme) | Enforce best practices for JavaScript promises | 3.7.0 | ISC | dev | |
738 | 760 | | [eslint-plugin-security@1.4.0](https://github.com/nodesecurity/eslint-plugin-security#readme) | Security rules for eslint | 1.4.0 | Apache-2.0 | dev | |
739 | 761 | | [eslint-plugin-standard@3.0.1](https://github.com/xjamundx/eslint-plugin-standard#readme) | ESlint Plugin for the Standard Linter | 3.0.1 | MIT | dev | |
740 | | - | [eslint-plugin-unicorn@4.0.2](https://github.com/sindresorhus/eslint-plugin-unicorn#readme) | Various awesome ESLint rules | 4.0.2 | MIT | dev | |
| 762 | + | [eslint-plugin-unicorn@4.0.3](https://github.com/sindresorhus/eslint-plugin-unicorn#readme) | Various awesome ESLint rules | 4.0.3 | MIT | dev | |
741 | 763 | | [eslint-plugin-xss@0.1.9](https://github.com/Rantanen/eslint-plugin-xss#readme) | Validates XSS related issues of mixing HTML and non-HTML content in variables. | 0.1.9 | ISC | dev | |
742 | 764 | | [fixpack@2.3.1](https://github.com/henrikjoreteg/fixpack) | cli tool that cleans up package.json files. | 2.3.1 | MIT | dev | |
743 | 765 | | [husky@^0.14.3](https://github.com/typicode/husky) | Prevents bad commit or push (git hooks, pre-commit/precommit, pre-push/prepush, post-merge/postmerge and all that stuff...) | 0.14.3 | MIT | dev | |
744 | 766 | | [jest@22.4.3](http://facebook.github.io/jest/) | Delightful JavaScript Testing. | 22.4.3 | MIT | dev | |
745 | 767 | | [jest-runner-eslint@0.4.0](https://github.com/jest-community/jest-runner-eslint) | An experimental ESLint runner for Jest | 0.4.0 | MIT | dev | |
746 | 768 | | [lec@^1.0.1](https://github.com/iShafayet/lec) | Command Line Wrapper for Line Ending Corrector (An utility that makes sure your files have consistent line endings) | 1.0.1 | MIT | dev | |
747 | | - | [lint-staged@7.0.3](https://github.com/okonet/lint-staged#readme) | Lint files staged by git | 7.0.3 | MIT | dev | |
| 769 | + | [lint-staged@7.0.4](https://github.com/okonet/lint-staged#readme) | Lint files staged by git | 7.0.4 | MIT | dev | |
| 770 | + | [lodash.isundefined@3.0.1](https://lodash.com/) | The modern build of lodash’s `_.isUndefined` as a module. | 3.0.1 | MIT | dev | |
| 771 | + | [lodash.noop@3.0.1](https://lodash.com/) | The lodash method `_.noop` exported as a module. | 3.0.1 | MIT | dev | |
748 | 772 | | [markdown-magic@0.1.21](https://github.com/DavidWells/markdown-magic#readme) | Automatically update markdown files with content from external sources | 0.1.21 | MIT | dev | |
749 | 773 | | [markdown-magic-dependency-table@1.3.2](https://github.com/camacho/markdown-magic-dependency-table#readme) | Generate table of information about dependencies automatically in markdown | 1.3.2 | MIT | dev | |
750 | 774 | | [markdown-magic-install-command@1.3.1](https://github.com/camacho/markdown-magic-install-command#readme) | Print install command for markdown file | 1.3.1 | MIT | dev | |
|
755 | 779 | | [standard-version@4.3.0](https://github.com/conventional-changelog/standard-version#readme) | replacement for `npm version` with automatic CHANGELOG generation | 4.3.0 | ISC | dev | |
756 | 780 | <!-- AUTO-GENERATED-CONTENT:END --> |
757 | 781 |
|
| 782 | +### 7.3. Optional |
| 783 | + |
| 784 | +<!-- AUTO-GENERATED-CONTENT:START (DEPENDENCYTABLE:optional=true) --> |
| 785 | +| **Dependency** | **Description** | **Version** | **License** | **Type** | |
| 786 | +| -------------- | --------------- | ----------- | ----------- | -------- | |
| 787 | +<!-- AUTO-GENERATED-CONTENT:END --> |
| 788 | + |
758 | 789 | ## 8. **APIs** |
759 | 790 |
|
760 | 791 | ![APIs][icon-rest-api-image] |
|
0 commit comments