package fileutil

Import Path
	mvdan.cc/sh/v3/fileutil (on go.dev)

Dependency Relation
	imports 4 packages, and imported by one package

Involved Source Files

	  d file.go
		Package fileutil allows inspecting shell files, such as detecting whether a
		file may be shell or extracting its shebang.
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type ScriptConfidence int (basic type)
		ScriptConfidence defines how likely a file is to be a shell script,
		from complete certainty that it is not one to complete certainty that
		it is one.

		As Outputs Of (at least 2)
			func CouldBeScript(info os.FileInfo) ScriptConfidence
			func CouldBeScript2(entry fs.DirEntry) ScriptConfidence
		As Types Of (total 3)
			const ConfIfShebang
			const ConfIsScript
			const ConfNotScript


Package-Level Functions (total 4)

	 func CouldBeScript(info os.FileInfo) ScriptConfidence
		CouldBeScript is a shortcut for CouldBeScript2(fs.FileInfoToDirEntry(info)).
		
		Deprecated: prefer CouldBeScript2, which usually requires fewer syscalls.

	 func CouldBeScript2(entry fs.DirEntry) ScriptConfidence
		CouldBeScript2 reports how likely a directory entry is to be a shell script.
		It discards directories, symlinks, hidden files and files with non-shell
		extensions.

	 func HasShebang(bs []byte) bool
		HasShebang reports whether bs begins with a valid shell shebang.
		It supports variations with /usr and env.

	 func Shebang(bs []byte) string
		Shebang parses a "#!" sequence from the beginning of the input bytes,
		and returns the shell that it points to.
		
		For instance, it returns "sh" for "#!/bin/sh",
		and "bash" for "#!/usr/bin/env bash".


Package-Level Constants (total 3)

	const ConfIfShebang ScriptConfidence = 1
		ConfIfShebang describes files which might be shell scripts, depending
		on the shebang line in the file's contents. Since CouldBeScript only
		works on os.FileInfo, the answer in this case can't be final.

	const ConfIsScript ScriptConfidence = 2
		ConfIsScript describes files which are definitely shell scripts,
		which are regular files with a valid shell extension.

	const ConfNotScript ScriptConfidence = 0
		ConfNotScript describes files which are definitely not shell scripts,
		such as non-regular files or files with a non-shell extension.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.