.github/ISSUE_TEMPLATE/bug_report.md

@@ -12,10 +12,15 @@ A clear and concise description of what the bug is.
 
 Before filing a bug, please confirm that you have:
 
-1. Installed the necessary Tiptap extensions for whatever functionality you are trying to use (e.g. `Color` extension for using the `MenuButtonTextColor`).
-2. Passed the extensions you need to the `extensions` field of `RichTextEditor`/`useEditor`
+1. Set up your extensions correctly.
 
-See [README info here](https://github.com/sjdemartini/mui-tiptap#choosing-your-editor-extensions) for more details.
+   a. Installed the necessary Tiptap extensions for whatever functionality you are trying to use (e.g. `Color` extension for using the `MenuButtonTextColor`).
+
+   b. Passed the extensions you need to the `extensions` field of `RichTextEditor`/`useEditor`
+
+   See [README info here](https://github.com/sjdemartini/mui-tiptap#choosing-your-editor-extensions) for more details.
+
+2. Confirmed there isn't CSS external to mui-tiptap that is causing a problem with appearance/layout.
 
 ### To Reproduce
 
@@ -37,8 +42,10 @@ If applicable, add screenshots to help explain your problem.
 
 ### System (please complete the following information)
 
-- mui-tiptap version: [e.g. 1.1.0]
-- tiptap version: [e.g. 2.0.0]
+- `mui-tiptap` version: [e.g. 1.1.0]
+- `tiptap` version: [e.g. 2.0.0]
+- `@mui/material`: [e.g. 6.0.0]
+- `@mui/icons-material` version: [e.g. 6.0.0]
 - Browser: [e.g. Chrome, Firefox]
 - Node version: [e.g 16.4.2]
 - OS: [e.g. Ubuntu 22.04, macOS 11.4]

.github/workflows/build-test.yml

@@ -13,28 +13,85 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [18]
+        node-version: [20]
+        # Test across different versions of Tiptap to ensure compatibility: the
+        # version used in our lockfile, an older version we support, and the
+        # latest v2 version.
+        tiptap-version: [null, 2.0.4, "^2.10.0"]
+        include:
+          - tiptap-version: 2.0.4
+            # Specify the version of y-prosemirror to use to ensure proper peer
+            # dependency compatibility and resolution.
+            y-prosemirror-version: 1.0.20
 
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Setup pnpm
-        uses: pnpm/action-setup@v2
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+
+      - name: Install Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
         with:
-          version: 8
+          node-version: ${{ matrix.node-version }}
+          cache: "pnpm"
 
       - run: pnpm install
 
       - name: Dependencies audit
         run: pnpm audit --audit-level=high
 
+      - if: ${{ matrix.tiptap-version != null }}
+        name: Override tiptap version to ${{ matrix.tiptap-version }}
+        # So that we can update all tiptap packages at once, we use
+        # `pnpm update`, which allows wildcard syntax and version specifier
+        # (unlike `pnpm install`). We have to separately install the indirect
+        # dependencies of @tiptap/react with the desired version (the floating
+        # and bubble menu packages), since `update` doesn't apply to them.
+        run: |
+          pnpm update -D "@tiptap/*@${{ matrix.tiptap-version }}"
+          pnpm add -D "@tiptap/extension-floating-menu@${{ matrix.tiptap-version }}" "@tiptap/extension-bubble-menu@${{ matrix.tiptap-version }}"
+          pnpm dedupe
+
+      - if: ${{ matrix.y-prosemirror-version }}
+        name: Override y-prosemirror version to ${{ matrix.y-prosemirror-version }}
+        run: pnpm add -D "y-prosemirror@${{ matrix.y-prosemirror-version }}"
+
       - name: Check for duplicate dependencies
         run: pnpm dedupe --check
 
+      - if: ${{ matrix.tiptap-version == '2.0.4' }}
+        name: Resolve known inconsequential TS differences in Tiptap 2.0.4
+        # 1) Delete the `@ts-expect-error` comments where needed, as older
+        # versions of Tiptap didn't have the same types that required this
+        # override.
+        # 2) Add `@ts-expect-error` to TableImproved.ts where the typing in
+        # older versions was incorrect (as Tiptap itself did here
+        # https://github.com/ueberdosis/tiptap/blob/b0198eb14b98db5ca691bd9bfe698ffaddbc4ded/packages/extension-table/src/table.ts#L253,
+        # and we did prior to updating to newer Tiptap).
+        # 3) Restore an older version of the demo SuggestionList, since it
+        # relied on local typing overrides awaiting fixes published in Tiptap
+        # 2.5.0. This ensures `type:check` passes, though isn't part of the
+        # build anyway.
+        run: |
+          sed -i '/@ts-expect-error/d' src/extensions/HeadingWithAnchor.ts src/extensions/ResizableImage.ts
+
+          sed -i '/View: this.options.View/i\
+                        // @ts-expect-error incorrect type\
+          ' src/extensions/TableImproved.ts
+
+          git fetch origin tag v1.16.0 --no-tags
+          git restore --source v1.16.0 src/demo/SuggestionList.tsx
+
       - name: Build
         run: pnpm run build
 
+      - name: Install dependencies in example project
+        # In order to lint both our main project and the example sub-project, we
+        # need to install the dependencies for the example project too.
+        run: pnpm run example:install
+
       - name: Type check
         # Though this largely happens as part of `pnpm run build`, there are
         # some files that are not part of the publishable build but which we'd
@@ -68,4 +125,11 @@ jobs:
         run: pnpm run test:coverage
 
       - name: Validate the build's packaging CJS and ESM compatibility
-        run: npx @arethetypeswrong/cli@0.15.4 --pack
+        # For now, we ignore the named-exports rule, as this gets triggered for
+        # the `node16 (from ESM)` context, and appears hard to resolve while
+        # still avoiding these issues:
+        # - https://github.com/sjdemartini/mui-tiptap/issues/256
+        # - https://github.com/sjdemartini/mui-tiptap/issues/264
+        # Ideally we can fix this in the future without breaking Node and NextJS
+        # contexts.
+        run: npx @arethetypeswrong/cli@0.16.2 --pack --ignore-rules named-exports

.github/workflows/release.yml

@@ -14,28 +14,23 @@ jobs:
     permissions:
       contents: read
       id-token: write # Needed for https://docs.npmjs.com/generating-provenance-statements
-    strategy:
-      matrix:
-        node-version: [18]
 
     needs: [build-test] # Require standard CI steps to pass before publishing
 
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
 
       # Set up .npmrc file to publish to npm. This also allows NODE_AUTH_TOKEN
       # to work below.
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: "18.x"
+          node-version: "20.x"
           registry-url: "https://registry.npmjs.org"
 
-      - name: Setup pnpm
-        uses: pnpm/action-setup@v2
-        with:
-          version: 8
-
       - run: pnpm install
 
       - run: pnpm run build

.nvmrc

@@ -1 +1 @@
-v18
+v22

CONTRIBUTING.md

@@ -41,6 +41,6 @@ When a new version should be cut since some new changes have landed on the `main
 1. Go to the `main` branch and pull in the latest changes.
 2. Run `npm version <major | minor | patch | premajor | preminor | prepatch | prerelease>`, depending on what's appropriate per semver conventions for the latest changes.
    - This will create a commit that updates the `version` in `package.json`, and add a git tag for that new commit.
-3. Push the commit and tags (ex: `git push origin main` and `git push --tags`)
+3. Push the commit and tag (ex: `git push origin main` and `git push origin refs/tags/v0.0.0`, where `v0.0.0` is the new version number/tag).
 4. The `release.yml` GitHub Actions workflow will run and should publish to npm upon completion.
 5. Once the new version has been successfully published to npm, create a "Release" in GitHub for to the newly pushed tag, per the steps [here](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release), which can auto-generate release notes that can be edited and cleaned up for clarity and succinctness.