Ignore files listed in .mdbookignore during build

[egasimus]

Based on #1908 by @Bergmann89.

This fixes the issues identified by @ehuss, except for the updated copy_files_except_ext function:

Since this is a public API, the API can't change. I think you will need to create a new function. Also, the naming would no longer be appropriate (_ext was filtering on extensions, and this is now filtering on ignore).

I would like to discuss that.

the naming would no longer be appropriate

Agreed, I'd call it just copy_files

I think you will need to create a new function.

In which case copy_files_except_ext would be orphaned within the mdBook codebase - as far as I saw, it has a single caller.

Maybe some package that depends on mdbook uses this function, maybe none does; information flows the other way, so we have no way of knowing, and no way of addressing that, except, of course, for... semver (which Cargo helpfully enforces).

Since this is a public API, the API can't change

As far as I understand the semver specification, public API can change as long as the change is denoted by incrementing the major version - except in the case of 0.x versions, where anything goes. Generally, I'm a detractor of using 0.x versions for prolonged periods of time, exactly for this reason.

Maybe, after adding much-awaited support for .mdbookignore, it would be a good time to release a 1.0.0, and start harnessing the full benefits of the semver standard by tracking breaking changes in the major version? That's what it's for 🤷

[ehuss]

Regarding the semver compatibility: Yea, the API can change across semver-incompatible releases, but we have to minimize the semver-incompatible releases because they affect plugins (plugins may need to be updated in order to use the new release). We will eventually plan to release a 0.5 release, which will likely include a variety of API changes, but it will likely be a while before that is ready. In order to avoid waiting for that, you can add new functions and avoid changing existing ones. Any stale functions can be removed in the next semver-breaking release (0.5).

[Bergmann89]

Hey @egasimus, this problem came up to me again. I've pulled your changes and rebased on the latest master. I've also made you a contributor on my fork, so that we are able to work on the same PR.

[pnkfelix]

Hey @egasimus and @Bergmann89 , it sounds to me like this PR could get over the finish line if it is "just" changed to avoid the API-breaking change to copy_files_except_ext, by adding a new function.

I'm willing to look into make that additional change here, but I figured I'd ask if either of you two want to take that on first, rather than stepping on your toes.

[Bergmann89]

Hey @pnkfelix,

currently I have no time to work on this, but I've added you as a collaborator to my fork. Feel free to finish the work.

Greetings, Bergmann.

[egasimus]

Same here! I can't make the context switch into this right now (dammit >_<), but by all means do proceed @pnkfelix, it would be awesome for anyone to finalize this! 🚀

[Razer6]

Whats the state of this PR? I sitting in front of the same problem. I am happy to take a look and bring it to the finish line if needed.

[Bergmann89]

Hey @Razer6,

I've added the changes from @egasimus to the original PR (#1908) a while ago, but unfortunately I din't had time to finish it. I added you as a collaborator to my fork. Feel free to finish the PR.

Greetings.