@simpleapps-com/augur-skills 2026.3.19 → 2026.3.20
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/package.json
CHANGED
|
@@ -13,18 +13,18 @@ Shared npm packages for Next.js ecommerce sites and React Native apps. Published
|
|
|
13
13
|
|
|
14
14
|
Before writing custom code, check whether a package export already solves the problem.
|
|
15
15
|
|
|
16
|
-
## Ground Truth: Read the
|
|
16
|
+
## Ground Truth: Read the Docs
|
|
17
17
|
|
|
18
18
|
This skill is a **stub, not an archive**. New packages are created, existing packages gain features, APIs evolve. This skill MUST NOT be treated as the complete picture.
|
|
19
19
|
|
|
20
|
-
**Always read the installed packages in
|
|
20
|
+
**Always read the installed packages' documentation in `node_modules/`:**
|
|
21
21
|
|
|
22
22
|
1. Use `Glob("repo/node_modules/@simpleapps-com/*")` to discover ALL available packages — there may be packages not listed here
|
|
23
|
-
2. Read `repo/node_modules/@simpleapps-com/<package>/
|
|
24
|
-
3. Read
|
|
25
|
-
4.
|
|
23
|
+
2. Read `repo/node_modules/@simpleapps-com/<package>/llms.txt` — machine-readable, lists every export with descriptions and usage examples. This is the fastest path to discovering what exists.
|
|
24
|
+
3. Read `repo/node_modules/@simpleapps-com/<package>/README.md` for full API docs, code examples, and "Replaces" guidance
|
|
25
|
+
4. MUST NOT read `dist/`, `.d.ts`, or compiled JS files to discover capabilities — they are minified, chunked, and incomplete. The README and llms.txt are the source of truth.
|
|
26
26
|
|
|
27
|
-
When this skill and the installed
|
|
27
|
+
When this skill and the installed docs disagree, **the installed docs win**. This skill exists to point you in the right direction, not to replace reading the docs.
|
|
28
28
|
|
|
29
29
|
## Known Packages
|
|
30
30
|
|
|
@@ -40,13 +40,37 @@ These are starting hints — not a complete list. Always check `node_modules/@si
|
|
|
40
40
|
|
|
41
41
|
## How to Check for Package Solutions
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
MUST follow this procedure before writing custom code or filing a package issue:
|
|
44
44
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
45
|
+
### Step 1: Read llms.txt
|
|
46
|
+
|
|
47
|
+
For each installed `@simpleapps-com/augur-*` package, read its `llms.txt`:
|
|
48
|
+
```
|
|
49
|
+
Read("repo/node_modules/@simpleapps-com/<package>/llms.txt")
|
|
50
|
+
```
|
|
51
|
+
This lists every export with descriptions and usage examples.
|
|
52
|
+
|
|
53
|
+
### Step 2: Read README.md for details
|
|
54
|
+
|
|
55
|
+
If llms.txt shows a relevant export, read the README for full API, code examples, and "Replaces" guidance showing what site code it eliminates.
|
|
56
|
+
|
|
57
|
+
### Step 3: MUST NOT grep compiled output
|
|
58
|
+
|
|
59
|
+
MUST NOT read or grep `dist/`, `.d.ts`, `.js`, or any compiled files to discover package capabilities. These are minified build artifacts — unreliable for discovery. The README and llms.txt are the ONLY source of truth.
|
|
60
|
+
|
|
61
|
+
### Step 4: Before filing a package issue
|
|
62
|
+
|
|
63
|
+
Before creating an issue on `simpleapps-com/augur-packages` requesting a new feature:
|
|
64
|
+
1. Search ALL package llms.txt files for the function/hook name
|
|
65
|
+
2. Search ALL package README.md files for the concept
|
|
66
|
+
3. If found, the problem is site adoption — not a package gap. Use the existing export.
|
|
67
|
+
|
|
68
|
+
### Step 5: Before writing custom code
|
|
69
|
+
|
|
70
|
+
Before creating a custom hook, utility, or action in a site:
|
|
71
|
+
1. Search ALL package llms.txt files for similar functionality
|
|
72
|
+
2. Check the augur-hooks README "Examples" section for the pattern
|
|
73
|
+
3. If a package export exists, use it. If it does not work as expected, file a bug on the package — not a reimplementation in the site.
|
|
50
74
|
|
|
51
75
|
## What Stays Site-Specific
|
|
52
76
|
|
|
@@ -60,6 +60,14 @@ Every token costs time, money, and cognitive load. Be concise without losing cla
|
|
|
60
60
|
|
|
61
61
|
Default to brief. Expand only when the reader cannot infer meaning from context. Two sentences that answer the question beat two pages that fill the context window.
|
|
62
62
|
|
|
63
|
+
## Code Style
|
|
64
|
+
|
|
65
|
+
Use descriptive variable and function names. Abbreviations save keystrokes but cost readability — the human reviewing your output MUST be able to understand the code without deciphering names.
|
|
66
|
+
|
|
67
|
+
- MUST use full words: `$groupQuantity` not `$gq`, `cartItem` not `ci`
|
|
68
|
+
- Loop counters (`i`, `j`, `k`) and well-known abbreviations (`id`, `url`, `db`) are fine
|
|
69
|
+
- Function names SHOULD describe what they do: `calculateShippingCost` not `calcShip`
|
|
70
|
+
|
|
63
71
|
## Claude Code Keywords
|
|
64
72
|
|
|
65
73
|
Thinking trigger words (`think`, `think hard`, `ultrathink`) are deprecated. Extended thinking is on by default. Use `/effort` (low/medium/high/max) for control.
|