feature: gritty: migrate to ESM

Author: coderaiser

.madrun.mjs .madrun.js.madrun.mjs renamed to .madrun.js

@@ -1,6 +1,10 @@
 import {run, cutEnv} from 'madrun';
+import {defineEnv} from 'supertape/env';
 
-const SUPERTAPE_TIMEOUT = 15_000;
+const env = defineEnv({
+    css: true,
+    timeout: 15_000,
+});
 
 export default {
     'start': () => 'node bin/gritty',
@@ -25,11 +29,6 @@ export default {
     'watch:lint': async () => `nodemon -w client -w server -w webpack.config.js -x ${await run('lint')}`,
     'report': () => 'c8 report --reporter=lcov',
 
-    'coverage': async () => [`c8 ${await cutEnv('test')}`, {
-        SUPERTAPE_TIMEOUT,
-    }],
-    
-    'test': () => [`tape 'test/**/*.js'`, {
-        SUPERTAPE_TIMEOUT,
-    }],
+    'coverage': async () => [env, `c8 ${await cutEnv('test')}`],
+    'test': () => [env, `tape 'test/**/*.js'`],
 };

README.md

@@ -107,15 +107,15 @@ And use it this way:
 
 ```js
 // server.js
-const http = require('node:http');
-const gritty = require('gritty');
+import http from 'node:http';
+import {gritty} from 'gritty';
 
-const express = require('express');
-const io = require('socket.io');
+import express from 'express';
+import {Server} from 'socket.io';
 
 const app = express();
 const server = http.createServer(app);
-const socket = io.listen(server);
+const socket = new Server(server);
 
 const port = 1337;
 const ip = '0.0.0.0';

bin/gritty.js

@@ -1,10 +1,25 @@
 #!/usr/bin/env node
 
-'use strict';
+import process from 'node:process';
+import http from 'node:http';
+import {fileURLToPath} from 'node:url';
+import {dirname} from 'node:path';
+import yargsParser from 'yargs-parser';
+import squad from 'squad';
+import express from 'express';
+import {Server} from 'socket.io';
+import {gritty} from '#gritty/server';
+import bin from '../help.json' with {
+    type: 'json',
+};
+import pack from '../package.json' with {
+    type: 'json',
+};
 
-const {join} = require('node:path');
-const process = require('node:process');
-const args = require('yargs-parser')(process.argv.slice(2), {
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const args = yargsParser(process.argv.slice(2), {
     boolean: [
         'version',
         'help',
@@ -45,12 +60,10 @@ function main(args) {
 }
 
 function path() {
-    console.log(join(__dirname, '..'));
+    console.log(new URL('..', import.meta.url).pathname);
 }
 
 function start(options) {
-    const squad = require('squad');
-    
     const {
         port,
         command,
@@ -61,12 +74,6 @@ function start(options) {
 
     const DIR = `${__dirname}/../`;
 
-    const gritty = require('../');
-    const http = require('node:http');
-    
-    const express = require('express');
-    const io = require('socket.io');
-    
     const app = express();
     const server = http.createServer(app);
 
@@ -77,7 +84,7 @@ function start(options) {
         .use(gritty())
         .use(express.static(DIR));
 
-    const socket = io(server);
+    const socket = new Server(server);
 
     gritty.listen(socket, {
         command,
@@ -92,7 +99,6 @@ function start(options) {
 }
 
 function help() {
-    const bin = require('../help');
     const usage = 'Usage: gritty [options]';
 
     console.log(usage);
@@ -104,7 +110,6 @@ function help() {
 }
 
 function version() {
-    const pack = require('../package');
     console.log('v' + pack.version);
 }
 

client/get-el.js

@@ -1,8 +1,6 @@
-'use strict';
-
 const isString = (a) => typeof a === 'string';
 
-module.exports = (el) => {
+export default (el) => {
     if (isString(el))
         return document.querySelector(el);
 

client/get-env.js

@@ -1,8 +1,6 @@
-'use strict';
-
 const isFn = (a) => typeof a === 'function';
 
-module.exports = (env) => {
+export default (env) => {
     const obj = {};
 
     for (const name of Object.keys(env)) {

client/get-host.js

@@ -1,6 +1,4 @@
-'use strict';
-
-module.exports = () => {
+export default () => {
     const l = location;
 
     return l.origin || l.protocol + '//' + l.host;

client/gritty.js

@@ -1,20 +1,14 @@
-'use strict';
-
-require('@xterm/xterm/css/xterm.css');
-
-const {FitAddon} = require('@xterm/addon-fit');
-const {WebglAddon: _WebglAddon} = require('@xterm/addon-webgl');
-const currify = require('currify');
-const {tryCatch} = require('try-catch');
-
-const wrap = require('wraptile');
-
-const {io} = require('socket.io-client');
-const {Terminal: _Terminal} = require('@xterm/xterm');
-
-const getEl = require('./get-el');
-const getHost = require('./get-host');
-const getEnv = require('./get-env');
+import '@xterm/xterm/css/xterm.css';
+import {FitAddon} from '@xterm/addon-fit';
+import {WebglAddon as _WebglAddon} from '@xterm/addon-webgl';
+import currify from 'currify';
+import {tryCatch} from 'try-catch';
+import wrap from 'wraptile';
+import {io} from 'socket.io-client';
+import * as _Terminal from '@xterm/xterm';
+import getEl from './get-el.js';
+import getHost from './get-host.js';
+import getEnv from './get-env.js';
 
 const onWindowResize = wrap(_onWindowResize);
 const onTermData = currify(_onTermData);
@@ -25,17 +19,11 @@ const onDisconnect = wrap(_onDisconnect);
 
 const onConnect = wrap(_onConnect);
 
-module.exports = gritty;
-module.exports._onConnect = _onConnect;
-module.exports._onDisconnect = _onDisconnect;
-module.exports._onData = _onData;
-module.exports._onTermResize = _onTermResize;
-module.exports._onTermData = _onTermData;
-module.exports._onWindowResize = _onWindowResize;
+export default gritty;
 
 const defaultFontFamily = 'Menlo, Consolas, "Liberation Mono", Monaco, "Lucida Console", monospace';
 
-module.exports._defaultFontFamily = defaultFontFamily;
+export const _defaultFontFamily = defaultFontFamily;
 
 function gritty(element, options = {}) {
     const el = getEl(element);
@@ -123,7 +111,7 @@ function createTerminal(terminalContainer, overrides) {
     };
 }
 
-function _onConnect(socket, fitAddon, {env, cwd, cols, rows, command, autoRestart}) {
+export function _onConnect(socket, fitAddon, {env, cwd, cols, rows, command, autoRestart}) {
     socket.emit('terminal', {
         env,
         cwd,
@@ -139,26 +127,26 @@ function _onConnect(socket, fitAddon, {env, cwd, cols, rows, command, autoRestar
     fitAddon.fit();
 }
 
-function _onDisconnect(terminal) {
+export function _onDisconnect(terminal) {
     terminal.writeln('terminal disconnected...');
 }
 
-function _onData(terminal, data) {
+export function _onData(terminal, data) {
     terminal.write(data);
 }
 
-function _onTermResize(socket, {cols, rows}) {
+export function _onTermResize(socket, {cols, rows}) {
     socket.emit('resize', {
         cols,
         rows,
     });
 }
 
-function _onTermData(socket, data) {
+export function _onTermData(socket, data) {
     socket.emit('data', data);
 }
 
-function _onWindowResize(fitAddon) {
+export function _onWindowResize(fitAddon) {
     // Uncaught Error: This API only accepts integers
     // when gritty mimized
     const fit = fitAddon.fit.bind(fitAddon);

package.json

@@ -1,7 +1,7 @@
 {
   "name": "gritty",
   "version": "9.0.4",
-  "type": "commonjs",
+  "type": "module",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "Web terminal emulator",
   "bin": {
@@ -12,6 +12,10 @@
     "type": "git",
     "url": "git+https://github.com/cloudcmd/gritty.git"
   },
+  "imports": {
+    "#gritty/client": "./client/gritty.js",
+    "#gritty/server": "./server/gritty.js"
+  },
   "scripts": {
     "start": "madrun start",
     "start:dev": "madrun start:dev",

server/gritty.js

@@ -1,17 +1,16 @@
-'use strict';
-
-const process = require('node:process');
-
-const path = require('node:path');
-
-const log = require('debug')('gritty');
-const Router = require('router');
-
-const currify = require('currify');
-const wraptile = require('wraptile');
-const _pty = require('node-pty');
-
-const stringArgv = require('string-to-argv');
+import process from 'node:process';
+import path, {dirname} from 'node:path';
+import {fileURLToPath} from 'node:url';
+import debug from 'debug';
+import Router from 'router';
+import currify from 'currify';
+import wraptile from 'wraptile';
+import _pty from 'node-pty';
+import stringArgv from 'string-to-argv';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+const log = debug('gritty');
 const isFn = (a) => typeof a === 'function';
 const isBool = (a) => typeof a === 'boolean';
 
@@ -45,7 +44,7 @@ const choose = (a, b, options) => {
     return options.default;
 };
 
-module.exports = (options = {}) => {
+export const gritty = (options = {}) => {
     const router = Router();
     const {prefix = '/gritty'} = options;
 
@@ -103,7 +102,7 @@ function createTerminal(overrides = {}) {
     return term;
 }
 
-module.exports.listen = (socket, options = {}) => {
+gritty.listen = (socket, options = {}) => {
     check(socket, options);
 
     const {prefix, auth} = options;

test/before.js

@@ -1,16 +1,12 @@
-'use strict';
-
-const http = require('node:http');
-
-const {promisify} = require('node:util');
-const express = require('express');
-
-const io = require('socket.io');
-const gritty = require('..');
+import http from 'node:http';
+import {promisify} from 'node:util';
+import express from 'express';
+import {Server} from 'socket.io';
+import {gritty} from '#gritty/server';
 
 const isFn = (a) => typeof a === 'function';
 
-module.exports = before;
+export default before;
 
 function before(options, fn = options) {
     if (isFn(options))
@@ -25,7 +21,7 @@ function before(options, fn = options) {
 
     app.use(gritty());
 
-    const socket = io(server);
+    const socket = new Server(server);
 
     gritty.listen(socket, options);
 
@@ -35,7 +31,7 @@ function before(options, fn = options) {
     });
 }
 
-module.exports.connect = promisify((options, fn = options) => {
+export const connect = promisify((options, fn = options) => {
     before(options, (port, done, socket) => {
         fn(null, {
             port,