Promises

.editorconfig

@@ -0,0 +1,16 @@
+; EditorConfig file: https://EditorConfig.org
+; Install the "EditorConfig" plugin into your editor to use
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+
+[package.json]
+; indent_style = tab
+indent_size = 4

.eslintignore

@@ -1,4 +1,4 @@
 .git
-coverage/
 node_modules/
 var/
+docs/jsdoc

.eslintrc.js

@@ -1,108 +1,134 @@
+'use strict';
 module.exports = {
-    env: {
-      node: true,
-      browser: false
-    },
-    extends: [
-      '@passport-next/eslint-config-passport-next/sauron-node.js',
-      // Override ash-nazg's current preference for ESM
-      'plugin:node/recommended-script'
-    ],
-    overrides: [
-      {
-        files: ['test/**'],
-        env: {
-          // jest: true,
-          mocha: true
-        },
-        globals: {
-          expect: 'readonly'
-        },
-        rules: {
-          'jsdoc/require-jsdoc': 'off'
-          // 'jest/no-disabled-tests': [2],
-          // 'jest/no-focused-tests': [2],
-          // 'jest/no-identical-title': [2],
-          // 'jest/prefer-to-have-length': [2],
-          // 'jest/valid-expect': [2],
-        }
+  env: {
+    node: true,
+    browser: false
+  },
+  extends: [
+    'eslint-config-ash-nazg/sauron-node.js',
+    // 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/**/*.test.js'],
+      env: {
+        // jest: true,
+        mocha: true
+      },
+      globals: {
+        expect: 'readonly'
       },
-      {
-        files: ['**/*.md'],
-        rules: {
-          'eol-last': 'off',
-          'no-console': 'off',
-          'no-undef': 'off',
-          'no-unused-vars': 'warn',
-          'padded-blocks': 'off',
-          'import/unambiguous': 'off',
-          'import/no-unresolved': 'off',
-          'node/no-missing-import': 'off',
-          'node/no-missing-require': 'off',
-          'func-names': 'off',
-          'import/newline-after-import': 'off',
-          strict: 'off',
-          // Disable until eslint-plugin-jsdoc may fix: https://github.com/gajus/eslint-plugin-jsdoc/issues/211
-          indent: 'off'
-        }
+      plugins: [
+        'chai-friendly'
+      ],
+      rules: {
+        'no-unused-expressions': 'off',
+        'chai-friendly/no-unused-expressions': ['error', {
+          allowShortCircuit: false,
+          allowTernary: false,
+          allowTaggedTemplates: false
+        }],
+        'jsdoc/require-jsdoc': 'off'
+        // 'jest/no-disabled-tests': [2],
+        // 'jest/no-focused-tests': [2],
+        // 'jest/no-identical-title': [2],
+        // 'jest/prefer-to-have-length': [2],
+        // 'jest/valid-expect': [2],
       }
-    ],
-    globals: {
-      // By some ESLint bug, config overrides not working with globals
-      require: 'readonly',
-      module: 'readonly',
-      exports: 'writable'
     },
-    plugins: [
-      // 'jest'
-    ],
-    rules: {
-      'no-underscore-dangle': 0,
-      'no-param-reassign': 0,
+    {
+      files: ['**/*.md'],
+      processor: 'markdown/markdown'
+    },
+    {
+      files: '**/*.md/*.js',
+      rules: {
+        'eol-last': 'off',
+        'no-console': 'off',
+        'no-undef': 'off',
+        'no-unused-vars': 'warn',
+        'padded-blocks': 'off',
+        'import/unambiguous': 'off',
+        'import/no-unresolved': 'off',
+        'node/no-missing-import': 'off',
+        'node/no-missing-require': 'off',
+        'func-names': 'off',
+        'import/newline-after-import': 'off',
+        strict: 'off',
+        // Disable until eslint-plugin-jsdoc may fix: https://github.com/gajus/eslint-plugin-jsdoc/issues/211
+        indent: 'off'
+      }
+    }
+  ],
+  globals: {
+    // By some ESLint bug, config overrides not working with globals
+    require: 'readonly',
+    module: 'readonly',
+    exports: 'writable'
+  },
+  plugins: [
+    // 'jest'
+  ],
+  rules: {
+    'no-underscore-dangle': 0,
+    'no-param-reassign': 0,
 
-      // Disable until implementing promises and Node version supporting
-      'promise/prefer-await-to-callbacks': 0,
-      'promise/prefer-await-to-then': 0,
+    // Disable as middleware approach requires some callbacks
+    'promise/prefer-await-to-callbacks': 0,
 
-      // Disable until ready to tackle
-      'require-jsdoc': 0,
+    // Disable until ready to tackle
+    'eslint-comments/require-description': 0,
 
-      // Disable current preferences of ash-nazg
-      'import/no-commonjs': 0,
-      'node/exports-style': 0,
+    // Disable current preferences of eslint-config-passport-next
+    'import/no-commonjs': 0,
+    'node/exports-style': 0,
 
-      // add back different or stricter rules from airbnb
-      'object-curly-spacing': ['error', 'always'],
-      'func-names': 'warn',
-      'max-len': ['error', 100, 2, {
-        ignoreUrls: true,
-        ignoreComments: false,
-        ignoreRegExpLiterals: true,
-        ignoreStrings: true,
-        ignoreTemplateLiterals: true,
-      }],
-      'space-before-function-paren': ['error', {
-        anonymous: 'always',
-        named: 'never',
-        asyncArrow: 'always'
-      }],
-      'no-multiple-empty-lines': ['error', { max: 2, maxEOF: 0 }],
-      'arrow-parens': ['error', 'as-needed', {
-        requireForBlockBody: true,
-      }],
-      'no-empty-function': ['error', {
-        allow: [
-          'arrowFunctions',
-          'functions',
-          'methods',
-        ]
-      }],
-      'no-unused-vars': ['error', { vars: 'all', args: 'after-used', ignoreRestSiblings: true }],
-      'no-multi-assign': ['error'],
-      'no-unused-expressions': ['error', {
-        allowShortCircuit: false,
-        allowTernary: false,
-        allowTaggedTemplates: false,
-      }]
-    }
-  };
+    // add back different or stricter rules from airbnb
+    'object-curly-spacing': ['error', 'always'],
+    'func-names': 'warn',
+    'max-len': ['error', 100, 2, {
+      ignoreUrls: true,
+      ignoreComments: false,
+      ignoreRegExpLiterals: true,
+      ignoreStrings: true,
+      ignoreTemplateLiterals: true
+    }],
+    'space-before-function-paren': ['error', {
+      anonymous: 'always',
+      named: 'never',
+      asyncArrow: 'always'
+    }],
+    'no-multiple-empty-lines': ['error', { max: 2, maxEOF: 0 }],
+    'arrow-parens': ['error', 'as-needed', {
+      requireForBlockBody: true
+    }],
+    'no-empty-function': ['error', {
+      allow: [
+        'arrowFunctions',
+        'functions',
+        'methods'
+      ]
+    }],
+    'no-unused-vars': ['error', { vars: 'all', args: 'after-used', ignoreRestSiblings: true }],
+    'no-multi-assign': ['error'],
+    'no-unused-expressions': ['error', {
+      allowShortCircuit: false,
+      allowTernary: false,
+      allowTaggedTemplates: false
+    }],
+    'jsdoc/tag-lines': ['error', 'never', {
+      tags: {
+        example: { lines: 'always' }
+      }
+    }]
+  }
+};

.gitignore

@@ -1,5 +1,4 @@
-reports/
-docs/
+docs/jsdoc
 var/
 
 

.travis.yml

@@ -1,8 +1,8 @@
 language: "node_js"
 node_js:
-  - "10"
-  - "12"
-  - "14"
+  - 12
+  - 14
+  - 16
 
 script:
   - "npm run test"

CONTRIBUTING.md

@@ -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

README.md

@@ -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)
@@ -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)
-

docs/jsdoc-config.js

@@ -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'
+  }
+};