forked from mcndt/obsidian-toggl-integration
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
69 changed files
with
27,442 additions
and
14,865 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
OUTDIR="/Users/maximecannoodt/Documents/obsidian-test-vault/test-vault/.obsidian/plugins/obsidian-toggl-integration" | ||
DEBUG=TRUE |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
OUTDIR="./test-vault/.obsidian/plugins/obsidian-toggl-integration" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,45 @@ | ||
{ | ||
"root": true, | ||
"parser": "@typescript-eslint/parser", | ||
"env": { "node": true }, | ||
"plugins": [ | ||
"@typescript-eslint" | ||
], | ||
"extends": [ | ||
"eslint:recommended", | ||
"plugin:@typescript-eslint/eslint-recommended", | ||
"plugin:@typescript-eslint/recommended" | ||
], | ||
"parserOptions": { | ||
"sourceType": "module" | ||
}, | ||
"rules": { | ||
"no-unused-vars": "off", | ||
"@typescript-eslint/no-unused-vars": ["error", { "args": "none" }], | ||
"@typescript-eslint/ban-ts-comment": "off", | ||
"no-prototype-builtins": "off", | ||
"@typescript-eslint/no-empty-function": "off" | ||
} | ||
} | ||
"root": true, | ||
"parser": "@typescript-eslint/parser", | ||
"env": { "node": true }, | ||
"plugins": ["@typescript-eslint", "import", "sort-keys-fix"], | ||
"extends": [ | ||
"eslint:recommended", | ||
"plugin:@typescript-eslint/eslint-recommended", | ||
"plugin:@typescript-eslint/recommended", | ||
"plugin:import/errors", | ||
"plugin:import/warnings", | ||
"plugin:import/typescript" | ||
], | ||
"parserOptions": { | ||
"sourceType": "module" | ||
}, | ||
"rules": { | ||
"sort-keys-fix/sort-keys-fix": "warn", | ||
"no-unused-vars": "off", | ||
"@typescript-eslint/no-unused-vars": ["error", { "args": "none" }], | ||
"@typescript-eslint/ban-ts-comment": "off", | ||
"no-prototype-builtins": "off", | ||
"@typescript-eslint/no-empty-function": "off", | ||
"import/no-unresolved": "off", | ||
"import/order": [ | ||
"warn", | ||
{ | ||
"groups": ["builtin", "external", "internal", "parent", "sibling"], | ||
"pathGroups": [ | ||
{ | ||
"pattern": "react", | ||
"group": "external", | ||
"position": "before" | ||
} | ||
], | ||
"pathGroupsExcludedImportTypes": [], | ||
"newlines-between": "always", | ||
"alphabetize": { | ||
"order": "asc", | ||
"caseInsensitive": false | ||
} | ||
} | ||
] | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,9 @@ | ||
{ | ||
"semi": true, | ||
"trailingComma": "none", | ||
"singleQuote": true, | ||
"useTabs": true, | ||
"trailingComma": "all", | ||
"singleQuote": false, | ||
"useTabs": false, | ||
"tabWidth": 2, | ||
"printWidth": 80, | ||
"jsxBracketSameLine": true | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,20 @@ | ||
{ | ||
"editor.formatOnSave": true, | ||
"editor.formatOnSave": true, | ||
"editor.codeActionsOnSave": { | ||
"source.fixAll.eslint": true | ||
}, | ||
"[html]": { | ||
"editor.defaultFormatter": "esbenp.prettier-vscode" | ||
}, | ||
"[javascript]": { | ||
}, | ||
"[javascript]": { | ||
"editor.defaultFormatter": "esbenp.prettier-vscode" | ||
}, | ||
"[typescript]": { | ||
}, | ||
"[typescript]": { | ||
"editor.defaultFormatter": "esbenp.prettier-vscode" | ||
}, | ||
"editor.rulers": [ | ||
80 | ||
], | ||
"conventionalCommits.scopes": [ | ||
"reports", | ||
"api" | ||
] | ||
} | ||
}, | ||
"editor.rulers": [80], | ||
"editor.tabSize": 2, | ||
"editor.detectIndentation": false, | ||
"conventionalCommits.scopes": ["reports", "api"], | ||
"editor.definitionLinkOpensInPeek": true | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,61 +1,67 @@ | ||
[![GitHub tag (Latest by date)](https://img.shields.io/github/v/tag/mcndt/obsidian-toggl-integration)](https://github.com/mcndt/obsidian-toggl-integration/releases) ![GitHub all releases](https://img.shields.io/github/downloads/mcndt/obsidian-toggl-integration/total) | ||
# Toggl Track Integration for Obsidian | ||
Add integration with the Toggl Track API to manage your timers inside Obsidian. | ||
|
||
## Functionality | ||
- ✨ **NEW**: **Generate time tracking reports inside of your notes with code blocks** | ||
- See your current timer and how long it has been running in the status bar | ||
- Get a summary of your day in the side panel | ||
- Create, start, and stop a new timer using the command palette, or restart an recent one | ||
|
||
![](https://raw.githubusercontent.com/mcndt/obsidian-toggl-integration/master/demo2.gif) | ||
|
||
## Rendering time reports inside your notes | ||
|
||
Using simple code blocks it is possible to render time tracking reports inside your Obsidian notes. For example, | ||
|
||
~~~ | ||
```toggl | ||
SUMMARY | ||
PAST 7 DAYS | ||
``` | ||
~~~ | ||
|
||
Will result in something like: | ||
|
||
![example-summary-report](https://user-images.githubusercontent.com/23149353/148293946-4e70ede9-0a9f-401e-af4b-f954caaeed84.png) | ||
|
||
You can find a full tutorial and reference on rendering time reports in the [plugin wiki](https://github.com/mcndt/obsidian-toggl-integration/wiki/Toggl-Query-Language-(TQL)-Reference). | ||
|
||
## Setup | ||
|
||
Configuring this plugin requires you to first request an API token from Toggl. More info on how to do this [can be found here](https://support.toggl.com/en/articles/3116844-where-is-my-api-token-located). | ||
|
||
To set up this plugin, simply enter your API token in the settings tab, click connect and select the Toggl Workspace you wish to use. | ||
|
||
![settings](https://raw.githubusercontent.com/mcndt/obsidian-toggl-integration/master/settings.png) | ||
|
||
## Use with other plugins: | ||
|
||
### QuickAdd | ||
|
||
The developer of the QuickAdd plugin has created a preset menu for timers using QuickAdd. Instructions are available [here](https://github.com/chhoumann/quickadd/blob/master/docs/Examples/Macro_TogglManager.md) and you can find out how he did it on the Obsidian Discord server ([link to message](https://discord.com/channels/686053708261228577/707816848615407697/876069796553293835)). | ||
|
||
## Roadmap | ||
|
||
You can see my more detailed roadmap for this plugin on this page: [Development Roadmap](https://github.com/mcndt/obsidian-toggl-integration/projects/1). I try to keep the cards in each column sorted by priority. | ||
|
||
## Feature Requests | ||
Please make feature requests in the GitHub discussions tab: [click here](https://github.com/mcndt/obsidian-toggl-integration/discussions/categories/feature-requests) | ||
|
||
If you would to like to talk about the plugin with me more directly, you can find me in the Obsidian Discord server as `Maximio#6460`. Feel free to tag me! | ||
|
||
## Dependencies | ||
Currently I rely on this repo for providing a JavaScript interface with the Toggl Track API: https://github.com/saintedlama/toggl-client | ||
|
||
However in the future I might write fork this so I can refactor it to use mobile friendly APIs (e.g. using Obsidian’s own request API). | ||
|
||
## Support | ||
If you like this plugin and want to support me, you can do so via *Buy me a Coffee*: | ||
|
||
<a href="https://www.buymeacoffee.com/mcndt"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=mcndt&button_colour=5F7FFF&font_colour=ffffff&font_family=Inter&outline_colour=000000&coffee_colour=FFDD00"></a> | ||
[![GitHub tag (Latest by date)](https://img.shields.io/github/v/tag/mcndt/obsidian-toggl-integration)](https://github.com/mcndt/obsidian-toggl-integration/releases) ![GitHub all releases](https://img.shields.io/github/downloads/mcndt/obsidian-toggl-integration/total) | ||
|
||
# Toggl Track Integration for Obsidian | ||
|
||
Add integration with the Toggl Track API to manage your timers inside Obsidian. | ||
|
||
## Functionality | ||
|
||
- ✨ **NEW**: **Generate time tracking reports inside of your notes with code blocks** | ||
- See your current timer and how long it has been running in the status bar | ||
- Get a summary of your day in the side panel | ||
- Create, start, and stop a new timer using the command palette, or restart an recent one | ||
|
||
![](https://raw.githubusercontent.com/mcndt/obsidian-toggl-integration/master/demo2.gif) | ||
|
||
## Rendering time reports inside your notes | ||
|
||
Using simple code blocks it is possible to render time tracking reports inside your Obsidian notes. For example, | ||
|
||
```` | ||
```toggl | ||
SUMMARY | ||
PAST 7 DAYS | ||
``` | ||
```` | ||
|
||
Will result in something like: | ||
|
||
![example-summary-report](https://user-images.githubusercontent.com/23149353/148293946-4e70ede9-0a9f-401e-af4b-f954caaeed84.png) | ||
|
||
You can find a full tutorial and reference on rendering time reports in the [plugin wiki](<https://github.com/mcndt/obsidian-toggl-integration/wiki/Toggl-Query-Language-(TQL)-Reference>). | ||
|
||
## Setup | ||
|
||
Configuring this plugin requires you to first request an API token from Toggl. More info on how to do this [can be found here](https://support.toggl.com/en/articles/3116844-where-is-my-api-token-located). | ||
|
||
To set up this plugin, simply enter your API token in the settings tab, click connect and select the Toggl Workspace you wish to use. | ||
|
||
![settings](https://raw.githubusercontent.com/mcndt/obsidian-toggl-integration/master/settings.png) | ||
|
||
## Use with other plugins: | ||
|
||
### QuickAdd | ||
|
||
The developer of the QuickAdd plugin has created a preset menu for timers using QuickAdd. Instructions are available [here](https://github.com/chhoumann/quickadd/blob/master/docs/Examples/Macro_TogglManager.md) and you can find out how he did it on the Obsidian Discord server ([link to message](https://discord.com/channels/686053708261228577/707816848615407697/876069796553293835)). | ||
|
||
## Roadmap | ||
|
||
You can see my more detailed roadmap for this plugin on this page: [Development Roadmap](https://github.com/mcndt/obsidian-toggl-integration/projects/1). I try to keep the cards in each column sorted by priority. | ||
|
||
## Feature Requests | ||
|
||
Please make feature requests in the GitHub discussions tab: [click here](https://github.com/mcndt/obsidian-toggl-integration/discussions/categories/feature-requests) | ||
|
||
If you would to like to talk about the plugin with me more directly, you can find me in the Obsidian Discord server as `Maximio#6460`. Feel free to tag me! | ||
|
||
## Dependencies | ||
|
||
Currently I rely on this repo for providing a JavaScript interface with the Toggl Track API: https://github.com/saintedlama/toggl-client | ||
|
||
However in the future I might write fork this so I can refactor it to use mobile friendly APIs (e.g. using Obsidian’s own request API). | ||
|
||
## Support | ||
|
||
If you like this plugin and want to support me, you can do so via _Buy me a Coffee_: | ||
|
||
<a href="https://www.buymeacoffee.com/mcndt"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=mcndt&button_colour=5F7FFF&font_colour=ffffff&font_family=Inter&outline_colour=000000&coffee_colour=FFDD00"></a> |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,4 @@ | ||
declare module 'toggl-client'; | ||
declare module 'simple-svelte-autocomplete'; | ||
declare module "toggl-client"; | ||
declare module "simple-svelte-autocomplete"; | ||
declare module "obsidian"; | ||
declare module "env"; |
Oops, something went wrong.