Ellpeck/ObsidianSimpleTimeTracker
1
0
Fork 0
mirror of https://github.com/Ellpeck/ObsidianSimpleTimeTracker.git synced 2024-12-18 19:39:22 +01:00
Code Issues Projects Releases Wiki Activity

store timestamps as iso instead of unix

Browse source 
closes #26
This commit is contained in:
Ell 2023-09-08 13:59:50 +02:00
parent f766fa7210
commit e95f62fb9d
3 changed files with 61 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

106
src/tracker.ts
View file

@ -1,5 +1,5 @@
import { moment, App, MarkdownSectionInformation, ButtonComponent, TextComponent, TFile } from "obsidian"; import {moment, App, MarkdownSectionInformation, ButtonComponent, TextComponent, TFile} from "obsidian";
import { SimpleTimeTrackerSettings } from "./settings"; import {SimpleTimeTrackerSettings} from "./settings";
export interface Tracker { export interface Tracker {
entries: Entry[]; entries: Entry[];
@ -7,8 +7,8 @@ export interface Tracker {
export interface Entry { export interface Entry {
name: string; name: string;
startTime: number; startTime: string;
endTime: number; endTime: string;
subEntries: Entry[]; subEntries: Entry[];
} }
@ -31,7 +31,9 @@ export async function saveTracker(tracker: Tracker, app: App, fileName: string,
export function loadTracker(json: string): Tracker { export function loadTracker(json: string): Tracker {
if (json) { if (json) {
try { try {
return JSON.parse(json); let ret = JSON.parse(json);
fixLegacyTimestamps(ret.entries);
return ret;
} catch (e) { } catch (e) {
console.log(`Failed to parse Tracker from ${json}`); console.log(`Failed to parse Tracker from ${json}`);
} }
@ -40,7 +42,7 @@ export function loadTracker(json: string): Tracker {
} }
export function displayTracker(tracker: Tracker, element: HTMLElement, file: string, getSectionInfo: () => MarkdownSectionInformation, settings: SimpleTimeTrackerSettings): void { export function displayTracker(tracker: Tracker, element: HTMLElement, file: string, getSectionInfo: () => MarkdownSectionInformation, settings: SimpleTimeTrackerSettings): void {
element.classList.add('simple-time-tracker-container'); element.classList.add("simple-time-tracker-container");
// add start/stop controls // add start/stop controls
let running = isRunning(tracker); let running = isRunning(tracker);
let btn = new ButtonComponent(element) let btn = new ButtonComponent(element)
@ -105,7 +107,7 @@ export function displayTracker(tracker: Tracker, element: HTMLElement, file: str
}, 1000); }, 1000);
} }
function startSubEntry(entry: Entry, name: string) { function startSubEntry(entry: Entry, name: string): void {
// if this entry is not split yet, we add its time as a sub-entry instead // if this entry is not split yet, we add its time as a sub-entry instead
if (!entry.subEntries) { if (!entry.subEntries) {
entry.subEntries = [{...entry, name: `Part 1`}]; entry.subEntries = [{...entry, name: `Part 1`}];
@ -115,19 +117,19 @@ function startSubEntry(entry: Entry, name: string) {
if (!name) if (!name)
name = `Part ${entry.subEntries.length + 1}`; name = `Part ${entry.subEntries.length + 1}`;
entry.subEntries.push({name: name, startTime: moment().unix(), endTime: null, subEntries: null}); entry.subEntries.push({name: name, startTime: moment().toISOString(), endTime: null, subEntries: null});
} }
function startNewEntry(tracker: Tracker, name: string): void { function startNewEntry(tracker: Tracker, name: string): void {
if (!name) if (!name)
name = `Segment ${tracker.entries.length + 1}`; name = `Segment ${tracker.entries.length + 1}`;
let entry: Entry = {name: name, startTime: moment().unix(), endTime: null, subEntries: null}; let entry: Entry = {name: name, startTime: moment().toISOString(), endTime: null, subEntries: null};
tracker.entries.push(entry); tracker.entries.push(entry);
} }
function endRunningEntry(tracker: Tracker): void { function endRunningEntry(tracker: Tracker): void {
let entry = getRunningEntry(tracker.entries); let entry = getRunningEntry(tracker.entries);
entry.endTime = moment().unix(); entry.endTime = moment().toISOString();
} }
function removeEntry(entries: Entry[], toRemove: Entry): boolean { function removeEntry(entries: Entry[], toRemove: Entry): boolean {
@ -171,12 +173,12 @@ function getRunningEntry(entries: Entry[]): Entry {
return null; return null;
} }
function getDuration(entry: Entry) { function getDuration(entry: Entry): number {
if (entry.subEntries) { if (entry.subEntries) {
return getTotalDuration(entry.subEntries); return getTotalDuration(entry.subEntries);
} else { } else {
let endTime = entry.endTime ? moment.unix(entry.endTime) : moment(); let endTime = entry.endTime ? moment(entry.endTime) : moment();
return endTime.diff(moment.unix(entry.startTime)); return endTime.diff(moment(entry.startTime));
} }
} }
@ -187,7 +189,7 @@ function getTotalDuration(entries: Entry[]): number {
return ret; return ret;
} }
function setCountdownValues(tracker: Tracker, current: HTMLElement, total: HTMLElement, currentDiv: HTMLDivElement, settings: SimpleTimeTrackerSettings) { function setCountdownValues(tracker: Tracker, current: HTMLElement, total: HTMLElement, currentDiv: HTMLDivElement, settings: SimpleTimeTrackerSettings): void {
let running = getRunningEntry(tracker.entries); let running = getRunningEntry(tracker.entries);
if (running && !running.endTime) { if (running && !running.endTime) {
current.setText(formatDuration(getDuration(running), settings)); current.setText(formatDuration(getDuration(running), settings));
@ -198,16 +200,16 @@ function setCountdownValues(tracker: Tracker, current: HTMLElement, total: HTMLE
total.setText(formatDuration(getTotalDuration(tracker.entries), settings)); total.setText(formatDuration(getTotalDuration(tracker.entries), settings));
} }
function formatTimestamp(timestamp: number, settings: SimpleTimeTrackerSettings): string { function formatTimestamp(timestamp: string, settings: SimpleTimeTrackerSettings): string {
return moment.unix(timestamp).format(settings.timestampFormat); return moment(timestamp).format(settings.timestampFormat);
} }
function formatEditableTimestamp(timestamp: number, settings: SimpleTimeTrackerSettings) { function formatEditableTimestamp(timestamp: string, settings: SimpleTimeTrackerSettings): string {
return moment.unix(timestamp).format(settings.editableTimestampFormat); return moment(timestamp).format(settings.editableTimestampFormat);
} }
function unformatEditableTimestamp(formatted: string, settings: SimpleTimeTrackerSettings): number { function unformatEditableTimestamp(formatted: string, settings: SimpleTimeTrackerSettings): string {
return moment(formatted, settings.editableTimestampFormat).unix(); return moment(formatted, settings.editableTimestampFormat).toISOString();
} }
function formatDuration(totalTime: number, settings: SimpleTimeTrackerSettings): string { function formatDuration(totalTime: number, settings: SimpleTimeTrackerSettings): string {
@ -233,6 +235,18 @@ function formatDuration(totalTime: number, settings: SimpleTimeTrackerSettings):
return ret; return ret;
} }
function fixLegacyTimestamps(entries: Entry[]): void {
for (let entry of entries) {
if (!isNaN(+entry.startTime))
entry.startTime = moment.unix(+entry.startTime).toISOString();
if (entry.endTime && !isNaN(+entry.endTime))
entry.endTime = moment.unix(+entry.endTime).toISOString();
if (entry.subEntries)
fixLegacyTimestamps(entry.subEntries);
}
}
function createMarkdownTable(tracker: Tracker, settings: SimpleTimeTrackerSettings): string { function createMarkdownTable(tracker: Tracker, settings: SimpleTimeTrackerSettings): string {
let table = [["Segment", "Start time", "End time", "Duration"]]; let table = [["Segment", "Start time", "End time", "Duration"]];
for (let entry of tracker.entries) for (let entry of tracker.entries)
@ -265,7 +279,7 @@ function createCsv(tracker: Tracker, settings: SimpleTimeTrackerSettings): strin
} }
function createTableSection(entry: Entry, settings: SimpleTimeTrackerSettings): string[][] { function createTableSection(entry: Entry, settings: SimpleTimeTrackerSettings): string[][] {
let ret: string[][] = [[ let ret = [[
entry.name, entry.name,
entry.startTime ? formatTimestamp(entry.startTime, settings) : "", entry.startTime ? formatTimestamp(entry.startTime, settings) : "",
entry.endTime ? formatTimestamp(entry.endTime, settings) : "", entry.endTime ? formatTimestamp(entry.endTime, settings) : "",
@ -281,22 +295,26 @@ class EditableField {
cell: HTMLTableCellElement; cell: HTMLTableCellElement;
label: HTMLSpanElement; label: HTMLSpanElement;
box: TextComponent; box: TextComponent;
constructor(row: HTMLTableRowElement, indent: number, value: string) { constructor(row: HTMLTableRowElement, indent: number, value: string) {
this.cell = row.createEl("td"); this.cell = row.createEl("td");
this.label = this.cell.createEl("span", { text: value }); this.label = this.cell.createEl("span", {text: value});
this.label.style.marginLeft = `${indent}em`; this.label.style.marginLeft = `${indent}em`;
this.box = new TextComponent(this.cell).setValue(value); this.box = new TextComponent(this.cell).setValue(value);
this.box.inputEl.classList.add('simple-time-tracker-input'); this.box.inputEl.classList.add("simple-time-tracker-input");
this.box.inputEl.hide(); this.box.inputEl.hide();
} }
editing(): boolean { editing(): boolean {
return this.label.hidden; return this.label.hidden;
} }
beginEdit(value: string) {
beginEdit(value: string): void {
this.label.hidden = true; this.label.hidden = true;
this.box.setValue(value); this.box.setValue(value);
this.box.inputEl.show(); this.box.inputEl.show();
} }
endEdit(): string { endEdit(): string {
const value = this.box.getValue(); const value = this.box.getValue();
this.label.setText(value); this.label.setText(value);
@ -308,20 +326,16 @@ class EditableField {
class EditableTimestampField extends EditableField { class EditableTimestampField extends EditableField {
settings: SimpleTimeTrackerSettings; settings: SimpleTimeTrackerSettings;
constructor(row: HTMLTableRowElement, indent: number, value: string, settings: SimpleTimeTrackerSettings) { constructor(row: HTMLTableRowElement, indent: number, value: string, settings: SimpleTimeTrackerSettings) {
if (value) { super(row, indent, value ? formatTimestamp(value, settings) : "");
const timestamp = Number(value);
value = timestamp > 0 ? formatTimestamp(timestamp, settings) : "";
}
super(row, indent, value);
this.settings = settings; this.settings = settings;
} }
beginEdit(value: string) {
if (value) { beginEdit(value: string): void {
value = formatEditableTimestamp(Number(value), this.settings); super.beginEdit(value ? formatEditableTimestamp(value, this.settings) : "");
}
super.beginEdit(value);
} }
endEdit(): string { endEdit(): string {
const value = this.box.getValue(); const value = this.box.getValue();
let displayValue = value; let displayValue = value;
@ -334,7 +348,8 @@ class EditableTimestampField extends EditableField {
this.label.hidden = false; this.label.hidden = false;
return value; return value;
} }
getTimestamp(): number {
getTimestamp(): string {
if (this.box.getValue()) { if (this.box.getValue()) {
return unformatEditableTimestamp(this.box.getValue(), this.settings); return unformatEditableTimestamp(this.box.getValue(), this.settings);
} else { } else {
@ -343,19 +358,14 @@ class EditableTimestampField extends EditableField {
} }
} }
function nullableNumberToString(value: number) { function addEditableTableRow(tracker: Tracker, entry: Entry, table: HTMLTableElement, newSegmentNameBox: TextComponent, running: boolean, file: string, getSectionInfo: () => MarkdownSectionInformation, settings: SimpleTimeTrackerSettings, indent: number): void {
if (value == null) return '';
return String(value);
}
function addEditableTableRow(tracker: Tracker, entry: Entry, table: HTMLTableElement, newSegmentNameBox: TextComponent, running: boolean, file: string, getSectionInfo: () => MarkdownSectionInformation, settings: SimpleTimeTrackerSettings, indent: number) {
let row = table.createEl("tr"); let row = table.createEl("tr");
let nameField = new EditableField(row, indent, entry.name); let nameField = new EditableField(row, indent, entry.name);
let startField = new EditableTimestampField(row, indent, nullableNumberToString(entry.startTime), settings); let startField = new EditableTimestampField(row, indent, (entry.startTime), settings);
let endField = new EditableTimestampField(row, indent, nullableNumberToString(entry.endTime), settings); let endField = new EditableTimestampField(row, indent, (entry.endTime), settings);
row.createEl("td", { text: entry.endTime || entry.subEntries ? formatDuration(getDuration(entry), settings) : "" }); row.createEl("td", {text: entry.endTime || entry.subEntries ? formatDuration(getDuration(entry), settings) : ""});
let entryButtons = row.createEl("td"); let entryButtons = row.createEl("td");
if (!running) { if (!running) {
@ -376,15 +386,15 @@ function addEditableTableRow(tracker: Tracker, entry: Entry, table: HTMLTableEle
if (nameField.editing()) { if (nameField.editing()) {
entry.name = nameField.endEdit(); entry.name = nameField.endEdit();
startField.endEdit(); startField.endEdit();
entry.startTime = startField.getTimestamp(); entry.startTime = startField.getTimestamp().toString();
endField.endEdit(); endField.endEdit();
entry.endTime = endField.getTimestamp(); entry.endTime = endField.getTimestamp().toString();
await saveTracker(tracker, this.app, file, getSectionInfo()); await saveTracker(tracker, this.app, file, getSectionInfo());
editButton.setIcon("lucide-pencil"); editButton.setIcon("lucide-pencil");
} else { } else {
nameField.beginEdit(entry.name); nameField.beginEdit(entry.name);
startField.beginEdit(nullableNumberToString(entry.startTime)); startField.beginEdit((entry.startTime));
endField.beginEdit(nullableNumberToString(entry.endTime)); endField.beginEdit((entry.endTime));
editButton.setIcon("lucide-check"); editButton.setIcon("lucide-check");
} }
}); });

3
test-vault/.obsidian/core-plugins-migration.json vendored
View file

@ -25,5 +25,6 @@
"publish": false, "publish": false,
"sync": false, "sync": false,
"canvas": true, "canvas": true,
"bookmarks": true "bookmarks": true,
"properties": false
} }

2
test-vault/test/Cool Project.md
View file

@ -2,5 +2,5 @@
These are the notes for my cool project. There's so much left to do! I wish I had a way to track the amount of time I spend on each part of the project. These are the notes for my cool project. There's so much left to do! I wish I had a way to track the amount of time I spend on each part of the project.
```simple-time-tracker ```simple-time-tracker
{"entries":[{"name":"Segment 1","startTime":1666189948,"endTime":1666189951,"subEntries":null},{"name":"Segment 2","startTime":1666189953,"endTime":1666189961,"subEntries":null},{"name":"Segment 3","startTime":null,"endTime":null,"subEntries":[{"name":"Part 1","startTime":1666189962,"endTime":1666189995,"subEntries":null},{"name":"Part 2","startTime":1666190004,"endTime":1666190025,"subEntries":null},{"name":"Part 3","startTime":1666190094,"endTime":1666190101,"subEntries":null}]},{"name":"Segment 4","startTime":1666190088,"endTime":1666190091,"subEntries":null},{"name":"Segment 5","startTime":1684857704,"endTime":1684857708,"subEntries":null},{"name":"Segment 6","startTime":1684857710,"endTime":1684857712,"subEntries":null},{"name":"Segment 7","startTime":1684857729,"endTime":1684857732,"subEntries":null},{"name":"Segment 8","startTime":1684857743,"endTime":1684857748,"subEntries":null}]} {"entries":[{"name":"Segment 1","startTime":"2022-10-19T14:32:28.000Z","endTime":"2022-10-19T14:32:31.000Z","subEntries":null},{"name":"Segment 2","startTime":"2022-10-19T14:32:33.000Z","endTime":"2022-10-19T14:32:41.000Z","subEntries":null},{"name":"Segment 3","startTime":"1970-01-01T00:00:00.000Z","endTime":null,"subEntries":[{"name":"Part 1","startTime":"2022-10-19T14:32:42.000Z","endTime":"2022-10-19T14:33:15.000Z","subEntries":null},{"name":"Part 2","startTime":"2022-10-19T14:33:24.000Z","endTime":"2022-10-19T14:33:45.000Z","subEntries":null},{"name":"Part 3","startTime":"2022-10-19T14:34:54.000Z","endTime":"2022-10-19T14:35:01.000Z","subEntries":null}]},{"name":"Segment 4","startTime":"2022-10-19T14:34:48.000Z","endTime":"2022-10-19T14:34:51.000Z","subEntries":null},{"name":"Segment 5","startTime":"2023-05-23T16:01:44.000Z","endTime":"2023-05-23T16:01:48.000Z","subEntries":null},{"name":"Segment 6","startTime":"2023-05-23T16:01:50.000Z","endTime":"2023-05-23T16:01:52.000Z","subEntries":null},{"name":"Segment 7","startTime":"2023-05-23T16:02:09.000Z","endTime":"2023-05-23T16:02:12.000Z","subEntries":null},{"name":"Segment 8","startTime":"1970-01-01T00:00:00.000Z","endTime":null,"subEntries":[{"name":"Part 1","startTime":"2023-05-23T16:02:20.000Z","endTime":"2023-05-23T16:02:28.000Z","subEntries":null},{"name":"Part 2","startTime":"2023-09-08T11:58:11.000Z","endTime":"2023-09-08T11:58:38.000Z","subEntries":null}]}]}
``` ```