use_gh_linguist: GitHub Linguist Exclusions

View source: R/use_linguist.R

use_gh_linguistR Documentation

GitHub Linguist Exclusions

Description

This function creates a .gitattributes file in the root of your project in order to exclude certain file types from being detected as a certain programming language on GitHub. See details for more information.

Usage

use_gh_linguist(excludes = c("*.js", "*.html", "*.css"))

Arguments

excludes

Character vector of wildcards indicating extensions to be labelled as linguist-vendored and ignored by GitHub's language detector github-linguist.

Details

By default this function will write *.js, *.html, and *.css to a .gitattributes file in order for github-linguist to ignore Javascript, HTML, and CSS languages in your repositories language section.

The resulting file will look like so:

# github linguist exclusions:
*.js linguist-vendored
*.html linguist-vendored
*.css linguist-vendored

Value

invisibly returns the text written to .gitattributes

Examples

## Not run: 
use_gh_linguist()

## End(Not run)

jimbrig/jimstools documentation built on Sept. 12, 2022, 12:08 p.m.