Skip to content

add some command linking and (bad) frecency links #2

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

Open
MynockSpit wants to merge 6 commits into
base: main
Choose a base branch
from
Open

add some command linking and (bad) frecency links #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d9305e2
add some command linking and (bad) frecency links
MynockSpit Jul 1, 2022
85c4fcf
make command more easily editable
MynockSpit Sep 16, 2022
5330f9f
make interacting via server more fluid (by displaying prior commands …
MynockSpit Sep 23, 2022
bbda7cd
update server to separate posts from puts more, add repeat links
MynockSpit Sep 23, 2022
7f4902c
make note have tags; add --reverse and --limit to show command
MynockSpit Sep 23, 2022
9dbe0e0
make sure nb throws an error on unknown commands
MynockSpit Sep 23, 2022
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
53 changes: 53 additions & 0 deletions helpers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,56 @@ export function generateDimension(argDimension, dimensionName) {
return dimension
}

// This function is a little nuts, and probably not worth it. Use it as a
// tagged template literal (e.g. printIfExists`foo ${var} bar`) to print
// the string if `var` "exists" where "exists" is some pseudo definition
// that I made up. So yeah. There's that.
export function printIfExists(strings, input, ...otherArgs) {
if (otherArgs.length > 0) {
throw new Error(`Unexpected usage! Use like ${printIfExists.name}\`before ${variable} after\`.`)
}

function wrap(str) {
return strings[0] + str + strings[1]
}

if (input !== undefined) {
if (input && Array.isArray(input) && input.length > 0) {
return wrap(input.join(', '))
}

else if (input && typeof input === 'object' && Object.keys(input).length > 0) {
try {
return wrap(JSON.stringify(input))
} catch (e) {
return wrap(input)
}
}

else if (
(typeof input === 'string' && input !== '') ||
(typeof input === 'number') ||
(typeof input === 'boolean')
) {
return wrap(input)
}
}

// if we've fallen all the way through without returning, display nothing
return ''
}

export function handleValueAndTags(value, tags) {
// for a dumb edge-case where Number('') returns 0
let valueAsNumber = value === '' ? NaN : Number(value)
let valueIsNotNumber = Number.isNaN(valueAsNumber)
// prevents us from making an "undefined" tag when value is not provided
let valueIsTag = valueIsNotNumber && value !== undefined && value !== ''

let finalValue = valueIsNotNumber ? 1 : valueAsNumber
let finalTags = (valueIsTag ? [value, ...tags] : tags)
.map(tag => tag.trim()) // trim out spacing for the case where someone does `note <stream> ' tag'`
.filter(tag => tag !== '')

return { value: finalValue, tags: finalTags }
}
73 changes: 50 additions & 23 deletions nb.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,22 @@ import {
formatTime,
indexOrNot,
parseTimestamp,
generateDimension
generateDimension,
printIfExists,
handleValueAndTags
} from './helpers.js'

updateNotifier({ pkg }).notify()

yargs(hideBin(process.argv))
.command({
command: 'note <stream> <value>',
command: 'note <stream> [value] [tags...]',
description: 'record something worth remembering',
builder: yargs => {
return yargs
.positional('stream', { describe: 'the id of the stream to write to', type: 'string' })
.positional('value', { describe: 'the value to remember' })
.positional('value', { describe: 'the value to remember', type: "string" })
.positional('tags', { describe: 'tags to categorize this value', type: "array" })
.option('timestamp', { alias: 'ts' })
},
handler: args => {
Expand All @@ -52,14 +55,16 @@ yargs(hideBin(process.argv))
console.log(`stream ${args.stream} does not exist; creating it now.`)
}

const { value, tags } = handleValueAndTags(args.value, args.tags)

if (args.timestamp) {
const parsedTimestamp = parseTimestamp(args.timestamp)
let values = [...stream.values, [ parsedTimestamp, args.value ]].sort((a, b) => a[0] - b[0])
let values = [...stream.values, [parsedTimestamp, value, ...tags]].sort((a, b) => a[0] - b[0])
db.put(args.stream, { ...stream, values })
console.log(`noted ${args.value} in stream ${formatStreamName(stream)} at time ${args.timestamp}.`)
console.log(`noted ${value}${printIfExists` (${tags})`} in stream ${formatStreamName(stream)} at time ${args.timestamp}.`)
} else {
db.put(args.stream, { ...stream, values: [...stream.values, [ Date.now(), args.value ]] })
console.log(`noted ${args.value} in stream ${formatStreamName(stream)}.`)
db.put(args.stream, { ...stream, values: [...stream.values, [Date.now(), value, ...tags]] })
console.log(`noted ${value}${printIfExists` (${tags})`} in stream ${formatStreamName(stream)}.`)
}
}
})
Expand Down Expand Up @@ -94,15 +99,17 @@ yargs(hideBin(process.argv))
}
})
.command({
command: 'correct <stream> [index] [note]',
command: 'correct <stream> [index] [value] [tags...]',
description: 'correct a memory',
builder: yargs => {
return yargs
.positional('stream', { describe: 'the stream containing the memory to replace' })
.positional('index', { describe: 'the memory to replace; reference it by its timestamp or index. if not specified, the newest note will be corrected' })
.option('note', { describe: 'the new note value' })
.positional('value', { describe: 'the new note value' })
.positional('tags', { describe: 'the new note\'s tags', type: "array" })
},
handler: args => {

let stream = db.get(args.stream)
if (stream === undefined)
throw Error(`stream ${args.stream} does not exist.`)
Expand All @@ -124,13 +131,15 @@ yargs(hideBin(process.argv))
throw Error(`stream does not contain memory with index ${index}.`)

const newValues = values
newValues[correctionIndex] = [values[correctionIndex][0], args.note]

const { value, tags } = handleValueAndTags(args.value, args.tags)
newValues[correctionIndex] = [values[correctionIndex][0], value, ...tags]

db.put(args.stream, { ...stream, values: newValues })
if (args.index === undefined) {
console.log(`corrected latest note ${values.length} in stream ${formatStreamName(stream)}.`)
console.log(`corrected latest note ${values.length} (${value}${printIfExists`, [${tags}]`}) in stream ${formatStreamName(stream)}.`)
} else {
console.log(`corrected note ${args.index} in stream ${formatStreamName(stream)}.`)
console.log(`corrected note ${args.index} (${value}${printIfExists`, [${tags}]`}) in stream ${formatStreamName(stream)}.`)
}
}
})
Expand Down Expand Up @@ -194,30 +203,45 @@ yargs(hideBin(process.argv))
// TODO: Implement timeline format
.option('format', { describe: 'the format of the output', choices: ['csv', 'table', 'chart', 'graph', 'json', 'timeline'], default: 'csv' })
.option('time-format', { describe: 'the format of timestamps in the output', choices: ['unix', 'relative', 'date'], default: 'relative' })
.option('reverse', { describe: "reverse the order of the returned data", type: "boolean", default: false })
.option('limit', { describe: "how many entries to display", type: "number"})
},
handler: args => {
const stream = db.get(args.stream)
if (stream === undefined) throw Error(`stream ${args.stream} does not exist.`)

// attach the index to the note before (potentially) reversing it and trimming it
let notes = stream.values.map((value, index) => [index, ...value])

if (args.reverse) notes = notes.reverse()

if (typeof args.limit === 'number' && args.limit > 0) {
notes = notes.slice(0, args.limit)
}

if (args.format === 'csv') {
for(let i = 0; i < stream.values.length; i++) {
console.log(`${i}, ${formatTime(stream.values[i][0], args.timeFormat)}, ${stream.values[i][1]}`)
}
notes.forEach((note) => {
let [index, time, value, ...otherValues] = note
console.log(`${index}, ${formatTime(time, args.timeFormat)}, ${value}${printIfExists`, (${otherValues})`}`)
})
} else if (args.format === 'chart') {
console.log(chart(stream.values.map((value) => value[1]), {
console.log(chart(notes.map((value) => value[2]), {
width: generateDimension(args.width, 'width'),
height: generateDimension(args.height, 'height'),
dense: true
}))
} else if (args.format === 'graph') {
console.log(sparkly(stream.values.map((value) => value[1]), { minimum: 0 }))
console.log(sparkly(notes.map((value) => value[2]), { minimum: 0 }))
} else if (args.format === 'table') {
const table = new AsciiTable(formatStreamName(stream))
table.setHeading('index', 'time', 'value')
table.addRowMatrix(stream.values.map((value, index) => [index, formatTime(value[0], args.timeFormat), value[1]]))
table.setHeading('index', 'time', 'value', 'tags')
table.addRowMatrix(notes.map(note => {
let [index, time, value, ...otherValues] = note
return [index, formatTime(time, args.timeFormat), value, printIfExists`${otherValues}`]
}))
console.log(table.toString())
} else if (args.format === 'json') {
console.log(JSON.stringify({ ...stream, values: stream.values.map((value, index) => [index, ...value]) }, null, 2))
console.log(JSON.stringify({ ...stream, values: notes }, null, 2))
} else {
throw Error(`format ${args.format} not implemented yet.`)
}
Expand All @@ -233,7 +257,7 @@ yargs(hideBin(process.argv))
handler: args => {
const stream = db.get(args.stream)
if (stream === undefined) throw Error(`stream ${args.stream} does not exist.`)
if (args.name) { db.put(args.stream, {... stream, name: args.name }) }
if (args.name) { db.put(args.stream, { ...stream, name: args.name }) }
console.log(`updated stream ${formatStreamName(stream)}.`)
}
})
Expand Down Expand Up @@ -276,7 +300,7 @@ yargs(hideBin(process.argv))
for (let metaRow = 0; metaRow < rowCount; metaRow++) {
for (let literalRow = 0; literalRow < height - 2; literalRow++) {
let row = ''
for(let column = 0; column < chartsPerRow; column++) {
for (let column = 0; column < chartsPerRow; column++) {
if (metaRow * chartsPerRow + column < streams.length) {
row += charts[metaRow * chartsPerRow + column][literalRow]
}
Expand All @@ -287,6 +311,7 @@ yargs(hideBin(process.argv))
}
})
.demandCommand()
.strictCommands()
.help()
},
handler: args => {
Expand Down Expand Up @@ -322,7 +347,7 @@ yargs(hideBin(process.argv))


let fromStreams = from.keys()
for(let i = 0; i < fromStreams.length; i++) {
for (let i = 0; i < fromStreams.length; i++) {
if (!to.has(fromStreams[i])) {
to.put(fromStreams[i], { id: fromStreams[i], ...defaultStream })
console.log(`stream ${fromStreams[i]} does not exist; creating it now.`)
Expand Down Expand Up @@ -352,11 +377,13 @@ yargs(hideBin(process.argv))
}
})
.demandCommand()
.strictCommands()
.help()
},
handler: args => {
}
})
.demandCommand()
.strictCommands()
.help()
.argv
Loading