Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed naming to match ZIM naming conventions. #26

Merged
merged 1 commit into from
Sep 24, 2024
Merged

Conversation

josephlewis42
Copy link
Collaborator

@josephlewis42 josephlewis42 commented Sep 19, 2024

Adds a flag for file names and two new placeholders to format names in a way that is expected for ZIMFarm produced ZIMs.

Fixes #15

Example run showing the new names:

$ devdocs2zim --output /tmp/devdocs/ --slug lua~5.4 --debug
[devdocs2zim::2024-09-19 09:05:19,601] DEBUG:Fetching https://devdocs.io/docs.json
[devdocs2zim::2024-09-19 09:05:20,323] INFO:Fetching common CSS...
[devdocs2zim::2024-09-19 09:05:20,323] DEBUG:Fetching https://devdocs.io/application.css
[devdocs2zim::2024-09-19 09:05:20,755] DEBUG:  Found app CSS with 111511 chars.
[devdocs2zim::2024-09-19 09:05:20,756] INFO:Generating ZIM for lua~5.4
[devdocs2zim::2024-09-19 09:05:20,757] INFO:  Writing to: /tmp/devdocs/devdocs.io_en_lua-5.4_2024-09.zim

Copy link

codecov bot commented Sep 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.70%. Comparing base (653029f) to head (a7b7e5d).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #26      +/-   ##
==========================================
+ Coverage   92.61%   92.70%   +0.08%     
==========================================
  Files           4        4              
  Lines         325      329       +4     
  Branches       44       44              
==========================================
+ Hits          301      305       +4     
  Misses         22       22              
  Partials        2        2              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@benoit74 benoit74 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, only one small typo. Good job.

Please amend your commit and force push, no need to have two commits. I will merge right after.

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@benoit74 benoit74 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@benoit74 benoit74 merged commit abf16af into main Sep 24, 2024
5 checks passed
@benoit74 benoit74 deleted the jl/feat/names branch September 24, 2024 07:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Revisit default ZIM name and filename
2 participants