You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
### Description
<!-- Provide a comprehensive description here about what your PR aims to
solve. -->
<!-- You may also add additional context -->
Migrate from TypeBox to ArkType, TypeScript's 1:1 validator.
---
### PR Checklist
<!-- Please do not remove this section -->
<!-- Mark each item with an "x" ([ ] becomes [x]) -->
- [x] Read the Developer's Guide in
[CONTRIBUTING.md](https://github.com/bedtime-coders/bedstack/blob/main/CONTRIBUTING.md)
- [x] Use a concise title to represent the changes introduced in this PR
- [x] Provide a detailed description of the changes introduced in this
PR, and, if necessary, some screenshots
- [x] Reference an issue or discussion where the feature or changes have
been previously discussed
- [x] Add a failing test that passes with the changes introduced in this
PR, or explain why it's not feasible
- [x] Add documentation for the feature or changes introduced in this PR
to the docs; you can run them with `bun docs`
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Switched project validation/type system to ArkType, updating
runtime/type exports.
* **Bug Fixes**
* Improved validation error formatting and path/message handling for
clearer, more robust errors.
* **Documentation**
* Updated Bun links to bun.com; added ArkType and Biome to docs, badges,
and setup guidance; refreshed overview and getting-started content.
* **Chores**
* Updated dependencies to add ArkType/arkregex and remove legacy
validator; minor package description tweak.
<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-9Lines changed: 11 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,19 @@
1
1
# Developer's Guide
2
2
3
-
Hey there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great and we truly appreciate your time and effort.
3
+
Hey there! Contributing to this project is highly encouraged. Community help is essential for maintaining its quality, and every effort is appreciated.
4
4
5
5
> [!IMPORTANT]
6
6
> Before submitting your contribution, please take a moment and read through the following guidelines.
7
7
8
8
## 👨💻 Repository Setup
9
9
10
-
This project uses [Bun](https://bun.sh) as a runtime as well as a package manager. It's a modern, fast, and lightweight alternative to [Node.js](https://nodejs.org/en/) and [npm](https://www.npmjs.com/). To install Bun on POSIX systems (like Ubuntu or macOS), run the following command:
10
+
This project uses [Bun](https://bun.com) as a runtime as well as a package manager. It's a modern, fast, and lightweight alternative to [Node.js](https://nodejs.org/en/) and [npm](https://www.npmjs.com/). To install Bun on POSIX systems (like Ubuntu or macOS), run the following command:
11
11
12
12
```sh
13
-
curl -fsSL https://bun.sh/install | bash
13
+
curl -fsSL https://bun.com/install | bash
14
14
```
15
15
16
-
Otherwise, visit the [Bun installation page](https://bun.sh/docs/installation) for installation options.
16
+
Otherwise, visit the [Bun installation page](https://bun.com/docs/installation) for installation options.
17
17
18
18
## 💡 Commands
19
19
@@ -27,7 +27,7 @@ Build the project for production. The result is under `dist/`.
27
27
28
28
### `bun check`
29
29
30
-
We use [Biome](https://biomejs.dev/) for **both linting and formatting**. It is an ultra-fast, Rust based linter and formatter.
30
+
Biome is used for **both linting and formatting**. It is an ultra-fast, Rust based linter and formatter.
31
31
It also lints JSON.
32
32
33
33
You can also run `bun fix` to apply any safe fixes automatically.
@@ -54,7 +54,7 @@ For typo fixes, it's recommended to batch multiple typo fixes into one pull requ
54
54
55
55
### Pull Request
56
56
57
-
If you don't know how to send a Pull Request, we recommend reading[the guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
57
+
If you don't know how to send a Pull Request, it is recommended to read[the guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
58
58
59
59
If your PR fixes or resolves an existing issue, please add the following line in your PR description according to the following example:
60
60
@@ -75,19 +75,21 @@ Replacing:
75
75
76
76
This will let GitHub know the issues are linked, and automatically close them once the PR gets merged. Learn more at [the guide](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).
77
77
78
-
It's ok to have multiple commits in a single PR, you don't need to rebase or force push for your changes as we will use `Squash and Merge`to squash the commits into one commit when merging.
78
+
It's ok to have multiple commits in a single PR; changes do not need to be rebased or force pushed, as Squash and Merge will be used to combine the commits into one when merging.
79
79
80
80
## 📖 References
81
81
82
82
### Lint
83
83
84
-
We use [Biome](https://biomejs.dev/) for both linting and formatting with [a few custom rules](./biome.jsonc). It is an ultra-fast, Rust based linter and formatter.
84
+
Biome is used for both linting and formatting with [a few custom rules](./biome.jsonc). It is an ultra-fast, Rust based linter and formatter.
85
85
86
86
<table><tr><td>
87
87
88
88
#### IDE Setup
89
89
90
-
We recommend using [VS Code](https://code.visualstudio.com/) along with the [Biome extension](https://marketplace.visualstudio.com/items?itemName=biomejs.biome).
90
+
[Visual Studio Code](https://code.visualstudio.com/) is recommended for the best experience along with:
91
+
-[Biome extension](https://marketplace.visualstudio.com/items?itemName=biomejs.biome) for linting and formatting.
92
+
-[ArkType extension](https://marketplace.visualstudio.com/items?itemName=arktypeio.arkdark) for syntax highlighting and type-safe regex support.
91
93
92
94
With the settings on the right, you can have auto fix and formatting when you save the code you are editing.
[Bun](https://bun.sh/) + [ElysiaJS](https://elysiajs.com/) + [Drizzle](https://orm.drizzle.team/) = the stack you don't want to sleep on
8
+
[Bun](https://bun.com/) + [ElysiaJS](https://elysiajs.com/) + [Drizzle](https://orm.drizzle.team/) = the stack you don't want to sleep on
9
9
10
10
[bedstack.js.org](https://bedstack.js.org)
11
11
12
12
</div>
13
13
14
14
> [!TIP]
15
-
> ⚡ **New!** Our Prisma-based alternative to Bedstack was just approved on CodebaseShow. Check it out: [Bepstack](https://github.com/bedtime-coders/bepstack)
16
-
17
-
> [!TIP]
18
-
> ⚡ **New!** We've added support for [Drizzle v1 Beta](https://orm.drizzle.team/roadmap) in _Bedstack (Stripped)_. Check it out: [`drizzle-v1` branch](https://github.com/bedtime-coders/bedstack-stripped/tree/drizzle-v1)
Copy file name to clipboardExpand all lines: SUPPORT.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,16 @@ This article explains where to get help with Bedstack.
4
4
Please read through the following guidelines.
5
5
6
6
> [!WARNING]
7
-
> Before participating in our community, please read our
7
+
> Before participating in the community, please read the
8
8
> [code of conduct](CODE_OF_CONDUCT.md).
9
9
> By interacting with this repository, organization, or community you agree to
10
10
> abide by its terms.
11
11
12
12
## Asking quality questions
13
13
14
-
Questions can go to our[Discord server](https://discord.gg/8UcP9QB5AV) or [GitHub discussions](https://github.com/bedtime-coders/bedstack/discussions).
14
+
Questions can go to the[Discord server](https://discord.gg/8UcP9QB5AV) or [GitHub discussions](https://github.com/bedtime-coders/bedstack/discussions).
15
15
16
-
Help us help you!
16
+
Clear questions are easier to answer.
17
17
Spend time framing questions and add links and resources.
18
18
Spending the extra time up front can help save everyone time in the long run.
19
19
Here are some tips:
@@ -29,7 +29,7 @@ Here are some tips:
29
29
* Provide sample code, such as a [CodeSandbox](https://codesandbox.io/) or video, if possible
30
30
* Screenshots can help, but if there’s important text such as code or error
31
31
messages in them, please also provide those as text
32
-
* The more time you put into asking your question, the better we can help you
32
+
* The more time put into asking a question, the better the community can provide assistance
![autofix-ci[bot]](https://avatars.githubusercontent.com/in/243519?v=4&size=40){kind=avatar}
0 commit comments