Comments (3)
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.
- A maintainer doing a force merge, intentionally or unintentionally.
- A bug that causes some pipelines to pass falsely even in this scenario.
- 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.
Related Issues (20)
- > It is a reasonable request. But since the pages are internal to your team, I am wondering how much effort is it to just periodically fetch the master pages and add your local set of pages. If there are multiple remote sources to merge from, that would be a valid request as keeping multiple sources in sync would be difficult. HOT 1
- tldr --update failed HOT 2
- zsh autocompletion fails with: `(eval):1: bad pattern: [[`
- Version 3.3.8 is not available in npm, latest there is 3.3.7 HOT 7
- Language argument support HOT 1
- ENH: Mention number of new commands when doing `tldr -u` and maybe output a list of new commands as well
- Rendered emails become URL-encoded
- Highlight generic path placeholders differently
- Highlight number, string and boolean placeholders differently
- Transition from master to main branch HOT 2
- Permission error when running tldr HOT 1
- Feature request: update only specific languages in cache HOT 1
- Fetch individual translation archives for cache based on the environment variable configuration HOT 2
- Rendered output displays "See also:" line twice HOT 4
- Client specification v2.1 compliance: add placeholder escaping support
- Cannot update cache on Windows
- `tldr --list` output should be not in a single line
- `repository` in the config is not used anymore HOT 1
- Running tldr with a non-existent topic or doing an update causes long freezes HOT 7
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from tldr-node-client.