regex inference, fn, 2.2 prerelease

.github/CONTRIBUTING.md

@@ -47,7 +47,6 @@ git checkout -b amazing-feature
 ```
 
 6. Do your best to write code that is stylistically consistent with its context. The linter will help with this, but it won't catch everything. Here's a few general guidelines:
-
    - Favor mutation over copying objects in perf-sensitive contexts
    - Favor clarity in naming with the following exceptions:
      - Ubiquitous variables/types. For example, use `s` over `dynamicParserState` for a variable of type DynamicParserState that is used in the same way across many functions.
@@ -56,13 +55,11 @@ git checkout -b amazing-feature
 We also have some unique casing rules for our TypeScript types to facilitate type-level code that can parallel its runtime implementation and be easily understood:
 
 - Use `PascalCase` for...
-
   - Entities/non-generic types (e.g. `User`, `SomeData`)
-  - Generic types with noun names, like `Array<t>`. As a rule of thumb, your generic should be named this way if all its parameters have defaults (unfortunately TS's built-in `Array` type doesn't have a default parameter, but it probably should have been `unknown`!)
+  - Generic types with noun names, like `Array<t>`. As a rule of thumb, if your generic is named this way, all parameters have defaults.
 
 - Use `camelCase` for...
-
-  - Generic types with verb names like `inferDomain<t>`. Types named this way should generally have at least one required parameter.
+  - Generic types with verb names like `inferDomain<t>`. Types named this way have at least one required parameter.
   - Parameter names, e.g. `t` in `Array<t>`
 
 7. Once you've made the changes you want to and added corresponding unit tests, run the `prChecks` command in the project root and address any errors:

.gitignore

@@ -14,6 +14,3 @@ tmp
 .attest
 tsconfig.build.json
 coverage
-# we avoid committing the root pnpm-lock in order to keep the root of the repo as clean as possible.
-# we can get away with this to since we're only installing devDependencies and they're all pinned.
-/pnpm-lock.yaml

.vscode/settings.json

@@ -37,10 +37,6 @@
 		"ATTEST_skipTypes": "true"
 	},
 	"testExplorer.useNativeTesting": true,
-	"editor.unicodeHighlight.allowedCharacters": {
-		// Hair Space: used as a sentinel for error messages
-		" ": true
-	},
 	"search.exclude": {
 		"**/out": true,
 		"**/.next": true,
@@ -50,5 +46,11 @@
 	},
 	"editor.quickSuggestions": {
 		"strings": "on"
+	},
+	"github.copilot.enable": {
+		"*": false,
+		"plaintext": false,
+		"markdown": false,
+		"scminput": false
 	}
 }

ark/attest/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 NOTE: This changelog is incomplete, but will include notable attest-specific changes (many updates consist almost entirely of bumped `arktype` versions for assertions).
 
+## 0.47.0
+
+Add a `failOnMissingSnapshots` config option. Defaults to `true` if `CI` is set in your environment, `false` otherwise.
+
 ## 0.46.0
 
 Fix an issue causing some bench files to not be parsed correctly, leading to errors and 0 instantiation counts.

ark/attest/__tests__/assertions.test.ts

@@ -1,4 +1,6 @@
 import { attest } from "@ark/attest"
+import { MissingSnapshotError } from "@ark/attest/internal/assert/assertions.js"
+import { attestInternal } from "@ark/attest/internal/assert/attest.js"
 import { type } from "arktype"
 import * as assert from "node:assert/strict"
 
@@ -201,4 +203,12 @@ Actual: [ArkError]`)
 			"BAR"
 		)
 	})
+
+	it("failOnMissingSnapshots", () => {
+		assert.throws(
+			() =>
+				attestInternal("", { cfg: { failOnMissingSnapshots: true } }).snap(),
+			MissingSnapshotError
+		)
+	})
 })

ark/attest/__tests__/benchExpectedOutput.ts

@@ -30,21 +30,21 @@ type makeComplexType<S extends string> =
 	:	S
 
 bench("bench type", () => ({}) as makeComplexType<"defenestration">).types([
-	177,
+	163,
 	"instantiations"
 ])
 
 bench(
 	"bench type from external module",
 	() => ({}) as externalmakeComplexType<"defenestration">
-).types([193, "instantiations"])
+).types([179, "instantiations"])
 
 bench(
 	"bench call and type",
 	() => ({}) as makeComplexType<"antidisestablishmentarianism">,
 	fakeCallOptions
 )
 	.mean([2, "ms"])
-	.types([345, "instantiations"])
+	.types([317, "instantiations"])
 
 bench("empty", () => {}).types([0, "instantiations"])

ark/attest/__tests__/snapExpectedOutput.ts

@@ -72,7 +72,7 @@ attest({ [Symbol("mySymbol")]: 1 }).snap({ "Symbol(mySymbol)": 1 })
 const it = (name: string, fn: () => void) => fn()
 
 it("can snap instantiations", () => {
-	attest.instantiations([229, "instantiations"])
+	attest.instantiations([212, "instantiations"])
 	return {} as makeComplexType<"asbsdfsaodisfhsda">
 })
 

ark/attest/__tests__/utils.ts

@@ -7,7 +7,12 @@ export const runThenGetContents = (templatePath: string): string => {
 	const tempPath = templatePath + ".temp.ts"
 	copyFileSync(templatePath, tempPath)
 	try {
-		shell(`node --import=tsx ${tempPath}`, { cwd: dirName() })
+		shell(`node --import=tsx ${tempPath}`, {
+			cwd: dirName(),
+			env: {
+				ATTEST_failOnMissingSnapshots: "0"
+			}
+		})
 	} catch (e) {
 		console.error(e)
 	}

ark/attest/assert/assertions.ts

@@ -20,6 +20,8 @@ export const throwAssertionError = ({
 	throw e
 }
 
+export class MissingSnapshotError extends Error {}
+
 export type AssertFn = (
 	expected: unknown,
 	actual: unknown,

ark/attest/assert/chainableAssertions.ts

@@ -1,4 +1,4 @@
-import { caller } from "@ark/fs"
+import { caller, positionToString } from "@ark/fs"
 import {
 	printable,
 	snapshot,
@@ -20,6 +20,7 @@ import type { Completions } from "../cache/writeAssertionCache.ts"
 import { getConfig } from "../config.ts"
 import { chainableNoOpProxy } from "../utils.ts"
 import {
+	MissingSnapshotError,
 	TypeAssertionMapping,
 	assertEqualOrMatching,
 	assertEquals,
@@ -124,9 +125,15 @@ export class ChainableAssertions implements AssertionRecord {
 			const snapName = this.ctx.lastSnapName ?? "snap"
 			const expectedSerialized = snapshot(args[0])
 			if (!args.length || this.ctx.cfg.updateSnapshots) {
+				const position = caller()
+				if (this.ctx.cfg.failOnMissingSnapshots) {
+					throw new MissingSnapshotError(
+						`.${snapName}() at ${positionToString(position)} must be populated.`
+					)
+				}
 				if (this.snapRequiresUpdate(expectedSerialized)) {
 					const snapshotArgs: SnapshotArgs = {
-						position: caller(),
+						position,
 						serializedValue: this.serializedActual,
 						snapFunctionName: snapName
 					}
@@ -339,20 +346,14 @@ type snapProperty<expected, kind extends AssertionKind> = {
 export type Unwrapper<expected = unknown> = (opts?: UnwrapOptions) => expected
 
 export const nonOverlappingSatisfiesMessage =
-	"The type of your actual value and expected satisfies constraint have no overlap"
+	"This type has no overlap with your satisfies constraint"
 
 export type nonOverlappingSatisfiesMessage =
 	typeof nonOverlappingSatisfiesMessage
 
 type validateExpectedOverlaps<expected, satisfies> =
 	isDisjoint<expected, satisfies> extends true ?
-		ErrorType<
-			nonOverlappingSatisfiesMessage,
-			{
-				actual: expected
-				satisfies: satisfies
-			}
-		>
+		ErrorType<nonOverlappingSatisfiesMessage>
 	:	unknown
 
 export type comparableValueAssertion<expected, kind extends AssertionKind> = {

ark/attest/cache/ts.ts

@@ -58,15 +58,34 @@ export class TsServer {
 
 	getSourceFileOrThrow(path: string): ts.SourceFile {
 		const tsPath = path.replaceAll("\\", "/")
-		const file = this.virtualEnv.getSourceFile(tsPath)
-		if (!file) {
+		const existingFile = this.virtualEnv.getSourceFile(tsPath)
+		if (existingFile) return existingFile
+
+		if (!this.virtualEnv.sys.fileExists(tsPath)) {
+			throwInternalError(
+				`@ark/attest: TypeScript was unable to resolve expected file at ${tsPath}.\n`
+			)
+		}
+
+		const contents = this.virtualEnv.sys.readFile(tsPath)
+
+		if (!contents) {
+			throwInternalError(
+				`@ark/attest: TypeScript says a file exists at ${tsPath}, but was unable to read its contents.\n`
+			)
+		}
+
+		this.virtualEnv.createFile(tsPath, contents)
+
+		const createdFile = this.virtualEnv.getSourceFile(tsPath)
+
+		if (!createdFile) {
 			throwInternalError(
-				`TypeScript was unable to resolve expected file at ${path}.\n
-Make sure it is included in your tsconfig.json.`
+				`@ark/attest: TypeScript tried to create a file at ${tsPath} but was unable to access it.`
 			)
 		}
 
-		return file
+		return createdFile
 	}
 }
 

ark/attest/cli/cli.ts

@@ -17,7 +17,7 @@ const baseFileName = basename(fileName())
 
 const thisFileIndex = process.argv.findIndex(
 	// if running from build output in npm, will be a file called `attest`
-	// if running from build output in pnpm, will be cli.js in build output
+	// if running from build output in pnpm, will be `cli.js` in build output
 	s => s.endsWith(baseFileName) || s.endsWith("attest")
 )