Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# auto-generated and third-party code
/vendor
/.travis
/.github
/build
/include
/generate/templates/templates/

# Don't try to check .d.ts files
**/*.ts

# Gitignore
/build/
/coverage/
/dist/
/include/
/lib/enums.js
/lib/nodegit.js
/node_modules/
/src/
/test/coverage/
/test/home/
/test/repos/
/test/test/

/generate/output
/generate/**/*.json
!/generate/input/*.json

/generate/missing-tests.json
/binding.gyp

# Generated vendor files
/vendor/openssl/
/vendor/libssh2/Makefile
/vendor/libssh2/config.status
/vendor/libssh2/docs/Makefile
/vendor/libssh2/example/.deps/
/vendor/libssh2/example/Makefile
/vendor/libssh2/example/libssh2_config.h
/vendor/libssh2/example/stamp-h2
/vendor/libssh2/libssh2.pc
/vendor/libssh2/libtool
/vendor/libssh2/src/.deps/
/vendor/libssh2/src/Makefile
/vendor/libssh2/src/libssh2_config.h
/vendor/libssh2/src/stamp-h1
/vendor/libssh2/tests/.deps/
/vendor/libssh2/tests/Makefile

*.log
.DS_STORE
.idea

.vscode
jsconfig.json

test/id_rsa
test/nodegit-test-rsa
36 changes: 36 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
"root": true,
"extends": [
"eslint:recommended",
"plugin:prettier/recommended",
"plugin:mocha/recommended",
"plugin:node/recommended"
],
"parserOptions": {
"ecmaVersion": 2020
},
"env": {
"es6": true,
"node": true,
"mocha": true
},
"plugins": ["prettier", "mocha", "node"],
"rules": {
"array-callback-return": "error",
"prettier/prettier": "warn",
"mocha/no-setup-in-describe": "warn",
"no-process-exit": "warn",
"no-shadow": "warn",
"no-unused-vars": [
"error",
// allow unused vars starting with _
{
"argsIgnorePattern": "^_",
"ignoreRestSiblings": true,
"varsIgnorePattern": "^_"
}
],
"node/no-missing-require": "warn",
"prefer-const": "warn"
}
}
31 changes: 0 additions & 31 deletions .jshintrc

This file was deleted.

62 changes: 62 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
/vendor
/.travis
/.github
/build
/include

# Don't interfere with npm
package-lock.json
package.json

# Autogenerated
/CHANGELOG.md

# Gitignore
/build/
/coverage/
/dist/
/include/
/lib/enums.js
/lib/nodegit.js
/node_modules/
/src/
/test/coverage/
/test/home/
/test/repos/
/test/test/

/generate/output
/generate/templates
/generate/**/*.json
!/generate/input/*.json

/generate/missing-tests.json
/binding.gyp

# Generated vendor files
/vendor/openssl/
/vendor/libssh2/Makefile
/vendor/libssh2/config.status
/vendor/libssh2/docs/Makefile
/vendor/libssh2/example/.deps/
/vendor/libssh2/example/Makefile
/vendor/libssh2/example/libssh2_config.h
/vendor/libssh2/example/stamp-h2
/vendor/libssh2/libssh2.pc
/vendor/libssh2/libtool
/vendor/libssh2/src/.deps/
/vendor/libssh2/src/Makefile
/vendor/libssh2/src/libssh2_config.h
/vendor/libssh2/src/stamp-h1
/vendor/libssh2/tests/.deps/
/vendor/libssh2/tests/Makefile

*.log
.DS_STORE
.idea

.vscode
jsconfig.json

test/id_rsa
test/nodegit-test-rsa
6 changes: 6 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"jsdocUseInlineCommentForASingleTagBlock": true,
"plugins": ["./node_modules/@homer0/prettier-plugin-jsdoc"],
"printWidth": 120,
"singleQuote": false
}
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
Contribution Guidelines
-----------------------
## Contribution Guidelines

### A Note on Issues and Support ##
### A Note on Issues and Support

We try to be available pretty often to help when problems come up. We like to split incoming questions
into two categories: potential bugs/features, and questions. If you want a feature added, or think you've found a bug
in the code (or in the examples), search the [issue tracker](https://github.com/nodegit/nodegit/issues) and if you don't
find anything, file a new issue. If you just have questions, instead of using issues, [sign up](http://slack.libgit2.org/)
to libgit2's Slack instance and then contact us in the [#nodegit channel](https://libgit2.slack.com/messages/nodegit/).

## How to Help ##
## How to Help

NodeGit is iterating pretty quickly, but it can always go faster. We welcome help with the deeper darker parts,
like the templates and binding and more, but there are plenty of smaller things to do as well.
Things that are always needed:
- Filing issues (see above).
- Writing tests (See [here](https://github.com/nodegit/nodegit/blob/master/TESTING.md)).
- Writing examples.

- Filing issues (see above).
- Writing tests (See [here](https://github.com/nodegit/nodegit/blob/master/TESTING.md)).
- Writing examples.

These are all good easy ways to start getting involved with the project. You can also look through the issue tracker
and see if you can help with any existing issues. Please comment with your intention and any questions before getting
Expand Down
7 changes: 4 additions & 3 deletions FAQ.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
NodeGit FAQ
-----------
## NodeGit FAQ

Feel free to add common problems with their solutions here, or just anything that wasn't clear at first.

#### Error: callback returned unsupported credentials type ####
#### Error: callback returned unsupported credentials type

As seen in nodegit/#959 -- some golang hackers have started to use the following stanza in .gitconfig to allow `go get` to work with private repos:

```
[url "git@github.com:"]
insteadOf = https://github.com/
```

But if you do this, code can call `NodeGit.Clone.clone(url: 'https://foo')` and have the `authentication` callback be asked for **SSH** credentials instead of HTTPS ones, which might not be what your application expected.
15 changes: 7 additions & 8 deletions HISTORY.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
0.2.0 / 2014-11-24
===================
# 0.2.0 / 2014-11-24

* Shifted to promises; asynchronous methods now provide promises.
* Lots of new methods exposed for merging, pushing, blaming and more.
* SSH transport now works.
* Switched generation of native module code from ejsg to Combyne.
* Added continuous integration with Linux, OSX, and Windows.
* Many method and property names have changed.
- Shifted to promises; asynchronous methods now provide promises.
- Lots of new methods exposed for merging, pushing, blaming and more.
- SSH transport now works.
- Switched generation of native module code from ejsg to Combyne.
- Added continuous integration with Linux, OSX, and Windows.
- Many method and property names have changed.
Loading