ep_spellcheck 0.0.89 → 0.0.91

package/.github/workflows/backend-tests.yml

@@ -22,11 +22,11 @@ jobs:
           version: 1.0
       -
         name: Install etherpad core
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
         with:
           repository: ether/etherpad-lite
           path: etherpad-lite
-      - uses: pnpm/action-setup@v3
+      - uses: pnpm/action-setup@v6
         name: Install pnpm
         with:
           version: 10
@@ -35,7 +35,7 @@ jobs:
         shell: bash
         run: |
           echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
-      - uses: actions/cache@v4
+      - uses: actions/cache@v5
         name: Setup pnpm cache
         with:
           path: ${{ env.STORE_PATH }}
@@ -44,7 +44,7 @@ jobs:
             ${{ runner.os }}-pnpm-store-
       -
         name: Checkout plugin repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
         with:
           path: plugin
       - name: Remove tests

package/.github/workflows/frontend-tests.yml

@@ -12,10 +12,10 @@ jobs:
     steps:
       -
         name: Check out Etherpad core
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
         with:
           repository: ether/etherpad-lite
-      - uses: pnpm/action-setup@v3
+      - uses: pnpm/action-setup@v6
         name: Install pnpm
         with:
           version: 10
@@ -24,7 +24,7 @@ jobs:
         shell: bash
         run: |
           echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
-      - uses: actions/cache@v4
+      - uses: actions/cache@v5
         name: Setup pnpm cache
         with:
           path: ${{ env.STORE_PATH }}
@@ -33,7 +33,7 @@ jobs:
             ${{ runner.os }}-pnpm-store-
       -
         name: Check out the plugin
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
         with:
           path: ./node_modules/__tmp
       -

package/.github/workflows/npmpublish.yml

@@ -31,7 +31,7 @@ jobs:
         uses: actions/checkout@v6
         with:
           repository: ether/etherpad-lite
-      - uses: pnpm/action-setup@v5
+      - uses: pnpm/action-setup@v6
         name: Install pnpm
         with:
           version: 10
@@ -59,12 +59,20 @@ jobs:
           [ "${NEW_COMMITS}" -gt 0 ] || exit 0
           git config user.name 'github-actions[bot]'
           git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
-          pnpm i
+          pnpm i --frozen-lockfile
           # `pnpm version patch` bumps package.json, makes a commit, and creates
           # a `v<new-version>` tag. Capture the new tag name from package.json
           # rather than parsing pnpm's output, which has historically varied.
-          pnpm version patch
-          NEW_TAG="v$(node -p "require('./package.json').version")"
+          # Bump the patch component directly with Node. pnpm/action-setup@v6
+          # sometimes installs pnpm 11 pre-releases even when version: 10.x is
+          # requested (pnpm/action-setup#225); those pre-releases either skip
+          # the git commit/tag or reject --no-git-tag-version as unknown.
+          # Doing the bump in Node sidesteps both failure modes.
+          NEW_VERSION=$(node -e "const fs=require('fs');const p=require('./package.json');const v=p.version.split('.');v[2]=String(Number(v[2])+1);p.version=v.join('.');fs.writeFileSync('./package.json',JSON.stringify(p,null,2)+'\n');console.log(p.version);")
+          NEW_TAG="v${NEW_VERSION}"
+          git add package.json
+          git commit -m "${NEW_TAG}"
+          git tag -a "${NEW_TAG}" -m "${NEW_TAG}"
           # CRITICAL: use --atomic so the branch update and the tag update
           # succeed (or fail) as a single transaction on the server. The old
           # `git push --follow-tags` was non-atomic per ref: if a concurrent

package/README.md

@@ -13,3 +13,20 @@ Toggle on/off 'SpellCheck' option in Settings.  Uses your native browser spellch
 ## TODO
 
 * Remember user settings as cookies
+
+## Installation
+
+Install from the Etherpad admin UI (**Admin → Manage Plugins**,
+search for `ep_spellcheck` and click *Install*), or from the Etherpad
+root directory:
+
+```sh
+pnpm run plugins install ep_spellcheck
+```
+
+> ⚠️ Don't run `npm i` / `npm install` yourself from the Etherpad
+> source tree — Etherpad tracks installed plugins through its own
+> plugin-manager, and hand-editing `package.json` can leave the
+> server unable to start.
+
+After installing, restart Etherpad.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ep_spellcheck",
-  "version": "0.0.89",
+  "version": "0.0.91",
   "keywords": [
     "spell",
     "check",
@@ -23,8 +23,8 @@
   },
   "devDependencies": {
     "eslint": "^8.57.1",
-    "eslint-config-etherpad": "^4.0.4",
-    "typescript": "^6.0.2"
+    "eslint-config-etherpad": "^4.0.5",
+    "typescript": "^6.0.3"
   },
   "scripts": {
     "lint": "eslint .",

package/static/js/spellcheck.js

@@ -5,25 +5,16 @@ const padcookie = require('ep_etherpad-lite/static/js/pad_cookie').padcookie;
 const postAceInit = (hook, context) => {
   const $outer = $('iframe[name="ace_outer"]').contents().find('iframe');
   const $inner = $outer.contents().find('#innerdocbody');
+  // The `spellcheck` attribute is inherited from the nearest ancestor that
+  // sets it, so we only need to toggle it on #innerdocbody. The previous
+  // implementation walked every <div>/<span> descendant on every toggle,
+  // which is O(n) in line count and multiplied the browser's already-slow
+  // per-keystroke spellchecking work — observable as typing lag on pads
+  // with more than a few hundred lines (#26). Setting the attribute once
+  // on the contenteditable root is equivalent for the browser's checker.
   const spellcheck = {
-    enable: () => {
-      $inner.attr('spellcheck', 'true');
-      $inner.find('div').each(function () {
-        $(this).attr('spellcheck', 'true');
-        $(this).find('div').each(function () {
-          $(this).attr('spellcheck', 'true');
-        });
-      });
-    },
-    disable: () => {
-      $inner.attr('spellcheck', 'false');
-      $inner.find('div').each(function () {
-        $(this).attr('spellcheck', 'false');
-        $(this).find('span').each(function () {
-          $(this).attr('spellcheck', 'false');
-        });
-      });
-    },
+    enable: () => { $inner.attr('spellcheck', 'true'); },
+    disable: () => { $inner.attr('spellcheck', 'false'); },
   };
   /* init */
   if (padcookie.getPref('spellcheck') === false) {
@@ -49,7 +40,12 @@ const postAceInit = (hook, context) => {
       padcookie.setPref('spellcheck', false);
       spellcheck.disable();
     }
-    if (window.browser.chrome) window.location.reload();
+    // The previous code force-reloaded the page on Chrome via
+    // `window.browser.chrome`. That check was always a no-op on Chrome
+    // (Chrome has no `window.browser` object — it's the Firefox
+    // WebExtension API) and would have thrown a TypeError on Firefox.
+    // Toggling the spellcheck attribute takes effect in every current
+    // browser without a reload, so just drop the reload.
   });
 };
 exports.postAceInit = postAceInit;

package/static/tests/frontend-new/specs/spellcheck.spec.ts

@@ -0,0 +1,18 @@
+import {expect, test} from '@playwright/test';
+import {goToNewPad} from 'ep_etherpad-lite/tests/frontend-new/helper/padHelper';
+
+test.beforeEach(async ({page}) => {
+  await goToNewPad(page);
+});
+
+test.describe('ep_spellcheck', () => {
+  test('Spellcheck is on by default when not disabled', async ({page}) => {
+    // ep_spellcheck flips the spellcheck attribute on the inner editor
+    // body. Wait up to 5s in case it's set asynchronously after pad init.
+    const innerFrame = page.frame('ace_inner')!;
+    await expect.poll(
+        async () => innerFrame.locator('body').getAttribute('spellcheck'),
+        {timeout: 5_000})
+        .toBe('true');
+  });
+});

package/static/tests/frontend/spellcheck.js

@@ -1,20 +0,0 @@
-'use strict';
-
-describe('Spellcheck', function () {
-  // create a new pad before each test run
-  beforeEach(function (cb) {
-    helper.newPad(cb);
-    this.timeout(60000);
-  });
-
-  it("Checks Spellcheck is on by default if it isn't disabled", function (done) {
-    this.timeout(60000);
-    const $inner = helper.padInner$;
-    const shouldBeOn = true;
-
-    helper.waitFor(() => ($inner.attr('spellcheck') === shouldBeOn)).done(() => {
-      expect($inner.attr('spellcheck') === shouldBeOn);
-      done();
-    });
-  });
-});