lightweight-charts-indicators 0.23.1 → 0.24.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.
package/AGENTS.md CHANGED
@@ -15,6 +15,7 @@ read the skill first: [skills/lightweight-charts-indicators/SKILL.md](skills/lig
15
15
  | `src/chart-context.ts`, `src/other-symbol.ts`, `src/alert-states.ts`, ... | Shared helpers (`lightweight-charts-indicators/helpers`) |
16
16
  | `src/style-outputs*.ts`, `src/reference-names.ts`, `src/value-formats.ts` | Generated tables: do not edit by hand |
17
17
  | `docs/INDICATOR_INVENTORY*.md` | Catalogue |
18
+ | `src/about.json`, `scripts/about/` | Help text of every entry (the `./about` entry) and the scripts that write and check them |
18
19
  | `tests/unit/` | Unit suite (seeded bars, no network) |
19
20
  | `tests/reference-regression/`, `tests/regression/` | Reference suites (local or private data) |
20
21
  | `skills/lightweight-charts-indicators/` | Agent guide and its tested examples (shipped in the package) |
@@ -37,5 +38,6 @@ npm run test:pinesuite # reference CSV comparison (needs PINESUITE_TOKEN)
37
38
  object; it is registered in `src/index.ts` with a unique kebab-case id and `overlay` equal to `metadata.overlay`.
38
39
  - `calculate(bars, inputs?, chart?)` is pure and returns one point per bar for every declared plot (`NaN` = no value).
39
40
  - Ports follow their original script; a deliberate difference is commented in the code.
40
- - Every new indicator gets a unit test; typecheck, tests and build pass before a commit.
41
+ - Every new indicator gets a unit test and a help text (`node scripts/about/write.mjs`, then `node scripts/about/check.mjs`);
42
+ typecheck, tests and build pass before a commit.
41
43
  - Do not bump `version` (in `package.json` and `src/index.ts`) or tag outside a release: a `v*` tag publishes.
@@ -0,0 +1,4 @@
1
+ /** Registry id -> what the indicator computes, how to read it and its main inputs (plain English, at most 500 characters). */
2
+ export declare const indicatorAbout: Readonly<Record<string, string>>;
3
+ /** The help text of a registry entry, undefined for an id without one. */
4
+ export declare function aboutIndicator(id: string): string | undefined;