@signpostmarv/ts-assert 0.4.0 → 0.4.2

package/lib/assertables.d.ts

@@ -0,0 +1,29 @@
+import type { FunctionDeclaration, Identifier, TypeReferenceNode } from 'typescript';
+type named_function = (FunctionDeclaration & {
+    name: Identifier;
+});
+type assertable_function<NodeParam extends string = string> = (named_function & {
+    name: (Identifier & {
+        text: `is${string}`;
+    });
+    parameters: [
+        {
+            name: (Identifier & {
+                text: NodeParam;
+            });
+            type: (TypeReferenceNode & {
+                typeName: Identifier;
+            });
+        }
+    ];
+    type: ({
+        parameterName: (Identifier & {
+            text: NodeParam;
+        });
+        type: (TypeReferenceNode & {
+            typeName: Identifier;
+        });
+    });
+});
+export declare const assertables: assertable_function[];
+export default assertables;

package/lib/assertables.js

@@ -0,0 +1,51 @@
+import { readFile, } from 'node:fs/promises';
+import ts from 'typescript';
+import assert from 'node:assert/strict';
+// oxlint-disable-next-line @stylistic/max-len
+// oxlint-disable-next-line typescript/no-unsafe-assignment, typescript/no-unsafe-call
+const typescript_defs = await readFile(`${import.meta.dirname}/../node_modules/typescript/lib/typescript.d.ts`);
+const ast = ts.createSourceFile('typescript.d.ts', 
+// oxlint-disable-next-line @stylistic/max-len
+// oxlint-disable-next-line typescript/no-unsafe-argument, typescript/no-unsafe-call, typescript/no-unsafe-member-access
+typescript_defs.toString(), ts.ScriptTarget.Latest, false, ts.ScriptKind.TS).statements.filter((e) => ts.isModuleDeclaration(e));
+// oxlint-disable-next-line @stylistic/max-len
+// oxlint-disable-next-line typescript/no-unsafe-call, typescript/no-unsafe-member-access
+assert.equal(ast.length, 1, 'Could not obtain typescript module AST');
+const module_body = ast[0].body;
+// oxlint-disable-next-line @stylistic/max-len
+// oxlint-disable-next-line typescript/no-unsafe-call, typescript/no-unsafe-member-access
+assert.equal(!!module_body && !!ts.isModuleBlock(module_body), true, 'Could not obtain module body!');
+const { statements } = module_body;
+const functions = statements.filter((e) => {
+    return ts.isFunctionDeclaration(e) && !!e.name;
+});
+const skip_these = [
+    'isAssertClause',
+    'isAssertEntry',
+    'isImportTypeAssertionContainer',
+    'isUnparsedTextLike',
+    'isUnparsedNode',
+    'isUnparsedPrepend',
+    'isUnparsedSource',
+    'isUnparsedTextLike',
+];
+export const assertables = functions.filter((e) => {
+    return (e.name.text.startsWith('is')
+        && !skip_these.includes(e.name.text)
+        && 1 === e.parameters.length
+        && !!e.parameters[0].type
+        && ts.isTypeReferenceNode(e.parameters[0].type)
+        && ts.isIdentifier(e.parameters[0].type.typeName)
+        && ts.isIdentifier(e.parameters[0].name)
+        && !!e.type
+        && ts.isTypePredicateNode(e.type)
+        && !!e.type.type
+        && ts.isTypeReferenceNode(e.type.type)
+        && ts.isIdentifier(e.type.type.typeName)
+        && ts.isIdentifier(e.type.parameterName)
+        && e.parameters[0].name.text === e.type.parameterName.text);
+}).sort((a, b) => {
+    return a.name.text.localeCompare(b.name.text);
+});
+export default assertables;
+//# sourceMappingURL=assertables.js.map

package/lib/assertables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertables.js","sourceRoot":"","sources":["assertables.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,QAAQ,GACR,MAAM,kBAAkB,CAAC;AAQ1B,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,MAAM,MAAM,oBAAoB,CAAC;AAExC,8CAA8C;AAC9C,sFAAsF;AACtF,MAAM,eAAe,GAAG,MAAM,QAAQ,CAAC,GACtC,MAAM,CAAC,IAAI,CAAC,OACb,iDAAiD,CAAC,CAAC;AAEnD,MAAM,GAAG,GAAG,EAAE,CAAC,gBAAgB,CAC9B,iBAAiB;AAEjB,8CAA8C;AAC9C,wHAAwH;AACxH,eAAe,CAAC,QAAQ,EAAE,EAC1B,EAAE,CAAC,YAAY,CAAC,MAAM,EACtB,KAAK,EACL,EAAE,CAAC,UAAU,CAAC,EAAE,CAChB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAA0B,EAAE,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;AAE9E,8CAA8C;AAC9C,yFAAyF;AACzF,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,wCAAwC,CAAC,CAAC;AAEtE,MAAM,WAAW,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAEhC,8CAA8C;AAC9C,yFAAyF;AACzF,MAAM,CAAC,KAAK,CACX,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,WAAW,CAAC,EAChD,IAAI,EACJ,+BAA+B,CAC/B,CAAC;AAEF,MAAM,EAAC,UAAU,EAAC,GAAG,WAA0B,CAAC;AAMhD,MAAM,SAAS,GAAqB,UAAU,CAAC,MAAM,CACpD,CAAC,CAAC,EAAuB,EAAE;IAC1B,OAAO,EAAE,CAAC,qBAAqB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAChD,CAAC,CACD,CAAC;AA8CF,MAAM,UAAU,GAAG;IAClB,gBAAgB;IAChB,eAAe;IACf,gCAAgC;IAChC,oBAAoB;IACpB,gBAAgB;IAChB,mBAAmB;IACnB,kBAAkB;IAClB,oBAAoB;CACpB,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAA0B,SAAS,CAAC,MAAM,CACjE,CAAC,CAAC,EAA4B,EAAE;IAC/B,OAAO,CACN,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;WACzB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;WACjC,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,MAAM;WACzB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI;WACtB,EAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;WAC5C,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;WAC9C,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;WACrC,CAAC,CAAC,CAAC,CAAC,IAAI;WACR,EAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC;WAC9B,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI;WACb,EAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;WACnC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;WACrC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;WACrC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAC1D,CAAC;AACH,CAAC,CACD,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;IACf,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC/C,CAAC,CAAC,CAAC;AAEH,eAAe,WAAW,CAAC"}

package/lib/assertables.ts

@@ -0,0 +1,135 @@
+import {
+	readFile,
+} from 'node:fs/promises';
+import type {
+	FunctionDeclaration,
+	Identifier,
+	ModuleBlock,
+	ModuleDeclaration,
+	TypeReferenceNode,
+} from 'typescript';
+import ts from 'typescript';
+import assert from 'node:assert/strict';
+
+// oxlint-disable-next-line @stylistic/max-len
+// oxlint-disable-next-line typescript/no-unsafe-assignment, typescript/no-unsafe-call
+const typescript_defs = await readFile(`${
+	import.meta.dirname
+}/../node_modules/typescript/lib/typescript.d.ts`);
+
+const ast = ts.createSourceFile(
+	'typescript.d.ts',
+
+	// oxlint-disable-next-line @stylistic/max-len
+	// oxlint-disable-next-line typescript/no-unsafe-argument, typescript/no-unsafe-call, typescript/no-unsafe-member-access
+	typescript_defs.toString(),
+	ts.ScriptTarget.Latest,
+	false,
+	ts.ScriptKind.TS,
+).statements.filter((e): e is ModuleDeclaration => ts.isModuleDeclaration(e));
+
+// oxlint-disable-next-line @stylistic/max-len
+// oxlint-disable-next-line typescript/no-unsafe-call, typescript/no-unsafe-member-access
+assert.equal(ast.length, 1, 'Could not obtain typescript module AST');
+
+const module_body = ast[0].body;
+
+// oxlint-disable-next-line @stylistic/max-len
+// oxlint-disable-next-line typescript/no-unsafe-call, typescript/no-unsafe-member-access
+assert.equal(
+	!!module_body && !!ts.isModuleBlock(module_body),
+	true,
+	'Could not obtain module body!',
+);
+
+const {statements} = module_body as ModuleBlock;
+type named_function = (
+	& FunctionDeclaration
+	& {name: Identifier}
+);
+
+const functions: named_function[] = statements.filter(
+	(e): e is named_function => {
+		return ts.isFunctionDeclaration(e) && !!e.name;
+	},
+);
+
+type assertable_function<
+	NodeParam extends string = string,
+> = (
+	& named_function
+	& {
+		name: (
+			& Identifier
+			& {text: `is${string}`}
+		),
+		parameters: [
+			{
+				name: (
+					& Identifier
+					& {
+						text: NodeParam,
+					}
+				),
+				type: (
+					& TypeReferenceNode
+					& {
+						typeName: Identifier,
+					}
+				),
+			},
+		],
+		type: (
+			& {
+				parameterName: (
+					& Identifier
+					& {
+						text: NodeParam,
+					}
+				),
+				type: (
+					& TypeReferenceNode
+					& {
+						typeName: Identifier,
+					}
+				),
+			}
+		),
+	}
+);
+
+const skip_these = [
+	'isAssertClause',
+	'isAssertEntry',
+	'isImportTypeAssertionContainer',
+	'isUnparsedTextLike',
+	'isUnparsedNode',
+	'isUnparsedPrepend',
+	'isUnparsedSource',
+	'isUnparsedTextLike',
+];
+
+export const assertables: assertable_function[] = functions.filter(
+	(e): e is assertable_function => {
+		return (
+			e.name.text.startsWith('is')
+			&& !skip_these.includes(e.name.text)
+			&& 1 === e.parameters.length
+			&& !!e.parameters[0].type
+			&& ts.isTypeReferenceNode(e.parameters[0].type)
+			&& ts.isIdentifier(e.parameters[0].type.typeName)
+			&& ts.isIdentifier(e.parameters[0].name)
+			&& !!e.type
+			&& ts.isTypePredicateNode(e.type)
+			&& !!e.type.type
+			&& ts.isTypeReferenceNode(e.type.type)
+			&& ts.isIdentifier(e.type.type.typeName)
+			&& ts.isIdentifier(e.type.parameterName)
+			&& e.parameters[0].name.text === e.type.parameterName.text
+		);
+	},
+).sort((a, b) => {
+	return a.name.text.localeCompare(b.name.text);
+});
+
+export default assertables;