ghusers 0.2.3 → 1.0.0

package/.github/dependabot.yml

@@ -0,0 +1,20 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'weekly'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+    cooldown:
+      default-days: 5
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: 'weekly'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+    cooldown:
+      default-days: 5

package/.github/workflows/test-and-release.yml

@@ -0,0 +1,56 @@
+name: Test & Maybe Release
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        node: [lts/*, current]
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v6
+      - name: Use Node.js ${{ matrix.node }}
+        uses: actions/setup-node@v6
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Install Dependencies
+        run: npm install --no-progress
+      - name: Check build is up to date
+        run: |
+          npm run build
+          git diff --exit-code || (echo "::error::Build artifacts not committed. Run 'npm run build' and commit the changes." && exit 1)
+      - name: Run tests
+        run: npm test
+
+  release:
+    name: Release
+    needs: test
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+      id-token: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: lts/*
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install dependencies
+        run: npm install --no-progress --no-package-lock --no-save
+      - name: Build
+        run: npm run build
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_CONFIG_PROVENANCE: true
+        run: npx semantic-release

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+## [1.0.0](https://github.com/rvagg/ghusers/compare/v0.2.3...v1.0.0) (2026-01-27)
+
+### ⚠ BREAKING CHANGES
+
+* modernise, ESM, promises, update deps, GHA, auto-release (#2)
+
+### Bug Fixes
+
+* add release config ([5634369](https://github.com/rvagg/ghusers/commit/5634369e698b8991f075d7440cbf6c48d0386fab))
+
+### Trivial Changes
+
+* modernise, ESM, promises, update deps, GHA, auto-release ([#2](https://github.com/rvagg/ghusers/issues/2)) ([26f55f1](https://github.com/rvagg/ghusers/commit/26f55f196cca3b651b6abdbcc030c3dd64f5e53c))

package/README.md

@@ -1,43 +1,60 @@
 # ghusers
 
-[![Build Status](https://secure.travis-ci.org/rvagg/ghusers.png)](http://travis-ci.org/rvagg/ghusers)
+**A Node.js library to interact with the GitHub users API**
 
-**A node library to interact with the GitHub users API**
+[![NPM](https://nodei.co/npm/ghusers.svg?style=flat&data=n,v&color=blue)](https://nodei.co/npm/ghusers/)
 
-[![NPM](https://nodei.co/npm/ghusers.png?mini=true)](https://nodei.co/npm/ghusers/)
+## Requirements
+
+- Node.js >= 20
 
 ## Example usage
 
 ```js
-const ghusers     = require('ghusers')
-    , authOptions = { user: 'rvagg', token: '24d5dee258c64aef38a66c0c5eca459c379901c2' }
+import * as ghusers from 'ghusers'
+
+const auth = { token: 'your-github-token' }
 
 // get user by login/username
-ghusers.get(authOptions, 'substack', function (err, user) {
-  // object containing full details of @substack
-  console.log(user)
-})
+const user = await ghusers.get(auth, 'substack')
+console.log(user)
 ```
 
-
-The auth data is compatible with [ghauth](https://github.com/rvagg/ghauth) so you can just connect them together to make a simple command-line application:
+The auth data is compatible with [ghauth](https://github.com/rvagg/ghauth) so you can connect them together:
 
 ```js
-const ghauth      = require('ghauth')
-    , ghusers     = require('ghusers')
-    , authOptions = {
-          configName : 'team-lister'
-        , scopes     : [ 'user' ]
-      }
-
-ghauth(authOptions, function (err, authData) {
-  ghusers.get(authData, 'rvagg', function (err, user) {
-    console.log(user)
-  })
+import ghauth from 'ghauth'
+import * as ghusers from 'ghusers'
+
+const auth = await ghauth({
+  configName: 'user-lookup',
+  scopes: ['user']
 })
+
+const user = await ghusers.get(auth, 'rvagg')
+console.log(user)
 ```
 
+## API
+
+All methods return Promises.
+
+### ghusers.get(auth, user, options)
+
+Get full user data for a given login/username.
+
+## Authentication
+
+See [ghauth](https://github.com/rvagg/ghauth) for an easy way to obtain and cache GitHub authentication tokens. The `auth` object returned by ghauth is directly compatible with all ghusers methods.
+
+## See also
+
+* [ghissues](https://github.com/rvagg/ghissues) - interact with the GitHub issues API
+* [ghpulls](https://github.com/rvagg/ghpulls) - interact with the GitHub pull requests API
+* [ghteams](https://github.com/rvagg/ghteams) - interact with the GitHub teams API
+* [ghrepos](https://github.com/rvagg/ghrepos) - interact with the GitHub repos API
+* [ghauth](https://github.com/rvagg/ghauth) - GitHub authentication
 
 ## License
 
-**ghusers** is Copyright (c) 2014 Rod Vagg [@rvagg](https://github.com/rvagg) and licensed under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.
+**ghusers** is Copyright (c) 2014-2025 Rod Vagg [@rvagg](https://github.com/rvagg) and licensed under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.

package/ghusers.js

@@ -1,13 +1,10 @@
-const ghutils = require('ghutils')
+import { ghget } from 'ghutils'
 
+const defaultApiUrl = 'https://api.github.com'
 
-module.exports.get = function get (auth, user, options, callback) {
-  if (typeof options == 'function') {
-    callback = options
-    options  = {}
-  }
-
-  var url = 'https://api.github.com/users/' + user
-
-  ghutils.ghget(auth, url, options, callback)
+export async function get (auth, user, options = {}) {
+  const apiUrl = options._apiUrl || defaultApiUrl
+  const url = `${apiUrl}/users/${user}`
+  const { data } = await ghget(auth, url, options)
+  return data
 }

package/package.json

@@ -1,10 +1,17 @@
 {
   "name": "ghusers",
-  "version": "0.2.3",
+  "version": "1.0.0",
   "description": "Interact with the GitHub users API",
-  "main": "ghusers.js",
+  "type": "module",
+  "exports": "./ghusers.js",
+  "engines": {
+    "node": ">=20"
+  },
   "scripts": {
-    "test": "node test.js"
+    "lint": "standard",
+    "build": "true",
+    "test:unit": "node --test test.js",
+    "test": "npm run lint && npm run test:unit"
   },
   "repository": {
     "type": "git",
@@ -21,10 +28,98 @@
   },
   "homepage": "https://github.com/rvagg/ghusers",
   "dependencies": {
-    "ghutils": "~1.3.0"
+    "ghutils": "^5.0.2"
   },
   "devDependencies": {
-    "tape": "~4.0.0",
-    "xtend": "~4.0.0"
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^12.0.2",
+    "@semantic-release/npm": "^13.1.3",
+    "@semantic-release/release-notes-generator": "^14.1.0",
+    "conventional-changelog-conventionalcommits": "^9.1.0",
+    "semantic-release": "^25.0.2",
+    "standard": "^17.1.2"
+  },
+  "release": {
+    "branches": [
+      "master"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "breaking": true,
+              "release": "major"
+            },
+            {
+              "revert": true,
+              "release": "patch"
+            },
+            {
+              "type": "feat",
+              "release": "minor"
+            },
+            {
+              "type": "fix",
+              "release": "patch"
+            },
+            {
+              "type": "chore",
+              "release": "patch"
+            },
+            {
+              "type": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "scope": "no-release",
+              "release": false
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "chore",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "docs",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "test",
+                "section": "Tests"
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      "@semantic-release/git"
+    ]
   }
 }

package/test.js

@@ -1,25 +1,35 @@
-const ghutils = require('ghutils/test')
-    , http    = require('http')
-    , test    = require('tape')
-    , xtend   = require('xtend')
-    , ghusers = require('./')
+import { test } from 'node:test'
+import assert from 'node:assert'
+import { createMockServer } from 'ghutils/test-util'
+import * as ghusers from './ghusers.js'
 
+test('get user', async () => {
+  const auth = { token: 'test-token' }
+  const testData = { login: 'testuser', id: 1, name: 'Test User' }
 
-test('test get user', function (t) {
-  t.plan(7)
+  const server = await createMockServer({ response: testData })
+  try {
+    const result = await ghusers.get(auth, 'testuser', {
+      _apiUrl: server.baseUrl
+    })
+    assert.deepStrictEqual(result, testData)
+    assert.ok(server.requests[0].url.includes('/users/testuser'))
+    assert.strictEqual(server.requests[0].headers.authorization, 'Bearer test-token')
+  } finally {
+    await server.close()
+  }
+})
 
-  var auth     = { user: 'authuser', token: 'authtoken' }
-    , username = 'testuser'
-    , testData = { login: username, test: 'data' }
-    , server
+test('auth header is correctly set', async () => {
+  const auth = { token: 'my-secret-token' }
+  const testData = { login: 'testuser' }
 
-  server = ghutils.makeServer(testData)
-    .on('ready', function () {
-      ghusers.get(xtend(auth), username, ghutils.verifyData(t, testData))
-    })
-    .on('request', ghutils.verifyRequest(t, auth))
-    .on('get', ghutils.verifyUrl(t, [
-        'https://api.github.com/users/' + username
-    ]))
-    .on('close'  , ghutils.verifyClose(t))
+  const server = await createMockServer({ response: testData })
+  try {
+    await ghusers.get(auth, 'testuser', { _apiUrl: server.baseUrl })
+    assert.strictEqual(server.requests[0].headers.authorization, 'Bearer my-secret-token')
+    assert.strictEqual(server.requests[0].headers.accept, 'application/vnd.github+json')
+  } finally {
+    await server.close()
+  }
 })

package/.jshintrc

@@ -1,59 +0,0 @@
-{
-    "predef": [ ]
-  , "bitwise": false
-  , "camelcase": false
-  , "curly": false
-  , "eqeqeq": false
-  , "forin": false
-  , "immed": false
-  , "latedef": false
-  , "noarg": true
-  , "noempty": true
-  , "nonew": true
-  , "plusplus": false
-  , "quotmark": true
-  , "regexp": false
-  , "undef": true
-  , "unused": true
-  , "strict": false
-  , "trailing": true
-  , "maxlen": 120
-  , "asi": true
-  , "boss": true
-  , "debug": true
-  , "eqnull": true
-  , "esnext": true
-  , "evil": true
-  , "expr": true
-  , "funcscope": false
-  , "globalstrict": false
-  , "iterator": false
-  , "lastsemic": true
-  , "laxbreak": true
-  , "laxcomma": true
-  , "loopfunc": true
-  , "multistr": false
-  , "onecase": false
-  , "proto": false
-  , "regexdash": false
-  , "scripturl": true
-  , "smarttabs": false
-  , "shadow": false
-  , "sub": true
-  , "supernew": false
-  , "validthis": true
-  , "browser": true
-  , "couch": false
-  , "devel": false
-  , "dojo": false
-  , "mootools": false
-  , "node": true
-  , "nonstandard": true
-  , "prototypejs": false
-  , "rhino": false
-  , "worker": true
-  , "wsh": false
-  , "nomen": false
-  , "onevar": false
-  , "passfail": false
-}

package/.npmignore

@@ -1,2 +0,0 @@
-node_modules
-ex.js

package/.travis.yml

@@ -1,10 +0,0 @@
-language: node_js
-node_js:
-  - "0.10"
-branches:
-  only:
-    - master
-notifications:
-  email:
-    - rod@vagg.org
-script: npm test