@pkgjs/statusboard 0.1.3 → 0.1.4

package/README.md

@@ -10,22 +10,10 @@ This repository is managed by the [Package Maintenance Working Group](https://gi
 
 ## Example
 
-https://expressjs.github.io/statusboard/
+Example statusboards using `@pkgjs/statusboard`:
 
-## TODO
+- <https://expressjs.github.io/statusboard/> - [Github](https://github.com/expressjs/statusboard)
 
-- Cli logger
-- ~~Pull commit activity~~
-- ~~Clean up template~~
-- `create` command to setup a new project
-- ~~GH actions for building/publishing ([see express](https://github.com/expressjs/statusboard/blob/1de8da96746deb1952ecc0c22427f81083e022c9/.github/workflows/build.yml))~~ https://github.com/pkgjs/gh-pages
-- Contribution graph like on github
-- Meetings page (pull tag "meeting")
-- ~~Orginizations (pull all repos from an org)~~
-- Typescript support (load typings or if authored in TS)
-- People/Teams (specify and display teams, for example the express TC)
-- GH CI status
-- Pinned projects
 
 ## Setup
 
@@ -65,3 +53,14 @@ $ npm run build
 # commit and push the branches now
 $ cd build && git add . && git commit -m "our new statuspage" && git push
 ```
+
+## TODO
+
+- Cli logger
+- `create` command to setup a new project
+- Contribution graph like on github
+- Meetings page (pull tag "meeting")
+- Typescript support (load typings or if authored in TS)
+- People/Teams (specify and display teams, for example the express TC)
+- GH CI status
+- Pinned projects

package/lib/config.js

@@ -18,6 +18,7 @@ const DEFAULTS = {
   template: builder,
   indicies,
   bots: true,
+  head: [],
   title: 'StatusBoard',
   description: 'Project StatusBoard',
   issueLabels: ['top priority', 'good first issue', 'help wanted', 'discussion', 'meeting']
@@ -40,6 +41,7 @@ class Config {
     // All the dynamic stuff for a project
     this.title = opts.title || DEFAULTS.title
     this.description = opts.description || DEFAULTS.description
+    this.head = opts.head || DEFAULTS.head
 
     // Include bots in stats
     this.bots = opts.bots === undefined ? DEFAULTS.bots : opts.bots

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pkgjs/statusboard",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "A dashboard for project status",
   "author": "Wes Todd <wes@wesleytodd.com>",
   "keywords": [
@@ -9,6 +9,12 @@
     "badges",
     "express"
   ],
+  "files": [
+    "template",
+    "bin",
+    "index.js",
+    "lib"
+  ],
   "license": "MIT",
   "main": "index.js",
   "repository": {

package/template/index.html

@@ -5,11 +5,18 @@
     <title><%= title %></title>
     <meta name="description" content="<%= description %>">
     <meta name="viewport" content="width=device-width, initial-scale=1">
-
-    <!-- <link rel="manifest" href="site.webmanifest"> -->
-    <!-- <link rel="apple-touch-icon" href="icon.png"> -->
+    <meta name="robots" content="index, follow" />
+    <meta name="googlebot" content="index, follow" />
     <meta name="theme-color" content="#fafafa">
-    <!-- Place favicon.ico in the root directory -->
+
+    <meta property="og:type" content="website" />
+    <meta property="og:title" content="<%= title %>" />
+    <meta property="og:description" content="<%= description %>" />
+
+    <meta name="twitter:title" content="<%= title %>" />
+    <meta name="twitter:description" content="<%= description %>" />
+
+    <%- head.join('\n') %>
 
     <link href="<%= files.css.index %>" rel="stylesheet" />
     <script>

package/.github/workflows/build.yml

@@ -1,53 +0,0 @@
-name: Generate Statusboard
-
-on:
-  push:
-    branches:
-      - main
-  workflow_dispatch:
-
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-concurrency:
-  group: "pages"
-  cancel-in-progress: false
-
-jobs:
-  index:
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v4
-    - name: Setup Pages
-      uses: actions/configure-pages@v5
-    - uses: actions/setup-node@v4
-      with:
-        node-version: 20
-    - uses: actions/cache@v4
-      id: cache
-      with:
-        path: |
-          ~/.npm
-          ~/.cache
-          ./dist
-          ./node_modules
-        key: ${{ runner.os }}-build-${{ github.sha }}
-    - if: steps.cache.outputs.cache-hit != 'true'
-      run: npm install
-      shell: bash
-    - run: npm run build
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-    - name: Upload artifact
-      uses: actions/upload-pages-artifact@v3
-      with:
-        path: './gh-pages'
-    - name: Deploy to GitHub Pages
-      id: deployment
-      uses: actions/deploy-pages@v4

package/.github/workflows/test.yml

@@ -1,51 +0,0 @@
-name: Run Tests
-
-on: 
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
-
-concurrency:
-  group: "${{ github.workflow }} ✨ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}"
-  cancel-in-progress: false
-
-jobs:
-  lint:
-    name: Lint
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 'lts/*'
-
-      - name: Install dependencies
-        run: npm install --ignore-scripts --only=dev
-
-      - name: Run lint
-        run: npm run lint
-
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [18, 19, 20, 21, 22, 23]
-    steps:
-    - uses: actions/checkout@v4
-
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ matrix.node-version }}
-
-    - name: Install dependencies
-      run: npm install
-
-    - name: Run tests
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      run: npm test

package/CODE_OF_CONDUCT.md

@@ -1,4 +0,0 @@
-# Code of Conduct
-
-The Node.js Code of Conduct, which applies to this project, can be found at
-https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md.

package/CONTRIBUTING.md

@@ -1,36 +0,0 @@
-# Contributing
-
-## Code of Conduct
-
-The Node.js project has a
-[Code of Conduct](https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md)
-to which all contributors must adhere.
-
-See [details on our policy on Code of Conduct](https://github.com/nodejs/node/blob/master/doc/guides/contributing/code-of-conduct.md).
-
-<a id="developers-certificate-of-origin"></a>
-## Developer's Certificate of Origin 1.1
-
-By making a contribution to this project, I certify that:
-
-* (a) The contribution was created in whole or in part by me and I
-  have the right to submit it under the open source license
-  indicated in the file; or
-
-* (b) The contribution is based upon previous work that, to the best
-  of my knowledge, is covered under an appropriate open source
-  license and I have the right under that license to submit that
-  work with modifications, whether created in whole or in part
-  by me, under the same open source license (unless I am
-  permitted to submit under a different license), as indicated
-  in the file; or
-
-* (c) The contribution was provided directly to me by some other
-  person who certified (a), (b) or (c) and I have not modified
-  it.
-
-* (d) I understand and agree that this project and the contribution
-  are public and that a record of the contribution (including all
-  personal information I submit with it, including my sign-off) is
-  maintained indefinitely and may be redistributed consistent with
-  this project or the open source license(s) involved.

package/test/fixtures/config.js

@@ -1,37 +0,0 @@
-'use strict'
-const path = require('path')
-
-module.exports = {
-  db: path.join(__dirname, 'tmp', 'data.db'),
-  baseUrl: '/statusboard',
-  outputDirectory: path.join(__dirname, 'tmp'),
-  github: {
-    token: process.env.GITHUB_TOKEN
-  },
-
-  title: 'StatusBoard Test',
-  description: 'A test for StatusBoard',
-
-  orgs: [
-    'pkgjs'
-  ],
-
-  projects: [
-    'nodejs/package-maintenance',
-    {
-      name: 'Express StatusBoard',
-      repo: 'expressjs/statusboard'
-    }
-  ],
-
-  people: [
-    {
-      name: 'Wes Todd',
-      email: 'wes@wesleytodd.com',
-      website: 'http://www.github.com/wesleytodd',
-      npmUsername: 'wesleytodd',
-      githubUsername: 'wesleytodd',
-      twitterUsername: 'wesleytodd'
-    }
-  ]
-}

package/test/index.js

@@ -1,68 +0,0 @@
-'use strict'
-require('dotenv').config()
-const { suite, test, before } = require('mocha')
-const assert = require('assert')
-const fs = require('fs-extra')
-const pkg = require('../package.json')
-const statusboard = require('../')
-
-// These tests require a github token
-assert(process.env.GITHUB_TOKEN, `
-Tests require GITHUB_TOKEN to be a valid GitHub personal token.
-See: https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line
-
-Then run:
-
-  $ echo "GITHUB_TOKEN=<your token>" > .env
-`)
-
-const CONFIG = require('./fixtures/config')
-suite(pkg.name, () => {
-  before(async () => {
-    await fs.remove(CONFIG.outputDirectory)
-  })
-
-  test('Configure a statusboard instance', async () => {
-    const board = await statusboard(CONFIG)
-    assert.strictEqual(board.config.db, CONFIG.db)
-    assert.strictEqual(board.config.outputDirectory, CONFIG.outputDirectory)
-    assert.strictEqual(board.config.baseUrl, CONFIG.baseUrl)
-    assert.strictEqual(board.config.title, CONFIG.title)
-    assert.strictEqual(board.config.description, CONFIG.description)
-
-    assert.strictEqual(board.config.orgs.length, CONFIG.orgs.length)
-    assert.strictEqual(board.config.orgs[0].name, CONFIG.orgs[0])
-
-    assert.strictEqual(board.config.projects.length, CONFIG.projects.length)
-
-    assert.strictEqual(board.config.projects[0].name, CONFIG.projects[0])
-    assert.strictEqual(board.config.projects[0].repo, CONFIG.projects[0])
-    assert.strictEqual(board.config.projects[0].repoOwner, CONFIG.projects[0].split('/')[0])
-    assert.strictEqual(board.config.projects[0].repoName, CONFIG.projects[0].split('/')[1])
-
-    assert.strictEqual(board.config.projects[1].name, CONFIG.projects[1].name)
-    assert.strictEqual(board.config.projects[1].repo, CONFIG.projects[1].repo)
-    assert.strictEqual(board.config.projects[1].repoOwner, CONFIG.projects[1].repo.split('/')[0])
-    assert.strictEqual(board.config.projects[1].repoName, CONFIG.projects[1].repo.split('/')[1])
-
-    assert(board.config.issueLabels.length > 0)
-    assert.strictEqual(board.config.people.length, CONFIG.people.length)
-
-    // Check exposed interface a little
-    assert.strictEqual(typeof board.buildIndex, 'function')
-    assert.strictEqual(typeof board.buildSite, 'function')
-    assert.strictEqual(typeof board.close, 'function')
-  })
-
-  test('Building the statusboard index', async function () {
-    this.timeout(0)
-    const board = await statusboard(CONFIG)
-    await board.buildIndex()
-  })
-
-  test('should build a web page from a template', async function () {
-    this.timeout(0)
-    const board = await statusboard(CONFIG)
-    await board.buildSite()
-  })
-})