Clear changes

Author: Artem Shteltser

.eslintignore

@@ -3,5 +3,4 @@ docs
 lib
 
 # Dependency directories
-node_modules
-src/authentication/**/*
+node_modules

README.md

@@ -28,6 +28,24 @@ via **yarn**:
 $ yarn add bitbucket
 ```
 
+## Authentication
+
+Bitbucket supports different authentication strategies:
+
+- OAuth 2
+- App passwords
+- Basic auth
+
+### Basic auth
+
+```javascript
+const { Bitbucket } = require('bitbucket')
+
+const bitbucket = new Bitbucket({
+  auth: '',
+})
+```
+
 ## Usage
 
 ### Browser

package-lock.json

@@ -10,9 +10,7 @@
     "rest"
   ],
   "homepage": "https://github.com/MunifTanjim/node-bitbucket#readme",
-  "bugs": {
-    "url": "https://github.com/MunifTanjim/node-bitbucket/issues"
-  },
+  "bugs": "https://github.com/MunifTanjim/node-bitbucket/issues",
   "license": "MIT",
   "author": "MunifTanjim (https://muniftanjim.com)",
   "files": [
@@ -24,17 +22,14 @@
   "unpkg": "lib/index.umd.js",
   "jsdelivr": "lib/index.umd.js",
   "types": "lib/index.d.ts",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/MunifTanjim/node-bitbucket.git"
-  },
+  "repository": "github:MunifTanjim/node-bitbucket",
   "scripts": {
-    "build": "npm-run-all -s build:core",
+    "build": "npm-run-all -s build:core build:plugins",
     "prebuild:core": "rimraf lib/*.js lib/*.js.map",
     "build:core": "bili",
     "prebuild:plugins": "rimraf lib/plugins/*.js lib/plugins/*.js.map",
     "build:plugins": "npm-run-all -s build:plugin:*",
-    "build:plugin:authenticate": "PLUGIN=authenticate bili",
+    "build:plugin:authenticate": "cross-env PLUGIN=auth bili",
     "predocs:build": "mkdirp docs && rimraf docs/*",
     "docs:build": "npm run generate:api-docs",
     "postdocs:build": "apidoc -i docs -o docs",
@@ -54,7 +49,6 @@
     "validate:types:index": "tsc --noEmit lib/index.d.ts",
     "validate:types:minimal": "tsc --noEmit lib/minimal.d.ts",
     "validate:types:plugin:authenticate": "tsc --noEmit lib/plugins/authenticate.d.ts",
-    "format": "prettier --write \"**/*.{js,jsx,ts,tsx,json}\"",
     "test": "jest"
   },
   "dependencies": {
@@ -77,14 +71,15 @@
     "apidoc": "0.17.5",
     "bili": "^4.10.0",
     "clean-deep": "^3.3.0",
+    "cross-env": "^7.0.3",
     "deep-sort-object": "^1.0.2",
     "eslint": "^6.8.0",
     "eslint-config-prettier": "^6.10.0",
     "eslint-config-standard-with-typescript": "^15.0.1",
     "eslint-plugin-import": "^2.20.1",
     "eslint-plugin-jest": "^23.8.2",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-prettier": "^3.3.1",
+    "eslint-plugin-prettier": "^3.1.2",
     "eslint-plugin-promise": "^4.2.1",
     "eslint-plugin-standard": "^4.0.1",
     "husky": "^4.2.5",
@@ -95,15 +90,12 @@
     "mkdirp": "^1.0.4",
     "mustache": "^4.0.1",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.2.1",
+    "prettier": "^2.0.5",
     "pretty-quick": "^2.0.1",
     "rimraf": "^3.0.2",
     "rollup-plugin-typescript2": "^0.27.1",
     "ts-jest": "^26.0.0",
     "ts-node": "^8.10.1",
     "typescript": "^3.8.3"
-  },
-  "directories": {
-    "test": "test"
   }
 }

package.json

@@ -3,7 +3,6 @@ import btoa from 'btoa-lite'
 type AuthOptions = import('./types').AuthOptions
 type Authentication = import('./types').Authentication
 
-// eslint-disable-next-line @typescript-eslint/require-await
 export function auth(authState: AuthOptions): Authentication {
   if (authState.type === 'token') {
     return {

src/plugins/auth/basicAuth/auth.ts

@@ -10,6 +10,11 @@ const routes = getOAuthRoutes(oAuth2Spec)
 function authenticatePlugin(client: APIClient, clientOptions: Options): void {
   client.registerEndpoints({ oauth: routes.getToken })
 
+  // (1) If neither `options.authStrategy` nor `options.auth` are set, the `octokit` instance
+  //     is unauthenticated. The `this.auth()` method is a no-op and no request hook is registered.
+  // (2) If only `options.auth` is set, use the default token authentication strategy.
+  // (3) If `options.authStrategy` is set then use it and pass in `options.auth`. Always pass own request as many strategies accept a custom request instance.
+
   if (!clientOptions.auth) return
   switch (clientOptions.authStrategy) {
     case 'OAuth':