@glint/type-test 1.5.2 → 2.0.0-alpha.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 The Ember TypeScript team and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -17,7 +17,7 @@ It's similar in concept to (and built on) the [`expect-type`][et] library.
 For strict-mode templates, the `expectTypeOf` helper and `to` collection of expectations are
 both directly importable from `@glint/type-test`.
 
-```tsx
+```glimmer-ts
 import { expectTypeOf, to } from '@glint/type-test';
 
 let letters = ['a', 'b', 'c'];
@@ -35,7 +35,7 @@ let letters = ['a', 'b', 'c'];
 For "classic" loose-mode Ember templates, `@glint/type-test` provides a `typeTest` wrapper that
 will pass `expectTypeOf` and `to` to your template as args:
 
-```tsx
+```ts
 import { typeTest } from '@glint/type-test';
 import { hbs } from 'ember-cli-htmlbars';
 
@@ -52,7 +52,7 @@ typeTest(
 You can also optionally provide an initial `this` value to `typeTest` to make values available
 in your template to either test inference against or to use as a basis for comparing type equality.
 
-```tsx
+```ts
 import { typeTest } from '@glint/type-test';
 import { hbs } from 'ember-cli-htmlbars';
 
@@ -72,7 +72,7 @@ typeTest(
 This library provides a set of expectations to compare the type of a given value to common simple
 types.
 
-```tsx
+```glimmer-ts
 import { expectTypeOf, to } from '@glint/type-test';
 
 let symbolValue = Symbol('hi');
@@ -95,7 +95,7 @@ let neverValue: never = (null as never);
 
 It also provides expectations that allow you to compare the type of one value to that of another.
 
-```tsx
+```glimmer-ts
 import { expectTypeOf, to } from '@glint/type-test';
 
 let a: 'a' | 'b' = 'a';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glint/type-test",
-  "version": "1.5.2",
+  "version": "2.0.0-alpha.1",
   "repository": "typed-ember/glint",
   "description": "Tools for testing inferred types in Glint-enabled templates",
   "license": "MIT",
@@ -14,16 +14,30 @@
     "README.md",
     "lib"
   ],
-  "scripts": {
-    "test": "glint -p __tests__"
-  },
   "dependencies": {
     "expect-type": "^0.15.0"
   },
   "peerDependencies": {
-    "@glint/template": "^1.5.2"
+    "@glint/template": "*"
+  },
+  "devDependencies": {
+    "@glint/template": "1.6.0-alpha.0"
+  },
+  "release-plan": {
+    "semverIncrementAs": {
+      "major": "prerelease",
+      "minor": "prerelease",
+      "patch": "prerelease"
+    },
+    "semverIncrementTag": "alpha",
+    "publishTag": "alpha"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "test": "echo 'no standalone tests within this project'",
+    "test:typecheck": "glint -p __tests__",
+    "test:tsc": "echo 'no standalone tsc within this project'"
   }
-}
+}

package/lib/index.d.ts

@@ -1,87 +0,0 @@
-import { DirectInvokable, HasContext } from '@glint/template/-private/integration';
-import { Equal, Extends, IsAny, IsNever, IsUnknown } from 'expect-type';
-interface UnaryExpectations<T> {
-    string: [Equal<T, string>, 'Expected type to be `string`, but got'];
-    number: [Equal<T, number>, 'Expected type to be `number`, but got'];
-    boolean: [Equal<T, boolean>, 'Expected type to be `boolean`, but got'];
-    symbol: [Equal<T, symbol>, 'Expected type to be a `symbol`, but got'];
-    any: [IsAny<T>, 'Expected type to be `any`, but got'];
-    unknown: [IsUnknown<T>, 'Expected type to be `unknown`, but got'];
-    never: [IsNever<T>, 'Expected type to be `never`, but got'];
-    null: [Equal<T, null>, 'Expected type to be `null`, but got'];
-    undefined: [Equal<T, undefined>, 'Expected type to be `undefined`, but got'];
-}
-interface BinaryExpectations<T, U> {
-    equal: [Equal<T, U>, 'Expected first type to be identical to the second'];
-    assignableTo: [Extends<T, U>, 'Expected first type to be assignable to the second'];
-}
-declare const Expectation: unique symbol;
-declare type Expectation<T> = {
-    [Expectation]: T;
-};
-declare type UnaryExpectationKind = keyof UnaryExpectations<any>;
-declare type UnaryExpectation<K extends UnaryExpectationKind> = Expectation<K>;
-declare type BinaryExpectationKind = keyof BinaryExpectations<any, any>;
-declare type BinaryExpectation<K extends BinaryExpectationKind> = Expectation<K>;
-declare type UnmetExpectation<M, T> = [M, T];
-declare type TypeTestTemplate<T> = abstract new () => HasContext<{
-    this: T;
-    args: {
-        expectTypeOf: typeof expectTypeOf;
-        to: typeof to;
-    };
-    blocks: {};
-    element: unknown;
-}>;
-declare type ExpectTypeOf = DirectInvokable<{
-    <T, E extends UnaryExpectationKind>(actual: T, expectation: UnaryExpectation<E>): UnaryExpectations<T>[E] extends [false, infer M] ? UnmetExpectation<M, T> : void;
-    <T, E extends BinaryExpectationKind, U>(actual: T, expectation: BinaryExpectation<E>, expected: U): BinaryExpectations<T, U>[E] extends [false, infer M] ? UnmetExpectation<M, [T, U]> : void;
-}>;
-/**
- * Given a value, an expectation, and potentially a second value as the
- * target of that expectation, confirms whether the type of that value
- * meets the constraints set by the given expectation.
- *
- * ```handlebars
- * {{expectTypeOf 123 to.beNumber}}
- * {{expectTypeOf 123 to.equalTypeOf (add 1 2)}}
- * ```
- */
-export declare const expectTypeOf: ExpectTypeOf;
-/**
- * Provides a set of possible expectations to apply against the
- * type of a value passed to `{{expectTypeOf}}`.
- */
-export declare const to: {
-    equalTypeOf: BinaryExpectation<'equal'>;
-    beAssignableToTypeOf: BinaryExpectation<'assignableTo'>;
-    beString: UnaryExpectation<'string'>;
-    beNumber: UnaryExpectation<'number'>;
-    beBoolean: UnaryExpectation<'boolean'>;
-    beSymbol: UnaryExpectation<'symbol'>;
-    beAny: UnaryExpectation<'any'>;
-    beUnknown: UnaryExpectation<'unknown'>;
-    beNever: UnaryExpectation<'never'>;
-    beNull: UnaryExpectation<'null'>;
-    beUndefined: UnaryExpectation<'undefined'>;
-};
-/**
- * Given a loose-mode template (e.g. as defined using `hbs`), this
- * wrapper sets the context of that template appropriately. It receives
- * the `expectTypeOf` and `to` imports from this module as args, and
- * optionally takes an initial `context` parameter that determines the
- * type of the `{{this}}` value in the template.
- *
- * ```typescript
- * typeTest(
- *   { message: 'hello' },
- *   hbs`
- *     {{@expectTypeOf this.message @to.beString}}
- *   `
- * );
- * ```
- */
-export declare function typeTest<T>(context: T, template: TypeTestTemplate<T>): void;
-export declare function typeTest(template: TypeTestTemplate<null>): void;
-export declare function typeTest(...args: Array<unknown>): void;
-export {};

package/lib/index.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}