Ignoring Files
Korbit Defaults
By default, Korbit will ignore files that match the following patterns:
View ignored files
# Test files and directories
test*/
**/test*/
spec/
specs/
**/spec/
**/specs/
**/__tests__/
**/__mocks__/
**/conftest.py
**/karma.conf.js
**/pytest.ini
**/phpunit.xml
*.test.*
*.spec.*
**/test_*
*_test*
*_spec.rb
*.feature
# Others
!/storage/.keep
**/.git/
config/
*/config/
**/vendor/
**pycache**/
**pypackages**/
*.bowerrc
*.d
*.dll
*.h
*.hex
*.lock
*.min.js
*.min.ts
*.pickle
*.so
*.x86*64
.Python
*.pyd
.byebug_history
.cache
.coverage
.coverage._
.dmypy.json
.eggs/
.env*
.hg/
.hypothesis/
.idea/
.installed.cfg
.ipynb_checkpoints
.mtj.tmp/
.mypy_cache/
.nox/
.pdm.toml
.powenv
.pybuilder/
.pyre/
.pytest_cache/
.pytype/
.ropeproject
.rvmrc
.spyderproject
.spyproject
.svn/
.tmp*versions/
.tox/
.venv
.vs/
.vscode/
.webassets-cache
.yarn-integrity
/.bundle
/bower_components/
/build/
/coverage/
/dist/
/log/
/logs/
/node*modules/
/out/
/public/assets
/public/packs
/public/packs-test
/public/uploads
/pycache/
/storage/*
/temp/
/tmp/
/vendor/assets/bower_components
/vendor/bundle
/yarn-error.log
ENV/
MANIFEST
Mkfile.old
Module.symvers
\*.env.example
*.a
*.app
*.class
*.cmd
*.cover
*.ctxt
*.dSYM/
*.dylib
*.ear
*.egg
*.egg-info/
*.elf
*.exe
*.exp
*.gch
*.i*86
*.idb
*.ilk
*.jar
*.ko
*.la
*.lai
*.lib
*.lo
*.log
*.map
*.mo
*.mod
*.mod\*
*.nar
*.o
*.obj
*.out
*.pch
*.pdb
*.pot
*.py,cover
*.slo
*.smod
*.su
*.test
*.war
bower.json
build/
celerybeat-schedule
celerybeat.pid
cover/
coverage.xml
cython_debug/
db.sqlite3
db.sqlite3-journal
develop-eggs/
dist/
dkms.conf
dmypy.json
downloads/
eggs/
env.bak/
env/
go.work
hs*err_pid*
htmlcov/
instance/
ipython_config.py
lib64/
local*settings.py
modules.order
node_modules/
nosetests.xml
package-lock.json
parts/
pip-delete-this-directory.txt
pip-log.txt
profile_default/
replay_pid*
sdist/
share/python-wheels/
target/
var/
venv.bak/
venv/
wheels/
yarn-debug.log*
## Android
## Gradle files
.gradle/
build/
## Android Studio generated files and folders
captures/
.externalNativeBuild/
.cxx/
## IntelliJ
\*.iml
.idea/
misc.xml
deploymentTargetDropDown.xml
render.experimental.xml
## Keystore files
*.jks
*.keystore
## Flutter
### Miscellaneous
*.class
*.lock
*.log
*.pyc
\*.swp
.DS_Store
.atom/
.buildlog/
.history
.svn/
### IntelliJ related
*.iml
*.ipr
\*.iws
.idea/
### Visual Studio Code related
.classpath
.project
.settings/
.vscode/\*
### Flutter repo-specific
/bin/cache/
/bin/internal/bootstrap.bat
/bin/internal/bootstrap.sh
/bin/mingit/
/dev/benchmarks/mega_gallery/
/dev/bots/.recipe_deps
/dev/bots/android_tools/
/dev/devicelab/ABresults\*.json
/dev/docs/doc/
/dev/docs/api_docs.zip
/dev/docs/flutter.docs.zip
/dev/docs/lib/
/dev/docs/pubspec.yaml
/dev/integration_tests/**/xcuserdata
/dev/integration_tests/**/Pods
/packages/flutter/coverage/
version
analysis_benchmark.json
### packages file containing multi-root paths
.packages.generated
### Flutter/Dart/Pub related
**/doc/api/
.dart_tool/
.flutter-plugins
.flutter-plugins-dependencies
**/generated*plugin_registrant.dart
.packages
.pub-preload-cache/
.pub-cache/
.pub/
build/
linked\_\*.ds
unlinked.ds
unlinked_spec.ds
### Android related
**/android/**/gradle-wrapper.jar
.gradle/
**/android/captures/
**/android/gradlew
**/android/gradlew.bat
**/android/local.properties
**/android/**/GeneratedPluginRegistrant.java \*_/android/key.properties
*.jks
### iOS/XCode related
**/ios/**/*.mode1v3
**/ios/**/*.mode2v3
**/ios/**/*.moved-aside
**/ios/**/*.pbxuser
**/ios/**/*.perspectivev3
**/ios/**/*sync/
**/ios/**/.sconsign.dblite
**/ios/**/.tags*
**/ios/**/.vagrant/
**/ios/**/DerivedData/
**/ios/**/Icon?
**/ios/**/Pods/
**/ios/**/.symlinks/
**/ios/**/profile
**/ios/**/xcuserdata
**/ios/.generated/
**/ios/Flutter/.last_build_id
**/ios/Flutter/App.framework
**/ios/Flutter/Flutter.framework
**/ios/Flutter/Flutter.podspec
**/ios/Flutter/Generated.xcconfig
**/ios/Flutter/ephemeral
**/ios/Flutter/app.flx
**/ios/Flutter/app.zip
**/ios/Flutter/flutter_assets/
**/ios/Flutter/flutter_export_environment.sh
**/ios/ServiceDefinitions.json
\*\*/ios/Runner/GeneratedPluginRegistrant.*
### macOS
**/Flutter/ephemeral/
**/Pods/
**/macos/Flutter/GeneratedPluginRegistrant.swift
**/macos/Flutter/ephemeral
\*\*/xcuserdata/
### Windows
**/windows/flutter/generated_plugin_registrant.cc
**/windows/flutter/generated_plugin_registrant.h
\*\*/windows/flutter/generated_plugins.cmake
### Linux
**/linux/flutter/generated_plugin_registrant.cc
**/linux/flutter/generated_plugin_registrant.h
\*\*/linux/flutter/generated_plugins.cmake
### Coverage
coverage/
### Exceptions to above rules.
!**/ios/**/default.mode1v3
!**/ios/**/default.mode2v3
!**/ios/**/default.pbxuser
!**/ios/**/default.perspectivev3
!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages
!/dev/ci/**/Gemfile.lock
# Rust
## Generated by Cargo will have compiled files and executables
debug/
target/
# Images
*.ase
*.art
*.bmp
*.blp
*.cd5
*.cit
*.cpt
*.cr2
*.cut
*.dds
*.dib
*.djvu
*.egt
*.exif
*.gif
*.gpl
*.grf
*.icns
*.ico
*.iff
*.jng
*.jpeg
*.jpg
*.jfif
*.jp2
*.jps
*.lbm
*.max
*.miff
*.mng
*.msp
*.nef
*.nitf
*.ota
*.pbm
*.pc1
*.pc2
*.pc3
*.pcf
*.pcx
*.pdn
*.pgm
*.PI1
*.PI2
*.PI3
*.pict
*.pct
*.pnm
*.pns
*.ppm
*.psb
*.psd
*.pdd
*.psp
*.px
*.pxm
*.pxr
*.qfx
*.raw
*.rle
*.sct
*.sgi
*.rgb
*.int
*.bw
*.tga
*.tiff
*.tif
*.vtf
*.xbm
*.xcf
*.xpm
*.3dv
*.amf
*.ai
*.awg
*.cgm
*.cdr
*.cmx
*.dxf
*.e2d
*.egt
*.eps
*.fs
*.gbr
*.odg
*.svg
*.stl
*.vrml
*.x3d
*.sxd
*.v2d
*.vnd
*.wmf
*.emf
*.art
*.xar
*.png
*.webp
*.jxr
*.hdp
*.wdp
*.cur
*.ecw
*.iff
*.lbm
*.liff
*.nrrd
*.pam
*.pcx
*.pgf
*.sgi
*.rgb
*.rgba
*.bw
*.int
*.inta
*.sid
*.ras
*.sun
*.tga
*.heic
*.heif
# Unity
*.fbx
# Videos
*.webm
*.mkv
*.flv
*.vob
*.ogv
*.ogg
*.rrc
*.gifv
*.mng
*.mov
*.avi
*.qt
*.wmv
*.yuv
*.rm
*.asf
*.amv
*.mp4
*.m4p
*.m4v
*.mpg
*.mp2
*.mpeg
*.mpe
*.mpv
*.m4v
*.svi
*.3gp
*.3g2
*.mxf
*.roq
*.nsv
*.flv
*.f4v
*.f4p
*.f4a
*.f4b
*.mod
# Binary
*.pkl
*.pkg
*.dmg
*.exe
*.bin
*/bin/
bin/
# Compressed
# https://www.computerhope.com/jargon/c/compfile.htm
*.arc
*.arj
*.as
*.b64
*.btoa
*.bz
*.bz2
*.cab
*.cpt
*.gz
*.hqx
*.iso
*.lha
*.lzh
*.mim
*.mme
*.pak
*.pf
*.rar
*.rpm
*.sea
*.sit
*.sitx
*.tar.gz
*.tar
*.tbz
*.tbz2
*.tgz
*.uu
*.uue
*.z
*.zip
*.zipx
*.zoo
*.zz
# stylesheets
*.css
*.scss
*.sass
*.less
*.styl
# fonts
*.ttf
*.otf
*.woff
*.woff2
*.eot
# documents
*.pdf
Excluding additional files
To further limit the files that Korbit will scan in PR reviews, you can create a .korbitignore
file in your repository. This file will include rules for ignoring scanned files and operates the same as a .gitignore
file.
- Create a file called
.korbitignore
in the main directory of your repository - follow the same globbing patterns as would in a
.gitignore
to exclude certain files (see below)
Rules
Use wildcards like *
(matches any number of characters) and ?
(matches any single character) to specify patterns for ignoring multiple files or directories.
Specify paths relative to the .korbitignore
file's location. For example, to ignore config.txt
in a data
subdirectory, write data/config.txt
in the file.
By default, patterns only apply to the current directory. To match files in subdirectories, use /
or **/
as prefixes.
Example .korbitignore
file contents:
tests/**/test_*
folder/**/*.js
fake_framework/*