@simpleapps-com/augur-config 2.4.0 → 2026.11.1
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/EXPORTS.md +43 -44
- package/README.md +41 -29
- package/dist/augur-doctor.d.ts +13 -0
- package/dist/augur-doctor.d.ts.map +1 -0
- package/dist/augur-doctor.js +742 -0
- package/dist/augur-doctor.js.map +1 -0
- package/dist/chunk-RY3GDLDS.js +26 -0
- package/dist/chunk-RY3GDLDS.js.map +1 -0
- package/dist/chunk-ZV56KMH3.js +172 -0
- package/dist/chunk-ZV56KMH3.js.map +1 -0
- package/dist/doctor/checks.d.ts +34 -0
- package/dist/doctor/checks.d.ts.map +1 -0
- package/dist/doctor/cli.d.ts +11 -0
- package/dist/doctor/cli.d.ts.map +1 -0
- package/dist/doctor/node-reader.d.ts +7 -0
- package/dist/doctor/node-reader.d.ts.map +1 -0
- package/dist/doctor/report.d.ts +5 -0
- package/dist/doctor/report.d.ts.map +1 -0
- package/dist/doctor/rules.d.ts +227 -0
- package/dist/doctor/rules.d.ts.map +1 -0
- package/dist/eslint-next.d.ts +9 -0
- package/dist/eslint-next.d.ts.map +1 -0
- package/dist/eslint-next.js +35 -0
- package/dist/eslint-next.js.map +1 -0
- package/dist/eslint-shared.d.ts +36 -0
- package/dist/eslint-shared.d.ts.map +1 -0
- package/dist/eslint.d.ts +6 -0
- package/dist/eslint.d.ts.map +1 -0
- package/dist/eslint.js +30 -0
- package/dist/eslint.js.map +1 -0
- package/dist/lighthouse.d.ts +62 -0
- package/dist/lighthouse.d.ts.map +1 -0
- package/dist/lighthouse.js +68 -0
- package/dist/lighthouse.js.map +1 -0
- package/dist/prettier-next.d.ts +5 -0
- package/dist/prettier-next.d.ts.map +1 -0
- package/{src → dist}/prettier-next.js +9 -7
- package/dist/prettier-next.js.map +1 -0
- package/dist/prettier.d.ts +5 -0
- package/dist/prettier.d.ts.map +1 -0
- package/dist/prettier.js +17 -0
- package/dist/prettier.js.map +1 -0
- package/llms.txt +40 -20
- package/package.json +49 -12
- package/bin/augur-doctor.mjs +0 -1038
- package/src/eslint-next.js +0 -40
- package/src/eslint.js +0 -35
- package/src/lighthouse.js +0 -108
- package/src/prettier.js +0 -12
package/EXPORTS.md
CHANGED
|
@@ -1,70 +1,69 @@
|
|
|
1
1
|
# @simpleapps-com/augur-config exports
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
> Generated from the package's build by `pnpm -C repo/sites/augur-build generate`. Do not edit by hand.
|
|
4
|
+
> Guide: https://augur.build/docs/packages/augur-config
|
|
4
5
|
|
|
5
|
-
|
|
6
|
-
> Regenerate with: `pnpm run generate-exports`
|
|
6
|
+
## `@simpleapps-com/augur-config/eslint`
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
### Values
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
| Export | Kind | Description |
|
|
11
|
+
|--------|------|-------------|
|
|
12
|
+
| `default` | const | The ESLint preset for Augur packages and React sites. |
|
|
11
13
|
|
|
12
|
-
|
|
13
|
-
import config from "@simpleapps-com/augur-config/eslint";
|
|
14
|
-
```
|
|
14
|
+
### Types
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
`PresetConfig`
|
|
17
17
|
|
|
18
|
-
|
|
19
|
-
import config from "@simpleapps-com/augur-config/eslint/next";
|
|
20
|
-
```
|
|
18
|
+
## `@simpleapps-com/augur-config/eslint/next`
|
|
21
19
|
|
|
22
|
-
###
|
|
20
|
+
### Values
|
|
23
21
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
22
|
+
| Export | Kind | Description |
|
|
23
|
+
|--------|------|-------------|
|
|
24
|
+
| `default` | const | The ESLint preset for Next.js sites: the base rules plus Next's recommended and Core Web Vitals. |
|
|
27
25
|
|
|
28
|
-
|
|
26
|
+
## `@simpleapps-com/augur-config/prettier`
|
|
29
27
|
|
|
30
|
-
|
|
31
|
-
import config from "@simpleapps-com/augur-config/prettier/next";
|
|
32
|
-
```
|
|
28
|
+
### Values
|
|
33
29
|
|
|
34
|
-
|
|
30
|
+
| Export | Kind | Description |
|
|
31
|
+
|--------|------|-------------|
|
|
32
|
+
| `default` | const | The Prettier preset for Augur packages (with Tailwind class sorting). |
|
|
35
33
|
|
|
36
|
-
|
|
34
|
+
## `@simpleapps-com/augur-config/prettier/next`
|
|
37
35
|
|
|
38
|
-
|
|
39
|
-
{ "extends": "@simpleapps-com/augur-config/tsconfig/base" }
|
|
40
|
-
```
|
|
36
|
+
### Values
|
|
41
37
|
|
|
42
|
-
|
|
38
|
+
| Export | Kind | Description |
|
|
39
|
+
|--------|------|-------------|
|
|
40
|
+
| `default` | const | The Prettier preset for Next.js sites: the base options plus sorted, grouped imports. |
|
|
43
41
|
|
|
44
|
-
|
|
42
|
+
## `@simpleapps-com/augur-config/tsconfig/base`
|
|
45
43
|
|
|
46
|
-
|
|
47
|
-
{ "extends": "@simpleapps-com/augur-config/tsconfig/react" }
|
|
48
|
-
```
|
|
44
|
+
tsconfig preset: `{ "extends": "@simpleapps-com/augur-config/tsconfig/base" }`
|
|
49
45
|
|
|
50
|
-
|
|
46
|
+
## `@simpleapps-com/augur-config/tsconfig/react`
|
|
51
47
|
|
|
52
|
-
tsconfig preset
|
|
48
|
+
tsconfig preset: `{ "extends": "@simpleapps-com/augur-config/tsconfig/react" }`
|
|
53
49
|
|
|
54
|
-
|
|
55
|
-
{ "extends": "@simpleapps-com/augur-config/tsconfig/react-native" }
|
|
56
|
-
```
|
|
50
|
+
## `@simpleapps-com/augur-config/tsconfig/react-native`
|
|
57
51
|
|
|
58
|
-
|
|
52
|
+
tsconfig preset: `{ "extends": "@simpleapps-com/augur-config/tsconfig/react-native" }`
|
|
59
53
|
|
|
60
|
-
|
|
54
|
+
## `@simpleapps-com/augur-config/tsconfig/next`
|
|
61
55
|
|
|
62
|
-
|
|
63
|
-
{ "extends": "@simpleapps-com/augur-config/tsconfig/next" }
|
|
64
|
-
```
|
|
56
|
+
tsconfig preset: `{ "extends": "@simpleapps-com/augur-config/tsconfig/next" }`
|
|
65
57
|
|
|
66
|
-
|
|
58
|
+
## `@simpleapps-com/augur-config/lighthouse`
|
|
67
59
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
60
|
+
### Values
|
|
61
|
+
|
|
62
|
+
| Export | Kind | Description |
|
|
63
|
+
|--------|------|-------------|
|
|
64
|
+
| `defaultAssertions` | const | Default assertion thresholds for Augur e-commerce sites. |
|
|
65
|
+
| `lighthousePreset` | function | Creates a Lighthouse CI config with Augur e-commerce defaults. |
|
|
66
|
+
|
|
67
|
+
### Types
|
|
68
|
+
|
|
69
|
+
`LighthousePresetOptions`
|
package/README.md
CHANGED
|
@@ -1,41 +1,53 @@
|
|
|
1
1
|
# @simpleapps-com/augur-config
|
|
2
2
|
|
|
3
|
-
> Shared tooling configuration presets for Augur ecommerce sites
|
|
3
|
+
> Shared tooling configuration presets for Augur ecommerce sites, and the `augur-doctor` site check
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Part of the **@simpleapps-com/augur-\*** platform. Each package releases on its own CalVer
|
|
6
|
+
version; nothing requires them to share one.
|
|
6
7
|
|
|
7
|
-
|
|
8
|
+
- Guide: https://augur.build/docs/packages/augur-config
|
|
9
|
+
- Every export: [`EXPORTS.md`](EXPORTS.md) (generated from the build)
|
|
10
|
+
- Releases: https://augur.build/docs/packages/changelog
|
|
8
11
|
|
|
9
12
|
## Install
|
|
10
13
|
|
|
11
14
|
```bash
|
|
12
|
-
pnpm add @simpleapps-com/augur-config
|
|
15
|
+
pnpm add -D @simpleapps-com/augur-config
|
|
13
16
|
```
|
|
14
17
|
|
|
15
18
|
## Presets
|
|
16
19
|
|
|
17
|
-
| Import
|
|
18
|
-
|
|
19
|
-
| `@simpleapps-com/augur-config/eslint`
|
|
20
|
-
| `@simpleapps-com/augur-config/eslint/next`
|
|
21
|
-
| `@simpleapps-com/augur-config/prettier`
|
|
22
|
-
| `@simpleapps-com/augur-config/prettier/next`
|
|
23
|
-
| `@simpleapps-com/augur-config/tsconfig/base`
|
|
24
|
-
| `@simpleapps-com/augur-config/tsconfig/react`
|
|
25
|
-
| `@simpleapps-com/augur-config/tsconfig/react-native` | tsconfig preset
|
|
26
|
-
| `@simpleapps-com/augur-config/tsconfig/next`
|
|
27
|
-
| `@simpleapps-com/augur-config/lighthouse`
|
|
28
|
-
|
|
29
|
-
##
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
20
|
+
| Import | Type |
|
|
21
|
+
| ---------------------------------------------------- | ----------------------------------------- |
|
|
22
|
+
| `@simpleapps-com/augur-config/eslint` | ESLint flat config |
|
|
23
|
+
| `@simpleapps-com/augur-config/eslint/next` | ESLint flat config (Next.js) |
|
|
24
|
+
| `@simpleapps-com/augur-config/prettier` | Prettier config |
|
|
25
|
+
| `@simpleapps-com/augur-config/prettier/next` | Prettier config (Next.js, sorted imports) |
|
|
26
|
+
| `@simpleapps-com/augur-config/tsconfig/base` | tsconfig preset |
|
|
27
|
+
| `@simpleapps-com/augur-config/tsconfig/react` | tsconfig preset |
|
|
28
|
+
| `@simpleapps-com/augur-config/tsconfig/react-native` | tsconfig preset |
|
|
29
|
+
| `@simpleapps-com/augur-config/tsconfig/next` | tsconfig preset |
|
|
30
|
+
| `@simpleapps-com/augur-config/lighthouse` | `lighthousePreset()` for Lighthouse CI |
|
|
31
|
+
|
|
32
|
+
## augur-doctor
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
npx augur-doctor # the current directory
|
|
36
|
+
npx augur-doctor ./sites/shop
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Scores a site against the platform standard (site files, config presets, next.config, tests,
|
|
40
|
+
proxy adoption, package versions) and exits 1 when any check fails. Each installed
|
|
41
|
+
`@simpleapps-com/augur-*` package is checked against its own latest published version.
|
|
42
|
+
|
|
43
|
+
## Development
|
|
44
|
+
|
|
45
|
+
TypeScript in `src/`, built to `dist/` (ESM) by tsup; the tsconfig presets ship as JSON from
|
|
46
|
+
`src/tsconfig/`. The doctor's decisions are proved (`src/doctor/rules.ts`, model
|
|
47
|
+
`models/AugurConfig.dfy`, link `models/links/augur-config-doctor-rules.dfy`); the file reads
|
|
48
|
+
(`src/doctor/checks.ts`, `node-reader.ts`) and the scorecard (`report.ts`) are tested at 100%.
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
pnpm -C repo/packages/augur-config test
|
|
52
|
+
pnpm -C repo/packages/augur-config proofs
|
|
53
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
/**
|
|
3
|
+
* augur-doctor -- Site health check against the Augur platform standard.
|
|
4
|
+
*
|
|
5
|
+
* Usage:
|
|
6
|
+
* npx augur-doctor (runs against current directory)
|
|
7
|
+
* npx augur-doctor /path/to/site
|
|
8
|
+
*
|
|
9
|
+
* Checks a consumer site for alignment with the reference implementation and prints a
|
|
10
|
+
* pass/fail/warn scorecard.
|
|
11
|
+
*/
|
|
12
|
+
export {};
|
|
13
|
+
//# sourceMappingURL=augur-doctor.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"augur-doctor.d.ts","sourceRoot":"","sources":["../src/augur-doctor.ts"],"names":[],"mappings":";AACA;;;;;;;;;GASG"}
|