<commit_before>/*package cmd contains code for running shellfish in its various command
line modes */
package cmd

type GlobalConfig struct {
	snapshotFmt, snapshotType string
	rockstarDir, treeDir, memorDir string
	snapshotRange []int
}

type Mode interface {
	// ReadConfig reads a mode-specific config file and stores its contents
	// within the Mode.
	ReadConfig(name string) error
	// Run executes the mode. It takes a list of tokenized command line flags,
	// an initialized GlobalConfig struct, and a slice of lines representing the
	// contents of stdin. It will return a slice of lines that should be
	// written to stdout along with an error if one occurs.
	Run(flags []string, gConfig *GlobalConfig, stdin []string) ([]string, error)
}<commit_msg>Added documentation for cmd outline.<commit_after>/*package cmd contains code for running shellfish in its various command
line modes */
package cmd

// Mode represents the interface used by the main binary when interacting with
// a given command line mode.
type Mode interface {
	// ReadConfig reads a mode-specific config file and stores its contents
	// within the Mode.
	ReadConfig(name string) error
	// ExampleConfig returns the text of an example config file of this mode.
	ExampleConfig() string
	// Run executes the mode. It takes a list of tokenized command line flags,
	// an initialized GlobalConfig struct, and a slice of lines representing the
	// contents of stdin. It will return a slice of lines that should be
	// written to stdout along with an error if one occurs.
	Run(flags []string, gConfig *GlobalConfig, stdin []string) ([]string, error)
}

// GlobalConfig is a config file used by every mode. It contains information on
// the directories that various files are stored in.
type GlobalConfig struct {
	snapshotFmt, snapshotType string
	rockstarDir, treeDir, memorDir string
	snapshotRange []int
}
{'fraction_non_alphanumeric': 0.06329787234042553, 'fraction_numerical': 0.0, 'mean_word_length': 4.153424657534247, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4568483', 'n_tokens_mistral': 476, 'n_tokens_neox': 474, 'n_words': 258}