Merge branch 'main' into next

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Install and run `prettier`
+5cfa3fb64a6e9d40ed3b48c18abb3790ec6de2ca

.github/workflows/test.yml

@@ -32,4 +32,5 @@ jobs:
           composer-options: ${{ matrix.php == 8.3 && '--ignore-platform-req=php+' || '' }}
       - run: vendor/bin/phpunit --testdox --colors=always
       - run: npm ci && npm run build
-      - run: npm test
+      - run: npm run test
+      - run: npm run typecheck

.prettierignore

@@ -0,0 +1,6 @@
+.github/
+dist/
+tests/fixtures/
+vendor/
+*.md
+.git-blame-ignore-revs

CHANGELOG.md

@@ -8,6 +8,12 @@ Breaking changes are marked with ⚠️.
 
 ## [Unreleased]
 
+## [v1.8.0] - 2023-10-06
+
+**Added**
+
+- Add type declarations and `ziggy.d.ts` generation by @lmeysel and @bakerkretzmar in https://github.com/tighten/ziggy/pull/664
+
 ## [v1.7.0] - 2023-10-04
 
 **Added**
@@ -299,7 +305,8 @@ Breaking changes are marked with ⚠️.
 
 For previous changes see the [Releases](https://github.com/tighten/ziggy/releases) page.
 
-[Unreleased]: https://github.com/tighten/ziggy/compare/v1.7.0...HEAD
+[Unreleased]: https://github.com/tighten/ziggy/compare/v1.8.0...HEAD
+[v1.8.0]: https://github.com/tighten/ziggy/compare/v1.7.0...v1.8.0
 [v1.7.0]: https://github.com/tighten/ziggy/compare/v1.6.2...v1.7.0
 [v1.6.2]: https://github.com/tighten/ziggy/compare/v1.6.1...v1.6.2
 [v1.6.1]: https://github.com/tighten/ziggy/compare/v1.6.0...v1.6.1

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing
 
-Thanks for your interest in contributing to Ziggy! Contributions are **welcome** and will be fully **credited**.
+Thanks for your interest in contributing to Ziggy! Contributions are welcome and will be credited.
 
 To keep things running smoothly we ask you to follow a few guidelines when contributing. Please read and understand this contribution guide before creating an issue or pull request.
 
@@ -10,31 +10,39 @@ Be kind.
 
 ## Viability
 
-If you have an idea for a feature, we'd prefer you open an issue before going to the trouble of writing code. We welcome your ideas, but we'd like to work with you to come up with solutions that work well for the project as a whole. We're usually pretty responsive, so it shouldn't take us long to figure out whether and how best to implement your idea.
+If you have an idea for a feature, we'd prefer you open a discussion before going to the trouble of writing code. We welcome your ideas, but we'd like to work with you to come up with solutions that work well for the project as a whole. We're usually pretty responsive, so it shouldn't take us long to figure out whether and how best to implement your idea.
 
 ## Procedure
 
 Before filing an issue:
 
-- Attempt to replicate the problem, to ensure that it wasn't a coincidence
-- Check to make sure your feature suggestion isn't already present within the project
-- Check the pull requests tab to ensure that your feature or bugfix isn't already in progress
+- Attempt to replicate the problem, to ensure that it wasn't a coincidence.
+- Check to make sure your feature suggestion isn't already present within the project.
+- Check the pull requests tab to ensure that your feature or bugfix isn't already in progress.
 
 Before submitting a pull request:
 
-- Check the codebase to ensure that your feature doesn't already exist
-- Check the pull requests to ensure that another person hasn't already submitted the feature or fix
+- Check the codebase to ensure that your feature doesn't already exist.
+- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
 
 ## Tests
 
-Please write tests for any fixes or new features you contribute. We use [Orchestra Testbench](http://orchestraplatform.com/docs/latest/components/testbench/) as our base PHPUnit test for PHP and [Jest](https://jestjs.io/) for testing our JavaScript.
+Please write tests for any fixes or new features you contribute. We use [Orchestra Testbench](https://github.com/orchestral/testbench) as our base PHPUnit test for PHP and [Jest](https://jestjs.io/) for testing our JavaScript.
 
-You can run PHP tests with `vendor/bin/phpunit` and JavaScript tests with `npm test`.
+You can run PHP tests with `vendor/bin/phpunit` and JavaScript tests with `npm run test`.
 
 If you need any help with this please don't hesitate to ask.
 
 > If your filesystem uses `CRLF` instead of `LF` line endings (e.g. Windows) you may see errors related to that when running tests. To fix this you can run `git config --global core.autocrlf input` to configure Git to preserve the line endings from the repository when cloning. You may have to clone this repository again.
 
+## Types
+
+TypeScript types are included with Ziggy and maintained manually.
+
+To test the type definitions, open `tests/js/types.ts` in an editor or IDE with TypeScript support. This file contains sample code using Ziggy's `route()` function, and can be used to ensure that specific examples do or don't type-check as expected. To add a test for code that should work, add the code (with a comment explaining its purpose) and verify that it doesn't create any type errors. To add a test for code that should _not_ work, and should generate a type error, add the code with a `// @ts-expect-error` annotation, and verify that without the annotation it generates a type error and with the annotation it doesn't.
+
+See also [`tighten/ziggy-type-testing`](https://github.com/tighten/ziggy-type-testing).
+
 ## Requirements
 
 - **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer).