pkg

package
v0.20.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 14, 2024 License: BSD-2-Clause Imports: 1 Imported by: 0

Documentation

Overview

Package pkg is the root of packages that implement Elvish.

Index

Constants

This section is empty.

Variables

View Source 
var ElvFiles embed.FS

ElvFiles contains the Elvish sources found inside pkg - the .d.elv files for modules implemented in Go and the actual sources of bundled modules. It is defined to support reading documentation of builtin modules from Elvish itself.

Some of these files may be embedded as a string variable elsewhere. This is fine since the compiler is smart enough to only include one copy of the same file in the binary (as least as of Go 1.21).

This is only used by src.elv.sh/pkg/mods/doc, but has to live in this package because go:embed only supports embedding files found in the current directory and its descendents, and this directory is the lowest common ancestor of these files.

Functions

This section is empty.

Types

This section is empty.

Source Files

View all Source files

Directories

Path Synopsis
Package buildinfo contains build information.
 Package buildinfo contains build information.
cli
Package cli implements a generic interactive line editor.
 Package cli implements a generic interactive line editor.
clitest
Package clitest provides utilities for testing cli.App.
 Package clitest provides utilities for testing cli.App.
examples/e3bc
Command e3bc ("Elvish-editor-enhanced bc") is a wrapper for the bc command that uses Elvish's cli library for an enhanced CLI experience.
 Command e3bc ("Elvish-editor-enhanced bc") is a wrapper for the bc command that uses Elvish's cli library for an enhanced CLI experience.
examples/e3bc/bc
examples/nav
Command nav runs the navigation mode of the line editor.
 Command nav runs the navigation mode of the line editor.
examples/widget
Command widget allows manually testing a single widget.
 Command widget allows manually testing a single widget.
examples/win_tty
histutil
Package histutil provides utilities for working with command history.
 Package histutil provides utilities for working with command history.
lscolors
Package lscolors provides styling of filenames based on file features.
 Package lscolors provides styling of filenames based on file features.
modes
Package mode implements modes, which are widgets tailored for a specific task.
 Package mode implements modes, which are widgets tailored for a specific task.
prompt
Package prompt provides an implementation of the cli.Prompt interface.
 Package prompt provides an implementation of the cli.Prompt interface.
term
Package term provides functionality for working with terminals.
 Package term provides functionality for working with terminals.
tk
Package tk is the toolkit for the cli package.
 Package tk is the toolkit for the cli package.
Package daemon implements a service for mediating access to the data store, and its client.
 Package daemon implements a service for mediating access to the data store, and its client.
daemondefs
Package daemondefs contains definitions used for the daemon.
 Package daemondefs contains definitions used for the daemon.
internal/api
Package api defines types and constants useful for the API between the daemon service and client.
 Package api defines types and constants useful for the API between the daemon service and client.
Package diag contains building blocks for formatting and processing diagnostic information.
 Package diag contains building blocks for formatting and processing diagnostic information.
Package edit implements the line editor for Elvish.
 Package edit implements the line editor for Elvish.
complete
Package complete implements the code completion algorithm for Elvish.
 Package complete implements the code completion algorithm for Elvish.
filter
Package filter implements the Elvish filter DSL.
 Package filter implements the Elvish filter DSL.
highlight
Package highlight provides an Elvish syntax highlighter.
 Package highlight provides an Elvish syntax highlighter.
Package elvdoc extracts doc comments of Elvish variables and functions.
 Package elvdoc extracts doc comments of Elvish variables and functions.
Package env keeps names of environment variables with special significance to Elvish.
 Package env keeps names of environment variables with special significance to Elvish.
Package errutil contains common error-related utilities.
 Package errutil contains common error-related utilities.
Package eval handles evaluation of parsed Elvish code and provides runtime facilities.
 Package eval handles evaluation of parsed Elvish code and provides runtime facilities.
errs
Package errs declares error types used as exception causes.
 Package errs declares error types used as exception causes.
evaltest
Package evaltest supports testing the Elvish interpreter and libraries.
 Package evaltest supports testing the Elvish interpreter and libraries.
vals
Package vals contains basic facilities for manipulating values used in the Elvish runtime.
 Package vals contains basic facilities for manipulating values used in the Elvish runtime.
vars
Package vars contains basic types for manipulating Elvish variables.
 Package vars contains basic types for manipulating Elvish variables.
Package fsutil provides filesystem utilities.
 Package fsutil provides filesystem utilities.
Package getopt implements a command-line argument parser.
 Package getopt implements a command-line argument parser.
Package glob implements globbing for elvish.
 Package glob implements globbing for elvish.
Package logutil provides logging utilities.
 Package logutil provides logging utilities.
Package lsp implements a language server for Elvish.
 Package lsp implements a language server for Elvish.
md
Package md implements a Markdown parser.
 Package md implements a Markdown parser.
mdrun
Command mdrun can be used to test the md package.
 Command mdrun can be used to test the md package.
Package mods collects standard library modules.
 Package mods collects standard library modules.
daemon
Package daemon implements the builtin daemon: module.
 Package daemon implements the builtin daemon: module.
doc
Package doc implements the doc: module.
 Package doc implements the doc: module.
epm
file
flag
math
Package math exposes functionality from Go's math package as an elvish module.
 Package math exposes functionality from Go's math package as an elvish module.
os
Package os exposes functionality from Go's os package as an Elvish module.
 Package os exposes functionality from Go's os package as an Elvish module.
path
Package path provides functions for manipulating filesystem path names.
 Package path provides functions for manipulating filesystem path names.
platform
Package platform exposes variables and functions that deal with the specific platform being run on, such as the OS name and CPU architecture.
 Package platform exposes variables and functions that deal with the specific platform being run on, such as the OS name and CPU architecture.
re
Package re implements a regular expression module.
 Package re implements a regular expression module.
readline-binding
runtime
Package runtime implements the runtime module.
 Package runtime implements the runtime module.
store
str
Package str exposes functionality from Go's strings package as an Elvish module.
 Package str exposes functionality from Go's strings package as an Elvish module.
unix
Package unix exports an Elvish namespace that contains variables and functions that deal with features unique to Unix-like operating systems.
 Package unix exports an Elvish namespace that contains variables and functions that deal with features unique to Unix-like operating systems.
Package must contains simple functions that panic on errors.
 Package must contains simple functions that panic on errors.
Package parse implements the elvish parser.
 Package parse implements the elvish parser.
cmpd
Package cmpd contains utilities for working with compound nodes.
 Package cmpd contains utilities for working with compound nodes.
np
Package np provides utilities for working with node paths from a leaf of a parse tree to the root.
 Package np provides utilities for working with node paths from a leaf of a parse tree to the root.
parseutil
Package parseutil contains utilities built on top of the parse package.
 Package parseutil contains utilities built on top of the parse package.
Package persistent contains subpackages for persistent data structures, similar to those of Clojure.
 Package persistent contains subpackages for persistent data structures, similar to those of Clojure.
hash
Package hash contains some common hash functions suitable for use in hash maps.
 Package hash contains some common hash functions suitable for use in hash maps.
hashmap
Package hashmap implements persistent hashmap.
 Package hashmap implements persistent hashmap.
list
Package list implements persistent list.
 Package list implements persistent list.
vector
Package vector implements persistent vector.
 Package vector implements persistent vector.
Package pprof adds profiling support to the Elvish program.
 Package pprof adds profiling support to the Elvish program.
Package prog provides the entry point to Elvish.
 Package prog provides the entry point to Elvish.
progtest
Package progtest provides a framework for testing subprograms.
 Package progtest provides a framework for testing subprograms.
Package rpc is a trimmed down version of net/rpc in the standard library.
 Package rpc is a trimmed down version of net/rpc in the standard library.
Package shell is the entry point for the terminal interface of Elvish.
 Package shell is the entry point for the terminal interface of Elvish.
Package store defines the permanent storage service.
 Package store defines the permanent storage service.
storedefs
Package storedefs contains definitions of the store API.
 Package storedefs contains definitions of the store API.
storetest
Package storetest keeps test suites against storedefs.Store.
 Package storetest keeps test suites against storedefs.Store.
Package strutil provides string utilities.
 Package strutil provides string utilities.
sys
Package sys provide system utilities with the same API across OSes.
 Package sys provide system utilities with the same API across OSes.
eunix
Package eunix provides extra Unix-specific system utilities.
 Package eunix provides extra Unix-specific system utilities.
ewindows
Package ewindows provides extra Windows-specific system utilities.
 Package ewindows provides extra Windows-specific system utilities.
Package testutil contains common test utilities.
 Package testutil contains common test utilities.
Package transcript contains utilities for working with Elvish transcripts.
 Package transcript contains utilities for working with Elvish transcripts.
Package tt supports table-driven tests with little boilerplate.
 Package tt supports table-driven tests with little boilerplate.
Package ui contains types that may be used by different editor frontends.
 Package ui contains types that may be used by different editor frontends.
Package wcwidth provides utilities for determining the column width of characters when displayed on the terminal.
 Package wcwidth provides utilities for determining the column width of characters when displayed on the terminal.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.