@skriptfabrik/elements-cli 0.4.1 → 0.5.0

package/.github/dependabot.yaml

@@ -0,0 +1,39 @@
+version: 2
+
+registries:
+  dockerhub:
+    type: 'docker-registry'
+    url: 'https://registry.hub.docker.com'
+    username: '${{ secrets.DOCKERHUB_USERNAME }}'
+    password: '${{ secrets.DOCKERHUB_TOKEN }}'
+    replaces-base: true
+
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    reviewers:
+      - 'skriptfabrik/developers'
+    schedule:
+      interval: 'weekly'
+      time: '08:00'
+      timezone: 'Europe/Berlin'
+
+  - package-ecosystem: 'npm'
+    directory: '/'
+    reviewers:
+      - 'skriptfabrik/developers'
+    schedule:
+      interval: 'weekly'
+      time: '08:00'
+      timezone: 'Europe/Berlin'
+
+  - package-ecosystem: 'docker'
+    directory: '/'
+    reviewers:
+      - 'skriptfabrik/developers'
+    registries:
+      - 'dockerhub'
+    schedule:
+      interval: 'weekly'
+      time: '08:00'
+      timezone: 'Europe/Berlin'

package/.github/pull_request_template.md

@@ -0,0 +1,12 @@
+## Describe your changes
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+
+## Checklist before requesting a review
+
+- [ ] I have included the ticket number of the issue at the beginning of the title of this pull request.
+- [ ] I have updated the docs and/or specs to reflect this change.
+- [ ] I have performed a self-review of my code.
+- [ ] I have added thorough tests.

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:18.2.0-alpine
+FROM node:18.14.0-alpine
 
 LABEL maintainer="Daniel Schröder <daniel.schroeder@skriptfabrik.com>"
 
@@ -12,7 +12,7 @@ COPY . /opt/elements-cli-${ELEMENTS_CLI_VERSION}
 RUN set -eux; \
     npm --prefix /opt/elements-cli-${ELEMENTS_CLI_VERSION} install; \
     rm -Rf ~/.npm; \
-    ln -s /opt/elements-cli-${ELEMENTS_CLI_VERSION}/elements-cli.js /usr/local/bin/elements
+    ln -s /opt/elements-cli-${ELEMENTS_CLI_VERSION}/elements-cli.mjs /usr/local/bin/elements
 
 WORKDIR /data
 

package/README.md

@@ -1,6 +1,6 @@
 [![NPM Version](https://img.shields.io/npm/v/@skriptfabrik/elements-cli)](https://www.npmjs.com/package/@skriptfabrik/elements-cli)
 [![NPM Downloads](https://img.shields.io/npm/dt/@skriptfabrik/elements-cli)](https://www.npmjs.com/package/@skriptfabrik/elements-cli)
-[![Continuous Integration](https://img.shields.io/github/workflow/status/skriptfabrik/elements-cli/Continuous%20Integration)](https://github.com/skriptfabrik/elements-cli/actions/workflows/ci.yml)
+[![Continuous Integration](https://img.shields.io/github/actions/workflow/status/skriptfabrik/elements-cli/ci.yml)](https://github.com/skriptfabrik/elements-cli/actions/workflows/ci.yml)
 
 # Elements CLI
 

package/{elements-cli.js → elements-cli.mjs}

@@ -1,19 +1,29 @@
 #!/usr/bin/env node
 
-const chalk = require('chalk');
-const chokidar = require('chokidar');
-const { compile } = require('handlebars');
-const corsAnywhere = require('cors-anywhere');
-const express = require('express');
-const fs = require('fs');
-const gracefulShutdown = require('http-graceful-shutdown');
-const handlebars = require('express-handlebars');
-const minimist = require('minimist');
-const path = require('path');
-const pkg = require('./package.json');
-const send = require('send');
-const { Server } = require('ws');
-const { URL } = require('url');
+import chalk from 'chalk';
+import chokidar from 'chokidar';
+import corsAnywhere from 'cors-anywhere';
+import express from 'express';
+import { engine } from 'express-handlebars';
+import { readFile } from 'fs/promises';
+import handlebars from 'handlebars';
+import gracefulShutdown from 'http-graceful-shutdown';
+import minimist from 'minimist';
+import { createRequire } from 'module';
+import path from 'path';
+import send from 'send';
+import { WebSocketServer } from 'ws';
+import { fileURLToPath, URL } from 'url';
+
+// Compat
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const require = createRequire(import.meta.url);
+
+// Package info
+
+const pkg = JSON.parse(await readFile(path.join(__dirname, 'package.json')));
 
 // Argument defaults
 
@@ -171,10 +181,10 @@ function sanitize(str, suffix = '') {
  * 
  * @param {http.Server} server The HTTP server instance
  * 
- * @returns {ws.Server}
+ * @returns {ws.WebSocketServer}
  */
 function upgrade(server) {
-  const wss = new Server({ server });
+  const wss = new WebSocketServer({ server });
 
   return wss.on('connection', (socket) => {
     socket.on('message', (message) => {
@@ -202,8 +212,8 @@ function upgrade(server) {
 /**
  * Create file system watcher and broatcast all file changes to every client
  * 
- * @param {sting}     filePath The file path to watch
- * @param {ws.Server} server   The web socket server instance
+ * @param {string}             filePath The file path to watch
+ * @param {ws.WebSocketServer} server   The web socket server instance
  * 
  * @returns {chokidar.FSWatcher}
  */
@@ -239,8 +249,8 @@ const delimiters = { open: '{{', close: '}}' },
 // Export rendered API docs
 
 if (argv._[0] === 'export') {
-  const input = fs.readFileSync(path.resolve(__dirname, 'views', 'index.handlebars')).toString('utf8');
-  const template = compile(input);
+  const input = (await readFile(path.resolve(__dirname, 'views', 'index.handlebars'))).toString('utf8');
+  const template = handlebars.compile(input);
   const version = pkg.dependencies['@stoplight/elements'];
 
   let tryItCorsProxy;
@@ -281,7 +291,7 @@ const app = express();
 
 // Enable Handlebars view engine
 
-app.engine('handlebars', handlebars.engine());
+app.engine('handlebars', engine());
 app.set('view engine', 'handlebars');
 app.set('views', path.join(__dirname, 'views'));
 
@@ -378,15 +388,22 @@ const server = app.listen(argv.port, argv.hostname, () => {
 
 // Watch files in working directory and launch web socket server
 
-if (argv.watch) {
-  watch(
+const watcher = argv.watch
+  ? watch(
     argv['working-dir'],
     upgrade(server).on('error', (err) => console.error(err))
   )
     .once('ready', () => console.error(`Watching ${path.resolve(argv['working-dir'])}`))
-    .on('error', (err) => console.error(err));
-}
+    .on('error', (err) => console.error(err))
+  : undefined;
 
 // Enable the graceful shutdown
 
-gracefulShutdown(server);
+gracefulShutdown(server, {
+  onShutdown: () => new Promise((resolve) => {
+    if (watcher) {
+      watcher.close();
+    }
+    resolve();
+  })
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skriptfabrik/elements-cli",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "The missing CLI for beautiful, interactive API docs powered by with Stoplight Elements",
   "keywords": [
     "stoplight",
@@ -21,20 +21,20 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@stoplight/elements": "7.7.3",
-    "chalk": "^4.0.0",
+    "@stoplight/elements": "7.7.10",
+    "chalk": "^5.2.0",
     "chokidar": "^3.5.3",
     "cors-anywhere": "~0.4.4",
     "express": "^4.18.2",
-    "express-handlebars": "^6.0.6",
+    "express-handlebars": "^6.0.7",
     "handlebars": "^4.7.7",
-    "http-graceful-shutdown": "^3.1.9",
+    "http-graceful-shutdown": "^3.1.12",
     "livereload-js": "3.4.1",
     "minimist": "^1.2.7",
     "send": "~0.18.0",
-    "ws": "^8.10.0"
+    "ws": "^8.12.0"
   },
   "bin": {
-    "elements": "./elements-cli.js"
+    "elements": "./elements-cli.mjs"
   }
 }