Compare commits
12 Commits
main
...
add-metada
Author | SHA1 | Date | |
---|---|---|---|
|
133c57afa5 | ||
|
dc9c75a9f0 | ||
|
7603d71a56 | ||
|
de60b262fc | ||
|
9b955e4787 | ||
|
e734a55eb6 | ||
|
8c48d15ecb | ||
|
13293bc8ac | ||
|
22a63953fb | ||
|
3fe5f882ec | ||
|
677c7abacf | ||
|
74ba388528 |
3
.editorconfig
Normal file
3
.editorconfig
Normal file
@ -0,0 +1,3 @@
|
||||
[*]
|
||||
end_of_line = lf
|
||||
insert_final_newline = true
|
@ -32,16 +32,6 @@ proguard/
|
||||
# Android Studio captures folder
|
||||
captures/
|
||||
|
||||
# IntelliJ
|
||||
*.iml
|
||||
.idea/workspace.xml
|
||||
.idea/tasks.xml
|
||||
.idea/gradle.xml
|
||||
.idea/assetWizardSettings.xml
|
||||
.idea/dictionaries
|
||||
.idea/libraries
|
||||
.idea/caches
|
||||
|
||||
# Keystore files
|
||||
# Uncomment the following line if you do not want to check your keystore files in.
|
||||
#*.jks
|
||||
|
2
Android.yml
Normal file
2
Android.yml
Normal file
@ -0,0 +1,2 @@
|
||||
editors:
|
||||
- Global/JetBrains.gitignore
|
@ -1 +0,0 @@
|
||||
Leiningen.gitignore
|
@ -1 +0,0 @@
|
||||
C++.gitignore
|
@ -1,6 +1,3 @@
|
||||
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
|
||||
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
|
||||
|
||||
# User-specific stuff
|
||||
.idea/**/workspace.xml
|
||||
.idea/**/tasks.xml
|
||||
@ -50,3 +47,6 @@ fabric.properties
|
||||
|
||||
# Editor-based Rest Client
|
||||
.idea/httpRequests
|
||||
|
||||
# Rider-specific rules
|
||||
*.sln.iml
|
||||
|
11
Global/JetBrains.yml
Normal file
11
Global/JetBrains.yml
Normal file
@ -0,0 +1,11 @@
|
||||
aliases:
|
||||
- IntelliJ
|
||||
- RubyMine
|
||||
- PhpStorm
|
||||
- AppCode
|
||||
- PyCharm
|
||||
- CLion
|
||||
- Android Studio
|
||||
- WebStorm
|
||||
- Rider
|
||||
reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
|
@ -1,7 +1,3 @@
|
||||
# Xcode
|
||||
#
|
||||
# gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore
|
||||
|
||||
## User settings
|
||||
xcuserdata/
|
||||
|
||||
|
3
Global/Xcode.yml
Normal file
3
Global/Xcode.yml
Normal file
@ -0,0 +1,3 @@
|
||||
aliases:
|
||||
- Objective-C
|
||||
- Swift
|
@ -1 +0,0 @@
|
||||
Java.gitignore
|
2
Leiningen.yml
Normal file
2
Leiningen.yml
Normal file
@ -0,0 +1,2 @@
|
||||
aliases:
|
||||
- Clojure
|
@ -1,63 +0,0 @@
|
||||
# Xcode
|
||||
#
|
||||
# gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore
|
||||
|
||||
## Build generated
|
||||
build/
|
||||
DerivedData/
|
||||
|
||||
## Various settings
|
||||
*.pbxuser
|
||||
!default.pbxuser
|
||||
*.mode1v3
|
||||
!default.mode1v3
|
||||
*.mode2v3
|
||||
!default.mode2v3
|
||||
*.perspectivev3
|
||||
!default.perspectivev3
|
||||
xcuserdata/
|
||||
|
||||
## Other
|
||||
*.moved-aside
|
||||
*.xccheckout
|
||||
*.xcscmblueprint
|
||||
|
||||
## Obj-C/Swift specific
|
||||
*.hmap
|
||||
*.ipa
|
||||
*.dSYM.zip
|
||||
*.dSYM
|
||||
|
||||
# CocoaPods
|
||||
#
|
||||
# We recommend against adding the Pods directory to your .gitignore. However
|
||||
# you should judge for yourself, the pros and cons are mentioned at:
|
||||
# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
|
||||
#
|
||||
# Pods/
|
||||
|
||||
# Carthage
|
||||
#
|
||||
# Add this line if you want to avoid checking in source code from Carthage dependencies.
|
||||
# Carthage/Checkouts
|
||||
|
||||
Carthage/Build
|
||||
|
||||
# fastlane
|
||||
#
|
||||
# It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the
|
||||
# screenshots whenever they are needed.
|
||||
# For more information about the recommended setup visit:
|
||||
# https://docs.fastlane.tools/best-practices/source-control/#source-control
|
||||
|
||||
fastlane/report.xml
|
||||
fastlane/Preview.html
|
||||
fastlane/screenshots/**/*.png
|
||||
fastlane/test_output
|
||||
|
||||
# Code Injection
|
||||
#
|
||||
# After new code Injection tools there's a generated folder /iOSInjectionProject
|
||||
# https://github.com/johnno1962/injectionforxcode
|
||||
|
||||
iOSInjectionProject/
|
3
Python.yml
Normal file
3
Python.yml
Normal file
@ -0,0 +1,3 @@
|
||||
editors:
|
||||
- Global/JetBrains.gitignore
|
||||
- Global/VisualStudioCode.gitignore
|
@ -1,68 +0,0 @@
|
||||
# Xcode
|
||||
#
|
||||
# gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore
|
||||
|
||||
## Build generated
|
||||
build/
|
||||
DerivedData/
|
||||
|
||||
## Various settings
|
||||
*.pbxuser
|
||||
!default.pbxuser
|
||||
*.mode1v3
|
||||
!default.mode1v3
|
||||
*.mode2v3
|
||||
!default.mode2v3
|
||||
*.perspectivev3
|
||||
!default.perspectivev3
|
||||
xcuserdata/
|
||||
|
||||
## Other
|
||||
*.moved-aside
|
||||
*.xccheckout
|
||||
*.xcscmblueprint
|
||||
|
||||
## Obj-C/Swift specific
|
||||
*.hmap
|
||||
*.ipa
|
||||
*.dSYM.zip
|
||||
*.dSYM
|
||||
|
||||
## Playgrounds
|
||||
timeline.xctimeline
|
||||
playground.xcworkspace
|
||||
|
||||
# Swift Package Manager
|
||||
#
|
||||
# Add this line if you want to avoid checking in source code from Swift Package Manager dependencies.
|
||||
# Packages/
|
||||
# Package.pins
|
||||
# Package.resolved
|
||||
.build/
|
||||
|
||||
# CocoaPods
|
||||
#
|
||||
# We recommend against adding the Pods directory to your .gitignore. However
|
||||
# you should judge for yourself, the pros and cons are mentioned at:
|
||||
# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
|
||||
#
|
||||
# Pods/
|
||||
|
||||
# Carthage
|
||||
#
|
||||
# Add this line if you want to avoid checking in source code from Carthage dependencies.
|
||||
# Carthage/Checkouts
|
||||
|
||||
Carthage/Build
|
||||
|
||||
# fastlane
|
||||
#
|
||||
# It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the
|
||||
# screenshots whenever they are needed.
|
||||
# For more information about the recommended setup visit:
|
||||
# https://docs.fastlane.tools/best-practices/source-control/#source-control
|
||||
|
||||
fastlane/report.xml
|
||||
fastlane/Preview.html
|
||||
fastlane/screenshots/**/*.png
|
||||
fastlane/test_output
|
@ -286,10 +286,6 @@ paket-files/
|
||||
# FAKE - F# Make
|
||||
.fake/
|
||||
|
||||
# JetBrains Rider
|
||||
.idea/
|
||||
*.sln.iml
|
||||
|
||||
# CodeRush
|
||||
.cr/
|
||||
|
||||
|
14
VisualStudio.yml
Normal file
14
VisualStudio.yml
Normal file
@ -0,0 +1,14 @@
|
||||
aliases:
|
||||
- CSharp
|
||||
- C#
|
||||
- FSharp
|
||||
- F#
|
||||
- VisualBasic
|
||||
- VB
|
||||
|
||||
editors:
|
||||
- Global/JetBrains.gitignore
|
||||
- Global/VisualStudioCode.gitignore
|
||||
|
||||
reviewers:
|
||||
- Brendan Forster (@shiftkey)
|
74
docs/metadata.md
Normal file
74
docs/metadata.md
Normal file
@ -0,0 +1,74 @@
|
||||
# Gitignore Metadata
|
||||
|
||||
This document outlines the additional metadata that can be associated with a gitignore template, and how tools can consume this metadata.
|
||||
|
||||
## Metadata Location
|
||||
|
||||
To add additional metadata to a gitignore template, add a new file to the same directory, with the matching name but ending in `yml`.
|
||||
|
||||
For example:
|
||||
- for `C.gitignore` the associated metadata will be stored in `C.yml`
|
||||
- for `Global/JetBrains.gitignore` the metadata file will be `Global/JetBrains.gitignore`
|
||||
|
||||
## Supported Fields
|
||||
|
||||
The structure of these files is still being settled upon, but for the moment these are some proposed entries.
|
||||
|
||||
#### `aliases`
|
||||
|
||||
Some templates can be used to represent a number of different situations, and rather than duplicating files on disk and needing to keep these in sync, we can store a list of these entries as metadata.
|
||||
|
||||
For example, JetBrains has a unified gitignore template that can be applied to all of their IDEs. Previously these were stored as comments in the header:
|
||||
|
||||
```
|
||||
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
|
||||
```
|
||||
|
||||
These values can be represented as metadata, so that tools consuming this repository can use these entries as matches if the user is searching for a specific product:
|
||||
|
||||
```yaml
|
||||
aliases:
|
||||
- IntelliJ
|
||||
- RubyMine
|
||||
- PhpStorm
|
||||
- AppCode
|
||||
- PyCharm
|
||||
- CLion
|
||||
- Android Studio
|
||||
- WebStorm
|
||||
- Rider
|
||||
```
|
||||
|
||||
#### `editors`
|
||||
|
||||
There are a number of editors out there that support working with different languages. Rather than baking every editor's rules in every language that is supported, a list of additional templates that might be of interest
|
||||
|
||||
```yaml
|
||||
editors:
|
||||
- Global/JetBrains.gitignore
|
||||
- Global/VisualStudioCode.gitignore
|
||||
```
|
||||
|
||||
#### `reference`
|
||||
|
||||
Some ecosystems have up-to-date documentation about things that are necessary to exclude from version control. To associate this with a template, this could be stored as a key-value pair in metadata:
|
||||
|
||||
```yaml
|
||||
reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
|
||||
```
|
||||
|
||||
### `reviewers`
|
||||
|
||||
This element is inspired by the [`DefinitelyTyped`](https://github.com/DefinitelyTyped/DefinitelyTyped) project, allowing community members to opt-in to reviewing templates when a pull request is opened. This helps to share the review load and credit people who have been helpful with reviews.
|
||||
|
||||
```yaml
|
||||
reviewers:
|
||||
- @shiftkey
|
||||
```
|
||||
|
||||
A friendly name can be provided alongside the GitHub account name.
|
||||
|
||||
```yaml
|
||||
reviewers:
|
||||
- Brendan Forster (@shiftkey)
|
||||
```
|
Loading…
Reference in New Issue
Block a user