https://github.com/raboro/obsidian-expiration-date-tracker-plugin

Opsidian plugin to keep track of all expiration dates, for example, for your groceries.
https://github.com/raboro/obsidian-expiration-date-tracker-plugin

ci eslinter javascript obsidian obsidian-plugin react typescript

Last synced: 2 months ago
JSON representation

Opsidian plugin to keep track of all expiration dates, for example, for your groceries.

• Host: GitHub
• URL: https://github.com/raboro/obsidian-expiration-date-tracker-plugin
• Owner: Raboro
• License: mit
• Created: 2023-08-22T19:26:49.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-07T20:52:29.000Z (over 1 year ago)
• Last Synced: 2025-03-24T03:53:20.197Z (3 months ago)
• Topics: ci, eslinter, javascript, obsidian, obsidian-plugin, react, typescript
• Language: TypeScript
• Homepage:
• Size: 692 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Obsidian-Expiration-Date-Tracker-Plugin

[![Latest Release](https://img.shields.io/github/v/release/Raboro/obsidian-expiration-date-tracker-plugin?include_prereleases&sort=semver&style=for-the-badge)](https://github.com/Raboro/obsidian-expiration-date-tracker-plugin/releases/latest) [![Total Downloads](https://img.shields.io/github/downloads/Raboro/obsidian-expiration-date-tracker-plugin/total?style=for-the-badge)](https://github.com/Raboro/obsidian-expiration-date-tracker-plugin/releases/latest)

[![Linter Workflow Status](https://img.shields.io/github/actions/workflow/status/Raboro/obsidian-expiration-date-tracker-plugin/linter.yml?branch=main&logo=github&style=for-the-badge)](https://github.com/Raboro/obsidian-expiration-date-tracker-plugin/actions/workflows/linter.yml)

[![Release Workflow Status](https://img.shields.io/github/actions/workflow/status/Raboro/obsidian-expiration-date-tracker-plugin/release.yml?branch=main&logo=github&style=for-the-badge)](https://github.com/Raboro/obsidian-expiration-date-tracker-plugin/actions/workflows/release.yml)

With this plugin you can keep track of all the expiration dates of your items such as groceries.

![Main Demo image](assets/MainDemo.png)

## Using

You need a file containing all the expiration data. To find the file you need to add the location in the settings. After that you can add your items in a table:

| Name | Date | Number of Elements | 

| --- | --- | --- | 

| apple | 29/08/2023 | 3 | 

| banana | 22/12/2023 | 200g | 

After that you can click on the ribbon icon or use the ``Track Expiration Dates`` command to trigger the data collection. Then all items are displayed in a separate view. You also get a notice for all expired items.

The Expiration Category contains the category name, the items within this category and the expand button. This button will show/hide all your items within this category. The Item contains the name, the number of elements (which can be a number like 10 apples of a string like 200g banana) and the days till it expires.

## Commands 

You can search for a specific item or category or track all your expiration dates. The data you searched for will be displayed in a modal.

![Command demo image](assets/CommandsDemo.png)

## Settings

You can set a date formatting. The default is: ``DD/MM/YYYY``. This is needed to collect your dates and display them. Also you can set the location of the file containing the expiration data. This must include `.md` as postfix. The default value is: `expirationDateNode.md`. \

You can also set all thresholds for the expiration categories. The default values are (in days):

- Expired: 0,

- Critical: 1,

- Very High: 2,

- High: 3,

- Medium: 5,

- Low: 10

For example if your item will expire in 6 days, it´s in the Low expiration category.

![Settings Demo image](assets/SettingsDemo.png)