bug: update command breaks when tldr repo has bad merge about tldr-node-client HOT 3 OPEN

I am wondering if we should be adding files that don't adhere to the directory structure in the first place. This should be handled by a CI job in the tldr repo that verifies that the directory structure is not broken. If we can prevent this from happening in the first place, that will be even better. Because otherwise, the client can choose not to update the cache, but then it can never update any further until it has been fixed in the tldr repo.

from tldr-node-client.

I am wondering if we should be adding files that don't adhere to the directory structure in the first place.

We shouldn't, but it's always going to be possible to do. Also, keep in mind this issue isn't just about directory structures either, it's about any unexpected non-network related IO error that could occur.

This should be handled by a CI job in the tldr repo that verifies that the directory structure is not broken. If we can prevent this from happening in the first place, that will be even better.

I agree we should prevent it from happening in the first place, and in Matrix it was already discussed to improve our pipelines. However, other unexpected issues my arise that aren't caught by CI even if this particular scenario is handled.

1. A maintainer doing a force merge, intentionally or unintentionally.
2. A bug that causes some pipelines to pass falsely even in this scenario.
3. A different issue entirely, like linked files, permissions, or any other potential complication that may lead to an IO error.

Software shouldn't trust dependencies fetched at runtime, or assume they'll return exactly what's expected. As far as this repo is concerned, tldr-pages/tldr is an external resource. Things breaking are 100% fine, but the client not resolving or guiding the user on how to run the very updates that would solve it is unsatisfactory imo.

from tldr-node-client.

Yep I agree. The checks should be there in both places.

from tldr-node-client.