Ignore files listed in `.mdbookignore` during build #1908

Bergmann89 · 2022-10-13T14:01:31Z

Implementation according to issue #1187 and #1156

ehuss · 2022-10-13T23:25:15Z

Thanks for the PR! Per the comment at #1187 (comment), can this be a setting in book.toml instead?

Bergmann89 · 2022-10-14T07:11:52Z

I can add this to the config too, but I would like to have this feature as ignore file.

schungx · 2022-10-14T07:19:17Z

An ignore file has the benefit of not polluting the main config file and so it can really be done on a user-by-user basis.

The pitfall is... of course... yet another file.

Bergmann89 · 2022-10-14T09:35:25Z

Just realized, that the gitignore crate has a bug :/ The following patterns will not ignore any file, but it should ignore everything except the mdbook-plantuml-img directory:

/*
!mdbook-plantuml-img

gitignore was not maintained since two years. Maybe it's better to have an own implementation for the ignore files or use the config only. If we add this to the config, it would be nice to have a setting for include and a exclude.

Bergmann89 · 2022-10-14T10:40:29Z

The ignore crate work as expected.

Bergmann89 · 2022-10-14T11:10:09Z

I've pushed a new version that uses the ignore crate instead of gitignore.

With the ignore crate we can do some further improvements:

Remove the custom implementation of file walk copy_files_except_ext with ignore::Walk which will have the benefit, that also ignore files in the sub directories will be evaluated.
Use ignore::Walk to evaluate all .gitignore files (not only in the root directory) to filter files in the watch command.

ehuss · 2022-10-15T21:36:49Z

Ok, seems fair to have a separate file. I personally prefer to keep things in one place, and to not have too many files, just to keep things simple (there's one place to describe the config).

I think switching to ignore sounds great.

Can you add some documentation and tests?

Bergmann89 · 2022-11-03T16:48:23Z

Any remarks? Or can we merge this? :)

ehuss

Overall I'm finding the difference between .gitignore and .mdbookignore a little confusing.

I'm guessing that watch does not ignore .mdbookignore files for a reason? Can you say more about why that choice was made?

ehuss · 2023-01-16T14:50:23Z

src/utils/fs.rs

@@ -94,13 +95,13 @@ pub fn copy_files_except_ext(
    to: &Path,
    recursive: bool,
    avoid_dir: Option<&PathBuf>,
-    ext_blacklist: &[&str],


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).

Done. I've added a new public function copy_files_except_ignored that is called by copy_files_except_ext to not have code duplication.

ehuss · 2023-01-16T14:51:10Z

src/book/mod.rs

@@ -856,4 +857,21 @@ mod tests {
        let got = preprocessor_should_run(&BoolPreprocessor(should_be), &html, &cfg);
        assert_eq!(got, should_be);
    }
+
+    #[test]
+    fn build_test_book() {


Since this test's intent is to validating the mdbookingore behavior, I think it is good to make sure the name reflects that.

Suggested change

fn build_test_book() {

fn mdbookignore_ignores_file() {

ehuss · 2023-01-16T14:53:19Z

src/utils/fs.rs

+            if let Some(ignore) = ignore {
+                let path = entry.path();
+                if ignore.matched(&path, path.is_dir()).is_ignore() {
+                    continue;
+                }
+            }


Since this clause is identical to the one below, can it be moved up out of the if clause and unified?

ehuss · 2023-01-16T15:07:23Z

guide/src/format/configuration/renderers.md

@@ -279,6 +279,16 @@ The value can be any valid URI the browser should navigate to (e.g. `https://rus
 This will generate an HTML page which will automatically redirect to the given location.
 Note that the source location does not support `#` anchor redirects.

+### `[.mdbookignore]`
+
+You can use a `.mdbookignore` file to exclude files from the build process. The file is places in the `src` directory of your book and has the format known from [`.gitignore`](https://git-scm.com/docs/gitignore) files.


Suggested change

You can use a `.mdbookignore` file to exclude files from the build process. The file is places in the `src` directory of your book and has the format known from [`.gitignore`](https://git-scm.com/docs/gitignore) files.

You can use a `.mdbookignore` file to exclude files from the build process. The file is placed in the `src` directory of your book and has the same format as [`.gitignore`](https://git-scm.com/docs/gitignore) files.

Also, can you split it to one sentence per line to make diffs easier to manage?

ehuss · 2023-01-16T15:07:54Z

guide/src/format/configuration/renderers.md

@@ -279,6 +279,16 @@ The value can be any valid URI the browser should navigate to (e.g. `https://rus
 This will generate an HTML page which will automatically redirect to the given location.
 Note that the source location does not support `#` anchor redirects.

+### `[.mdbookignore]`


I'm not sure why this is in square brackets. The other sections are like that because they are describing TOML sections of book.toml.

Suggested change

### `[.mdbookignore]`

### `.mdbookignore`

Bergmann89 · 2023-01-18T07:26:19Z

Overall I'm finding the difference between .gitignore and .mdbookignore a little confusing.

What exactly? We can also add this to the config if you want to, but I need any solution to ignore specific files processed by mdbook.

I'm guessing that watch does not ignore .mdbookignore files for a reason? Can you say more about why that choice was made?

Should not. If this is the case, this is a mistake on my side. I will check this.

I'm currently really busy in my own projects. I will resolve all of your findings once I have some more time for this. This may take a couple of weeks.

Greetings,
Bergmann89.

ehuss · 2023-01-18T14:20:09Z

What exactly? We can also add this to the config if you want to, but I need any solution to ignore specific files processed by mdbook.

There is a subtle difference between them (as indicated by the confusion around watch). gitignore files are copied, but not watched. mdbookignore files are not copied but are watched. The documentation doesn't make the differences clear to me, or explain why one would use one over the other. I might suggest in places where gitignore is mentioned in the documentation to make links to the mdbookignore section ("gitignore will only affect which files are watched for changes. To avoid copying certain source files to the output, see [mdbookignore]" or something like that).

I'm also wondering if copying should also avoid git ignored files. However, I think that will require opening the git repo and verifying which files are actually ignored similar to how Cargo itself works, but that is a pretty big hairy mess.

egasimus · 2023-08-23T04:02:23Z

Any news of this? Would be happy to help

Bergmann89 · 2023-08-23T06:47:45Z

Sorry, I had no time to make this ready yet. Feel free to fix the findings above :)

Bergmann89 · 2024-07-26T06:20:34Z

@ehuss I (finally) had some time to resolve the findings and rebased to the current master. Might there be some time for another review? :)

Bergmann89 force-pushed the master branch 4 times, most recently from 7f6adc7 to 92b89b5 Compare October 13, 2022 14:31

Bergmann89 force-pushed the master branch from 92b89b5 to 08466df Compare October 14, 2022 11:03

Bergmann89 force-pushed the master branch 3 times, most recently from 74fb51e to f144b57 Compare October 14, 2022 12:12

brettchalupa mentioned this pull request Oct 16, 2022

Prefere .bookignore when build too #1912

Open

Bergmann89 force-pushed the master branch from 732a67a to 244bb4c Compare October 17, 2022 08:43

ehuss mentioned this pull request Jan 3, 2023

Build even when broken symlinks are present #1944

Open

ehuss reviewed Jan 16, 2023

View reviewed changes

ehuss added the S-waiting-on-author Status: The marked PR is awaiting some action (such as code changes) from the PR author. label Jan 16, 2023

egasimus mentioned this pull request Sep 3, 2023

Ignore files listed in .mdbookignore during build #2183

Open

ehuss added the A-ignore Area: gitignore, ignoring files label Feb 25, 2024

Bergmann89 force-pushed the master branch 3 times, most recently from 79829cd to 3d838ef Compare March 7, 2024 12:31

Bergmann89 force-pushed the master branch from 3d838ef to 2385a9b Compare July 24, 2024 13:53

Bergmann89 mentioned this pull request Aug 21, 2024

Respect the .gitignore and .mdbookignore files max-heller/mdbook-pandoc#111

Open

Bergmann89 and others added 7 commits December 19, 2024 09:53

Ignore files listed in .mdbookignore during build

b081eca

Add documentation and unit tests for .mdbookignore

a885769

docs(mdbookignore): add manual line breaks

5b1ec0b

test(mdbookignore): rename test case

a3dfab9

refactor(utils/fs): hoist ignore conditional

b459b9f

Implement copy_files_except_ignore to not break the public API

98008f8

Make ignore a mandatory dependency

64cb09d

Bergmann89 force-pushed the master branch from 4742735 to 64cb09d Compare December 19, 2024 08:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ignore files listed in `.mdbookignore` during build #1908

Ignore files listed in `.mdbookignore` during build #1908

Bergmann89 commented Oct 13, 2022

ehuss commented Oct 13, 2022

Bergmann89 commented Oct 14, 2022

schungx commented Oct 14, 2022

Bergmann89 commented Oct 14, 2022

Bergmann89 commented Oct 14, 2022

Bergmann89 commented Oct 14, 2022

ehuss commented Oct 15, 2022

Bergmann89 commented Nov 3, 2022

ehuss left a comment

ehuss Jan 16, 2023

Bergmann89 Jul 24, 2024

ehuss Jan 16, 2023

Bergmann89 Jul 24, 2024

ehuss Jan 16, 2023

Bergmann89 Jul 24, 2024

ehuss Jan 16, 2023

Bergmann89 Jul 24, 2024

ehuss Jan 16, 2023

Bergmann89 Jul 24, 2024

Bergmann89 commented Jan 18, 2023

ehuss commented Jan 18, 2023

egasimus commented Aug 23, 2023

Bergmann89 commented Aug 23, 2023

Bergmann89 commented Jul 26, 2024

	You can use a `.mdbookignore` file to exclude files from the build process. The file is places in the `src` directory of your book and has the format known from [`.gitignore`](https://git-scm.com/docs/gitignore) files.
	You can use a `.mdbookignore` file to exclude files from the build process. The file is placed in the `src` directory of your book and has the same format as [`.gitignore`](https://git-scm.com/docs/gitignore) files.

Ignore files listed in .mdbookignore during build #1908

Are you sure you want to change the base?

Ignore files listed in .mdbookignore during build #1908

Conversation

Bergmann89 commented Oct 13, 2022

ehuss commented Oct 13, 2022

Bergmann89 commented Oct 14, 2022

schungx commented Oct 14, 2022

Bergmann89 commented Oct 14, 2022

Bergmann89 commented Oct 14, 2022

Bergmann89 commented Oct 14, 2022

ehuss commented Oct 15, 2022

Bergmann89 commented Nov 3, 2022

ehuss left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Bergmann89 commented Jan 18, 2023

ehuss commented Jan 18, 2023

egasimus commented Aug 23, 2023

Bergmann89 commented Aug 23, 2023

Bergmann89 commented Jul 26, 2024

Ignore files listed in `.mdbookignore` during build #1908

Ignore files listed in `.mdbookignore` during build #1908