Documentation
¶
Overview ¶
ignore is a library which returns a new ignorer object which can test against various paths. This is particularly useful when trying to filter files based on a .gitignore document
The rules for parsing the input file are the same as the ones listed in the Git docs here: http://git-scm.com/docs/gitignore
The summarized version of the same has been copied here:
- A blank line matches no files, so it can serve as a separator for readability.
- A line starting with # serves as a comment. Put a backslash ("\") in front of the first hash for patterns that begin with a hash.
- Trailing spaces are ignored unless they are quoted with backslash ("\").
- 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. 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".
- If the pattern ends with a slash, it is removed for the purpose of the following description, but it would only find a match with a directory. In other words, foo/ will match a directory foo and paths underneath it, but will not match a regular file or a symbolic link foo (this is consistent with the way how pathspec works in general in Git).
- If the pattern does not contain a slash /, Git treats it as a shell glob pattern and checks for a match against the pathname relative to the location of the .gitignore file (relative to the toplevel of the work tree if not from a .gitignore file).
- Otherwise, Git treats the pattern as a shell glob suitable for consumption by fnmatch(3) with the FNM_PATHNAME flag: wildcards in the pattern will not match a / in the pathname. For example, "Documentation/*.html" matches "Documentation/git.html" but not "Documentation/ppc/ppc.html" or "tools/perf/Documentation/perf.html".
- A leading slash matches the beginning of the pathname. For example, "/*.c" matches "cat-file.c" but not "mozilla-sha1/sha1.c".
- Two consecutive asterisks ("**") in patterns matched against full pathname may have special meaning: i. A leading "**" followed by a slash means match in all directories. For example, "** /foo" matches file or directory "foo" anywhere, the same as pattern "foo". "** /foo/bar" matches file or directory "bar" anywhere that is directly under directory "foo". ii. A trailing "/**" matches everything inside. For example, "abc/**" matches all files inside directory "abc", relative to the location of the .gitignore file, with infinite depth. iii. A slash followed by two consecutive asterisks then a slash matches zero or more directories. For example, "a/** /b" matches "a/b", "a/x/b", "a/x/y/b" and so on. iv. Other consecutive asterisks are considered invalid.
Index ¶
- Constants
- func GetHost() string
- type AttachCommonHeadersTransport
- type GQLError
- type GQLRequest
- type GQLResponse
- type Gateway
- func (g *Gateway) ConsumeLoginSession(ctx context.Context, code string) (string, error)
- func (g *Gateway) CreateEnvironment(ctx context.Context, req *entity.CreateEnvironmentRequest) (*entity.Environment, error)
- func (g *Gateway) CreateEphemeralEnvironment(ctx context.Context, req *entity.CreateEphemeralEnvironmentRequest) (*entity.Environment, error)
- func (g *Gateway) CreateLoginSession(ctx context.Context) (string, error)
- func (g *Gateway) CreatePlugin(ctx context.Context, req *entity.CreatePluginRequest) (*entity.Plugin, error)
- func (g *Gateway) CreateProject(ctx context.Context, req *entity.CreateProjectRequest) (*entity.Project, error)
- func (g *Gateway) CreateProjectFromTemplate(ctx context.Context, req *entity.CreateProjectFromTemplateRequest) (*entity.CreateProjectFromTemplateResult, error)
- func (g *Gateway) DeleteEnvironment(ctx context.Context, req *entity.DeleteEnvironmentRequest) error
- func (g *Gateway) DeleteProject(ctx context.Context, projectId string) error
- func (g *Gateway) DeleteVariable(ctx context.Context, req *entity.DeleteVariableRequest) error
- func (g *Gateway) DeployEnvironmentTriggers(ctx context.Context, req *entity.DeployEnvironmentTriggersRequest) error
- func (g *Gateway) Down(ctx context.Context, req *entity.DownRequest) error
- func (g *Gateway) GetAvailablePlugins(ctx context.Context, projectId string) ([]string, error)
- func (g *Gateway) GetDeploymentByID(ctx context.Context, req *entity.DeploymentByIDRequest) (*entity.Deployment, error)
- func (g *Gateway) GetDeploymentsForEnvironment(ctx context.Context, projectId, environmentId string) ([]*entity.Deployment, error)
- func (g *Gateway) GetEnvs(ctx context.Context, req *entity.GetEnvsRequest) (*entity.Envs, error)
- func (g *Gateway) GetLatestDeploymentForEnvironment(ctx context.Context, projectID, environmentID string) (*entity.Deployment, error)
- func (g *Gateway) GetProject(ctx context.Context, projectId string) (*entity.Project, error)
- func (g *Gateway) GetProjectByName(ctx context.Context, projectName string) (*entity.Project, error)
- func (g *Gateway) GetProjectDeploymentsURL(projectID string) string
- func (g *Gateway) GetProjectToken(ctx context.Context) (*entity.ProjectToken, error)
- func (g *Gateway) GetProjects(ctx context.Context) ([]*entity.Project, error)
- func (g *Gateway) GetServiceDeploymentsURL(projectID string, serviceID string, deploymentID string) string
- func (g *Gateway) GetStarters(ctx context.Context) ([]*entity.Starter, error)
- func (g *Gateway) GetUser(ctx context.Context) (*entity.User, error)
- func (g *Gateway) GetWorkflowStatus(ctx context.Context, workflowID string) (entity.WorkflowStatus, error)
- func (g *Gateway) GetWritableGithubScopes(ctx context.Context) ([]string, error)
- func (g *Gateway) Logout(ctx context.Context) error
- func (g *Gateway) NewRequestWithAuth(query string) (*GQLRequest, error)
- func (g *Gateway) NewRequestWithoutAuth(query string) *GQLRequest
- func (g *Gateway) OpenProjectDeploymentsInBrowser(projectID string) error
- func (g *Gateway) OpenProjectInBrowser(projectID string, environmentID string) error
- func (g *Gateway) OpenProjectPathInBrowser(projectID string, environmentID string, path string) error
- func (g *Gateway) OpenStaticUrlInBrowser(staticUrl string) error
- func (g *Gateway) SendPanic(ctx context.Context, req *entity.PanicRequest) (bool, error)
- func (g *Gateway) Up(ctx context.Context, req *entity.UpRequest) (*entity.UpResponse, error)
- func (g *Gateway) UpdateProject(ctx context.Context, req *entity.UpdateProjectRequest) (*entity.Project, error)
- func (g *Gateway) UpdateVariablesFromObject(ctx context.Context, req *entity.UpdateEnvsRequest) error
- type GitIgnore
- type IgnoreParser
Constants ¶
const (
CLI_SOURCE_HEADER = "cli"
)
Variables ¶
This section is empty.
Functions ¶
Types ¶
type AttachCommonHeadersTransport ¶
type AttachCommonHeadersTransport struct{}
type GQLRequest ¶
type GQLRequest struct {
// contains filtered or unexported fields
}
func (*GQLRequest) Var ¶
func (r *GQLRequest) Var(name string, value interface{})
type GQLResponse ¶
type GQLResponse struct { Errors []GQLError `json:"errors"` Data interface{} `json:"data"` }
type Gateway ¶
type Gateway struct {
// contains filtered or unexported fields
}
func (*Gateway) ConsumeLoginSession ¶
func (*Gateway) CreateEnvironment ¶
func (g *Gateway) CreateEnvironment(ctx context.Context, req *entity.CreateEnvironmentRequest) (*entity.Environment, error)
func (*Gateway) CreateEphemeralEnvironment ¶
func (g *Gateway) CreateEphemeralEnvironment(ctx context.Context, req *entity.CreateEphemeralEnvironmentRequest) (*entity.Environment, error)
func (*Gateway) CreateLoginSession ¶
func (*Gateway) CreatePlugin ¶
func (*Gateway) CreateProject ¶
func (*Gateway) CreateProjectFromTemplate ¶
func (g *Gateway) CreateProjectFromTemplate(ctx context.Context, req *entity.CreateProjectFromTemplateRequest) (*entity.CreateProjectFromTemplateResult, error)
func (*Gateway) DeleteEnvironment ¶
func (*Gateway) DeleteProject ¶
func (*Gateway) DeleteVariable ¶
func (*Gateway) DeployEnvironmentTriggers ¶
func (*Gateway) GetAvailablePlugins ¶
func (*Gateway) GetDeploymentByID ¶
func (g *Gateway) GetDeploymentByID(ctx context.Context, req *entity.DeploymentByIDRequest) (*entity.Deployment, error)
func (*Gateway) GetDeploymentsForEnvironment ¶
func (*Gateway) GetLatestDeploymentForEnvironment ¶
func (*Gateway) GetProject ¶
GetProject returns the project associated with the projectId, as well as it's environments, plugins, etc
func (*Gateway) GetProjectByName ¶
func (*Gateway) GetProjectDeploymentsURL ¶
func (*Gateway) GetProjectToken ¶
GetProjectToken looks up a project and environment by the RAILWAY_TOKEN
func (*Gateway) GetProjects ¶
GetProjects returns all projects associated with the user, as well as their environments associated with those projects, error otherwise Performs a dual join
func (*Gateway) GetServiceDeploymentsURL ¶
func (*Gateway) GetStarters ¶
func (*Gateway) GetWorkflowStatus ¶
func (*Gateway) GetWritableGithubScopes ¶
GetWritableGithubScopes returns scopes associated with Railway user
func (*Gateway) NewRequestWithAuth ¶
func (g *Gateway) NewRequestWithAuth(query string) (*GQLRequest, error)
func (*Gateway) NewRequestWithoutAuth ¶
func (g *Gateway) NewRequestWithoutAuth(query string) *GQLRequest
func (*Gateway) OpenProjectDeploymentsInBrowser ¶
func (*Gateway) OpenProjectInBrowser ¶
func (*Gateway) OpenProjectPathInBrowser ¶
func (*Gateway) OpenStaticUrlInBrowser ¶
func (*Gateway) UpdateProject ¶
func (*Gateway) UpdateVariablesFromObject ¶
type GitIgnore ¶
type GitIgnore struct {
// contains filtered or unexported fields
}
GitIgnore wraps a list of ignore pattern.
func CompileIgnoreFile ¶
Accepts a ignore file as the input, parses the lines out of the file and invokes the CompileIgnoreLines method
func CompileIgnoreFileAndLines ¶
Accepts a ignore file as the input, parses the lines out of the file and invokes the CompileIgnoreLines method with additional lines
func CompileIgnoreLines ¶
Accepts a variadic set of strings, and returns a GitIgnore object which converts and appends the lines in the input to regexp.Regexp patterns held within the GitIgnore objects "patterns" field
func (*GitIgnore) MatchesPath ¶
MatchesPath returns true if the given GitIgnore structure would target a given path string `f`.
type IgnoreParser ¶
An IgnoreParser is an interface which exposes a single method:
MatchesPath() - Returns true if the path is targeted by the patterns compiled in the GitIgnore structure