qword 1.0.2 → 1.1.0

package/package.json

@@ -1,9 +1,23 @@
 {
   "name": "qword",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Web editor based on CodeMirror 6",
   "main": "./server/index.js",
-  "exports": "./server/index.js",
+  "exports": {
+    ".": "./server/index.js",
+    "./client": "./client/index.js",
+    "./client/editor": "./client/editor.js",
+    "./client/create": "./client/create.js",
+    "./client/content": "./client/content.js",
+    "./client/position": "./client/position.js",
+    "./client/decorations": "./client/decorations.js",
+    "./client/events": "./client/events.js",
+    "./client/scroll": "./client/scroll.js",
+    "./client/dom": "./client/dom.js",
+    "./client/options": "./client/options.js",
+    "./client/history": "./client/history.js",
+    "./client/highlight": "./client/highlight.js"
+  },
   "type": "module",
   "bin": {
     "qword": "bin/qword.js"
@@ -16,6 +30,7 @@
     "start:dev": "madrun start:dev",
     "lint": "madrun lint",
     "test": "madrun test",
+    "test:dts": "madrun test:dts",
     "coverage": "madrun coverage",
     "fresh:lint": "madrun fresh:lint",
     "lint:fresh": "madrun lint:fresh",
@@ -25,10 +40,6 @@
     "build:client:dev": "madrun build:client:dev",
     "build:start": "madrun build:start",
     "build:start:dev": "madrun build:start:dev",
-    "cp:codemirror:modules": "madrun cp:codemirror:modules",
-    "build-progress:codemirror": "madrun build-progress:codemirror",
-    "build:codemirror:dev": "madrun build:codemirror:dev",
-    "build:codemirror": "madrun build:codemirror",
     "watch:server": "madrun watch:server",
     "watch:client": "madrun watch:client",
     "watch": "madrun watch",
@@ -49,8 +60,6 @@
     "try-to-catch": "^4.0.5"
   },
   "devDependencies": {
-    "@babel/core": "^7.0.0",
-    "@babel/preset-env": "^7.0.0",
     "@cloudcmd/clipboard": "^2.0.0",
     "@cloudcmd/create-element": "^2.0.2",
     "@codemirror/commands": "^6.10.3",
@@ -61,14 +70,20 @@
     "@codemirror/state": "^6.6.0",
     "@codemirror/theme-one-dark": "^6.1.3",
     "@codemirror/view": "^6.42.1",
+    "@lezer/highlight": "^1.2.3",
     "@putout/eslint-flat": "^4.0.0",
+    "@putout/plugin-convert-webpack-to-rspack": "^1.0.1",
     "@replit/codemirror-vim": "^6.3.0",
-    "babel-loader": "^10.0.0",
+    "@rspack/cli": "^2.2.1",
+    "@rspack/core": "^2.2.1",
+    "@supertape/loader-css": "^1.0.0",
+    "@supertape/loader-dom": "^1.0.0",
+    "@testing-library/dom": "^10.4.1",
+    "@uiw/codemirror-theme-nord": "^4.25.11",
     "callbackify": "^1.1.0",
-    "clean-css-loader": "^4.1.1",
-    "codemirror": "^5.0.0",
+    "check-dts": "^1.0.0",
     "css-loader": "^7.1.3",
-    "cssnano": "^7.1.2",
+    "cssnano": "^9.0.2",
     "daffy": "^1.0.3",
     "emitify": "^4.0.1",
     "es6-promisify": "^7.0.0",
@@ -84,10 +99,10 @@
     "rimraf": "^6.1.2",
     "smalltalk": "^5.0.0",
     "style-loader": "^4.0.0",
+    "superc8": "^12.7.0",
+    "supertape": "^13.5.2",
+    "supertest": "^7.2.2",
     "try-catch": "^4.0.9",
-    "url-loader": "^4.0.0",
-    "webpack": "^5.1.3",
-    "webpack-cli": "^7.0.2",
     "wraptile": "^3.0.0",
     "zipio": "^1.0.2"
   },

package/server/edit.js

@@ -7,6 +7,8 @@ import Edit from '../json/edit.json' with {
 
 const HOME = os.homedir();
 
+let configPath = `${HOME}/.qword.json`;
+
 export default async (req, res, next) => {
     if (req.url !== '/edit.json')
         return next();
@@ -21,6 +23,10 @@ export default async (req, res, next) => {
     res.json(data);
 };
 
+export const setConfigPath = (path) => {
+    configPath = path;
+};
+
 function replace(from, to) {
     for (const name of Object.keys(from)) {
         to[name] = from[name];
@@ -37,13 +43,12 @@ function copy(from) {
 }
 
 async function readEdit() {
-    const homePath = `${HOME}/.qword.json`;
     const data = copy(Edit);
     
-    const [error, edit] = await tryToCatch(readjson, homePath);
+    const [error, edit] = await tryToCatch(readjson, configPath);
     
     if (error && error.code !== 'ENOENT')
-        throw Error(`qword --config ${homePath}: ${error.message}`);
+        throw Error(`qword --config ${configPath}: ${error.message}`);
     
     if (!edit)
         return data;

package/server/edit.spec.js

@@ -0,0 +1,101 @@
+import {tmpdir} from 'node:os';
+import {join} from 'node:path';
+import {
+    mkdtempSync,
+    writeFileSync,
+    rmSync,
+} from 'node:fs';
+import {test} from 'supertape';
+import request from 'supertest';
+import express from 'express';
+import editFn, {setConfigPath} from './edit.js';
+
+const makeApp = () => {
+    const app = express();
+    app.use(editFn);
+    
+    return app;
+};
+
+const makeTempConfig = (content) => {
+    const dir = mkdtempSync(join(tmpdir(), 'qword-'));
+    const file = join(dir, 'config.json');
+    
+    writeFileSync(file, content);
+    
+    return {
+        file,
+        cleanup: () => rmSync(dir, {
+            recursive: true,
+            force: true,
+        }),
+    };
+};
+
+test('edit: returns 200 for /edit.json', async (t) => {
+    setConfigPath(join(mkdtempSync(join(tmpdir(), 'qword-')), 'config.json'));
+    const response = await request(makeApp()).get('/edit.json');
+    
+    t.equal(response.status, 200);
+    t.end();
+});
+
+test('edit: returns json content-type for /edit.json', async (t) => {
+    setConfigPath(join(mkdtempSync(join(tmpdir(), 'qword-')), 'config.json'));
+    
+    const response = await request(makeApp()).get('/edit.json');
+    const result = response.headers['content-type'].includes('json');
+    
+    t.ok(result);
+    t.end();
+});
+
+test('edit: response body has options field', async (t) => {
+    setConfigPath(join(mkdtempSync(join(tmpdir(), 'qword-')), 'config.json'));
+    const response = await request(makeApp()).get('/edit.json');
+    
+    t.ok(response.body.options);
+    t.end();
+});
+
+test('edit: passes through non-edit.json requests', async (t) => {
+    setConfigPath(join(mkdtempSync(join(tmpdir(), 'qword-')), 'config.json'));
+    
+    const app = makeApp();
+    
+    app.get('/other', (_req, res) => res.json({
+        ok: true,
+    }));
+    const response = await request(app).get('/other');
+    
+    t.equal(response.status, 200);
+    t.end();
+});
+
+test('edit: merges options from user config', async (t) => {
+    const {file, cleanup} = makeTempConfig(JSON.stringify({
+        options: {
+            theme: 'dark',
+        },
+    }));
+    setConfigPath(file);
+    const response = await request(makeApp()).get('/edit.json');
+    
+    cleanup();
+    
+    t.equal(response.body.options.theme, 'dark');
+    t.end();
+});
+
+test('edit: returns 404 when config read fails', async (t) => {
+    const {file, cleanup} = makeTempConfig('{}');
+    const dir = join(file, '..');
+    
+    setConfigPath(dir);
+    const response = await request(makeApp()).get('/edit.json');
+    
+    cleanup();
+    
+    t.equal(response.status, 404);
+    t.end();
+});

package/test/errors.ts

@@ -0,0 +1,21 @@
+import {
+    createEditor,
+    setValue,
+    positionToOffset,
+    setOption,
+} from '../client/index.js';
+
+const view = createEditor(document.body);
+
+// THROWS Argument of type 'number' is not assignable to parameter of type 'string'
+setValue(view, 5);
+
+// THROWS Argument of type 'number' is not assignable to parameter of type 'SourcePosition'
+positionToOffset(view.state.doc, 5);
+
+// THROWS Argument of type '"bogus"' is not assignable to parameter of type 'OptionKey'
+setOption(view, 'bogus', 'dark');
+
+// THROWS Argument of type '5' is not assignable to parameter of type 'OptionValue'
+setOption(view, 'theme', 5);
+

package/test/types.ts

@@ -0,0 +1,134 @@
+import Editor from '../client/editor.js';
+import {
+    createEditor,
+    getValue,
+    setValue,
+    offsetToPosition,
+    positionToOffset,
+    posFromIndex,
+    indexFromPos,
+    getCursorIndex,
+    getCursor,
+    markText,
+    addLineClass,
+    removeLineClass,
+    on,
+    off,
+    getScrollInfo,
+    scrollTo,
+    getView,
+    refresh,
+    observeResize,
+    setOption,
+    clearHistory,
+} from '../client/index.js';
+
+const view = createEditor(document.body, {
+    value: 'const a = 3',
+    mode: 'javascript',
+    keyMap: 'default',
+    theme: 'default',
+    lineNumbers: true,
+    readOnly: false,
+    foldGutter: true,
+});
+
+// content
+const value: string = getValue(view);
+setValue(view, 'const b = 4');
+
+// position
+const position = offsetToPosition(view.state.doc, 10);
+const offset: number = positionToOffset(view.state.doc, {
+    line: 0,
+    ch: 0,
+});
+const pos = posFromIndex(view, 0);
+const idx = indexFromPos(view, {
+    line: 0,
+    ch: 0,
+});
+const cursor = getCursorIndex(view);
+const {row, column} = getCursor(view);
+
+// decorations
+const handle = markText(view, {
+    line: 0,
+    ch: 0,
+}, {
+    line: 0,
+    ch: 1,
+}, {
+    className: 'hl-keyword',
+});
+handle.clear();
+addLineClass(view, 0, 'text', 'hl-string');
+removeLineClass(view, 0, 'text', 'hl-string');
+
+// events
+const binding = on(view, 'keydown', () => {});
+off(view, 'keydown', () => {});
+
+// scroll
+const {left, top} = getScrollInfo(view);
+scrollTo(view, left, top);
+
+// dom
+const found = getView(document.body);
+refresh(view);
+const unobserve = observeResize(view, document.body);
+unobserve();
+
+// options
+setOption(view, 'mode', 'javascript');
+setOption(view, 'theme', 'nord');
+setOption(view, 'keyMap', 'vim');
+
+// history
+clearHistory(view, view._historyCompartment, false);
+
+// Editor class
+const editor = new Editor(document.body, {
+    value: 'const a = 3',
+    mode: 'javascript',
+    theme: 'default',
+    keyMap: 'default',
+});
+editor
+    .setValue('const b = 4')
+    .focus()
+    .moveCursorTo(0, 1)
+    .addLineClass(0, 'hl-string')
+    .removeLineClass(0, 'hl-string')
+    .setMode('javascript')
+    .setTheme('nord')
+    .setKeyMap('vim')
+    .setModeForPath('a.js')
+    .clearHistory()
+    .on('change', () => {})
+    .emit('change', {});
+const editorValue: string = editor.getValue();
+const editorCursor = editor.getCursor();
+const editorPos = editor.posFromIndex(0);
+editor.markRange({
+    line: 0,
+    ch: 0,
+}, {
+    line: 0,
+    ch: 1,
+}, 'className').clear();
+
+// types compile
+void value;
+void position;
+void offset;
+void pos;
+void idx;
+void cursor;
+void row;
+void column;
+void binding;
+void found;
+void editorValue;
+void editorCursor;
+void editorPos;

package/client/codemirror/show-trailing.js

@@ -1,54 +0,0 @@
-'use strict';
-
-/* global CodeMirror */
-/* global define */
-
-(function(mod) {
-    const isFn = (a) => typeof a === 'function';
-    
-    if (typeof exports === 'object' && typeof module === 'object') // CommonJS
-        mod(require('../../lib/codemirror'));
-    else if (isFn(define) && define.amd) // AMD
-        define(['../../lib/codemirror'], mod);
-    else // Plain browser env
-        mod(CodeMirror);
-})((CodeMirror) => {
-    add();
-    
-    CodeMirror.defineOption('showTrailing', false, (cm, val, prev) => {
-        if (prev === CodeMirror.Init)
-            prev = false;
-        
-        if (prev && !val)
-            cm.removeOverlay('trailingspace');
-        else if (!prev && val)
-            cm.addOverlay({
-                token(stream) {
-                    let ret = null;
-                    const match = stream.match(/\s+$/);
-                    
-                    if (match && match[0] !== stream.string)
-                        ret = 'trailing-whitespace';
-                    
-                    stream.match(/^\s*\S/);
-                    
-                    return ret;
-                },
-                name: 'trailingspace',
-            });
-    });
-    
-    function add() {
-        const style = document.createElement('style');
-        
-        style.setAttribute('data-name', 'js-showTrailing');
-        
-        style.textContent = [
-            '.cm-trailing-whitespace {',
-            'color: #f80;',
-            'text-decoration: underline;',
-            '}'].join('');
-        
-        document.head.appendChild(style);
-    }
-});

package/client/codemirror/use-soft-tabs.js

@@ -1,38 +0,0 @@
-'use strict';
-
-/* global CodeMirror */
-/* global define */
-
-(function(mod) {
-    if (typeof exports === 'object' && typeof module === 'object') // CommonJS
-        mod(require('../../lib/codemirror'));
-    else if (typeof define === 'function' && define.amd) // AMD
-        define(['../../lib/codemirror'], mod);
-    else // Plain browser env
-        mod(CodeMirror);
-})((CodeMirror) => {
-    CodeMirror.defineOption('useSoftTabs', false, (cm) => {
-        cm.addKeyMap({
-            'Tab'(cm) {
-                let line;
-                const sel = cm.getSelection('\n');
-                const coupleLines = sel.length > 0;
-                const isSelected = cm.somethingSelected();
-                
-                if (isSelected) {
-                    line = cm.getLine(cm.getCursor().line);
-                    // Indent only if there are multiple lines selected, or if the selection spans a full line
-                    
-                    if (coupleLines && (sel.includes('\n') || sel.length === line.length)) {
-                        cm.indentSelection('add');
-                    }
-                } else {
-                    cm.execCommand('insertSoftTab');
-                }
-            },
-            'Shift-Tab'(cm) {
-                cm.indentSelection('subtract');
-            },
-        });
-    });
-});

package/client/set-key-map.js

@@ -1,3 +0,0 @@
-export default function(keyMap) {
-    this.setOption('keyMap', keyMap);
-}

package/dist/2b22a33a0a80bb926bbc.png

@@ -1 +0,0 @@
-export default "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAQAAAC1QeVaAAAAUklEQVR4XqXPYQrAIAhAYW/gXd8NJxTopVqsGEhtf+L9/ERU2k/HSMFQpKcYJeNFI9Be0LCMij8cYyjj5EHIivGBkwLfrbX3IF8PqumVmnDpEG+eDsKibPG2JwAAAABJRU5ErkJggg=="

package/dist/8e9019bd86255ac9a618.png

@@ -1 +0,0 @@
-export default "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAQAAAC1QeVaAAAAnUlEQVR4XoWQQQ6CQAxFewjkJkMCyXgJPMk7AiYczyBeZEAX6AKctGIaN+bt+trk9wtGQc/IkhnoKGxqqiWxOSZalapWFZ6VrIUDExsN0a5JRBq9LoVOR0eEQMoEhKizXhhsn0p1sCWVo7CwOf1RytPL8CPvwuBUoHL6ugeK30CVD1TqK7V/hdpe+VNChhOzV8xWny/+xosHF8578W/Hmc1OOC3wmwAAAABJRU5ErkJggg=="