[TypeScript] typegen creating output which conflicts with @typescript-eslint/ban-types about xstate-tools HOT 8 OPEN

Yes, although applying any linting whatsoever to generated files is probably not a great idea. When we release the CLI, we'll even be able to gitignore these assets and generate them on CI.

This is a cheap enough change to make, though.

from xstate-tools.

@mattpocock we can probably just output never at those locations instead of {} - but it's best to double-check that and add those to all existing type gen tests in this repo. Maybe we could even just skip those keys if they are empty~? That could be even better as we'd save some parsing time.

from xstate-tools.

I'm currently working around this with an override in my eslint.json to disable that rule for *.typegen.ts

from xstate-tools.

@horacioh Yes, see the CLI docs:

https://xstate.js.org/docs/packages/xstate-cli/#xstate-cli

from xstate-tools.

So what is the recommended way to handle this ? Add typegen files to eslintignore ?

Yes, this is a reasonable approach.

I will probably look in the future for alternative approaches for this but the mentioned ESLint rule shouldn't always be blindly trusted anyway. There are some cases for which {} is a better choice than all of the alternatives mentioned in this warning. So I'm not quite treating this as a high-priority issue.

from xstate-tools.

When we release the CLI, we'll even be able to gitignore these assets and generate them on CI.

@mattpocock Is there any example on how to do this on GH Actions? thanks in advance!

from xstate-tools.

YES!! I saw it and forgot to mention it here ;)

from xstate-tools.

HI all !

I'm having the same issue - toying around with a pretty simple machine that typegens this:

export interface Typegen0 {
  "@@xstate/typegen": true;
  internalEvents: {
    "xstate.init": { type: "xstate.init" };
    "xstate.stop": { type: "xstate.stop" };
  };
  invokeSrcNameMap: {};
  missingImplementations: {
    actions: never;
    delays: never;
    guards: never;
    services: never;
  };
  eventsCausingActions: {
    logEntry: "PLAY" | "STOP";
    logExit: "PAUSE" | "STOP" | "xstate.stop";
    logPaused: "PAUSE";
  };
  eventsCausingDelays: {};
  eventsCausingGuards: {};
  eventsCausingServices: {};
  matchesStates: "paused" | "playing" | "stopped";
  tags: never;
}

And the warnings as similar to what is described above

Don't use {} as a type. {} actually means "any non-nullish value".
- If you want a type meaning "any object", you probably want 'object' instead.
- If you want a type meaning "any value", you probably want 'unknown' instead.
- If you want a type meaning "empty object", you probably want 'Record<string, never>' instead. 
eslint(@typescript-eslint/ban-types)

So what is the recommended way to handle this ? Add typegen files to eslintignore ?

Thanks

from xstate-tools.