Consider type `local` as the default interceptor type

zimicjs / zimic

TypeScript-first HTTP request mocking

https://npmjs.com/package/zimic

MIT License

9 stars 2 forks source link

Consider type `local` as the default interceptor type #403

Open diego-aquino opened 1 month ago

diego-aquino commented 1 month ago

We could simplify our API to consider type: 'local' by default when creating an interceptor, making type an optional parameter.

Pros:

Simpler to get started;
Less mental overhead of comparing local vs remote interceptors when just starting with Zimic;
Will work in most testing scenarios.

Cons:

Users might never realize that type: 'remote' exists

To help with the only con I see, we could improve our documentation to encourage starting with a local interceptor, without passing any type, and point to other pages explaining advanced use cases with local and remote interceptors.

emanamoura commented 2 weeks ago

I think it is a nice thing to do, this appears to me a good first contribution, is this task open to contribute ?

diego-aquino commented 2 weeks ago

Hey, @emanamoura! Thanks for the interest in contributing to Zimic!

Right now, I'm working on the following issues to make it easier to contribute:

The most important one is the contributing guide showing how to fork and run the project, an overview of the packages and architecture, and our philosophies and guidelines. Would you like to wait for them before taking implementation tasks?

I expect to add the contributing guide and the issues/discussions templates by next week.

In the meantime, there are two tasks related to the documentation and the examples that may be good first issues too. Let me know if you are interested in working on them.

emanamoura commented 2 weeks ago

Hi @diego-aquino , yes ! I can wait. Could I get https://github.com/zimicjs/zimic/issues/406 ?