Skip to content

Commit 7e22c30

Browse files
authored
fix(save): implement "save" method for Node.js API (#17)
### Summary of changes 1. Add a `save` method to `baseResourceConveter`, which invokes `fileExporter.save`. 😒 1. Update API section of the README. 1. Enumerate README sections. 1. Add `.npmignore` and `.npmrc` files. 1. Update `ISSUE_TEMPLATE.md`, `defect-report.md`, and automated query parameters for "Report a defect" and "Request a feature" buttons. 1. Ensure all tests pass with 100% coverage. 1. Move the CLI's "help"/"usage" copy to an i18n directory. 1. Attempt to generate a CHANGELOG with semantic-release 🤞 . 1. Update outdated dependencies. ### Commit messages * fix(save): ensure module's save method functions Add a `save` method to baseResourceConveter, which invokes fileExporter.save 😒. * docs(readme): update API section Enumerate all sections. * style(manifest): format * docs(readme): fix typo Replace octokit ➡️ grc
1 parent 05b609b commit 7e22c30

17 files changed

+956
-279
lines changed

.github/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -744,14 +744,14 @@
744744
| [jest@22.4.3](http://facebook.github.io/jest/) | Delightful JavaScript Testing. | 22.4.3 | MIT | dev |
745745
| [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 |
746746
| [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.2](https://github.com/okonet/lint-staged#readme) | Lint files staged by git | 7.0.2 | 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 |
748748
| [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 |
749749
| [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 |
750750
| [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 |
751751
| [markdown-magic-package-scripts@1.2.1](https://github.com/camacho/markdown-magic-package-scripts#readme) | Print list of scripts in package.json with descriptions | 1.2.1 | MIT | dev |
752752
| [nsp@^3.2.1](https://github.com/nodesecurity/nsp#readme) | The Node Security (nodesecurity.io) command line interface | 3.2.1 | Apache-2.0 | dev |
753753
| [prettier@1.11.1](https://prettier.io) | Prettier is an opinionated code formatter | 1.11.1 | MIT | dev |
754-
| [semantic-release@15.1.4](https://github.com/semantic-release/semantic-release#readme) | Automated semver compliant package publishing | 15.1.4 | MIT | dev |
754+
| [semantic-release@15.1.5](https://github.com/semantic-release/semantic-release#readme) | Automated semver compliant package publishing | 15.1.5 | MIT | dev |
755755
<!-- AUTO-GENERATED-CONTENT:END -->
756756
757757
## 8. **APIs**

.github/ISSUE_TEMPLATE.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,20 @@ In order to {achieve value}.
4040
* > ⌦ Include as many relevant details about the environment
4141
> ⌦ in which the defect occured.
4242
43-
- Version of `github-resource-converter`:
44-
- Environment name and version (e.g. Chrome 39, node.js 5.4):
43+
- `github-resource-converter` version:
44+
- Node.js version (`node --version`):
45+
- NPM version (`npm --version`):
46+
- Yarn version (`yarn --version`):
4547
- Operating System and version (desktop or mobile):
46-
- Link to your project:
48+
49+
> **💡 MacOS**
50+
>
51+
> * 1. Open a Terminal
52+
> * 2. Run
53+
> `system_profiler SPHardwareDataType SPSoftwareDataType -detailLevel mini | pbcopy`
54+
> * 3. Paste (<kbd>command ⌘</kbd> + <kbd>v</kbd>) below:
55+
56+
* Link to your project: N/A
57+
* Link to RunKit or Repl example:
4758

4859
<!-- ⛔️ Do not remove anything below this comment. ⛔️ -->

.github/ISSUE_TEMPLATE/defect-report.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,24 @@ In order to {achieve value}.
3737
* > ⌦ Include as many relevant details about the environment
3838
> ⌦ in which the defect occured.
3939
40-
- Version of `github-resource-converter`:
41-
- Environment name and version (e.g. Chrome 39, node.js 5.4):
40+
* > ⌦ Include as many relevant details about the environment
41+
> ⌦ in which the defect occured.
42+
43+
- `github-resource-converter` version:
44+
- Node.js version (`node --version`):
45+
- NPM version (`npm --version`):
46+
- Yarn version (`yarn --version`):
4247
- Operating System and version (desktop or mobile):
43-
- Link to your project:
48+
49+
> **💡 MacOS**
50+
>
51+
> * 1. Open a Terminal
52+
> * 2. Run
53+
> `system_profiler SPHardwareDataType SPSoftwareDataType -detailLevel mini | pbcopy`
54+
> * 3. Paste (<kbd>command ⌘</kbd> + <kbd>v</kbd>) below:
55+
56+
* Link to your project: N/A
57+
* Link to RunKit or Repl example:
4458

4559
<!-- ⛔️ Do not remove anything below this comment. ⛔️ -->
4660

.npmignore

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
.bowerrc
2+
.cssTmp/
3+
.editorconfig
4+
.gitattributes
5+
.gitignore
6+
.gulp-scss-cache/
7+
.idea/
8+
.jshintrc
9+
.jsTmp/
10+
.nyc_output
11+
.sass-cache/
12+
.scannerwork
13+
.travis.yml
14+
.vscode
15+
*.csv
16+
appveyor.yml
17+
bower.json
18+
bower/
19+
coverage/
20+
docs/
21+
example/
22+
gulp/
23+
gulpfile.js
24+
karma-coverage.conf.js
25+
karma.conf.js
26+
reports
27+
src/
28+
test/
29+
tsconfig.json
30+
tsd.json
31+
tslint.json
32+
typings/
33+
lib/__fixtures__/
34+
lib/__mocks__/
35+
lib/__tests__/

.npmrc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
package-lock=false
2+
save-exact=true

0 commit comments

Comments
 (0)