NPM.Gitignore (NPM v0.6.0)

Manages .gitignore entries for npm projects.

Summary

Functions

check(project_dir)

Checks a .gitignore file on disk.

covers_node_modules?(content)

Checks if a .gitignore file covers node_modules.

essential()

Returns essential gitignore patterns for npm projects.

generate(opts \\ [])

Generates a .gitignore content for an npm project.

missing(content)

Returns missing essential patterns from a .gitignore file.

recommended()

Returns recommended gitignore patterns.

Functions

check(project_dir)

@spec check(String.t()) :: {:ok, [String.t()]} | {:error, :not_found}

Checks a .gitignore file on disk.

covers_node_modules?(content)

@spec covers_node_modules?(String.t()) :: boolean()

Checks if a .gitignore file covers node_modules.

essential()

@spec essential() :: [String.t()]

Returns essential gitignore patterns for npm projects.

generate(opts \\ [])

@spec generate(keyword()) :: String.t()

Generates a .gitignore content for an npm project.

missing(content)

@spec missing(String.t()) :: [String.t()]

Returns missing essential patterns from a .gitignore file.

recommended()

@spec recommended() :: [String.t()]

Returns recommended gitignore patterns.