build-test.yml

name: build-test

# Run this for pushes to the main branch and for pull requests, and allow this
# to be called from other workflows
on:
  push:
    branches: ["main"]
  pull_request:
  workflow_call:

jobs:
  build_and_test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: [18]

    steps:
      - name: Checkout repo
        uses: actions/checkout@v3

      - name: Setup pnpm
        uses: pnpm/action-setup@v2
        with:
          version: 9

      - run: pnpm install

      - name: Dependencies audit
        run: pnpm audit --audit-level=high

      - name: Check for duplicate dependencies
        run: pnpm dedupe --check

      - 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
        # also like to type-check.
        run: pnpm run type:check

      - name: Format check
        run: pnpm run format:check

      - name: Lint check
        run: pnpm run lint:check

      - name: Spell check
        run: pnpm run spell:check
        # We run the spell check so we can see the output in CI if/when we like,
        # but we won't enforce it, since there are too many technical/product
        # words used that are outside the standard dictionary.
        continue-on-error: true

      - name: Validate markdown links
        # Since most of our documentation is in README.md, notably with lots of
        # internal anchor links, validate that they're formed properly. As the
        # README and documentation is updated, we want to ensure that links
        # remain correct. (This also checks external links, though that's a
        # secondary concern.)
        run: pnpm run md-link:check

      - name: Test
        # Run the tests and print out the coverage information. In the future,
        # we could integrate with Codecov or something.
        run: pnpm run test:coverage

      - name: Validate the build's packaging CJS and ESM compatibility
        # 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