continuu

Author: ssalbdivad

ark/docs/content/docs/blog/arkregex.mdx

@@ -17,13 +17,13 @@ The `regex` function creates a `Regex` instance with types for `.test()`, `.exec
 import { regex } from "arkregex"
 
 const ok = regex("^ok$", "i")
-// 	  ^ Regex<"ok" | "oK" | "Ok" | "OK", { flags: "i" }>
+// Regex<"ok" | "oK" | "Ok" | "OK", { flags: "i" }>
 
 const semver = regex("^(\\d*)\\.(\\d*)\\.(\\d*)$")
-// 	  ^ Regex<`${bigint}.${bigint}.${bigint}`, { captures: [`${bigint}`, `${bigint}`, `${bigint}`] }>
+// Regex<`${bigint}.${bigint}.${bigint}`, { captures: [`${bigint}`, `${bigint}`, `${bigint}`] }>
 
 const email = regex("^(?<name>\\w+)@(?<domain>\\w+\\.\\w+)$")
-// 	  ^ Regex<`${string}@${string}.${string}`, { names: { name: string; domain: `${string}.${string}`; }; ...>
+// Regex<`${string}@${string}.${string}`, { names: { name: string; domain: `${string}.${string}`; }; ...>
 ```
 
 ### Features
@@ -53,6 +53,16 @@ const complexPattern = regex.cast<`pattern-${string}`, { captures: [string] }>(
 )
 ```
 
+#### Is it robust?
+
+`arkregex` types are [extensively tested](https://github.com/arktypeio/arktype/tree/main/ark/regex/__tests__/regex.test.ts) and [benchmarked](https://github.com/arktypeio/arktype/tree/main/ark/regex/__tests__/regex.bench.ts) using [attest](https://github.com/arktypeio/arktype/tree/main/ark/attest#readme).
+
+If anything not covered by the other FAQs is not behaving how you'd expect, please don't hesitate to [create an issue](https://github.com/arktypeio/arktype/issues/new).
+
+#### How can I get syntax highlighting for `regex`?
+
+The [ArkType extension](https://marketplace.visualstudio.com/items?itemName=arktypeio.arkdark) can be installed to add syntax highlighting to `regex` calls.
+
 <MainAutoplayDemo />
 
 ⚡ [Starting coding](/docs/intro/setup)

ark/docs/public/llms.txt

@@ -368,13 +368,13 @@ The `regex` function creates a `Regex` instance with types for `.test()`, `.exec
 import { regex } from "arkregex"
 
 const ok = regex("^ok$", "i")
-// 	  ^ Regex<"ok" | "oK" | "Ok" | "OK", { flags: "i" }>
+// Regex<"ok" | "oK" | "Ok" | "OK", { flags: "i" }>
 
 const semver = regex("^(\\d*)\\.(\\d*)\\.(\\d*)$")
-// 	  ^ Regex<`${bigint}.${bigint}.${bigint}`, { captures: [`${bigint}`, `${bigint}`, `${bigint}`] }>
+// Regex<`${bigint}.${bigint}.${bigint}`, { captures: [`${bigint}`, `${bigint}`, `${bigint}`] }>
 
 const email = regex("^(?<name>\\w+)@(?<domain>\\w+\\.\\w+)$")
-// 	  ^ Regex<`${string}@${string}.${string}`, { names: { name: string; domain: `${string}.${string}`; }; ...>
+// Regex<`${string}@${string}.${string}`, { names: { name: string; domain: `${string}.${string}`; }; ...>
 ```
 
 ### Features
@@ -404,6 +404,16 @@ const complexPattern = regex.cast<`pattern-${string}`, { captures: [string] }>(
 )
 ```
 
+#### Is it robust?
+
+`arkregex` types are [extensively tested](https://github.com/arktypeio/arktype/tree/main/ark/regex/__tests__/regex.test.ts) and [benchmarked](https://github.com/arktypeio/arktype/tree/main/ark/regex/__tests__/regex.bench.ts) using [attest](https://github.com/arktypeio/arktype/tree/main/ark/attest#readme).
+
+If anything not covered by the other FAQs is not behaving how you'd expect, please don't hesitate to [create an issue](https://github.com/arktypeio/arktype/issues/new).
+
+#### How can I get syntax highlighting for `regex`?
+
+The [ArkType extension](https://marketplace.visualstudio.com/items?itemName=arktypeio.arkdark) can be installed to add syntax highlighting to `regex` calls.
+
 <MainAutoplayDemo />
 
 ⚡ [Starting coding](/docs/intro/setup)

ark/extension/README.md

@@ -4,7 +4,9 @@
 </div>
 <div align="center">
 
-[ArkType](https://arktype.io) syntax highlighting and theme⛵
+[ArkType](https://arktype.io) syntax highlighting and inline errors ⛵
+
+[Install the extension](https://marketplace.visualstudio.com/items?itemName=arktypeio.arkdark)
 
 </div>
 

ark/regex/README.md

@@ -4,37 +4,37 @@ A drop-in replacement for `new RegExp()` with types
 
 ## Usage
 
-The `regex` function creates a `Regex` instance with types for `.test()`, `.exec()` and more, statically parsed from native JS syntax.
+The `regex` function creates a `Regex` instance with types for `.test()`, `.exec()` and more, statically parsed from native JS syntax:
 
 ```ts
 import { regex } from "arkregex"
 
 const ok = regex("^ok$", "i")
-// 	  ^ Regex<"ok" | "oK" | "Ok" | "OK", { flags: "i" }>
+// Regex<"ok" | "oK" | "Ok" | "OK", { flags: "i" }>
 
 const semver = regex("^(\\d*)\\.(\\d*)\\.(\\d*)$")
-// 	  ^ Regex<`${bigint}.${bigint}.${bigint}`, { captures: [`${bigint}`, `${bigint}`, `${bigint}`] }>
+// Regex<`${bigint}.${bigint}.${bigint}`, { captures: [`${bigint}`, `${bigint}`, `${bigint}`] }>
 
 const email = regex("^(?<name>\\w+)@(?<domain>\\w+\\.\\w+)$")
-// 	  ^ Regex<`${string}@${string}.${string}`, { names: { name: string; domain: `${string}.${string}`; }; ...>
+// Regex<`${string}@${string}.${string}`, { names: { name: string; domain: `${string}.${string}`; }; ...>
 ```
 
-## Features
+### Features
 
 - **Types**: Infers string types for your existing regular expressions, including positional and named captures
 - **Parity**: Supports 100% of [features](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions) allowed by `new RegExp()`
 - **Safety**: Syntax errors like referencing a group that doesn't exist are now type errors
-- **Zero Runtime**: Improves your type safety without impacting your bundle size[\*](#footnote)
+- **Zero Runtime**: Improves your type safety without impacting your bundle size
 
-## FAQ
+### FAQ
 
-### Why aren't some patterns like `[a-Z]` inferred more precisely?
+#### Why aren't some patterns like `[a-Z]` inferred more precisely?
 
 Constructing string literal types for these sorts of expressions is combinatorial and will explode very quickly if we infer character ranges like this as literal characters.
 
 We've tried to strike a balance between performance and precision while guaranteeing that the inferred types are at worst imprecise and never incorrect.
 
-### Why doesn't it work with my massive RegExp?
+#### Why doesn't it work with my massive RegExp?
 
 If your expression is especially long or complex, TypeScript won't be able to infer it.
 
@@ -46,10 +46,12 @@ const complexPattern = regex.cast<`pattern-${string}`, { captures: [string] }>(
 )
 ```
 
-<a id="footnote"></a>
-\*The actual runtime bundle size is two lines:
+#### Is it robust?
 
-```ts
-export const regex = (src, flags) => new RegExp(src, flags)
-Object.assign(regex, { cast: regex })
-```
+`arkregex` types are [extensively tested](https://github.com/arktypeio/arktype/tree/main/ark/regex/__tests__/regex.test.ts) and [benchmarked](https://github.com/arktypeio/arktype/tree/main/ark/regex/__tests__/regex.bench.ts) using [attest](https://github.com/arktypeio/arktype/tree/main/ark/attest#readme).
+
+If anything not covered by the other FAQs is not behaving how you'd expect, please don't hesitate to [create an issue](https://github.com/arktypeio/arktype/issues/new).
+
+#### How can I get syntax highlighting for `regex`?
+
+The [ArkType extension](https://marketplace.visualstudio.com/items?itemName=arktypeio.arkdark) can be installed to add syntax highlighting to `regex` calls.

ark/regex/__tests__/regex.test.ts

@@ -1343,5 +1343,3 @@ contextualize(() => {
 		})
 	})
 })
-
-const ok = regex("^ok$", "i")