slugignore

Documentation

Overview

Package slugignore implements Heroku-like .slugignore functionality for a given directory.

Heroku's .slugignore format treats all non-empty and non comment lines (comment lines are those beginning with a # characted) as Ruby Dir globs,

See: https://devcenter.heroku.com/articles/slug-compiler#ignoring-files-with-slugignore

Index

• type SlugIgnore
  • func ForDirectory(dir string) (SlugIgnore, error)

Types

type SlugIgnore

type SlugIgnore interface {
	IsIgnored(path string) bool
}

SlugIgnore is the interface for a parsed .slugignore file

A given SlugIgnore is only applicable to the directory which contains the .slugignore file, at the time at which it was parsed.

func ForDirectory

func ForDirectory(dir string) (SlugIgnore, error)

ForDirectory parses the .slugignore for a given directory.

If there is no .slugignore file found, it returns a SlugIgnore which always returns false when IsIgnored is called.