Skip to content

Commit 3ff104f

Browse files
author
Niilo Keinänen
committed
Drafting 1st version of lightningchart-js skill
1 parent b395ea0 commit 3ff104f

5 files changed

Lines changed: 155 additions & 1 deletion

File tree

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Validate skill
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- master
8+
9+
jobs:
10+
validate:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Check out repository
14+
uses: actions/checkout@v4
15+
16+
- name: Set up Node.js
17+
uses: actions/setup-node@v4
18+
with:
19+
node-version: 22
20+
21+
- name: Validate Agent Skill
22+
run: npx skills-ref validate ./lightningchart-js

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2026 LightningChart
3+
Copyright (c) 2026 LightningChart Ltd.
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# LightningChart JS Agent Skill
2+
3+
An Agent Skill for building with LightningChart JS accurately in AI coding
4+
agents.
5+
6+
The skill teaches agents to start every LightningChart JS task from the
7+
official LLM-friendly documentation indexes, then follow the exact
8+
task-specific documentation and API URLs found there. This helps prevent
9+
hallucinated method names, stale package names, wrong option shapes, and API
10+
patterns copied from unrelated charting libraries.
11+
12+
## Installation
13+
14+
Copy the `lightningchart-js` folder into a skills directory supported by your
15+
agent.
16+
17+
Project-local Agent Skills location:
18+
19+
```text
20+
.agents/skills/lightningchart-js/
21+
```
22+
23+
OpenAI Codex local skills location:
24+
25+
```text
26+
~/.codex/skills/lightningchart-js/
27+
```
28+
29+
Windows PowerShell example for Codex:
30+
31+
```powershell
32+
Copy-Item -Recurse .\lightningchart-js $env:USERPROFILE\.codex\skills\
33+
```
34+
35+
VS Code and other Agent Skills compatible tools can also use this skill from a
36+
project-local `.agents/skills/lightningchart-js/` directory.
37+
38+
## Example Prompts
39+
40+
```text
41+
Use $lightningchart-js to add a real-time line chart to this React component.
42+
```
43+
44+
```text
45+
Use $lightningchart-js to review this chart implementation for outdated or hallucinated LCJS APIs.
46+
```
47+
48+
```text
49+
Use $lightningchart-js to migrate this existing chart to LightningChart JS and verify the API usage with local type checks if possible.
50+
```
51+
52+
## License
53+
54+
This Agent Skill is licensed under the MIT License.
55+
56+
LightningChart JS is separate proprietary software with its own licensing terms:
57+
https://lightningchart.com/js-charts/

lightningchart-js/SKILL.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
name: lightningchart-js
3+
description: >
4+
Use LightningChart JS to build accurate high-performance charts, graphs,
5+
dashboards, and data visualizations in JavaScript or TypeScript. Activate
6+
when working with LightningChart, LCJS, real-time data, large datasets,
7+
financial charts, scientific visualization, WebGL charting, or any task that
8+
adds or modifies charting/data visualization code.
9+
license: MIT
10+
compatibility: Requires internet access or locally cached copies of the LightningChart JS LLM documentation indexes.
11+
metadata:
12+
author: LightningChart Ltd
13+
version: "1.0"
14+
docs: https://lightningchart.com/js-charts/docs/
15+
---
16+
17+
## Purpose
18+
19+
Use this skill to work with LightningChart JS without relying on stale model
20+
training data. LightningChart JS is a WebGL-accelerated JavaScript charting
21+
library for high-performance rendering of large datasets, real-time streams,
22+
financial charts, dashboards, and scientific visualization.
23+
24+
## Mandatory Source Of Truth
25+
26+
Always use these two LLM index files as the source of truth for
27+
LightningChart JS usage:
28+
29+
- Documentation index: https://lightningchart.com/js-charts/docs/llms.txt
30+
- API index: https://lightningchart.com/js-charts/api-documentation/v8.3.1/llms.txt
31+
32+
These files are indexes. Read them to find the exact task-specific
33+
documentation or API reference URL, then read that specific referenced page
34+
before making assumptions how LCJS API works.
35+
36+
NEVER guess LCJS APIs, method names, constructor options, enum names,
37+
configuration objects, import paths, or documentation URLs from memory.
38+
39+
## Common Errors
40+
41+
- Version matters. Prefer the URLs and API entries discovered from the supplied
42+
v8.3.1 API index unless the user or project explicitly targets another LCJS
43+
version.
44+
- The correct NPM package is `@lightningchart/lcjs`, NOT `@arction/lcjs`.
45+
Always install using the latest tag with `npm i @lightningchart/lcjs@latest`
46+
unless specified otherwise, but do not leave `latest` in `package.json`.
47+
- License key MUST be supplied to the `lightningChart()` function. Load it from
48+
an environment variable according to practices utilized in the local
49+
repository. Setup trial license information in advance like this:
50+
51+
```ts
52+
lightningChart({
53+
license: "...",
54+
licenseInformation: {
55+
appTitle: "LightningChart JS Trial",
56+
company: "LightningChart Ltd."
57+
},
58+
})
59+
```
60+
61+
- Tell the user to write their license to the environment variable or download
62+
their license from https://lightningchart.com/js-charts/
63+
- LCJS versions under v9.0 override the passed DIV `style.position`. If using
64+
CSS, use `!important` syntax. If using JS, style after creating the chart.
65+
66+
## Validation
67+
68+
If possible, rely on local type checks to confirm correct LCJS API usage.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
interface:
2+
display_name: "LightningChart JS"
3+
short_description: "Accurate LightningChart JS charting guidance"
4+
default_prompt: "Use $lightningchart-js to create high-performing and interactive data visualization components"
5+
6+
policy:
7+
allow_implicit_invocation: true

0 commit comments

Comments
 (0)