ep_disable_reset_authorship_colours 0.0.55 → 0.0.56

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

@@ -26,7 +26,7 @@ jobs:
         with:
           repository: ether/etherpad-lite
           path: etherpad-lite
-      - uses: pnpm/action-setup@v3
+      - uses: pnpm/action-setup@v6
         name: Install pnpm
         with:
           version: 10

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

@@ -15,7 +15,7 @@ jobs:
         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

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

@@ -1,3 +1,20 @@
 ![Publish Status](https://github.com/ether/ep_disable_reset_authorship_colours/workflows/Node.js%20Package/badge.svg) [![Backend Tests Status](https://github.com/ether/ep_disable_reset_authorship_colours/actions/workflows/test-and-release.yml/badge.svg)](https://github.com/ether/ep_disable_reset_authorship_colours/actions/workflows/test-and-release.yml)
 
 Disables the ability to reset authorship colors in Etherpad
+
+## Installation
+
+Install from the Etherpad admin UI (**Admin → Manage Plugins**,
+search for `ep_disable_reset_authorship_colours` and click *Install*), or from the Etherpad
+root directory:
+
+```sh
+pnpm run plugins install ep_disable_reset_authorship_colours
+```
+
+> ⚠️ 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/ep.json

@@ -2,7 +2,9 @@
   "parts":[
     {
       "name": "disable_reset_authorship_colours",
-      "hooks": {},
+      "hooks": {
+        "clientVars": "ep_disable_reset_authorship_colours/index:clientVars"
+      },
       "client_hooks": {
         "postAceInit": "ep_disable_reset_authorship_colours/static/js/disable_reset_authorship_colours:postAceInit"
       }

package/index.js

@@ -0,0 +1,13 @@
+'use strict';
+
+// Disable the Ctrl+Shift+C keyboard shortcut that triggers clearauthorship.
+// Hiding the toolbar button (done client-side in postAceInit) is not enough:
+// Etherpad's ace2_inner.ts binds Ctrl+Shift+C to CMDS.clearauthorship when
+// `clientVars.padShortcutEnabled.cmdShiftC` is truthy. Forcing that flag to
+// false here stops the shortcut from reaching the clearauthorship command.
+exports.clientVars = (hookName, {clientVars}) => {
+  if (clientVars && clientVars.padShortcutEnabled) {
+    clientVars.padShortcutEnabled.cmdShiftC = false;
+  }
+  return {};
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ep_disable_reset_authorship_colours",
   "description": "Disable The reset authorship colours button",
-  "version": "0.0.55",
+  "version": "0.0.56",
   "repository": {
     "type": "git",
     "url": "https://github.com/ether/ep_disable_reset_authorship_colours.git"
@@ -18,8 +18,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/tests/backend/specs/clientVars.js

@@ -0,0 +1,19 @@
+'use strict';
+
+const assert = require('assert').strict;
+const plugin = require('../../../..');
+
+describe(__filename, function () {
+  it('disables cmdShiftC in clientVars (regression for #4)', function () {
+    const clientVars = {padShortcutEnabled: {cmdShiftC: true, cmdShiftB: true}};
+    plugin.clientVars('clientVars', {clientVars});
+    assert.equal(clientVars.padShortcutEnabled.cmdShiftC, false);
+    // Other shortcuts must be untouched.
+    assert.equal(clientVars.padShortcutEnabled.cmdShiftB, true);
+  });
+
+  it('tolerates clientVars without padShortcutEnabled', function () {
+    const clientVars = {};
+    assert.doesNotThrow(() => plugin.clientVars('clientVars', {clientVars}));
+  });
+});