Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CLI mode UX improvement, new Set command #238

Merged
merged 3 commits into from
May 16, 2024
Merged

CLI mode UX improvement, new Set command #238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b83a245
bring the last message you sent back into the input box. I'm sure this
aapis May 15, 2024
0a381c2
basic command handling
aapis May 16, 2024
54262a0
refactor
aapis May 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DLPrototype/Parsers/SearchLanguage.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ extension SearchLanguage.Results {
}
}
default:
print("DERPO unimplemented Species \(component.species.name)")
print("[debug] Unimplemented Species \(component.species.name)")
}

if jobs.count > 0 {
Expand Down
2 changes: 2 additions & 0 deletions DLPrototype/Utils/Navigation.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,11 +208,13 @@ extension Navigation {
}

public struct CommandLineSession {
typealias CLIApp = CommandLineInterface.App
typealias CLIAppType = CommandLineInterface.App.AppType

var history: [History] = []
var command: String?
var app: CLIAppType = .log
var selected: CLIApp?

public struct History: Identifiable {
public var id: UUID = UUID()
Expand Down
172 changes: 134 additions & 38 deletions DLPrototype/Views/Entities/Today/CommandLineInterface.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ struct CommandLineInterface: View {
typealias Status = Navigation.CommandLineSession.History.Status

static private let maxItems: Int = 500
@State private var validSetCommands: [CLICommand] = []

@State private var apps: [CLIApp] = []
@State private var selected: CLIApp.AppType = .log
Expand Down Expand Up @@ -63,12 +64,23 @@ struct CommandLineInterface: View {

extension CommandLineInterface {
private func executeLogAction() -> Void {
let line = Navigation.CommandLineSession.History(
command: command,
status: nav.session.job == nil ? .error : .standard,
message: nav.session.job == nil ? "You must select a job first" : "",
appType: selected
)
var line: Navigation.CommandLineSession.History

if command == "help" {
line = Navigation.CommandLineSession.History(
command: command,
status: nav.session.job == nil ? .error : .standard,
message: apps.filter({$0.type == selected}).first?.helpText ?? "Help text",
appType: selected
)
} else {
line = Navigation.CommandLineSession.History(
command: command,
status: nav.session.job == nil ? .error : .standard,
message: nav.session.job == nil ? "You must select a job first" : "",
appType: selected
)
}

self.updateDisplay(line: line)

Expand Down Expand Up @@ -97,13 +109,40 @@ extension CommandLineInterface {
}

private func executeQueryAction() -> Void {
self.updateDisplay(status: .standard, message: "Searching for X")
self.updateDisplay(status: .standard, message: command)
self.clear()
}

private func executeSetAction() -> Void {
self.updateDisplay(status: .standard, message: "Set X = Y")
self.clear()
var line: Navigation.CommandLineSession.History = Navigation.CommandLineSession.History(
command: command,
status: .standard,
message: "",
appType: selected
)

if command == "help" {
line.message = apps.filter({$0.type == selected}).first?.helpText ?? "Help text"
}

Task {
let pattern = /^@(.*?)\.(.*?)=(\d+)/
let matches = command.matches(of: pattern)

if let match = matches.first {
// We found a matching CLICommand, execute it
if let cmd = validSetCommands.first(where: {$0.domain == match.1 && $0.method == match.2}) {
// Run the callback, successful response messages is defined there
cmd.callback(String(match.3), &line)
} else {
line.message = "Invalid command: @\(String(match.1)).\(String(match.2))"
line.status = .error
}
}

self.updateDisplay(line: line)
self.clear()
}
}

private func actionOnAppear() -> Void {
Expand All @@ -112,6 +151,7 @@ extension CommandLineInterface {
type: .log,
action: self.executeLogAction,
promptPlaceholder: "What are you working on?",
helpText: "Write out what you're working on right now, like right-right now, and hit return.",
showSelectorPanel: $showSelectorPanel,
command: $command,
selected: $selected
Expand All @@ -121,18 +161,32 @@ extension CommandLineInterface {
// type: .query,
// action: self.executeQueryAction,
// promptPlaceholder: "Find stuff",
// showSelectorPanel: $showSelectorPanel,
// showSelectorPanel: $showSelectorPanel, helpText: String,
// command: $command,
// selected: $selected
// ),
// CLIApp(
// type: .set,
// action: self.executeSetAction,
// promptPlaceholder: "Configure things",
// showSelectorPanel: $showSelectorPanel,
// command: $command,
// selected: $selected
// )
CLIApp(
type: .set,
action: self.executeSetAction,
promptPlaceholder: "Configure things",
helpText: "Syntax: @session.job=100.0",
showSelectorPanel: $showSelectorPanel,
command: $command,
selected: $selected
)
]

self.validSetCommands = [
CLICommand(domain: "session", method: "job", callback: { match, line in
let id: Double = Double(match) ?? 0.0
if let job = CoreDataJob(moc: moc).byId(id) {
nav.session.setJob(job)
line.status = .success
} else {
line.message = "Unable to find a Job with ID \(match)"
line.status = .error
}
})
]
}

Expand All @@ -141,21 +195,40 @@ extension CommandLineInterface {
if command == "exit" {
commandLineMode.toggle()
}

nav.session.cli.command = nil
command = ""
}

private func updateDisplay(status: Status, message: String) -> Void {
if nav.session.cli.history.count <= CommandLineInterface.maxItems {
nav.session.cli.history.append(
Navigation.CommandLineSession.History(
var item: Navigation.CommandLineSession.History

switch nav.session.cli.app {
case .log:
item = Navigation.CommandLineSession.History(
command: command,
status: nav.session.job == nil ? .error : .standard,
message: nav.session.job == nil ? "You must select a job first" : "",
appType: selected
)
)
case .set:
item = Navigation.CommandLineSession.History(
command: command,
status: .standard,
message: "",
appType: selected
)
case .query:
item = Navigation.CommandLineSession.History(
command: command,
status: .standard,
message: "",
appType: selected
)
}

nav.session.cli.history.append(item)
}
}

Expand All @@ -171,31 +244,55 @@ extension CommandLineInterface {
}

extension CommandLineInterface {
struct CLICommand {
var domain: String
var method: String
var callback: (String, inout Navigation.CommandLineSession.History) -> Void
}

struct App: View, Identifiable {
var id: UUID = UUID()
var type: AppType
var action: () -> Void
var promptPlaceholder: String
var helpText: String

@Binding public var showSelectorPanel: Bool
@Binding public var command: String
@Binding public var selected: AppType

@EnvironmentObject public var nav: Navigation

var body: some View {
HStack(spacing: 0) {
CommandLineInterface.AppSelectorButton(type: type, showSelectorPanel: $showSelectorPanel, selected: $selected)

FancyTextField(
placeholder: promptPlaceholder,
onSubmit: action,
fgColour: nav.session.job?.backgroundColor.isBright() ?? false ? .black : .white,
bgColour: nav.session.job?.backgroundColor ?? Theme.textBackground,
font: .title2,
font: Theme.fontTextField,
text: $command
)
.disabled(showSelectorPanel)
}
.onAppear(perform: actionOnAppear)
}

private func actionOnAppear() -> Void {
NSEvent.addLocalMonitorForEvents(matching: .keyDown) {
let code = Int($0.keyCode)

if code == 125 {
command = ""
} else if code == 126 {
if let last = nav.session.cli.history.last {
command = last.command
}
}
return $0
}
}

enum AppType: CaseIterable, Identifiable {
Expand Down Expand Up @@ -250,8 +347,8 @@ extension CommandLineInterface {
Text(line.command)
Spacer()
}
if [.error, .warning].contains(line.status) {

if !line.message.isEmpty {
HStack {
Image(systemName: "arrow.turn.down.right")
.padding([.leading], 8)
Expand All @@ -275,32 +372,31 @@ extension CommandLineInterface {
public var type: CLIApp.AppType
@Binding public var showSelectorPanel: Bool
@Binding public var selected: CLIApp.AppType

@EnvironmentObject public var nav: Navigation

var body: some View {
Button {
showSelectorPanel.toggle()
selected = type
nav.session.cli.app = type
} label: {
HStack {
Text("$")
.padding([.leading, .top, .bottom])
.font(.title2)

Text(type.name)
.padding([.top, .bottom, .trailing])
.font(.title2)
}
.background(type.bgColour)
.foregroundStyle(type.fgColour)
Text("$ \(type.name)")
.padding()
.background(type.bgColour)
.foregroundStyle(type.fgColour)
}
.buttonStyle(.plain)
.useDefaultHover({_ in})
}
}

struct AppSelectorPanel: View {
typealias CLIApp = CommandLineInterface.App

public var apps: [CLIApp]

@EnvironmentObject public var nav: Navigation

var body: some View {
VStack(alignment: .leading, spacing: 1) {
Expand Down