Feature Request: Generate Guards for Types in CI/CD or in Batch

[kacetal]

Hello,

I really like your library! However, I have a question—would it be possible to use it during CI/CD, or perhaps add a script that can generate predicates based on a pattern?

For example, given the following path:

src/components/other-folder/*/*.types.ts

The script would generate a corresponding guard file next to each type definition:

src/components/other-folder/*/*.types.guard.ts

Ideally, it would also add a re-export in each folder’s index.ts.

Is this currently possible, or is it something you plan to support?

Thanks!

[peter-leonov]

Hi,

Thanks for submitting the first issue on this repo :)

would it be possible to use it during CI/CD

Yep, this tool is inherently command line based, the Playground is more for demonstration purposes.

To install it as part of your project use this command:

npm i -D generate-type-guards
npx generate-type-guards --help

or perhaps add a script that can generate predicates based on a pattern?

This should be possible out of the box in any shell that supports globs, for example zsh:

npx generate-type-guards src/**/*.types.ts

This will visit every file that matches the src/**/*.types.ts pattern and create a *.types.predicates.ts next to it.

[kacetal]

It works but unfortunately it can't resolve the imports:

src/shared/api/firstObject/firstObject.types.ts (1,31): Cannot find module '@shared/api/secondObject'. Did you mean to set the 'moduleResolution' option to 'nodenext', or to add aliases to the 'paths' option?
While processing file: src/shared/api/firstObject/firstObject.types.ts
TypeScript compilation error
Likely it's a syntax error, if not then it's a bug.

In this case the first object has an import:

import { SecondObject } from "@shared/api/secondObject";

[peter-leonov]

Ah, this is the tool limitation per se, please try the workaround:

import { SecondObject } from "@shared/api/secondObject";
export type { SecondObject }

This is because trying to trace imports is a less trivial topic for a simple tool.