Skip to content

Commit f24aa4c

Browse files
authored
feat(analytics): add voluntary tracking code
* build(analytics): add tracking code GH-20 * docs(csv): add sample CSV * docs(csv): add sample CSV From `gregswindle/eslint-plugin-crc` Issues. * feat(analytics): add yeomon/insight Prompts consumers to allow for tracking on Google Analytics GH-20 * ci(travis): run standard-version Run standard-version on release and commit its artifacts. GH-20 * ci(travis): clarify release step GH-20 * docs(contribute): update toc & scripts GH-20
1 parent 51dbfd1 commit f24aa4c

19 files changed

+6478
-34
lines changed

.github/CONTRIBUTING.md

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,9 @@
6262
- [5. **Directory structure**](#5-directory-structure)
6363
- [6. **Logging**](#6-logging)
6464
- [7. **Dependencies**](#7-dependencies)
65+
* [7.1. Production](#71-production)
66+
* [7.2. Development](#72-development)
67+
* [7.3. Optional](#73-optional)
6568
- [8. **APIs**](#8-apis)
6669
* [8.1 **API design**](#81-api-design)
6770
* [8.2 **API security**](#82-api-security)
@@ -710,12 +713,31 @@
710713

711714
## 7. **Dependencies**
712715

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:
714737
715738
<!-- AUTO-GENERATED-CONTENT:START (DEPENDENCYTABLE:dev=true) -->
716739
| **Dependency** | **Description** | **Version** | **License** | **Type** |
717740
| -------------- | --------------- | ----------- | ----------- | -------- |
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 |
719741
| [@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 |
720742
| [@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 |
721743
| [ajv@6.4.0](https://github.com/epoberezkin/ajv) | Another JSON Schema Validator | 6.4.0 | MIT | dev |
@@ -729,22 +751,24 @@
729751
| [eslint-config-standard@11.0.0](https://github.com/standard/eslint-config-standard) | JavaScript Standard Style - ESLint Shareable Config | 11.0.0 | MIT | dev |
730752
| [eslint-config-xo@0.20.1](https://github.com/xojs/eslint-config-xo#readme) | ESLint shareable config for XO | 0.20.1 | MIT | dev |
731753
| [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 |
733755
| [eslint-plugin-json@1.2.0](https://github.com/azeemba/eslint-plugin-json#readme) | Lint JSON files | 1.2.0 | ISC | dev |
734756
| [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 |
735757
| [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 |
736758
| [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 |
737759
| [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 |
738760
| [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 |
739761
| [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 |
741763
| [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 |
742764
| [fixpack@2.3.1](https://github.com/henrikjoreteg/fixpack) | cli tool that cleans up package.json files. | 2.3.1 | MIT | dev |
743765
| [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 |
744766
| [jest@22.4.3](http://facebook.github.io/jest/) | Delightful JavaScript Testing. | 22.4.3 | MIT | dev |
745767
| [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 |
746768
| [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 |
748772
| [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 |
749773
| [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 |
750774
| [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,6 +779,13 @@
755779
| [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 |
756780
<!-- AUTO-GENERATED-CONTENT:END -->
757781

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+
758789
## 8. **APIs**
759790

760791
![APIs][icon-rest-api-image]

.github/config/markdown.config.js

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,25 @@
11
/* eslint global-require: "off" */
22
/* eslint node/no-unpublished-require: "off" */
3-
const path = require('path')
43
const markdownMagic = require('markdown-magic')
54
const markdownMagicDependencyTable = require('markdown-magic-dependency-table')
65
const markdownMagicPackageScripts = require('markdown-magic-package-scripts')
6+
const path = require('path')
77

88
const config = {
9-
'DEBUG': false,
10-
'transforms': {
11-
'DEPENDENCYTABLE': markdownMagicDependencyTable,
12-
'SCRIPTS': markdownMagicPackageScripts
9+
DEBUG: false,
10+
transforms: {
11+
DEPENDENCYTABLE: markdownMagicDependencyTable,
12+
SCRIPTS: markdownMagicPackageScripts
1313
}
1414
}
1515

16-
let markdownPath = path.join(__dirname, '**/*.md')
17-
markdownMagic(markdownPath, config)
16+
const main = () => {
17+
let markdownPath = path.join(__dirname, '**/*.md')
18+
markdownMagic(markdownPath, config)
19+
20+
markdownPath = path.join(__dirname, '..', 'CONTRIBUTING.md')
21+
console.log(markdownPath)
22+
markdownMagic(markdownPath, config)
23+
}
1824

19-
markdownPath = path.join(__dirname, '../*.md')
20-
markdownMagic(markdownPath, config)
25+
main()

.github/config/sonar-project.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ sonar.sourceEncoding=UTF-8
2929
#----- Project info
3030
sonar.projectKey=gregswindle-github-resource-converter
3131
sonar.projectName=github-resource-converter
32-
sonar.projectVersion=1.0.0
32+
sonar.projectVersion=1.0.1
3333

3434
# =====================================================
3535
# Meta-data for the project

.travis.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,4 +45,6 @@ deploy:
4545
provider: script
4646
skip_cleanup: true
4747
script:
48+
- npm run docs:changelog
49+
- git commit -a --amend --no-edit
4850
- npx travis-deploy-once "npx semantic-release"

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,14 @@
8989
9090
## 2. Installation
9191
92-
1. **Required:** `github-resource-converter` is written in JavaScript (CommonJS) for [Node.js ![External link][icon-octicon-link-external]](https://nodejs.org/), which must be installed prior to use. Node.js requires **npm**, which is used for installing dependencies. (**npm** installs with Node.js.)
92+
1. **Required:** `github-resource-converter` is written in JavaScript (CommonJS) for
93+
[Node.js ![External link][icon-octicon-link-external]](https://nodejs.org/) version
94+
<!-- AUTO-GENERATED-CONTENT:START (ENGINES) -->
95+
96+
<!-- AUTO-GENERATED-CONTENT:END -->
97+
98+
which must be installed prior to use.
99+
Node.js requires **npm**, which is used for installing dependencies. (**npm** installs with Node.js.)
93100
94101
1. **Recommended:** To avoid rate-limiting, you should [create a personal access token ![External link][icon-octicon-link-external]](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) and save your personal access token.
95102

0 commit comments

Comments
 (0)