sheetnext 0.2.9 → 0.2.10
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/README.md +18 -18
- package/README_CN.md +18 -18
- package/dist/sheetnext.css +1 -1
- package/dist/sheetnext.es.js +3 -3
- package/dist/sheetnext.locale.zh-CN.es.js +2 -2
- package/dist/sheetnext.locale.zh-CN.umd.js +3 -3
- package/dist/sheetnext.umd.js +3 -3
- package/docs/skill/sheetnext-dev/GENERATION.md +18 -18
- package/docs/skill/sheetnext-dev/README.md +44 -44
- package/docs/skill/sheetnext-dev/SKILL.md +58 -58
- package/docs/skill/sheetnext-dev/adapters/chatgpt.md +22 -22
- package/docs/skill/sheetnext-dev/adapters/claude.md +21 -21
- package/docs/skill/sheetnext-dev/adapters/codex.md +21 -21
- package/docs/skill/sheetnext-dev/adapters/copilot.md +15 -15
- package/docs/skill/sheetnext-dev/adapters/cursor.md +17 -17
- package/docs/skill/sheetnext-dev/references/ai-relay.md +284 -284
- package/docs/skill/sheetnext-dev/references/core-api.md +3181 -3181
- package/docs/skill/sheetnext-dev/references/enums.md +171 -171
- package/docs/skill/sheetnext-dev/references/events.md +341 -341
- package/docs/skill/sheetnext-dev/references/json-format.md +426 -426
- package/docs/skill/sheetnext-dev/references/recipes.md +56 -56
- package/package.json +1 -1
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
# Generation
|
|
2
|
-
|
|
3
|
-
Generated on 2026-04-28 by `scripts/doc-scanner.js`.
|
|
4
|
-
|
|
5
|
-
## Source Inputs
|
|
6
|
-
|
|
7
|
-
- Public API comments and signatures under `src/core/`.
|
|
8
|
-
- Enum definitions from `src/enum/index.js`.
|
|
9
|
-
- Static protocol references preserved from `docs/static-references/ai-relay.md` and `docs/static-references/json-format.md`.
|
|
10
|
-
- Built-in examples from `scripts/doc-examples.js`.
|
|
11
|
-
|
|
12
|
-
## Output Contract
|
|
13
|
-
|
|
14
|
-
- `SKILL.md` is the portable skill entry point.
|
|
15
|
-
- `references/` contains generated or preserved Markdown references for agent lookup.
|
|
16
|
-
- `adapters/` contains optional tool-specific setup notes.
|
|
17
|
-
|
|
18
|
-
Do not manually edit generated API reference files. Update the documented source or static reference input, then rerun the scanner.
|
|
1
|
+
# Generation
|
|
2
|
+
|
|
3
|
+
Generated on 2026-04-28 by `scripts/doc-scanner.js`.
|
|
4
|
+
|
|
5
|
+
## Source Inputs
|
|
6
|
+
|
|
7
|
+
- Public API comments and signatures under `src/core/`.
|
|
8
|
+
- Enum definitions from `src/enum/index.js`.
|
|
9
|
+
- Static protocol references preserved from `docs/static-references/ai-relay.md` and `docs/static-references/json-format.md`.
|
|
10
|
+
- Built-in examples from `scripts/doc-examples.js`.
|
|
11
|
+
|
|
12
|
+
## Output Contract
|
|
13
|
+
|
|
14
|
+
- `SKILL.md` is the portable skill entry point.
|
|
15
|
+
- `references/` contains generated or preserved Markdown references for agent lookup.
|
|
16
|
+
- `adapters/` contains optional tool-specific setup notes.
|
|
17
|
+
|
|
18
|
+
Do not manually edit generated API reference files. Update the documented source or static reference input, then rerun the scanner.
|
|
@@ -1,44 +1,44 @@
|
|
|
1
|
-
# SheetNext Dev Agent Skill
|
|
2
|
-
|
|
3
|
-
Generated from SheetNext API docs on 2026-04-28.
|
|
4
|
-
|
|
5
|
-
This directory is a portable Agent Skill package for SheetNext development. It is designed to work in two modes:
|
|
6
|
-
|
|
7
|
-
- Skill-aware agents can install or load the whole `sheetnext-dev/` directory.
|
|
8
|
-
- Other AI coding assistants can read `SKILL.md` first, then open the relevant files in `references/`.
|
|
9
|
-
|
|
10
|
-
## Package Layout
|
|
11
|
-
|
|
12
|
-
```text
|
|
13
|
-
sheetnext-dev/
|
|
14
|
-
SKILL.md # Portable skill entry point and operating rules
|
|
15
|
-
README.md # Human-facing usage notes
|
|
16
|
-
GENERATION.md # Regeneration notes and source inputs
|
|
17
|
-
adapters/ # Optional setup notes for specific AI tools
|
|
18
|
-
references/ # Source-of-truth SheetNext API references
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
## Recommended Use
|
|
22
|
-
|
|
23
|
-
1. Read `SKILL.md` before generating or modifying SheetNext code.
|
|
24
|
-
2. Read only the reference files needed for the task.
|
|
25
|
-
3. Verify exact method names and signatures in `references/core-api.md` before coding.
|
|
26
|
-
4. Treat `references/` as generated documentation; update SheetNext source comments or static docs, then rerun the scanner.
|
|
27
|
-
|
|
28
|
-
## Tool Adapters
|
|
29
|
-
|
|
30
|
-
- Codex: `adapters/codex.md`
|
|
31
|
-
- Claude: `adapters/claude.md`
|
|
32
|
-
- Cursor: `adapters/cursor.md`
|
|
33
|
-
- GitHub Copilot: `adapters/copilot.md`
|
|
34
|
-
- ChatGPT or generic assistants: `adapters/chatgpt.md`
|
|
35
|
-
|
|
36
|
-
The adapters are convenience instructions only. The portable contract is `SKILL.md` plus `references/`.
|
|
37
|
-
|
|
38
|
-
## Regenerate
|
|
39
|
-
|
|
40
|
-
From the `SNEditor` directory:
|
|
41
|
-
|
|
42
|
-
```powershell
|
|
43
|
-
node scripts\doc-scanner.js
|
|
44
|
-
```
|
|
1
|
+
# SheetNext Dev Agent Skill
|
|
2
|
+
|
|
3
|
+
Generated from SheetNext API docs on 2026-04-28.
|
|
4
|
+
|
|
5
|
+
This directory is a portable Agent Skill package for SheetNext development. It is designed to work in two modes:
|
|
6
|
+
|
|
7
|
+
- Skill-aware agents can install or load the whole `sheetnext-dev/` directory.
|
|
8
|
+
- Other AI coding assistants can read `SKILL.md` first, then open the relevant files in `references/`.
|
|
9
|
+
|
|
10
|
+
## Package Layout
|
|
11
|
+
|
|
12
|
+
```text
|
|
13
|
+
sheetnext-dev/
|
|
14
|
+
SKILL.md # Portable skill entry point and operating rules
|
|
15
|
+
README.md # Human-facing usage notes
|
|
16
|
+
GENERATION.md # Regeneration notes and source inputs
|
|
17
|
+
adapters/ # Optional setup notes for specific AI tools
|
|
18
|
+
references/ # Source-of-truth SheetNext API references
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Recommended Use
|
|
22
|
+
|
|
23
|
+
1. Read `SKILL.md` before generating or modifying SheetNext code.
|
|
24
|
+
2. Read only the reference files needed for the task.
|
|
25
|
+
3. Verify exact method names and signatures in `references/core-api.md` before coding.
|
|
26
|
+
4. Treat `references/` as generated documentation; update SheetNext source comments or static docs, then rerun the scanner.
|
|
27
|
+
|
|
28
|
+
## Tool Adapters
|
|
29
|
+
|
|
30
|
+
- Codex: `adapters/codex.md`
|
|
31
|
+
- Claude: `adapters/claude.md`
|
|
32
|
+
- Cursor: `adapters/cursor.md`
|
|
33
|
+
- GitHub Copilot: `adapters/copilot.md`
|
|
34
|
+
- ChatGPT or generic assistants: `adapters/chatgpt.md`
|
|
35
|
+
|
|
36
|
+
The adapters are convenience instructions only. The portable contract is `SKILL.md` plus `references/`.
|
|
37
|
+
|
|
38
|
+
## Regenerate
|
|
39
|
+
|
|
40
|
+
From the `SNEditor` directory:
|
|
41
|
+
|
|
42
|
+
```powershell
|
|
43
|
+
node scripts\doc-scanner.js
|
|
44
|
+
```
|
|
@@ -1,58 +1,58 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: "sheetnext-dev"
|
|
3
|
-
description: "Use for SheetNext spreadsheet apps, templates, events, import/export, JSON workbook data, and AI relay integration."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# SheetNext Development
|
|
7
|
-
|
|
8
|
-
Generated from SheetNext API docs on 2026-04-28.
|
|
9
|
-
|
|
10
|
-
This is a portable Agent Skill package. `SKILL.md` is the entry point, `references/` contains lazy-loaded API docs, and `adapters/` contains tool-specific setup notes.
|
|
11
|
-
|
|
12
|
-
Use the bundled references as the source of truth. Do not invent APIs.
|
|
13
|
-
|
|
14
|
-
## Compatibility
|
|
15
|
-
|
|
16
|
-
- Skill-aware agents can install or load this directory directly.
|
|
17
|
-
- Any AI coding assistant can use this package by reading this file first, then opening the relevant files in `references/`.
|
|
18
|
-
- Tool-specific setup notes live in `adapters/`; they are optional and do not change the source-of-truth API docs.
|
|
19
|
-
|
|
20
|
-
## When To Use
|
|
21
|
-
|
|
22
|
-
- Building SheetNext workbook, sheet, row, column, cell, drawing, table, pivot, slicer, formula, event, import/export, or AI relay features.
|
|
23
|
-
- Debugging SheetNext integrations or generated spreadsheet code.
|
|
24
|
-
- Converting requirements into SheetNext templates, JSON workbook data, or event-driven workflows.
|
|
25
|
-
|
|
26
|
-
## Read Order
|
|
27
|
-
|
|
28
|
-
1. For normal spreadsheet development, read `references/core-api.md`.
|
|
29
|
-
2. For events and hooks, read `references/events.md`.
|
|
30
|
-
3. For constants and enum values, read `references/enums.md`.
|
|
31
|
-
4. For JSON import/export data shape, read `references/json-format.md`.
|
|
32
|
-
5. For built-in AI relay integration, read `references/ai-relay.md`.
|
|
33
|
-
6. For common implementation patterns, read `references/recipes.md`.
|
|
34
|
-
|
|
35
|
-
## API Rules
|
|
36
|
-
|
|
37
|
-
- Public API is whatever appears in `references/core-api.md`.
|
|
38
|
-
- Deprecated APIs are excluded from the generated references; do not use undocumented old names.
|
|
39
|
-
- Internal SheetNext source members start with `_` or `#`; avoid them unless the user is editing SheetNext internals.
|
|
40
|
-
- Coordinates are zero-based when using numeric objects. A1 strings such as `"A1"` are one-based Excel-style references.
|
|
41
|
-
- Prefer existing SheetNext core APIs over direct DOM access or ad hoc state mutation.
|
|
42
|
-
- For templates, prefer `sheet.insertTemplate(...)`.
|
|
43
|
-
- For import/export, use `SN.IO`.
|
|
44
|
-
- For events, use `SN.Event`.
|
|
45
|
-
|
|
46
|
-
## Workflow
|
|
47
|
-
|
|
48
|
-
1. Identify the target object: `SN`, `Sheet`, `Cell`, `IO`, `Event`, etc.
|
|
49
|
-
2. Search the reference docs for the exact method name and signature before coding.
|
|
50
|
-
3. Generate the smallest working implementation first.
|
|
51
|
-
4. State verification steps and any assumptions about the documented API.
|
|
52
|
-
|
|
53
|
-
## Search Tips
|
|
54
|
-
|
|
55
|
-
- Method headings in `core-api.md` start with `####` followed by the signature.
|
|
56
|
-
- Class headings use `## ClassName`.
|
|
57
|
-
- Event names are grouped in `events.md` under `## Emitted events`.
|
|
58
|
-
- Enum names are under `## Enum Types` in `enums.md`.
|
|
1
|
+
---
|
|
2
|
+
name: "sheetnext-dev"
|
|
3
|
+
description: "Use for SheetNext spreadsheet apps, templates, events, import/export, JSON workbook data, and AI relay integration."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# SheetNext Development
|
|
7
|
+
|
|
8
|
+
Generated from SheetNext API docs on 2026-04-28.
|
|
9
|
+
|
|
10
|
+
This is a portable Agent Skill package. `SKILL.md` is the entry point, `references/` contains lazy-loaded API docs, and `adapters/` contains tool-specific setup notes.
|
|
11
|
+
|
|
12
|
+
Use the bundled references as the source of truth. Do not invent APIs.
|
|
13
|
+
|
|
14
|
+
## Compatibility
|
|
15
|
+
|
|
16
|
+
- Skill-aware agents can install or load this directory directly.
|
|
17
|
+
- Any AI coding assistant can use this package by reading this file first, then opening the relevant files in `references/`.
|
|
18
|
+
- Tool-specific setup notes live in `adapters/`; they are optional and do not change the source-of-truth API docs.
|
|
19
|
+
|
|
20
|
+
## When To Use
|
|
21
|
+
|
|
22
|
+
- Building SheetNext workbook, sheet, row, column, cell, drawing, table, pivot, slicer, formula, event, import/export, or AI relay features.
|
|
23
|
+
- Debugging SheetNext integrations or generated spreadsheet code.
|
|
24
|
+
- Converting requirements into SheetNext templates, JSON workbook data, or event-driven workflows.
|
|
25
|
+
|
|
26
|
+
## Read Order
|
|
27
|
+
|
|
28
|
+
1. For normal spreadsheet development, read `references/core-api.md`.
|
|
29
|
+
2. For events and hooks, read `references/events.md`.
|
|
30
|
+
3. For constants and enum values, read `references/enums.md`.
|
|
31
|
+
4. For JSON import/export data shape, read `references/json-format.md`.
|
|
32
|
+
5. For built-in AI relay integration, read `references/ai-relay.md`.
|
|
33
|
+
6. For common implementation patterns, read `references/recipes.md`.
|
|
34
|
+
|
|
35
|
+
## API Rules
|
|
36
|
+
|
|
37
|
+
- Public API is whatever appears in `references/core-api.md`.
|
|
38
|
+
- Deprecated APIs are excluded from the generated references; do not use undocumented old names.
|
|
39
|
+
- Internal SheetNext source members start with `_` or `#`; avoid them unless the user is editing SheetNext internals.
|
|
40
|
+
- Coordinates are zero-based when using numeric objects. A1 strings such as `"A1"` are one-based Excel-style references.
|
|
41
|
+
- Prefer existing SheetNext core APIs over direct DOM access or ad hoc state mutation.
|
|
42
|
+
- For templates, prefer `sheet.insertTemplate(...)`.
|
|
43
|
+
- For import/export, use `SN.IO`.
|
|
44
|
+
- For events, use `SN.Event`.
|
|
45
|
+
|
|
46
|
+
## Workflow
|
|
47
|
+
|
|
48
|
+
1. Identify the target object: `SN`, `Sheet`, `Cell`, `IO`, `Event`, etc.
|
|
49
|
+
2. Search the reference docs for the exact method name and signature before coding.
|
|
50
|
+
3. Generate the smallest working implementation first.
|
|
51
|
+
4. State verification steps and any assumptions about the documented API.
|
|
52
|
+
|
|
53
|
+
## Search Tips
|
|
54
|
+
|
|
55
|
+
- Method headings in `core-api.md` start with `####` followed by the signature.
|
|
56
|
+
- Class headings use `## ClassName`.
|
|
57
|
+
- Event names are grouped in `events.md` under `## Emitted events`.
|
|
58
|
+
- Enum names are under `## Enum Types` in `enums.md`.
|
|
@@ -1,22 +1,22 @@
|
|
|
1
|
-
# ChatGPT And Generic Assistant Adapter
|
|
2
|
-
|
|
3
|
-
Use this package by uploading or pasting `SKILL.md` first, then adding the reference files needed for the task.
|
|
4
|
-
|
|
5
|
-
## Minimal Context
|
|
6
|
-
|
|
7
|
-
Start with:
|
|
8
|
-
|
|
9
|
-
- `SKILL.md`
|
|
10
|
-
- `references/core-api.md`
|
|
11
|
-
|
|
12
|
-
Add these only when needed:
|
|
13
|
-
|
|
14
|
-
- `references/events.md` for event handling.
|
|
15
|
-
- `references/enums.md` for constants.
|
|
16
|
-
- `references/json-format.md` for import/export data.
|
|
17
|
-
- `references/ai-relay.md` for AI workflow integration.
|
|
18
|
-
- `references/recipes.md` for short examples.
|
|
19
|
-
|
|
20
|
-
## Prompt
|
|
21
|
-
|
|
22
|
-
You are using the SheetNext Dev skill. Read `SKILL.md` first. Use the provided reference files as the source of truth, do not invent APIs, and state which reference files you used.
|
|
1
|
+
# ChatGPT And Generic Assistant Adapter
|
|
2
|
+
|
|
3
|
+
Use this package by uploading or pasting `SKILL.md` first, then adding the reference files needed for the task.
|
|
4
|
+
|
|
5
|
+
## Minimal Context
|
|
6
|
+
|
|
7
|
+
Start with:
|
|
8
|
+
|
|
9
|
+
- `SKILL.md`
|
|
10
|
+
- `references/core-api.md`
|
|
11
|
+
|
|
12
|
+
Add these only when needed:
|
|
13
|
+
|
|
14
|
+
- `references/events.md` for event handling.
|
|
15
|
+
- `references/enums.md` for constants.
|
|
16
|
+
- `references/json-format.md` for import/export data.
|
|
17
|
+
- `references/ai-relay.md` for AI workflow integration.
|
|
18
|
+
- `references/recipes.md` for short examples.
|
|
19
|
+
|
|
20
|
+
## Prompt
|
|
21
|
+
|
|
22
|
+
You are using the SheetNext Dev skill. Read `SKILL.md` first. Use the provided reference files as the source of truth, do not invent APIs, and state which reference files you used.
|
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
# Claude Adapter
|
|
2
|
-
|
|
3
|
-
Use this package as a Claude skill when the environment supports custom skills. Otherwise, provide the files as project knowledge or attachments.
|
|
4
|
-
|
|
5
|
-
## Skill-Aware Setup
|
|
6
|
-
|
|
7
|
-
Install or copy the whole `sheetnext-dev/` directory into the tool-specific skills location, then start a new session and ask the assistant to use the SheetNext Dev skill.
|
|
8
|
-
|
|
9
|
-
## Manual Setup
|
|
10
|
-
|
|
11
|
-
Provide `SKILL.md` first. Add only the reference files needed for the current task:
|
|
12
|
-
|
|
13
|
-
- `references/core-api.md` for public classes and methods.
|
|
14
|
-
- `references/events.md` for event names and payloads.
|
|
15
|
-
- `references/enums.md` for constants and enum values.
|
|
16
|
-
- `references/json-format.md` for workbook JSON data.
|
|
17
|
-
- `references/ai-relay.md` for built-in AI relay integration.
|
|
18
|
-
|
|
19
|
-
## Prompt
|
|
20
|
-
|
|
21
|
-
Use `SKILL.md` as the operating guide. Do not invent SheetNext APIs. Search the relevant reference file for exact method names and signatures before producing code.
|
|
1
|
+
# Claude Adapter
|
|
2
|
+
|
|
3
|
+
Use this package as a Claude skill when the environment supports custom skills. Otherwise, provide the files as project knowledge or attachments.
|
|
4
|
+
|
|
5
|
+
## Skill-Aware Setup
|
|
6
|
+
|
|
7
|
+
Install or copy the whole `sheetnext-dev/` directory into the tool-specific skills location, then start a new session and ask the assistant to use the SheetNext Dev skill.
|
|
8
|
+
|
|
9
|
+
## Manual Setup
|
|
10
|
+
|
|
11
|
+
Provide `SKILL.md` first. Add only the reference files needed for the current task:
|
|
12
|
+
|
|
13
|
+
- `references/core-api.md` for public classes and methods.
|
|
14
|
+
- `references/events.md` for event names and payloads.
|
|
15
|
+
- `references/enums.md` for constants and enum values.
|
|
16
|
+
- `references/json-format.md` for workbook JSON data.
|
|
17
|
+
- `references/ai-relay.md` for built-in AI relay integration.
|
|
18
|
+
|
|
19
|
+
## Prompt
|
|
20
|
+
|
|
21
|
+
Use `SKILL.md` as the operating guide. Do not invent SheetNext APIs. Search the relevant reference file for exact method names and signatures before producing code.
|
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
# Codex Adapter
|
|
2
|
-
|
|
3
|
-
Use this package as a Codex skill by installing the whole `sheetnext-dev/` directory.
|
|
4
|
-
|
|
5
|
-
## Install From This Repository
|
|
6
|
-
|
|
7
|
-
From the `SNEditor` directory:
|
|
8
|
-
|
|
9
|
-
```powershell
|
|
10
|
-
Copy-Item -Recurse -Force .\docs\skill\sheetnext-dev "$env:USERPROFILE\.codex\skills\sheetnext-dev"
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
Restart Codex after copying the directory.
|
|
14
|
-
|
|
15
|
-
## Repository-Local Use
|
|
16
|
-
|
|
17
|
-
If the skill is not installed globally, ask Codex to read `docs/skill/sheetnext-dev/SKILL.md` first and then open the specific reference files required by the task.
|
|
18
|
-
|
|
19
|
-
## Prompt
|
|
20
|
-
|
|
21
|
-
Use the SheetNext Dev skill. Read `SKILL.md`, verify exact APIs in `references/core-api.md`, and use `references/events.md`, `references/enums.md`, `references/json-format.md`, or `references/ai-relay.md` only when the task needs them.
|
|
1
|
+
# Codex Adapter
|
|
2
|
+
|
|
3
|
+
Use this package as a Codex skill by installing the whole `sheetnext-dev/` directory.
|
|
4
|
+
|
|
5
|
+
## Install From This Repository
|
|
6
|
+
|
|
7
|
+
From the `SNEditor` directory:
|
|
8
|
+
|
|
9
|
+
```powershell
|
|
10
|
+
Copy-Item -Recurse -Force .\docs\skill\sheetnext-dev "$env:USERPROFILE\.codex\skills\sheetnext-dev"
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Restart Codex after copying the directory.
|
|
14
|
+
|
|
15
|
+
## Repository-Local Use
|
|
16
|
+
|
|
17
|
+
If the skill is not installed globally, ask Codex to read `docs/skill/sheetnext-dev/SKILL.md` first and then open the specific reference files required by the task.
|
|
18
|
+
|
|
19
|
+
## Prompt
|
|
20
|
+
|
|
21
|
+
Use the SheetNext Dev skill. Read `SKILL.md`, verify exact APIs in `references/core-api.md`, and use `references/events.md`, `references/enums.md`, `references/json-format.md`, or `references/ai-relay.md` only when the task needs them.
|
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
# GitHub Copilot Adapter
|
|
2
|
-
|
|
3
|
-
GitHub Copilot can use this package through repository instructions and referenced Markdown files.
|
|
4
|
-
|
|
5
|
-
## Recommended Setup
|
|
6
|
-
|
|
7
|
-
Add this summary to `.github/copilot-instructions.md` or your workspace instructions:
|
|
8
|
-
|
|
9
|
-
```text
|
|
10
|
-
For SheetNext development, use docs/skill/sheetnext-dev/SKILL.md as the guide. The source-of-truth API docs are in docs/skill/sheetnext-dev/references/. Check core-api.md for exact public APIs before writing code. Use events.md, enums.md, json-format.md, and ai-relay.md only when the task needs those areas.
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Usage
|
|
14
|
-
|
|
15
|
-
Reference specific files in prompts when possible, for example: `Use docs/skill/sheetnext-dev/references/events.md to wire the event handler`.
|
|
1
|
+
# GitHub Copilot Adapter
|
|
2
|
+
|
|
3
|
+
GitHub Copilot can use this package through repository instructions and referenced Markdown files.
|
|
4
|
+
|
|
5
|
+
## Recommended Setup
|
|
6
|
+
|
|
7
|
+
Add this summary to `.github/copilot-instructions.md` or your workspace instructions:
|
|
8
|
+
|
|
9
|
+
```text
|
|
10
|
+
For SheetNext development, use docs/skill/sheetnext-dev/SKILL.md as the guide. The source-of-truth API docs are in docs/skill/sheetnext-dev/references/. Check core-api.md for exact public APIs before writing code. Use events.md, enums.md, json-format.md, and ai-relay.md only when the task needs those areas.
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
Reference specific files in prompts when possible, for example: `Use docs/skill/sheetnext-dev/references/events.md to wire the event handler`.
|
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
# Cursor Adapter
|
|
2
|
-
|
|
3
|
-
Cursor can use this package as repository knowledge even when it does not auto-load Agent Skills.
|
|
4
|
-
|
|
5
|
-
## Recommended Setup
|
|
6
|
-
|
|
7
|
-
Keep `docs/skill/sheetnext-dev/` in the repository. Add a short project rule that points Cursor to the skill entry point and references.
|
|
8
|
-
|
|
9
|
-
Suggested rule text:
|
|
10
|
-
|
|
11
|
-
```text
|
|
12
|
-
For SheetNext work, read docs/skill/sheetnext-dev/SKILL.md first. Treat docs/skill/sheetnext-dev/references/ as the source of truth. Verify public APIs in references/core-api.md before generating code, and use events.md, enums.md, json-format.md, or ai-relay.md only when relevant.
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Usage
|
|
16
|
-
|
|
17
|
-
When requesting SheetNext work, mention the relevant area, such as events, JSON import/export, templates, formulas, or AI relay. Ask Cursor to search the matching reference before editing.
|
|
1
|
+
# Cursor Adapter
|
|
2
|
+
|
|
3
|
+
Cursor can use this package as repository knowledge even when it does not auto-load Agent Skills.
|
|
4
|
+
|
|
5
|
+
## Recommended Setup
|
|
6
|
+
|
|
7
|
+
Keep `docs/skill/sheetnext-dev/` in the repository. Add a short project rule that points Cursor to the skill entry point and references.
|
|
8
|
+
|
|
9
|
+
Suggested rule text:
|
|
10
|
+
|
|
11
|
+
```text
|
|
12
|
+
For SheetNext work, read docs/skill/sheetnext-dev/SKILL.md first. Treat docs/skill/sheetnext-dev/references/ as the source of truth. Verify public APIs in references/core-api.md before generating code, and use events.md, enums.md, json-format.md, or ai-relay.md only when relevant.
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
When requesting SheetNext work, mention the relevant area, such as events, JSON import/export, templates, formulas, or AI relay. Ask Cursor to search the matching reference before editing.
|