@giicha/joplin-plugin-checkbox-sum 0.0.0-stage → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 giicha
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,71 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Checkbox Sum Calculator (Joplin Plugin)
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
An automated, real-time plugin for **Joplin** that scans your active notes, detects checked (completed) checkboxes, extracts integer numbers from them, and instantly summarizes them in a dedicated sidebar panel.
|
|
4
|
+
|
|
5
|
+
It works natively across **both layouts**: standard Markdown lists and complex visual HTML tables generated by the Rich Text (WYSIWYG) editor.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## ✨ Features
|
|
10
|
+
|
|
11
|
+
* **Instant Dynamic Calculation:** Updates the total sum automatically a couple of seconds after you click a checkbox. No manual triggers required.
|
|
12
|
+
* **Smart Bold-Number Filter:** Explicitly ignores any numbers formatted as **bold text**. This lets you freely write item titles, serial codes, or model IDs containing digits without messing up your math.
|
|
13
|
+
* **Enhanced Details Breakdown:** Lists every counted row with its calculated sum highlighted in **bold**, followed by the formatted row content inside brackets.
|
|
14
|
+
* **Table Column Isolation:** Automatically excludes completely empty structural table columns/cells to keep the Details timeline compact and clear.
|
|
15
|
+
* **Toolbar Visibility Toggle:** Includes a customized plus-square button (`+`) on your main note toolbar to easily show or hide the side panel on demand.
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## 📊 Live Examples & Formatting Rules
|
|
20
|
+
|
|
21
|
+
### 🛠️ Rule: Bypassing Model Names with Numbers
|
|
22
|
+
If a row contains numbers that represent a model name or item count rather than a price, simply format them as **bold** (`**number**` in Markdown or using the `B` tool in the visual editor). The plugin will ignore bold numbers and add only regular numbers to the total sum.
|
|
23
|
+
|
|
24
|
+
#### Example 1: Rich Text HTML Tables
|
|
25
|
+
|
|
26
|
+
| Status | Item Specification | Price |
|
|
27
|
+
| :--- | :--- | :--- |
|
|
28
|
+
| 🟩 (Checked) | **Boeing 747 Airplane Model** | 1200 |
|
|
29
|
+
| 🟩 (Checked) | **Ergonomic Chair v2 Office** | 350 |
|
|
30
|
+
| ⬜ (Unchecked) | **Monitor 4K UltraHD** | 500 (Ignored) |
|
|
31
|
+
|
|
32
|
+
* **Panel Total:** `1550` (Calculates: 1200 + 350. The bolded `747` and `2` are safely filtered out).
|
|
33
|
+
* **Details List Displayed:**
|
|
34
|
+
* **1200** (Boeing **747** Airplane Model → 1200)
|
|
35
|
+
* **350** (Ergonomic Chair v**2** Office → 350)
|
|
36
|
+
|
|
37
|
+
#### Example 2: Standard Markdown List
|
|
38
|
+
```markdown
|
|
39
|
+
- [x] Bought **3** monitors for 900 USD
|
|
40
|
+
- [x] Paid **1** internet bill: 60 USD
|
|
41
|
+
- [ ] Upcoming order **2026** invoice: 150 USD (Ignored)
|
|
42
|
+
```
|
|
43
|
+
* **Panel Total:** `960` (Calculates: 900 + 60. The bolded counts `3` and `1` are ignored).
|
|
44
|
+
* **Details List Displayed:**
|
|
45
|
+
* **900** (Bought **3** monitors for 900 USD)
|
|
46
|
+
* **60** (Paid **1** internet bill: 60 USD)
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## 🛠️ Installation
|
|
51
|
+
|
|
52
|
+
### Manual Installation (.jpl file)
|
|
53
|
+
1. Download the latest compiled extension file from the `publish/` directory of this repository (e.g., `com.giicha.joplin-checkboxes-sum-plugin.jpl`).
|
|
54
|
+
2. Run **Joplin**.
|
|
55
|
+
3. Go to the top menu: **Tools** -> **Options** -> **Plugins**.
|
|
56
|
+
4. Click the gear icon (⚙️) located in the upper right section of the menu and select **Install from file**.
|
|
57
|
+
5. Select the downloaded `.jpl` bundle file and **restart Joplin**.
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## 🚀 Getting Started
|
|
62
|
+
|
|
63
|
+
1. Click the **Plus Square (`+`)** action button on your note toolbar to bring up the *Checkbox Sum* sidebar interface.
|
|
64
|
+
2. Begin checking checkboxes or table rows within your note body.
|
|
65
|
+
3. Check the calculated sum score changes instantly. A helpful disclaimer notice is appended to the bottom layout to remind you about the structural rules.
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## 📄 License
|
|
70
|
+
|
|
71
|
+
This repository is distributed under the terms of the **MIT License**. You are free to copy, modify, distribute, or use this extension setup commercially, provided the original author credits remain intact. See the `LICENSE` file for details.
|
package/README.md.bak
ADDED
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# Checkbox Sum Calculator (Joplin Plugin)
|
|
2
|
+
|
|
3
|
+
An automated, real-time plugin for **Joplin** that scans your active notes, detects checked (completed) checkboxes, extracts integer numbers from them, and instantly summarizes them in a dedicated sidebar panel.
|
|
4
|
+
|
|
5
|
+
It works natively across **both layouts**: standard Markdown lists and complex visual HTML tables generated by the Rich Text (WYSIWYG) editor.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## ✨ Features
|
|
10
|
+
|
|
11
|
+
* **Instant Dynamic Calculation:** Updates the total sum automatically a couple of seconds after you click a checkbox. No manual triggers required.
|
|
12
|
+
* **Smart Bold-Number Filter:** Explicitly ignores any numbers formatted as **bold text**. This lets you freely write item titles, serial codes, or model IDs containing digits without messing up your math.
|
|
13
|
+
* **Enhanced Details Breakdown:** Lists every counted row with its calculated sum highlighted in **bold**, followed by the formatted row content inside brackets.
|
|
14
|
+
* **Table Column Isolation:** Automatically excludes completely empty structural table columns/cells to keep the Details timeline compact and clear.
|
|
15
|
+
* **Toolbar Visibility Toggle:** Includes a customized plus-square button (`+`) on your main note toolbar to easily show or hide the side panel on demand.
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## 📊 Live Examples & Formatting Rules
|
|
20
|
+
|
|
21
|
+
### 🛠️ Rule: Bypassing Model Names with Numbers
|
|
22
|
+
If a row contains numbers that represent a model name or item count rather than a price, simply format them as **bold** (`**number**` in Markdown or using the `B` tool in the visual editor). The plugin will ignore bold numbers and add only regular numbers to the total sum.
|
|
23
|
+
|
|
24
|
+
#### Example 1: Rich Text HTML Tables
|
|
25
|
+
|
|
26
|
+
| Status | Item Specification | Price |
|
|
27
|
+
| :--- | :--- | :--- |
|
|
28
|
+
| 🟩 (Checked) | Boeing **747** Airplane Model | 1200 |
|
|
29
|
+
| 🟩 (Checked) | Ergonomic Chair v**2** Office | 350 |
|
|
30
|
+
| ⬜ (Unchecked) | Monitor **4K** UltraHD | 500 (Ignored) |
|
|
31
|
+
|
|
32
|
+
* **Panel Total:** `1550` (Calculates: 1200 + 350. The bolded `747` and `2` are safely filtered out).
|
|
33
|
+
* **Details List Displayed:**
|
|
34
|
+
* **1200** (Boeing **747** Airplane Model → 1200)
|
|
35
|
+
* **350** (Ergonomic Chair v**2** Office → 350)
|
|
36
|
+
|
|
37
|
+
#### Example 2: Standard Markdown List
|
|
38
|
+
```markdown
|
|
39
|
+
- [x] Bought **3** monitors for 900 USD
|
|
40
|
+
- [x] Paid **1** internet bill: 60 USD
|
|
41
|
+
- [ ] Upcoming order **2026** invoice: 150 USD (Ignored)
|
|
42
|
+
```
|
|
43
|
+
* **Panel Total:** `960` (Calculates: 900 + 60. The bolded counts `3` and `1` are ignored).
|
|
44
|
+
* **Details List Displayed:**
|
|
45
|
+
* **900** (Bought **3** monitors for 900 USD)
|
|
46
|
+
* **60** (Paid **1** internet bill: 60 USD)
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## 🛠️ Installation
|
|
51
|
+
|
|
52
|
+
### Manual Installation (.jpl file)
|
|
53
|
+
1. Download the latest compiled extension file from the `publish/` directory of this repository (e.g., `com.giicha.joplin-checkboxes-sum-plugin.jpl`).
|
|
54
|
+
2. Run **Joplin**.
|
|
55
|
+
3. Go to the top menu: **Tools** -> **Options** -> **Plugins**.
|
|
56
|
+
4. Click the gear icon (⚙️) located in the upper right section of the menu and select **Install from file**.
|
|
57
|
+
5. Select the downloaded `.jpl` bundle file and **restart Joplin**.
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## 🚀 Getting Started
|
|
62
|
+
|
|
63
|
+
1. Click the **Plus Square (`+`)** action button on your note toolbar to bring up the *Checkbox Sum* sidebar interface.
|
|
64
|
+
2. Begin checking checkboxes or table rows within your note body.
|
|
65
|
+
3. Check the calculated sum score changes instantly. A helpful disclaimer notice is appended to the bottom layout to remind you about the structural rules.
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## 📄 License
|
|
70
|
+
|
|
71
|
+
This repository is distributed under the terms of the **MIT License**. You are free to copy, modify, distribute, or use this extension setup commercially, provided the original author credits remain intact. See the `LICENSE` file for details.
|
package/package.json
CHANGED
|
@@ -1,6 +1,29 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@giicha/joplin-plugin-checkbox-sum",
|
|
3
|
-
"version": "
|
|
4
|
-
"
|
|
5
|
-
|
|
6
|
-
|
|
3
|
+
"version": "1.0.5",
|
|
4
|
+
"scripts": {
|
|
5
|
+
"dist": "webpack --env joplin-plugin-config=buildMain && webpack --env joplin-plugin-config=buildExtraScripts && webpack --env joplin-plugin-config=createArchive",
|
|
6
|
+
"prepare": "npm run dist",
|
|
7
|
+
"updateVersion": "webpack --env joplin-plugin-config=updateVersion",
|
|
8
|
+
"update": "npm install -g generator-joplin && yo joplin --node-package-manager npm --update --force"
|
|
9
|
+
},
|
|
10
|
+
"license": "MIT",
|
|
11
|
+
"keywords": [
|
|
12
|
+
"joplin-plugin"
|
|
13
|
+
],
|
|
14
|
+
"files": [
|
|
15
|
+
"publish"
|
|
16
|
+
],
|
|
17
|
+
"devDependencies": {
|
|
18
|
+
"@types/node": "^18.7.13",
|
|
19
|
+
"chalk": "^4.1.0",
|
|
20
|
+
"copy-webpack-plugin": "^11.0.0",
|
|
21
|
+
"fs-extra": "^10.1.0",
|
|
22
|
+
"glob": "^8.0.3",
|
|
23
|
+
"tar": "^6.1.11",
|
|
24
|
+
"ts-loader": "^9.3.1",
|
|
25
|
+
"typescript": "^4.8.2",
|
|
26
|
+
"webpack": "^5.74.0",
|
|
27
|
+
"webpack-cli": "^4.10.0"
|
|
28
|
+
}
|
|
29
|
+
}
|
|
Binary file
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
{
|
|
2
|
+
"manifest_version": 1,
|
|
3
|
+
"id": "com.giicha.joplin-checkboxes-sum-plugin",
|
|
4
|
+
"app_min_version": "3.7",
|
|
5
|
+
"version": "1.0.0",
|
|
6
|
+
"name": "Checkbox Sum",
|
|
7
|
+
"description": "Sum up all numbers inside note checkboxes.",
|
|
8
|
+
"author": "giicha",
|
|
9
|
+
"homepage_url": "",
|
|
10
|
+
"repository_url": "https://github.com/giicha/joplin-checkboxes-sum-plugin",
|
|
11
|
+
"keywords": [],
|
|
12
|
+
"categories": [],
|
|
13
|
+
"screenshots": [],
|
|
14
|
+
"icons": {},
|
|
15
|
+
"promo_tile": {},
|
|
16
|
+
"_publish_hash": "sha256:f864b1031bdee96e7ae62793f509e65c4fbf0025737ffcc4a587ed5157649051",
|
|
17
|
+
"_publish_commit": "master:aa4e7867781c25d0187d36e3c5605b0e5b0b8830"
|
|
18
|
+
}
|