.gitignore exclude folder but include specific subfolder

Question

I have a folder application/, which I add to the .gitignore.
Inside the application/-folder there is a folder application/language/gr.

How can I include this folder?

I've tried this:

application/
!application/language/gr/

Latini

Hopefully, the ".gitignore pattern format" documentation just got clearer (December 2013). See my answer below – Viscountcy

My favorite question and answer, added to favorites as well as to browser bookmarks. – Preconize

See also How do I tell Git to ignore everything except a subdirectory? – Hyunhz

Answer 1

If you exclude application/, then everything under it will always be excluded (even if some later negative exclusion pattern (“unignore”) might match something under application/).

To do what you want, you have to “unignore” every parent directory of anything that you want to “unignore”. Usually you end up writing rules for this situation in pairs: ignore everything in a directory, but not some certain subdirectory.

# you can skip this first one if it is not already excluded by prior patterns
!application/

application/*
!application/language/

application/language/*
!application/language/gr/

Note
The trailing /* is significant:

• The pattern dir/ excludes a directory named dir and (implicitly) everything under it.
  With dir/, Git will never look at anything under dir, and thus will never apply any of the “un-exclude” patterns to anything under dir.
• The pattern dir/* says nothing about dir itself; it just excludes everything under dir. With dir/*, Git will process the direct contents of dir, giving other patterns a chance to “un-exclude” some bit of the content (!dir/sub/).

Companionate

Are the trailing asterisks significant? If so, what's the difference in meaning? Per the algorithm described in the gitignore documentation, ending with a trailing slash matches a directory and paths beneath that directory. Ending with an asterisk would then fall to treatment as a glob pattern. Experimenting shows the asterisk variant to work, but not the one ending in just a trailing slash. I'd like to understand why that's so. – Grundyism

@seh: Yes, the trailing /* is significant. If a directory is excluded, Git will never look at the contents of that directory. The pattern dir/ excludes a directory named dir and (implicitly) everything under it. The pattern dir/* says nothing about dir itself; it just excludes everything under dir. With dir/, Git will never look at anything under dir, and thus will never apply any of the “un-exclude” patterns to anything under dir. With dir/*, Git will process the direct contents of dir, giving other patterns a chance to “un-exclude” some bit of the content (!dir/sub/). – Companionate

Ah, that explains it. No matter how many times I've read the gitignore documentation, I never understood when the reverted patterns don't work. With your explanation, it's now clear. The gitignore documentation needs a "recipe" section to explain how to do this. – Grundyism

Why on earth doesn't git just assume the trailing asterisk if the line points to a directory? Just adding that asterisk fixed the problem I was having and made git behave as expected! – School

Also note that until .gitignore is STAGED the changes will not show on your working copy. I sometimes forget that! – Matutinal

@School If the directory implied an asterisk then the first line would exempt all files in that directory from being ignored, even ones that should be ignored by other rules. – Periodical

For me, skipping the first line works all the time, no need for the !application/. !application/language/ overrules application/*. It does not overrule application/. – Billbug

I couldn't quite get this to work (crazy .gitignore file!), so instead I just force-added the files after cd'ing to the directory I wanted. git add -f . – Proximate

@Koda: force-adding works to a point -- the danger is that if you later add extra files to a directory that you force-added, they will not be included by default (you will have to explicitly force-add the new files as well, and it's easy to forget to do this). Getting the ignore exclusions correct avoids this problem. – Sambo

Note that you can't rely on the output of git status, which will just tell you that the top level directory is going to be added. Instead, do a git add of the top level directory and then git status will (hopefully) list the subset of files that have been matched by the pattern. – Freeze

Does not work for git version 2.10.2.windows.1. – Desiraedesire

I also found that the git status output can be miss-leading. I tried various ways to add the /.config/ranger folder but the git status can only show /.config. If I run git add then the /.config/ranger folder is actually added. – Yun

So the non-asterisk is recursive but doesn't allow exclusions, while the asterisk version is non-recursive but does allow exclusions? – Circadian

Quite convoluted, but functional – Explode

Adding /public/img/* and !/public/img/*/ worked perfectly for me. Ignoring the contents in the img directory, but not any of its subdirectories. – Obsequent

@ChrisJohnsen I don't seem this working when I need to ignore application/* from all root folder/sub-folders but unignore same directory inside particular path i.e. thirdparty. I am using following .gitignore application/* !thirdparty/**/application/ – Osteoblast

can't understand why this nonsense. regex would make gitignore much easier – Sisterhood

There is a "simple" principle guiding how gitignore works, but unfortunately, it's not consistent with how things are committed, which means our intuition works against us here. But if you can understand it then almost any ignoring pattern can be achieved without much effort. I tried to explain it here: https://mcmap.net/q/12119/-gitignore-ignore-all-files-in-folder-hierarchy-except-one-specific-filetype – Shepperd

Answer 2

Commit 59856de from Karsten Blees (kblees) for Git 1.9/2.0 (Q1 2014) clarifies that case:

gitignore.txt: clarify recursive nature of excluded directories

An optional prefix "!" which negates the pattern; any matching file excluded by a previous pattern will become included again.

It is not possible to re-include a file if a parent directory of that file is excluded. (*)
(*: unless certain conditions are met in git 2.8+, see below)
Git doesn't list excluded directories for performance reasons, so any patterns on contained files have no effect, no matter where they are defined.

Put a backslash ("\") in front of the first "!" for patterns that begin with a literal "!", for example, "\!important!.txt".

Example to exclude everything except a specific directory foo/bar (note the /* - without the slash, the wildcard would also exclude everything within foo/bar):

 --------------------------------------------------------------
     $ cat .gitignore
     # exclude everything except directory foo/bar
     /*
     !/foo
     /foo/*
     !/foo/bar
 --------------------------------------------------------------

In your case:

application/*
!application/**/
application/language/*
!application/language/**/
!application/language/gr/**

You must white-list folders first, before being able to white-list files within a given folder.

---

Update Feb/March 2016:

Note that with git 2.9.x/2.10 (mid 2016?), it might be possible to re-include a file if a parent directory of that file is excluded if there is no wildcard in the path re-included.

Nguyễn Thái Ngọc Duy (pclouds) is trying to add this feature:

• commit 506d8f1 for git v2.7.0, reverted in commit 76b620d git v2.8.0-rc0
• commit 5e57f9c git v2.8.0-rc0,... reverted(!) in commit 5cee3493 git 2.8.0.

So with git 2.9+, this could have actually worked, but was ultimately reverted:

application/
!application/language/gr/

Viscountcy

I tried to use the updated re-include syntax posted at the end of your answer on git for windows v2.8.1.windows.1 but it does not appear to work :( – Capitation

@DavidHancock Sorry, I have edited the answer: this is not available yet. – Viscountcy

Thanks for clearing that up. I have a monstrous .gitignore at the minute. I hope this makes it into 2.9. – Capitation

@DavidHancock me too: that is more than 13 Stack Overflow answers that I had to edit multiple times over! – Viscountcy

Git 2.9 was released yesterday. Confirming the application/ + !application/language/gr/ pattern mentioned in the answer is working as expected. – Tiptop

@RayShan Strange: I have see the revert commit cancelling that feature, but I haven't see (and the release note github.com/git/git/blob/master/Documentation/RelNotes/2.9.0.txt does not mention) any commit improving the .gitignore rules. – Viscountcy

Does not work for git version 2.10.2.windows.1. – Desiraedesire

@Desiraedesire Yes, it still does not work, and I have edited the answer to make it clearer. – Viscountcy

Answer 3

@Chris Johnsen's answer is great, but with a newer versions of Git (1.8.2 or later), there is a double asterisk pattern you can leverage for a bit more shorthand solution:

# assuming the root folder you want to ignore is 'application'
application/**/*

# the subfolder(s) you want to track:
!application/language/gr/

This way you don't have to "unignore" parent directory of the subfolder you want to track.

---

With Git 2.17.0 (Not sure how early before this version. Possibly back to 1.8.2), using the ** pattern combined with excludes for each subdirectory leading up to your file(s) works. For example:

# assuming the root folder you want to ignore is 'application'
application/**

# Explicitly track certain content nested in the 'application' folder:
!application/language/
!application/language/gr/
!application/language/gr/** # Example adding all files & folder in the 'gr' folder
!application/language/gr/SomeFile.txt # Example adding specific file in the 'gr' folder

Ethiopian

Alas, this fails (Git 1.8.4.msysgit.0) because the pattern ** can match zero subfolders, and * will match language and exclude it, preventing inclusion of gr. The full chain of parents @Chris Johnson recommends seems necessary still. – Urge

Sounds perfect but it doesn't work for me on git 2.3.7 ... /www/**/* !/www/config.xml !/www/res config.xml and the res directory are still ignored. – Deafening

@Deafening you need to also add !/www/res/. You can use the folder/**/* pattern, but you still need to add excludes for each subdirectory you want added. It's still shorter and more readable than the ignore/exclude combo. – Bushhammer

I know that's an old comment, but in case you are curious. I've added an edit to the answer documenting this approach. – Bushhammer

Answer 4

I've found only this actually works.

**/node_modules/*
!**/node_modules/keep-dir

Premillennial

Answer 5

There are a bunch of similar questions about this, so I'll post what I wrote before:

The only way I got this to work on my machine was to do it this way:

# Ignore all directories, and all sub-directories, and it's contents:
*/*

#Now ignore all files in the current directory 
#(This fails to ignore files without a ".", for example 
#'file.txt' works, but 
#'file' doesn't):
*.*

#Only Include these specific directories and subdirectories:
!wordpress/
!wordpress/*/
!wordpress/*/wp-content/
!wordpress/*/wp-content/themes/
!wordpress/*/wp-content/themes/*
!wordpress/*/wp-content/themes/*/*
!wordpress/*/wp-content/themes/*/*/*
!wordpress/*/wp-content/themes/*/*/*/*
!wordpress/*/wp-content/themes/*/*/*/*/*

Notice how you have to explicitly allow content for each level you want to include. So if I have subdirectories 5 deep under themes, I still need to spell that out.

This is from @Yarin's comment here: https://mcmap.net/q/11501/-using-gitignore-to-ignore-everything-but-specific-directories

These were useful topics:

• How do negated patterns work in .gitignore?
• How do gitignore exclusion rules actually work?

I also tried

*
*/*
**/**

and **/wp-content/themes/**

or /wp-content/themes/**/*

None of that worked for me, either. Lots of trial and error!

Abernethy

Note: Remember that order does matter in a .gitignore file too, so make sure you put your ! rules at the bottom. – Prytaneum

this is more embarrassing than javascript as a language itself. why on earth are there so many different and absurd answers for such a simple problem? (I'm being critical of git, not your solution). And no, git is not bad, but it has some bad parts. – Bertiebertila

Answer 6

The simplest and probably best way is to try adding the files manually (generally this takes precedence over .gitignore-style rules):

git add /path/to/module

You might need -f if the file is already ignored. You may even want the -N intent to add flag, to suggest you will add them, but not immediately. I often do this for new files I’m not ready to stage yet.

---

This a copy of an answer posted on what could easily be a duplicate QA. I am reposting it here for increased visibility—I find it easier not to have a mess of gitignore rules.

Tildy

Answer 7

I wanted to track Nagios configuration files located in /etc/nagios/ together with the plugins in /usr/lib64/nagios/plugins/. For this I have initialized a git repo in / and used the following exclusion list:

/*
!etc
etc/*
!etc/nagios
!usr
usr/*
!usr/lib64
usr/lib64/*
!usr/lib64/nagios
usr/lib64/nagios/*
!usr/lib64/nagios/plugins

Git walks down the list like that:

/*             exclude everything under / ...
!etc           but include /etc back
etc/*             exclude everything under /etc/...
!etc/nagios       but include /etc/nagios back
!usr           but include /usr back
usr/*             exclude everything under /usr/...
                  and so on...

Feudalize

git add node_modules/.vite/deps/HavokPhysics.wasm -f – Carberry

Answer 8

add a file named .gitignore to subfolder, then fill with

!/Bin/

this works for me!

Brazzaville

Answer 9

I have found a similar case here, where in laravel by default, .gitignore ignores all using asterix, then overrides the public directory. ( This is also the same solution as the main answer @Chris Johnsen, just a bit thinner and more concise maybe.)

*
!public
!.gitignore

This is not sufficient if you run into the OP scenario.

If you want to commit a specific subfolders of public, say for e.g. in your public/products directory you want to include files that are one subfolder deep e.g. to include public/products/a/b.jpg they wont be detected correctly, even if you add them specifically like this !/public/products, !public/products/*, etc..

The solution is to make sure you add an entry for every path level like this to override them all.

*
!.gitignore
!public/
!public/*/
!public/products/
!public/products/*
!public/products/*/
!public/products/*/
!public/products/*/*

Boyett

Answer 10

My JetBrains IntelliJ IDEA .gitignore-configuration, where I need to exclude whole .idea folder except .idea/runConfigurations:

.idea
!.idea/
.idea/*
!.idea/runConfigurations/

Further details:
https://github.com/daggerok/gitignore-idea-runConfigurations#exclude-idea-except-idearunconfigurations

Rodriguez

BTW, for me it was enough to use .idea/* and !.idea/runConfigurations/. No need to to write .idea and !.idea/. – Emlin

Answer 11

gitignore - Specifies intentionally untracked files to ignore.

Example to exclude everything except a specific directory foo/bar (note the /* - without the slash, the wildcard would also exclude everything within foo/bar):

$ cat .gitignore
# exclude everything except directory foo/bar
/*
!/foo
/foo/*
!/foo/bar

Another example for WordPress:

!/wp-content
wp-content/*
!/wp-content/plugins
wp-content/plugins/*
!wp-content/plugins/my-awesome-plugin

More informations in here: https://git-scm.com/docs/gitignore

Lunde

Answer 12

So , since many programmers uses node . the use case which meets this question is to exclude node_modules except one module module-a for example:

!node_modules/

node_modules/*
!node_modules/module-a/

Mccormick

Does not work for git version 2.10.2.windows.1. – Desiraedesire

For git version 2.10.2 follow this answer – Ruvolo

Answer 13

Add an additional answer:

!/.vs/              <== include this folder to source control, folder only, nothing else
/.vs/*              <== but ignore all files and sub-folder inside this folder
!/.vs/ProjectSettings.json <== but include this file to source control
!/.vs/config/       <== then include this folder to source control, folder only, nothing else
!/.vs/config/*      <== then include all files inside the folder

here is result:

Hanselka

Answer 14

This worked for me:

**/.idea/**
!**/.idea/copyright/
!.idea/copyright/profiles_settings.xml
!.idea/copyright/Copyright.xml

Modeling

This is the correct answer. the ** did it. – Aceae

Answer 15

Especially for the older Git versions, most of the suggestions won't work that well. If that's the case, I'd put a separate .gitignore in the directory where I want the content to be included regardless of other settings and allow there what is needed.

For example: /.gitignore

# ignore all .dll files
*.dll

/dependency_files/.gitignore

# include everything
!*

So everything in /dependency_files (even .dll files) are included just fine.

Eatable

Answer 16

In WordPress, this helped me:

wp-admin/
wp-includes/
/wp-content/*
!wp-content/plugins/
/wp-content/plugins/*
!/wp-content/plugins/plugin-name/
!/wp-content/plugins/plugin-name/*.*
!/wp-content/plugins/plugin-name/**

Trunks

Answer 17

Just another example of walking down the directory structure to get exactly what you want. Note: I didn't exclude Library/ but Library/**/*

# .gitignore file
Library/**/*
!Library/Application Support/
!Library/Application Support/Sublime Text 3/
!Library/Application Support/Sublime Text 3/Packages/
!Library/Application Support/Sublime Text 3/Packages/User/
!Library/Application Support/Sublime Text 3/Packages/User/*macro
!Library/Application Support/Sublime Text 3/Packages/User/*snippet
!Library/Application Support/Sublime Text 3/Packages/User/*settings
!Library/Application Support/Sublime Text 3/Packages/User/*keymap
!Library/Application Support/Sublime Text 3/Packages/User/*theme
!Library/Application Support/Sublime Text 3/Packages/User/**/
!Library/Application Support/Sublime Text 3/Packages/User/**/*macro
!Library/Application Support/Sublime Text 3/Packages/User/**/*snippet
!Library/Application Support/Sublime Text 3/Packages/User/**/*settings
!Library/Application Support/Sublime Text 3/Packages/User/**/*keymap
!Library/Application Support/Sublime Text 3/Packages/User/**/*theme

> git add Library

> git status

On branch master
Your branch is up-to-date with 'origin/master'.
Changes to be committed:
  (use "git reset HEAD <file>..." to unstage)

    new file:   Library/Application Support/Sublime Text 3/Packages/User/Default (OSX).sublime-keymap
    new file:   Library/Application Support/Sublime Text 3/Packages/User/ElixirSublime.sublime-settings
    new file:   Library/Application Support/Sublime Text 3/Packages/User/Package Control.sublime-settings
    new file:   Library/Application Support/Sublime Text 3/Packages/User/Preferences.sublime-settings
    new file:   Library/Application Support/Sublime Text 3/Packages/User/RESTer.sublime-settings
    new file:   Library/Application Support/Sublime Text 3/Packages/User/SublimeLinter/Monokai (SL).tmTheme
    new file:   Library/Application Support/Sublime Text 3/Packages/User/TextPastryHistory.sublime-settings
    new file:   Library/Application Support/Sublime Text 3/Packages/User/ZenTabs.sublime-settings
    new file:   Library/Application Support/Sublime Text 3/Packages/User/adrian-comment.sublime-macro
    new file:   Library/Application Support/Sublime Text 3/Packages/User/json-pretty-generate.sublime-snippet
    new file:   Library/Application Support/Sublime Text 3/Packages/User/raise-exception.sublime-snippet
    new file:   Library/Application Support/Sublime Text 3/Packages/User/trailing_spaces.sublime-settings

Colum

Answer 18

Similar to this comment, none of the solutions and patterns worked for me; forcing git to add the files and folders that should be excluded, worked:

git add -f .

Apples

Answer 19

I wanted to track jquery production js files and this worked:

node_modules/*
!node_modules/jquery
node_modules/jquery/*
!node_modules/jquery/dist/*

Gape

Answer 20

I often use this workaround in CLI where instead of configuring my .gitignore, I create a separate .include file where I define the (sub)directories I want included in spite of directories directly or recursively ignored by .gitignore.

Thus, I additionally use

git add `cat .include`

during staging, before committing.

To the OP, I suggest using a .include which has these lines:

<parent_folder_path>/application/language/gr/*

NOTE: Using cat does not allow usage of aliases (within .include) for specifying $HOME (or any other specific directory). This is because the line homedir/app1/* when passed to git add using the above command appears as git add 'homedir/app1/*', and enclosing characters in single quotes ('') preserves the literal value of each character within the quotes, thus preventing aliases (such as homedir) from functioning (see Bash Single Quotes).

Here is an example of a .include file I use in my repo here.

/home/abhirup/token.txt
/home/abhirup/.include
/home/abhirup/.vim/*
/home/abhirup/.viminfo
/home/abhirup/.bashrc
/home/abhirup/.vimrc
/home/abhirup/.condarc

Referent