Merge pull request #669 from marp-team/upgrade-jest

Upgrade Jest to v30

Author: yhatt

.circleci/config.yml

@@ -30,9 +30,14 @@ commands:
             sudo apt-get update
             sudo apt-get install -y libreoffice-common libreoffice-java-common libreoffice-impress default-jre
 
+      - run:
+          name: Hash patches
+          command: md5sum patches/* > ~/.patches.hash
+
       - restore_cache:
           keys:
-            - v3-dependencies-{{ .Environment.CIRCLE_JOB }}-{{ checksum "package-lock.json" }}-{{ .Branch }}
+            - v3-dependencies-{{ .Environment.CIRCLE_JOB }}-{{ checksum "package-lock.json" }}-{{ checksum "~/.patches.hash" }}-{{ .Branch }}
+            - v3-dependencies-{{ .Environment.CIRCLE_JOB }}-{{ checksum "package-lock.json" }}-{{ checksum "~/.patches.hash" }}-
             - v3-dependencies-{{ .Environment.CIRCLE_JOB }}-{{ checksum "package-lock.json" }}-
             - v3-dependencies-{{ .Environment.CIRCLE_JOB }}-
 
@@ -43,7 +48,7 @@ commands:
       - steps: << parameters.postinstall >>
 
       - save_cache:
-          key: v3-dependencies-{{ .Environment.CIRCLE_JOB }}-{{ checksum "package-lock.json" }}-{{ .Branch }}
+          key: v3-dependencies-{{ .Environment.CIRCLE_JOB }}-{{ checksum "package-lock.json" }}-{{ checksum "~/.patches.hash" }}-{{ .Branch }}
           paths:
             - ~/.npm
 

.github/CONTRIBUTING.md

@@ -8,12 +8,31 @@ We are following [**the contributing guideline of Marp team projects**][team-con
 
 ## Table of contents
 
-- [Marp team contributing guideline][team-contributing-guideline]
+- [Marp team contributing guideline ↗️][team-contributing-guideline]
 - [Development](#development)
+  - [Installation](#installation)
+  - [Build and watch](#build-and-watch)
+  - [Use built version](#use-built-version)
+  - [Testing](#testing)
 - [Debug](#debug)
 
 ## Development
 
+### Installation
+
+```bash
+npm install
+npx patch-package
+```
+
+Running [`npx patch-package`](https://github.com/ds300/patch-package) after `npm install` is required to apply patches for development dependencies. See also [the documentation of patches](../patches/README.md) for details.
+
+> [!NOTE]
+>
+> `patch-package` recommends to [add `postinstall` script to `package.json` to run it automatically after `npm install`](https://github.com/ds300/patch-package?tab=readme-ov-file#set-up). However, Marp CLI does not use it because it will run also when installing CLI by users.
+
+### Build and watch
+
 ```bash
 # Build (Bundle and minify)
 npm run build
@@ -30,7 +49,7 @@ Use `./marp-cli.js` instead of `marp` command.
 ./marp-cli.js --help
 ```
 
-### Standalone binary
+#### Standalone binary
 
 Standalone binaries created by [pkg](https://github.com/zeit/pkg) will output to `./bin` directory.
 
@@ -43,6 +62,21 @@ npm run build:standalone
 ./bin/marp-cli-linux --help
 ```
 
+### Testing
+
+```bash
+# Run all tests
+npm run test
+
+# Run tests with code coverage
+npm run test:coverage
+
+# Run test for specific file(s)
+npm run test -- ./test/marp-cli.ts
+```
+
+You need to install [Google Chrome](https://www.google.com/chrome/), [Mozilla Firefox](https://www.mozilla.org/firefox/), and [LibreOffice](https://www.libreoffice.org/download/download-libreoffice/) for running all tests.
+
 ## Debug
 
 If you have any trouble with Marp CLI, `--debug` (`-d`) option will help you to find the cause of the problem.

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Changed
 
 - Server mode: Connect to proxied watch notifier WebSocket server instead of `localhost` ([#513](https://github.com/marp-team/marp-cli/issues/513), [#664](https://github.com/marp-team/marp-cli/pull/664))
+- Upgrade Jest to v30 ([#669](https://github.com/marp-team/marp-cli/pull/669))
 
 ### Fixed