refactor(commands): separate commands and its core into two folders (#32)

- I think it would be better if one for commands only, one for the spec
handling core logic so people won't be confused by the core logic inside
the commands folder (cleaner I guess)
- Regen docs
This commit is contained in:
VERSE
2026-07-05 11:27:30 +07:00
committed by GitHub
parent 6b98455957
commit ebde9ba68f
536 changed files with 2241 additions and 2241 deletions
+3 -3
View File
@@ -1,14 +1,14 @@
package text
import (
"github.com/versenilvis/iris/commands/core"
"github.com/versenilvis/iris/spec"
)
func init() {
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "diff",
Description: "Compare files line by line",
Options: []core.Option{
Options: []spec.Option{
{Name: "-i", Description: "Ignore case differences in file contents"},
{Name: "--ignore-file-name-case", Description: "Ignore case when comparing file names"},
{Name: "--no-ignore-file-name-case", Description: "Consider case when comparing file names"},
+3 -3
View File
@@ -1,14 +1,14 @@
package text
import (
"github.com/versenilvis/iris/commands/core"
"github.com/versenilvis/iris/spec"
)
func init() {
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "dos2unix",
Description: "DOS to Unix file format converter",
Options: []core.Option{
Options: []spec.Option{
{Name: "-h", Description: "Show help for dos2unix"},
{Name: "--allow-chown", Description: "Allow file ownership change in old file mode"},
{Name: "-ascii", Description: "Convert only line breaks. This is the default conversion mode"},
+4 -4
View File
@@ -1,15 +1,15 @@
package text
import (
"github.com/versenilvis/iris/commands/core"
"github.com/versenilvis/iris/spec"
)
func init() {
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "find",
Description: "search for files",
Generator: core.FileGenerator("/"),
Options: []core.Option{
Generator: spec.FileGenerator("/"),
Options: []spec.Option{
{Name: "-name", Description: "match by name"},
{Name: "-iname", Description: "match by name (case insensitive)"},
{Name: "-type", Description: "match by type (f=file, d=dir, l=link)"},
+7 -7
View File
@@ -1,15 +1,15 @@
package text
import (
"github.com/versenilvis/iris/commands/core"
"github.com/versenilvis/iris/spec"
)
func init() {
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "grep",
Description: "search text in files",
Generator: core.FileGenerator(),
Options: []core.Option{
Generator: spec.FileGenerator(),
Options: []spec.Option{
{Name: "-r", Description: "recursive"},
{Name: "-R", Description: "recursive + follow symlinks"},
{Name: "-i", Description: "ignore case"},
@@ -38,11 +38,11 @@ func init() {
})
// egrep and fgrep aliases
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "egrep",
Description: "grep with extended regex",
Generator: core.FileGenerator(),
Options: []core.Option{
Generator: spec.FileGenerator(),
Options: []spec.Option{
{Name: "-r", Description: "recursive"},
{Name: "-i", Description: "ignore case"},
{Name: "-n", Description: "show line numbers"},
+3 -3
View File
@@ -1,14 +1,14 @@
package text
import (
"github.com/versenilvis/iris/commands/core"
"github.com/versenilvis/iris/spec"
)
func init() {
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "iconv",
Description: "Character set conversion",
Options: []core.Option{
Options: []spec.Option{
{Name: "--help", Description: "Show help for iconv"},
{Name: "--version", Description: "Output version information and exit"},
{Name: "-f", Description: "Specifies the encoding of the input"},
+3 -3
View File
@@ -1,14 +1,14 @@
package text
import (
"github.com/versenilvis/iris/commands/core"
"github.com/versenilvis/iris/spec"
)
func init() {
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "jq",
Description: "Output the jq version and exit with zero",
Options: []core.Option{
Options: []spec.Option{
{Name: "--version", Description: "Output the jq version and exit with zero"},
{Name: "--seq", Description: "Parse the input in streaming fashion, outputting arrays of path and leaf values"},
{Name: "--slurp", Description: "Use a tab for each indentation level instead of two spaces"},
+3 -3
View File
@@ -1,14 +1,14 @@
package text
import (
"github.com/versenilvis/iris/commands/core"
"github.com/versenilvis/iris/spec"
)
func init() {
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "pandoc",
Description: "A universal document converter",
Options: []core.Option{
Options: []spec.Option{
{Name: "-f", Description: "Specify input format"},
{Name: "-t", Description: "Specify output format"},
{Name: "-o", Description: "Write output to FILE instead of stdout"},
+7 -7
View File
@@ -1,15 +1,15 @@
package text
import (
"github.com/versenilvis/iris/commands/core"
"github.com/versenilvis/iris/spec"
)
func init() {
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "rg",
Description: "ripgrep (fast search)",
Generator: core.FileGenerator(),
Options: []core.Option{
Generator: spec.FileGenerator(),
Options: []spec.Option{
{Name: "-i", Description: "case insensitive"},
{Name: "-s", Description: "case sensitive"},
{Name: "-n", Description: "show line numbers"},
@@ -52,11 +52,11 @@ func init() {
},
})
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "fd",
Description: "fast find alternative",
Generator: core.FileGenerator("/"),
Options: []core.Option{
Generator: spec.FileGenerator("/"),
Options: []spec.Option{
{Name: "-t", Description: "type (f/d/l/x/e/s)"},
{Name: "-e", Description: "file extension"},
{Name: "-H", Description: "include hidden"},
+3 -3
View File
@@ -1,14 +1,14 @@
package text
import (
"github.com/versenilvis/iris/commands/core"
"github.com/versenilvis/iris/spec"
)
func init() {
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "seq",
Description: "Print sequences of numbers. (Defaults to increments of 1)",
Options: []core.Option{
Options: []spec.Option{
{Name: "-w", Description: "Equalize the widths of all numbers by padding with zeros as necessary"},
{Name: "-s", Description: "String separator between numbers. Default is newline"},
{Name: "-f", Description: "Use a printf(3) style format to print each number"},
+3 -3
View File
@@ -1,14 +1,14 @@
package text
import (
"github.com/versenilvis/iris/commands/core"
"github.com/versenilvis/iris/spec"
)
func init() {
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "sha1sum",
Description: "Print or check SHA1 (160-bit) checksums",
Options: []core.Option{
Options: []spec.Option{
{Name: "-b", Description: "Read in binary mode"},
{Name: "-c", Description: "Read SHA1 sums from the FILEs and check them"},
{Name: "--tag", Description: "Create a BSD-style checksum"},
+3 -3
View File
@@ -1,14 +1,14 @@
package text
import (
"github.com/versenilvis/iris/commands/core"
"github.com/versenilvis/iris/spec"
)
func init() {
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "shasum",
Description: "Print or Check SHA Checksums",
Options: []core.Option{
Options: []spec.Option{
{Name: "-a", Description: "Select SHA algorithm"},
{Name: "-b", Description: "Read in binary mode"},
{Name: "-c", Description: "Read SHA sums from the FILEs and check them"},
+3 -3
View File
@@ -1,14 +1,14 @@
package text
import (
"github.com/versenilvis/iris/commands/core"
"github.com/versenilvis/iris/spec"
)
func init() {
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "shred",
Description: "Overwrite a file to hide its contents, and optionally delete it",
Options: []core.Option{
Options: []spec.Option{
{Name: "--force", Description: "Change permissions to allow writing if necessary"},
{Name: "--iterations", Description: "Overwrite N times instead of the default (3)"},
{Name: "--random-source", Description: "Get random bytes from FILE"},
+3 -3
View File
@@ -1,14 +1,14 @@
package text
import (
"github.com/versenilvis/iris/commands/core"
"github.com/versenilvis/iris/spec"
)
func init() {
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "split",
Description: "Use suffix_length letters to form the suffix of the file name",
Options: []core.Option{
Options: []spec.Option{
{Name: "-a", Description: "Use suffix_length letters to form the suffix of the file name"},
{Name: "-b", Description: "N[K|k|M|m|G|g]"},
{Name: "-d", Description: "Use a numeric suffix instead of a alphabetic suffix"},
+26 -26
View File
@@ -1,16 +1,16 @@
package text
import (
"github.com/versenilvis/iris/commands/core"
"github.com/versenilvis/iris/spec"
)
func init() {
// awk
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "awk",
Description: "pattern-directed scanning",
Generator: core.FileGenerator(),
Options: []core.Option{
Generator: spec.FileGenerator(),
Options: []spec.Option{
{Name: "-F", Description: "field separator"},
{Name: "-v", Description: "assign variable"},
{Name: "-f", Description: "read program from file"},
@@ -21,11 +21,11 @@ func init() {
})
// gawk is also common
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "gawk",
Description: "GNU awk",
Generator: core.FileGenerator(),
Options: []core.Option{
Generator: spec.FileGenerator(),
Options: []spec.Option{
{Name: "-F", Description: "field separator"},
{Name: "-v", Description: "assign variable"},
{Name: "-f", Description: "read program from file"},
@@ -36,11 +36,11 @@ func init() {
})
// sed
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "sed",
Description: "stream editor",
Generator: core.FileGenerator(),
Options: []core.Option{
Generator: spec.FileGenerator(),
Options: []spec.Option{
{Name: "-e", Description: "add expression"},
{Name: "-f", Description: "read script from file"},
{Name: "-i", Description: "in-place edit"},
@@ -53,10 +53,10 @@ func init() {
})
// xargs
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "xargs",
Description: "build and run commands from stdin",
Options: []core.Option{
Options: []spec.Option{
{Name: "-I", Description: "replace string (e.g. -I{})"},
{Name: "-n", Description: "max args per command"},
{Name: "-P", Description: "parallel jobs"},
@@ -70,10 +70,10 @@ func init() {
})
// tr
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "tr",
Description: "translate or delete characters",
Options: []core.Option{
Options: []spec.Option{
{Name: "-d", Description: "delete characters"},
{Name: "-s", Description: "squeeze repeated chars"},
{Name: "-c", Description: "complement set"},
@@ -81,11 +81,11 @@ func init() {
})
// sort
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "sort",
Description: "sort lines of text",
Generator: core.FileGenerator(),
Options: []core.Option{
Generator: spec.FileGenerator(),
Options: []spec.Option{
{Name: "-n", Description: "numeric sort"},
{Name: "-r", Description: "reverse sort"},
{Name: "-k", Description: "sort by key field"},
@@ -100,11 +100,11 @@ func init() {
})
// uniq
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "uniq",
Description: "filter adjacent duplicate lines",
Generator: core.FileGenerator(),
Options: []core.Option{
Generator: spec.FileGenerator(),
Options: []spec.Option{
{Name: "-c", Description: "prefix count"},
{Name: "-d", Description: "only duplicates"},
{Name: "-u", Description: "only unique"},
@@ -115,11 +115,11 @@ func init() {
})
// cut
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "cut",
Description: "extract columns from lines",
Generator: core.FileGenerator(),
Options: []core.Option{
Generator: spec.FileGenerator(),
Options: []spec.Option{
{Name: "-d", Description: "delimiter"},
{Name: "-f", Description: "field numbers (e.g. 1,3 or 1-3)"},
{Name: "-c", Description: "character positions"},
@@ -128,11 +128,11 @@ func init() {
})
// tee
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "tee",
Description: "read stdin, write to stdout and files",
Generator: core.FileGenerator(),
Options: []core.Option{
Generator: spec.FileGenerator(),
Options: []spec.Option{
{Name: "-a", Description: "append to files"},
{Name: "-i", Description: "ignore interrupts"},
},
+3 -3
View File
@@ -1,14 +1,14 @@
package text
import (
"github.com/versenilvis/iris/commands/core"
"github.com/versenilvis/iris/spec"
)
func init() {
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "truncate",
Description: "Shrink or extend the size of a file to the specified size",
Options: []core.Option{
Options: []spec.Option{
{Name: "--no-create", Description: "Do not create any files"},
{Name: "--io-blocks", Description: "Treat SIZE as number of IO blocks instead of bytes"},
{Name: "--reference", Description: "Base size on RFILE"},
+3 -3
View File
@@ -1,14 +1,14 @@
package text
import (
"github.com/versenilvis/iris/commands/core"
"github.com/versenilvis/iris/spec"
)
func init() {
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "typos",
Description: "Source code spelling correction",
Options: []core.Option{
Options: []spec.Option{
{Name: "-c", Description: "Custom config file"},
{Name: "--isolated", Description: "Ignore implicit configuration files"},
{Name: "--diff", Description: "Print a diff of what would change"},
+2 -2
View File
@@ -1,11 +1,11 @@
package text
import (
"github.com/versenilvis/iris/commands/core"
"github.com/versenilvis/iris/spec"
)
func init() {
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "unix2dos",
Description: "Unix to DOS text file format convertor",
})
+4 -4
View File
@@ -1,19 +1,19 @@
package text
import (
"github.com/versenilvis/iris/commands/core"
"github.com/versenilvis/iris/spec"
)
func init() {
core.Register(&core.Spec{
spec.Register(&spec.Spec{
Name: "vale",
Description: "A syntax-aware linter for prose built with speed and extensibility in mind",
Subcommands: []core.Subcommand{
Subcommands: []spec.Subcommand{
{Name: "ls-config", Description: "Print the current configuration to stdout"},
{Name: "ls-metrics", Description: "Print the given file's internal metrics to stdout"},
{Name: "file", Description: "The path to a file you want to analyze"},
},
Options: []core.Option{
Options: []spec.Option{
{Name: "--help", Description: "Show help for vale"},
{Name: "--version", Description: "Print the current version"},
{Name: "--ignore-syntax", Description: "Lint all files line-by-line"},