feat: support private registries (#12)

Author: kinetifex

README.md

@@ -45,4 +45,26 @@ Add the plugin to your project with `yarn add @oclif/plugin-warn-if-update-avail
 
 # Configuration
 
-In `package.json`, set `oclif['warn-if-update-available'].timeoutInDays` to change the timeout duration between checks.
+In `package.json`, set `oclif['warn-if-update-available']` to an object with
+any of the following configuration properties:
+
+- `timeoutInDays` - Duration between update checks. Defaults to 60.
+- `registry` - URL of registry. Defaults to the public npm registry: `https://registry.npmjs.org`
+- `authorization` - Authorization header value for registries that require auth.
+
+## Example configuration
+
+```json
+{
+  "oclif": {
+    "plugins": [
+      "@oclif/plugin-warn-if-update-available"
+    ],
+    "warn-if-update-available": {
+      "timeoutInDays": 7,
+      "registry": "https://my.example.com/module/registry",
+      "authorization": "Basic <SOME READ ONLY AUTH TOKEN>"
+    }
+  }
+}
+``` 

src/get-version.ts

@@ -1,12 +1,18 @@
 import * as fs from 'fs-extra'
 import HTTP from 'http-call'
 
-async function run(name: string, file: string, version: string) {
-  await fs.outputJSON(file, {current: version}) // touch file with current version to prevent multiple updates
-  const {body} = await HTTP.get<any>(`https://registry.npmjs.org/${name.replace('/', '%2f')}`, {timeout: 5000})
-  await fs.outputJSON(file, {...body['dist-tags'], current: version})
+async function run(name: string, file: string, version: string, registry: string, authorization: string) {
+  const url = [
+    registry.replace(/\/+$/, ''), // remove trailing slash
+    name.replace('/', '%2f')      // scoped packages need escaped separator
+  ].join('/')
+  const headers = authorization ? {authorization} : {}
+
+  await fs.outputJSON(file, {current: version, headers}) // touch file with current version to prevent multiple updates
+  const {body} = await HTTP.get<any>(url, {headers, timeout: 5000})
+  await fs.outputJSON(file, {...body['dist-tags'], current: version, authorization})
   process.exit(0)
 }
 
-run(process.argv[2], process.argv[3], process.argv[4])
+run(process.argv[2], process.argv[3], process.argv[4], process.argv[5], process.argv[6])
 .catch(require('@oclif/errors/handle'))

src/hooks/init/check-update.ts

@@ -10,6 +10,13 @@ const debug = require('debug')('update-check')
 const hook: Hook<'init'> = async function ({config}) {
   const file = path.join(config.cacheDir, 'version')
 
+  // Destructure package.json configuration with defaults
+  const {
+    timeoutInDays = 60,
+    registry = 'https://registry.npmjs.org',
+    authorization = '',
+  } = (config.pjson.oclif as any)['warn-if-update-available'] || {}
+
   const checkVersion = async () => {
     try {
       const distTags = await fs.readJSON(file)
@@ -28,8 +35,6 @@ const hook: Hook<'init'> = async function ({config}) {
 
   const refreshNeeded = async () => {
     try {
-      const cfg = (config.pjson.oclif as any)['warn-if-update-available'] || {}
-      const timeoutInDays = cfg.timeoutInDays || 60
       const {mtime} = await fs.stat(file)
       const staleAt = new Date(mtime.valueOf() + 1000 * 60 * 60 * 24 * timeoutInDays)
       return staleAt < new Date()
@@ -43,7 +48,7 @@ const hook: Hook<'init'> = async function ({config}) {
     debug('spawning version refresh')
     spawn(
       process.execPath,
-      [path.join(__dirname, '../../../lib/get-version'), config.name, file, config.version],
+      [path.join(__dirname, '../../../lib/get-version'), config.name, file, config.version, registry, authorization],
       {
         detached: !config.windows,
         stdio: 'ignore',