@narumitw/pi-ticker 0.0.0 → 0.1.0

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.
Files changed (2) hide show
  1. package/README.md +18 -15
  2. package/package.json +5 -8
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  [![npm](https://img.shields.io/npm/v/@narumitw/pi-ticker)](https://www.npmjs.com/package/@narumitw/pi-ticker) [![Pi extension](https://img.shields.io/badge/Pi-extension-blue)](https://pi.dev) [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](./LICENSE)
4
4
 
5
- Show configurable Yahoo Finance market quotes in a width-aware widget above Pi's editor.
5
+ Pi Ticker shows configurable Yahoo Finance quotes in a width-aware widget above Pi's editor.
6
6
 
7
7
  ## ✨ Features
8
8
 
@@ -11,7 +11,7 @@ Show configurable Yahoo Finance market quotes in a width-aware widget above Pi's
11
11
  - Packs complete ticker entries into rows that fit the current terminal width.
12
12
  - Provides searchable TUI and RPC menus for adding, removing, and reordering symbols.
13
13
  - Persists widget visibility and the ordered symbol list in user settings.
14
- - Refreshes every 30 seconds while enabled and marks the last successful quote stale after a partial failure.
14
+ - Refreshes every 30 seconds while enabled, keeps successful results, and marks failed symbols' previous quotes stale.
15
15
  - Cancels polling, in-flight requests, and active menus during reload, session replacement, and shutdown.
16
16
 
17
17
  ## 📦 Install
@@ -43,7 +43,7 @@ Extensions run with Pi's permissions, so install only trusted packages.
43
43
 
44
44
  ## 🚀 Quick start
45
45
 
46
- Run Pi in TUI mode and open the ticker manager:
46
+ Open the ticker manager in TUI mode:
47
47
 
48
48
  ```text
49
49
  /ticker
@@ -57,26 +57,28 @@ The widget appears after the settings save and the first quote request completes
57
57
 
58
58
  `/ticker` opens **Manage tickers** in TUI and RPC modes.
59
59
 
60
- TUI mode keeps search, symbol removal, direct add, widget visibility, and refresh actions on one screen.
60
+ In TUI mode, one screen provides search, symbol removal, direct add, widget visibility, and refresh actions.
61
61
 
62
62
  The configured confirm binding or Space activates the focused row.
63
63
 
64
- An unmatched valid search changes the add row to **Add SYMBOL** so the symbol can be added directly.
64
+ When a valid search has no match, the add row changes to **Add SYMBOL** for direct addition.
65
65
 
66
66
  `Shift+Up` and `Shift+Down` reorder the focused ticker when the search field is empty and those keys do not conflict with configured standard bindings.
67
67
 
68
68
  RPC mode exposes portable dialogs for choosing and moving a ticker.
69
69
 
70
- Every accepted change saves immediately, and a failed save restores the previous displayed and effective value.
70
+ Each accepted change saves immediately.
71
71
 
72
- Removing the final ticker hides the widget and stops polling.
72
+ If a save fails, the manager restores the previous displayed and effective value.
73
+
74
+ Removing the final symbol hides the widget and stops polling.
73
75
 
74
76
  Escape closes transient TUI flows, and `Ctrl+C` remains a hard-close path.
75
77
 
76
78
  ## 💬 Commands
77
79
 
78
80
  - `/ticker` opens the ticker manager.
79
- - `/ticker <SYMBOL ...>` replaces the ordered symbol list and refreshes quotes.
81
+ - `/ticker <SYMBOL ...>` replaces the complete ordered symbol list and refreshes quotes.
80
82
  - `/ticker refresh` refreshes quotes immediately when the widget is enabled.
81
83
  - `/ticker help` shows direct-command usage.
82
84
  - `/ticker reset` reports that no default symbol list exists and leaves settings unchanged.
@@ -105,7 +107,7 @@ The extension does not read project settings or extension-specific environment-v
105
107
 
106
108
  A missing file uses an empty symbol list, keeps the widget enabled, and does not create the file, its parent directory, or a polling task.
107
109
 
108
- The file must contain a JSON object with these optional fields:
110
+ The settings file must contain a JSON object with these optional fields:
109
111
 
110
112
  | Field | Accepted values | Default | Behavior |
111
113
  | --- | --- | --- | --- |
@@ -127,7 +129,9 @@ Example:
127
129
 
128
130
  Unknown JSON fields are preserved during saves.
129
131
 
130
- Malformed or invalid settings are reported, ignored at runtime, and never overwritten by the extension.
132
+ Malformed or invalid settings use runtime defaults and leave the file unchanged.
133
+
134
+ Pi shows a warning when UI is available.
131
135
 
132
136
  Writes are ordered within one Pi process and published through a temporary file plus atomic rename.
133
137
 
@@ -139,13 +143,13 @@ Settings reload on startup and `/reload`.
139
143
 
140
144
  ## 🔒 Security and privacy
141
145
 
142
- The extension requests public chart metadata from Yahoo Finance over HTTPS without an API key.
146
+ The extension requests public quote metadata from Yahoo Finance over HTTPS without an API key.
143
147
 
144
148
  Requested ticker symbols and the host network address are visible to Yahoo Finance.
145
149
 
146
150
  The user settings file contains only ticker symbols and widget visibility; it stores no credential or secret.
147
151
 
148
- Ticker symbols and quote data are shown locally and are not added to model context by this extension.
152
+ The extension displays ticker symbols and quote data locally without adding them to model context.
149
153
 
150
154
  ## 🚧 Limitations
151
155
 
@@ -155,7 +159,7 @@ Quotes may be delayed and are not suitable for trading decisions.
155
159
 
156
160
  Each request times out after 10 seconds, and one symbol failure does not discard successful symbols.
157
161
 
158
- The polling queue is owned by one Pi session and is not shared across Pi processes.
162
+ Each Pi session owns its polling queue, and separate Pi processes do not share one.
159
163
 
160
164
  ## 🗂️ Package layout
161
165
 
@@ -185,5 +189,4 @@ Pi extension, market quotes, stock ticker, Yahoo Finance, editor widget, termina
185
189
 
186
190
  ## 📄 License
187
191
 
188
- MIT.
189
- See [`LICENSE`](./LICENSE).
192
+ [MIT](./LICENSE)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@narumitw/pi-ticker",
3
- "version": "0.0.0",
3
+ "version": "0.1.0",
4
4
  "description": "Pi extension that shows configurable Yahoo Finance quotes above the editor.",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -27,9 +27,6 @@
27
27
  "./dist/index.ts"
28
28
  ]
29
29
  },
30
- "piExtension": {
31
- "lifecycle": "stable"
32
- },
33
30
  "scripts": {
34
31
  "build": "node scripts/build-runtime.mjs",
35
32
  "check": "npm run build && biome check . && npm run typecheck",
@@ -45,10 +42,10 @@
45
42
  "@earendil-works/pi-tui": "*"
46
43
  },
47
44
  "devDependencies": {
48
- "@biomejs/biome": "2.5.10",
49
- "@earendil-works/pi-coding-agent": "0.84.3",
50
- "@earendil-works/pi-tui": "0.84.3",
51
- "@types/node": "26.2.0",
45
+ "@biomejs/biome": "2.5.11",
46
+ "@earendil-works/pi-coding-agent": "0.84.4",
47
+ "@earendil-works/pi-tui": "0.84.4",
48
+ "@types/node": "26.4.0",
52
49
  "esbuild": "0.28.2",
53
50
  "typescript": "7.0.2"
54
51
  },