README
¶
Ipê (deprecated)
A replacement for ls with some special features, like tree view and
Git integration. Works as terminal program or Go library.
Inspired by jacwah/oak and ogham/exa.
Deprecated
Don't use it! I made this code trying to learn Go but I never finished it and I don't see any reason for doing it now.
To-do list
- List directory contents
- Identify and organize column sizes in long views
- Make special features
- Tree view (-t)
- Separator of columns in long view (-S)
- Flag to specify maximum depth of recursion (-D)
- Flag to sort by an column/field (-s)
- Flag to filter entries (-f)
- Flag to show headers on long view (-h)
- Differentiate files types
- Flag to show directories first (--dirs-first)
- Accept more than one value in filter and ignore flags
- Flag to show number of hard links in long view (--links)
- Flag to show number of file system blocks in long view (--blocks)
- Flag to show group in long view (--group)
- Define colors
- Add Git integration
- Ignore "Git ignored" files by default
- Show files' Git status
- Change it into a lib
- Create formatters
- Get inode, user and group in Windows
- Define column alignment in long view
License
This project code is in the public domain. See the LICENSE file.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be in the public domain, without any additional terms or conditions.
Documentation
¶
Index ¶
- Variables
- type File
- func (f File) AccTime() time.Time
- func (f File) Blocks() int64
- func (f File) Children() []File
- func (f File) ClassifiedName() string
- func (f File) CrtTime() time.Time
- func (f File) DirSize() int64
- func (f File) Fd() int
- func (f File) FollowLink() (File, error)
- func (f File) FullName() string
- func (f File) Group() *user.Group
- func (f File) Inode() uint64
- func (f File) IsAppend() bool
- func (f File) IsDevice() bool
- func (f File) IsDir() bool
- func (f File) IsDotfile() bool
- func (f File) IsExclusive() bool
- func (f File) IsNamedPipe() bool
- func (f File) IsRegular() bool
- func (f File) IsSocket() bool
- func (f File) IsSymlink() bool
- func (f File) IsTemporary() bool
- func (f File) Links() uint64
- func (f File) ModTime() time.Time
- func (f File) Mode() os.FileMode
- func (f File) Name() string
- func (f File) Size() int64
- func (f File) Sys() interface{}
- func (f File) User() *user.User
Constants ¶
This section is empty.
Variables ¶
var ( // ErrNotSymlink is returned when the method expects a symbolic link, // but the file is not. ErrNotSymlink = errors.New("the file is not a symbolic link") )
Functions ¶
This section is empty.
Types ¶
type File ¶
type File struct {
// contains filtered or unexported fields
}
File represents a file.
func (File) ClassifiedName ¶
ClassifiedName returns the name with an appended type indicator.
func (File) DirSize ¶
DirSize return the length in bytes for all files inside the directory, recursively.
func (File) FollowLink ¶
FollowLink returns the file that the symbolic link points to. If the file is not a symbolic link, it returns `ErrNotSymlink`.
func (File) IsExclusive ¶
IsExclusive reports whether `f` describes an exclusive-use file.
func (File) IsNamedPipe ¶
IsNamedPipe reports whether `f` describes a named pipe (FIFO).
func (File) IsRegular ¶
IsRegular reports whether `f` describes a regular file. That is, it tests that no mode type bits are set.
func (File) IsTemporary ¶
IsTemporary reports whether `f` describes a temporary file (not backed up).
Source Files
Directories