feature: dword: migrate to ESM

Author: coderaiser

.eslintrc.json

@@ -8,16 +8,16 @@ jobs:
     strategy:
       matrix:
         node-version:
-          - 18.x
-          - 20.x
-          - 21.x
+          - 22.x
+          - 24.x
+          - 25.x
     steps:
-      - uses: actions/checkout@v4
-      - uses: oven-sh/setup-bun@v1
+      - uses: actions/checkout@v5
+      - uses: oven-sh/setup-bun@v2
         with:
           bun-version: latest
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
           node-version: ${{ matrix.node-version }}
       - name: Install Redrun

.github/workflows/nodejs.yml

@@ -15,3 +15,4 @@ modules/jshint
 !modules/jshint/README.md
 
 coverage
+*.config.*

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

@@ -1,15 +1,12 @@
 {
     "match": {
+        "client": {
+            "nodejs/declare": "off"
+        },
         "client/dword.js": {
             "remove-console": "off"
-        },
-        "*.md": {
-            "remove-unused-variables": "off"
         }
     },
-    "rules": {
-        "nodejs/declare": "off"
-    },
     "ignore": [
         "modules",
         "codemirror"

.npmignore

@@ -60,8 +60,9 @@ For this purpuse API could be used.
 Middleware of `dword`. Options could be omitted.
 
 ```js
-const dword = require('dword');
-const express = require('express');
+import {dword} from 'dword';
+import express from 'express';
+
 const app = express();
 
 app.use(dword({
@@ -81,8 +82,8 @@ app.listen(31_337);
 Could be used with [socket.io](http://socket.io "Socket.io") to handle editor events with.
 
 ```js
-const io = require('socket.io');
-const socket = io.listen(server);
+import {Server} from 'socket.io';
+const socket = new Server(server);
 
 dword.listen(socket, {
     // optional

.putout.json

@@ -1,8 +1,19 @@
 #!/usr/bin/env node
 
-'use strict';
+import fs from 'node:fs';
+import {fileURLToPath} from 'node:url';
+import {dirname} from 'node:path';
+import process from 'node:process';
+import http from 'node:http';
+import express from 'express';
+import {Server} from 'socket.io';
+import info from '../package.json' with {
+    type: 'json',
+};
+import {dword} from '../server/index.js';
 
-const fs = require('fs');
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
 const [arg] = process.argv.slice(2);
 
 if (!arg)
@@ -20,7 +31,7 @@ else
     });
 
 function getPath(name) {
-    const reg = /^(~|\/)/;
+    const reg = /^[~/]/;
 
     if (!reg.test(name))
         name = process.cwd() + '/' + name;
@@ -31,31 +42,26 @@ function getPath(name) {
 function main(name) {
     const filename = getPath(name);
     const DIR = `${__dirname}/../assets/`;
-    const dword = require('..');
-    const http = require('http');
-    const express = require('express');
-    const io = require('socket.io');
 
     const app = express();
     const server = http.createServer(app);
 
     const {env} = process;
 
-    const port = env.PORT /* c9           */ || env.VCAP_APP_PORT /* cloudfoundry */ || 1337;
-    
-    const ip = env.IP /* c9           */ || '0.0.0.0';
+    const port = env.PORT || 1337;
+    const ip = env.IP || '0.0.0.0';
 
     app
         .use(express.static(DIR))
         .use(dword({
-            online: false,
-            diff: true,
-            zip: true,
-        }));
+        online: false,
+        diff: true,
+        zip: true,
+    }));
 
     server.listen(port, ip);
 
-    const socket = io(server);
+    const socket = new Server(server);
     const edSocket = dword.listen(socket);
 
     edSocket.on('connection', () => {
@@ -84,19 +90,15 @@ function checkFile(name, callback) {
 }
 
 function version() {
-    console.log(`v${info().version}`);
-}
-
-function info() {
-    return require('../package');
+    console.log(`v${info.version}`);
 }
 
 function usage() {
-    console.log(`Usage: ${info().name} [filename]`);
+    console.log(`Usage: ${info.name} [filename]`);
 }
 
-function help() {
-    const bin = require('../json/bin');
+async function help() {
+    const bin = await import('../json/bin');
 
     usage();
     console.log('Options:');

.travis.yml

@@ -1,20 +1,20 @@
-'use strict';
-
-const clipboard = require('@cloudcmd/clipboard');
-const createElement = require('@cloudcmd/create-element');
-const once = require('once');
+import clipboard from '@cloudcmd/clipboard';
+import createElement from '@cloudcmd/create-element';
+import once from 'once';
+import _showMessageOnce from './show-message.js';
 
 const resolve = Promise.resolve.bind(Promise);
 const reject = Promise.reject.bind(Promise);
+const showMessageOnce = once(_showMessageOnce);
 
-const showMessageOnce = once(require('./show-message'));
-
-module.exports = (cmd) => {
+export default (cmd) => {
     const NAME = 'editor-clipboard';
     const {_Ace, _story} = this;
 
     const value = _Ace.getSelection('\n');
-    const insert = (a) => _Ace.getDoc().replaceSelection(a);
+    const insert = (a) => _Ace
+        .getDoc()
+        .replaceSelection(a);
 
     if (cmd === 'copy') {
         _story.setData(NAME, value);
@@ -23,7 +23,7 @@ module.exports = (cmd) => {
 
     if (cmd === 'cut') {
         _story.setData(NAME, value);
-        return cut(_story, value) ? resolve() : reject();
+        return cut(value) ? resolve() : reject();
     }
 
     return clipboard
@@ -38,7 +38,7 @@ module.exports = (cmd) => {
         });
 };
 
-function cut(story, value) {
+function cut(value) {
     const textarea = createElement('textarea', {
         value,
     });

README.md

@@ -1,16 +1,14 @@
-'use strict';
-
 /* global io */
-const {applyPatch} = require('daffy');
-const {alert} = require('smalltalk');
+import {applyPatch} from 'daffy';
+import {alert} from 'smalltalk';
 
 const getHost = () => {
     const l = location;
 
     return l.origin || l.protocol + '//' + l.host;
 };
 
-module.exports = function() {
+export default function() {
     const dword = this;
     const href = getHost();
     const FIVE_SECONDS = 5000;
@@ -70,10 +68,10 @@ module.exports = function() {
     });
 
     socket.on('disconnect', () => {
-        dword.save.patch = self._patchHttp;
+        dword.save.patch = globalThis._patchHttp;
     });
 
     socket.on('err', (error) => {
         alert(this._TITLE, error);
     });
-};
+}