Skip to content

Commit

Permalink
Merge 017745f into 5147e77
Browse files Browse the repository at this point in the history
  • Loading branch information
brettz9 committed Sep 12, 2019
2 parents 5147e77 + 017745f commit 11e6418
Show file tree
Hide file tree
Showing 36 changed files with 4,898 additions and 980 deletions.
2 changes: 1 addition & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.git
coverage/
node_modules/
var/
docs/jsdoc
18 changes: 14 additions & 4 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,17 @@ module.exports = {
},
extends: [
'@passport-next/eslint-config-passport-next/sauron-node.js',
// Override ash-nazg's current preference for ESM
// Override eslint-config-passport-next's current preference for ESM
'plugin:node/recommended-script'
],
settings: {
polyfills: [
// Needing these for some reason to avoid an error
"Promise",
"Promise.reject",
"Promise.resolve"
]
},
overrides: [
{
files: ['test/**'],
Expand Down Expand Up @@ -60,14 +68,16 @@ module.exports = {
'no-underscore-dangle': 0,
'no-param-reassign': 0,

// Disable until implementing promises and Node version supporting
// Disable until https://github.com/eslint/eslint/issues/11899 may be addressed
'require-atomic-updates': 0,

// Disable as middleware approach requires some callbacks
'promise/prefer-await-to-callbacks': 0,
'promise/prefer-await-to-then': 0,

// Disable until ready to tackle
'require-jsdoc': 0,

// Disable current preferences of ash-nazg
// Disable current preferences of eslint-config-passport-next
'import/no-commonjs': 0,
'node/exports-style': 0,

Expand Down
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
reports/
docs/
docs/jsdoc
var/


Expand Down
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ Ensure that the test suite passes by executing:
$ npm test
```

You can also run a single test file:

```bash
$ npm run test-one -- test/sessionmanager.test.js
```

Ensure that lint passes
```bash
$ npm run lint
Expand Down
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Passport-Next/Passport
# Passport-Next/Passport

Status:
[![NPM version](https://img.shields.io/npm/v/@passport-next/passport.svg)](https://www.npmjs.com/package/@passport-next/passport)
Expand Down Expand Up @@ -44,4 +44,3 @@ We support all [node versions](https://github.com/nodejs/Release) supported by t
## Contributing

Please see [CONTRIBUTING.md](https://github.com/passport-next/passport/blob/master/CONTRIBUTING.md)

32 changes: 32 additions & 0 deletions docs/jsdoc-config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
'use strict';

module.exports = {
recurseDepth: 10,
source: {
exclude: [
'node_modules',
'dist',
'var',
'coverage',
'test'
]
// excludePattern: ''
},
sourceType: 'module',
tags: {
allowUnknownTags: false
},
templates: {
cleverLinks: true,
monospaceLinks: false /* ,
default: {
layoutFile: 'docs/layout.tmpl'
} */
},
opts: {
recurse: true,
verbose: true,
destination: 'docs/jsdoc'
// tutorials: 'docs/tutorials'
}
};

0 comments on commit 11e6418

Please sign in to comment.