ep_disable_reset_authorship_colours 0.0.55 → 0.0.57

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

@@ -26,7 +26,11 @@ jobs:
         with:
           repository: ether/etherpad-lite
           path: etherpad-lite
-      - uses: pnpm/action-setup@v3
+      - uses: actions/setup-node@v4
+        name: Install Node.js
+        with:
+          node-version: 22
+      - uses: pnpm/action-setup@v6
         name: Install pnpm
         with:
           version: 10

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

@@ -15,7 +15,12 @@ jobs:
         uses: actions/checkout@v6
         with:
           repository: ether/etherpad-lite
-      - uses: pnpm/action-setup@v3
+          path: etherpad-lite
+      - uses: actions/setup-node@v4
+        name: Install Node.js
+        with:
+          node-version: 22
+      - uses: pnpm/action-setup@v6
         name: Install pnpm
         with:
           version: 10
@@ -32,63 +37,43 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pnpm-store-
       -
-        name: Check out the plugin
+        name: Checkout plugin repository
         uses: actions/checkout@v6
         with:
-          path: ./node_modules/__tmp
-      -
-        name: export GIT_HASH to env
-        id: environment
-        run: |
-          cd ./node_modules/__tmp
-          echo "::set-output name=sha_short::$(git rev-parse --short ${{ github.sha }})"
-      -
-        name: Determine plugin name
-        id: plugin_name
-        run: |
-          cd ./node_modules/__tmp
-          npx -c 'printf %s\\n "::set-output name=plugin_name::${npm_package_name}"'
-      -
-        name: Rename plugin directory
-        env:
-          PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
-        run: |
-          mv ./node_modules/__tmp ./node_modules/"${PLUGIN_NAME}"
-      -
-        name: Install plugin dependencies
-        env:
-          PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
-        run: |
-          cd ./node_modules/"${PLUGIN_NAME}"
-          pnpm i
-      # Etherpad core dependencies must be installed after installing the
-      # plugin's dependencies, otherwise npm will try to hoist common
-      # dependencies by removing them from src/node_modules and installing them
-      # in the top-level node_modules. As of v6.14.10, npm's hoist logic appears
-      # to be buggy, because it sometimes removes dependencies from
-      # src/node_modules but fails to add them to the top-level node_modules.
-      # Even if npm correctly hoists the dependencies, the hoisting seems to
-      # confuse tools such as `npm outdated`, `npm update`, and some ESLint
-      # rules.
+          path: plugin
       -
         name: Install Etherpad core dependencies
+        working-directory: ./etherpad-lite
         run: bin/installDeps.sh
+      - name: Install plugin
+        working-directory: ./etherpad-lite
+        run: |
+          pnpm run plugins i --path ../../plugin
       - name: Create settings.json
+        working-directory: ./etherpad-lite
         run: cp ./src/tests/settings.json settings.json
       - name: Run the frontend tests
+        working-directory: ./etherpad-lite
         shell: bash
         run: |
           pnpm run dev &
           connected=false
           can_connect() {
-          curl -sSfo /dev/null http://localhost:9001/ || return 1
-          connected=true
+            curl -sSfo /dev/null http://localhost:9001/ || return 1
+            connected=true
           }
           now() { date +%s; }
           start=$(now)
-          while [ $(($(now) - $start)) -le 15 ] && ! can_connect; do
-          sleep 1
+          while [ $(($(now) - $start)) -le 30 ] && ! can_connect; do
+            sleep 1
           done
           cd src
-          pnpm exec playwright install chromium  --with-deps
-          pnpm run test-ui --project=chromium
+          pnpm exec playwright install chromium --with-deps
+          # Use the declared-disables helper instead of plain test-ui:
+          # ep.json declares `disables: ["@feature:clear-authorship"]`,
+          # so the helper runs two passes — regression (everything not
+          # tagged @feature:clear-authorship must pass) + honesty (every
+          # test tagged @feature:clear-authorship must FAIL because the
+          # plugin disables the clear-authorship-colours button).
+          # See doc/PLUGIN_FEATURE_DISABLES.md.
+          ../bin/run-frontend-tests-with-disables.sh -- --project=chromium

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

@@ -1,8 +1,11 @@
 {
+  "disables": ["@feature:clear-authorship"],
   "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.57",
   "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}));
+  });
+});

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

@@ -0,0 +1,13 @@
+import {expect, test} from '@playwright/test';
+import {getPadBody, goToNewPad} from 'ep_etherpad-lite/tests/frontend-new/helper/padHelper';
+
+test.beforeEach(async ({page}) => {
+  await goToNewPad(page);
+});
+
+test.describe('ep_disable_reset_authorship_colours', () => {
+  test('pad loads with plugin installed', async ({page}) => {
+    const padBody = await getPadBody(page);
+    await expect(padBody).toBeVisible();
+  });
+});