@antelopejs/tooling-configs 0.5.3 → 0.5.5
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 +24 -23
- package/assets/readme/OFL.txt +93 -0
- package/assets/readme/geist-extrabold.woff2 +0 -0
- package/assets/readme/geist-mono.woff2 +0 -0
- package/dist/bin/api-diff.mjs +3 -3
- package/dist/bin/body-check.mjs +1 -1
- package/dist/bin/checks.mjs +1 -1
- package/dist/bin/comment-proof.mjs +2 -2
- package/dist/bin/ratchet.mjs +1 -1
- package/dist/bin/readme-strip.d.mts +1 -0
- package/dist/bin/readme-strip.mjs +134 -0
- package/dist/bin/sync.mjs +197 -51
- package/dist/{checks-BFGuy1KI.mjs → checks-DqTjyKCC.mjs} +994 -880
- package/dist/oxc/lint.mjs +1 -1
- package/dist/{package-DiaBP7bI.mjs → package-DnxZ2CXZ.mjs} +37 -30
- package/dist/{proof-stamp-BPIdT5ik.mjs → proof-stamp-Kg-tkM6G.mjs} +1 -1
- package/dist/{ratchet-BZvlFCWL.mjs → ratchet-1O8k4Dxu.mjs} +1 -1
- package/dist/{templates-C6cfOd2H.mjs → templates-Dg188oRC.mjs} +1 -1
- package/dist/{typescript-DJzdex32.mjs → typescript-DhavwHb7.mjs} +1 -1
- package/package.json +3 -1
package/README.md
CHANGED
|
@@ -17,28 +17,29 @@ The AntelopeJS guardrail pack: shared lint, format and dead-code presets, the co
|
|
|
17
17
|
|
|
18
18
|
## What's in the box
|
|
19
19
|
|
|
20
|
-
| Export | Import | What it gives
|
|
21
|
-
| ------------------ | ------------------------------------------------------------------------- |
|
|
22
|
-
| `./oxc/lint` | `import { antelopePreset } from "@antelopejs/tooling-configs/oxc/lint"` | The oxlint preset
|
|
23
|
-
| `./oxc/fmt` | `import { antelopeFmtPreset } from "@antelopejs/tooling-configs/oxc/fmt"` | The oxfmt preset (house style)
|
|
24
|
-
| `./eslint` | `import { antelopeNuxtConfig } from "@antelopejs/tooling-configs/eslint"` | ESLint for Nuxt layers
|
|
25
|
-
| `./knip` | `import { antelopeKnipConfig } from "@antelopejs/tooling-configs/knip"` | Knip for AntelopeJS modules
|
|
26
|
-
| `./oxc/anti-slop` | Loaded by the oxlint preset as a JS plugin | The vendored [anti-slop](https://github.com/dmmulroy/anti-slop) rules
|
|
27
|
-
| `./oxc/guardrails` | Loaded by the oxlint preset as a JS plugin | The `antelopejs` comment and test-quality rules
|
|
28
|
-
| `./verify` | `import type { VerifyConfig } from "@antelopejs/tooling-configs/verify"` | Types and check helpers for a shared verification skill's `verify.config.ts`
|
|
29
|
-
| bin | `antelopejs-sync [--init]` | Writes the guardrail pack into a repository; `--check` reports drift; `--init` onboards a bare repository
|
|
30
|
-
| bin | `antelopejs-checks [--no-services]` | Runs every check and prints only the failures; starts `.github/compose.yml` services around them
|
|
31
|
-
| bin | `antelopejs-ratchet` | Fails when recorded debt grows; `--update` lowers the record and adopts rules a pack release newly enabled
|
|
32
|
-
| bin | `antelopejs-suppressions` | Fails when suppressions exceed their budget or an added one breaks policy; `--update` lowers the budget
|
|
33
|
-
| bin | `antelopejs-check-size` | Fails on authored files over 20,000 bytes and on blanket disable directives
|
|
34
|
-
| bin | `antelopejs-api-diff <base-ref>` | Compares published declaration bundles against committed HEAD
|
|
35
|
-
| bin | `antelopejs-comment-proof <base-ref>` | Compares comment-free JavaScript emit against committed HEAD
|
|
36
|
-
| bin | `antelopejs-body-check <body.md \| -> [--head <sha>] [--base <sha>]` | Checks a PR body's proof and findings blocks against HEAD; `--findings` prints the findings block
|
|
37
|
-
| bin | `antelopejs-check-interface-ranges` | Fails on interface ranges that break module startup
|
|
38
|
-
| bin | `antelopejs-
|
|
39
|
-
| bin | `antelopejs-
|
|
40
|
-
| bin | `antelopejs-
|
|
41
|
-
| bin | `antelopejs-
|
|
20
|
+
| Export | Import | What it gives |
|
|
21
|
+
| ------------------ | ------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
22
|
+
| `./oxc/lint` | `import { antelopePreset } from "@antelopejs/tooling-configs/oxc/lint"` | The oxlint preset |
|
|
23
|
+
| `./oxc/fmt` | `import { antelopeFmtPreset } from "@antelopejs/tooling-configs/oxc/fmt"` | The oxfmt preset (house style) |
|
|
24
|
+
| `./eslint` | `import { antelopeNuxtConfig } from "@antelopejs/tooling-configs/eslint"` | ESLint for Nuxt layers |
|
|
25
|
+
| `./knip` | `import { antelopeKnipConfig } from "@antelopejs/tooling-configs/knip"` | Knip for AntelopeJS modules |
|
|
26
|
+
| `./oxc/anti-slop` | Loaded by the oxlint preset as a JS plugin | The vendored [anti-slop](https://github.com/dmmulroy/anti-slop) rules |
|
|
27
|
+
| `./oxc/guardrails` | Loaded by the oxlint preset as a JS plugin | The `antelopejs` comment and test-quality rules |
|
|
28
|
+
| `./verify` | `import type { VerifyConfig } from "@antelopejs/tooling-configs/verify"` | Types and check helpers for a shared verification skill's `verify.config.ts` |
|
|
29
|
+
| bin | `antelopejs-sync [--init]` | Writes the guardrail pack into a repository; `--check` reports drift; `--init` onboards a bare repository |
|
|
30
|
+
| bin | `antelopejs-checks [--no-services]` | Runs every check and prints only the failures; starts `.github/compose.yml` services around them |
|
|
31
|
+
| bin | `antelopejs-ratchet` | Fails when recorded debt grows; `--update` lowers the record and adopts rules a pack release newly enabled |
|
|
32
|
+
| bin | `antelopejs-suppressions` | Fails when suppressions exceed their budget or an added one breaks policy; `--update` lowers the budget |
|
|
33
|
+
| bin | `antelopejs-check-size` | Fails on authored files over 20,000 bytes and on blanket disable directives |
|
|
34
|
+
| bin | `antelopejs-api-diff <base-ref>` | Compares published declaration bundles against committed HEAD |
|
|
35
|
+
| bin | `antelopejs-comment-proof <base-ref>` | Compares comment-free JavaScript emit against committed HEAD |
|
|
36
|
+
| bin | `antelopejs-body-check <body.md \| -> [--head <sha>] [--base <sha>]` | Checks a PR body's proof and findings blocks against HEAD; `--findings` prints the findings block |
|
|
37
|
+
| bin | `antelopejs-check-interface-ranges` | Fails on interface ranges that break module startup |
|
|
38
|
+
| bin | `antelopejs-readme-strip --kind <kind> --name <label-name>` | Writes a framework repository's README strip banner to `.github/readme/strip.svg` ([docs](docs/documentation-checks.md#framework-strip-banner)) |
|
|
39
|
+
| bin | `antelopejs-garden [--json] [--apply] [--apply-prunes]` | The Gardener's scans of the organization through the GitHub API and npm |
|
|
40
|
+
| bin | `antelopejs-triage [--json]` | Community Triage's ranked shortlist of untriaged issues |
|
|
41
|
+
| bin | `antelopejs-verify <command>` | The harness of the shared `verify-interface`, `verify-module` and `verify-template` skills |
|
|
42
|
+
| bin | `antelopejs-lease run \| status \| down \| gc` | Ports, a mongod, logs and tmp per worktree; see [Run a DMS from a git worktree](./docs/agent-worktrees.md) |
|
|
42
43
|
|
|
43
44
|
## antelopejs-garden
|
|
44
45
|
|
|
@@ -198,7 +199,7 @@ pnpm dlx --package=@antelopejs/tooling-configs antelopejs-sync --init
|
|
|
198
199
|
npx --package=@antelopejs/tooling-configs antelopejs-sync --init
|
|
199
200
|
```
|
|
200
201
|
|
|
201
|
-
`--init` adds `node_modules` to `.gitignore` and declares each of `@antelopejs/tooling-configs`, `oxlint`, `oxlint-tsgolint` and `oxfmt` the repository does not declare yet. In a pnpm or npm workspace, it sets each member's declared pack tools to the root's ranges, so the workspace installs one copy of the pack, and moves the `options` of a member's oxlint config, which oxlint accepts only in the root config, to the same flags on the member's `oxlint` scripts. It stops before installing when an option has no command-line flag. It installs with the repository's package manager, runs `antelopejs-sync`, installs again when sync added devDependencies, and formats `package.json` with the installed oxfmt. It takes the full profile only and rejects `--check` and `--profile template`. Install output shows only when the install fails.
|
|
202
|
+
`--init` adds `node_modules` to `.gitignore` and declares each of `@antelopejs/tooling-configs`, `oxlint`, `oxlint-tsgolint` and `oxfmt` the repository does not declare yet. In a pnpm or npm workspace, it sets each member's declared pack tools to the root's ranges, so the workspace installs one copy of the pack. A root `catalog:` spec is copied as written. A member `catalog:` spec is kept when its catalog entry, in `pnpm-workspace.yaml` or Bun's root `package.json`, matches the root's range, and otherwise `--init` names the member and the package and stops before installing. It also moves the `options` of a member's oxlint config, which oxlint accepts only in the root config, to the same flags on the member's `oxlint` scripts. It stops before installing when an option has no command-line flag. It installs with the repository's package manager, runs `antelopejs-sync`, installs again when sync added devDependencies, and formats `package.json` with the installed oxfmt. It takes the full profile only and rejects `--check` and `--profile template`. Install output shows only when the install fails.
|
|
202
203
|
|
|
203
204
|
It then sets `delete_branch_on_merge` through `gh` when it can, even when an earlier step failed. When `gh` is missing, unauthenticated or refused, `--init` prints the `gh api -X PATCH repos/{owner}/{repo} -F delete_branch_on_merge=true` command to run and exits 1. After any failure, fix what it printed and rerun `antelopejs-sync --init`. Commit and push to the default branch afterwards, so the first run reports `ci / checks`.
|
|
204
205
|
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
Copyright 2026 The Geist Project Authors (https://github.com/vercel/geist-font)
|
|
2
|
+
|
|
3
|
+
This Font Software is licensed under the SIL Open Font License, Version 1.1.
|
|
4
|
+
This license is copied below, and is also available with a FAQ at:
|
|
5
|
+
https://openfontlicense.org
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
-----------------------------------------------------------
|
|
9
|
+
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
|
|
10
|
+
-----------------------------------------------------------
|
|
11
|
+
|
|
12
|
+
PREAMBLE
|
|
13
|
+
The goals of the Open Font License (OFL) are to stimulate worldwide
|
|
14
|
+
development of collaborative font projects, to support the font creation
|
|
15
|
+
efforts of academic and linguistic communities, and to provide a free and
|
|
16
|
+
open framework in which fonts may be shared and improved in partnership
|
|
17
|
+
with others.
|
|
18
|
+
|
|
19
|
+
The OFL allows the licensed fonts to be used, studied, modified and
|
|
20
|
+
redistributed freely as long as they are not sold by themselves. The
|
|
21
|
+
fonts, including any derivative works, can be bundled, embedded,
|
|
22
|
+
redistributed and/or sold with any software provided that any reserved
|
|
23
|
+
names are not used by derivative works. The fonts and derivatives,
|
|
24
|
+
however, cannot be released under any other type of license. The
|
|
25
|
+
requirement for fonts to remain under this license does not apply
|
|
26
|
+
to any document created using the fonts or their derivatives.
|
|
27
|
+
|
|
28
|
+
DEFINITIONS
|
|
29
|
+
"Font Software" refers to the set of files released by the Copyright
|
|
30
|
+
Holder(s) under this license and clearly marked as such. This may
|
|
31
|
+
include source files, build scripts and documentation.
|
|
32
|
+
|
|
33
|
+
"Reserved Font Name" refers to any names specified as such after the
|
|
34
|
+
copyright statement(s).
|
|
35
|
+
|
|
36
|
+
"Original Version" refers to the collection of Font Software components as
|
|
37
|
+
distributed by the Copyright Holder(s).
|
|
38
|
+
|
|
39
|
+
"Modified Version" refers to any derivative made by adding to, deleting,
|
|
40
|
+
or substituting -- in part or in whole -- any of the components of the
|
|
41
|
+
Original Version, by changing formats or by porting the Font Software to a
|
|
42
|
+
new environment.
|
|
43
|
+
|
|
44
|
+
"Author" refers to any designer, engineer, programmer, technical
|
|
45
|
+
writer or other person who contributed to the Font Software.
|
|
46
|
+
|
|
47
|
+
PERMISSION & CONDITIONS
|
|
48
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
|
49
|
+
a copy of the Font Software, to use, study, copy, merge, embed, modify,
|
|
50
|
+
redistribute, and sell modified and unmodified copies of the Font
|
|
51
|
+
Software, subject to the following conditions:
|
|
52
|
+
|
|
53
|
+
1) Neither the Font Software nor any of its individual components,
|
|
54
|
+
in Original or Modified Versions, may be sold by itself.
|
|
55
|
+
|
|
56
|
+
2) Original or Modified Versions of the Font Software may be bundled,
|
|
57
|
+
redistributed and/or sold with any software, provided that each copy
|
|
58
|
+
contains the above copyright notice and this license. These can be
|
|
59
|
+
included either as stand-alone text files, human-readable headers or
|
|
60
|
+
in the appropriate machine-readable metadata fields within text or
|
|
61
|
+
binary files as long as those fields can be easily viewed by the user.
|
|
62
|
+
|
|
63
|
+
3) No Modified Version of the Font Software may use the Reserved Font
|
|
64
|
+
Name(s) unless explicit written permission is granted by the corresponding
|
|
65
|
+
Copyright Holder. This restriction only applies to the primary font name as
|
|
66
|
+
presented to the users.
|
|
67
|
+
|
|
68
|
+
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
|
|
69
|
+
Software shall not be used to promote, endorse or advertise any
|
|
70
|
+
Modified Version, except to acknowledge the contribution(s) of the
|
|
71
|
+
Copyright Holder(s) and the Author(s) or with their explicit written
|
|
72
|
+
permission.
|
|
73
|
+
|
|
74
|
+
5) The Font Software, modified or unmodified, in part or in whole,
|
|
75
|
+
must be distributed entirely under this license, and must not be
|
|
76
|
+
distributed under any other license. The requirement for fonts to
|
|
77
|
+
remain under this license does not apply to any document created
|
|
78
|
+
using the Font Software.
|
|
79
|
+
|
|
80
|
+
TERMINATION
|
|
81
|
+
This license becomes null and void if any of the above conditions are
|
|
82
|
+
not met.
|
|
83
|
+
|
|
84
|
+
DISCLAIMER
|
|
85
|
+
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
86
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
|
|
87
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
|
88
|
+
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
|
|
89
|
+
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
90
|
+
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
|
91
|
+
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
92
|
+
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
|
|
93
|
+
OTHER DEALINGS IN THE FONT SOFTWARE.
|
|
Binary file
|
|
Binary file
|
package/dist/bin/api-diff.mjs
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
import { o as packageManager, s as parseManifest } from "../package-
|
|
2
|
+
import { o as packageManager, s as parseManifest } from "../package-DnxZ2CXZ.mjs";
|
|
3
3
|
import { t as runCli } from "../cli-4Tv71vYk.mjs";
|
|
4
4
|
import { c as repositoryRoot, l as resolveRevision } from "../files-DJ0TeaTU.mjs";
|
|
5
|
-
import { a as DIRECTORY_LINK, c as revisionCounts, d as createAddedPolicy, f as describeAllowance, i as stampProof, l as workspaceManifests, m as recordVerdict, o as compareRevisions, p as fillStars, u as allowedByGlob } from "../proof-stamp-
|
|
6
|
-
import { c as packagesAt, i as isTestSource, l as unpublishedAt, o as loadTypeScript, r as isExportPath, s as outputRoot, t as emitPackage } from "../typescript-
|
|
5
|
+
import { a as DIRECTORY_LINK, c as revisionCounts, d as createAddedPolicy, f as describeAllowance, i as stampProof, l as workspaceManifests, m as recordVerdict, o as compareRevisions, p as fillStars, u as allowedByGlob } from "../proof-stamp-Kg-tkM6G.mjs";
|
|
6
|
+
import { c as packagesAt, i as isTestSource, l as unpublishedAt, o as loadTypeScript, r as isExportPath, s as outputRoot, t as emitPackage } from "../typescript-DhavwHb7.mjs";
|
|
7
7
|
import { createRequire } from "node:module";
|
|
8
8
|
import { copyFileSync, cpSync, existsSync, globSync, mkdirSync, readFileSync, readdirSync, realpathSync, rmSync, statSync, symlinkSync, writeFileSync } from "node:fs";
|
|
9
9
|
import { basename, dirname, isAbsolute, join, parse, posix, relative, resolve, sep } from "node:path";
|
package/dist/bin/body-check.mjs
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
import { t as runCli } from "../cli-4Tv71vYk.mjs";
|
|
3
3
|
import { c as repositoryRoot, l as resolveRevision } from "../files-DJ0TeaTU.mjs";
|
|
4
4
|
import { t as lintDiagnostics } from "../oxlint-BbpTFFmf.mjs";
|
|
5
|
-
import { n as proofDigest, r as proofLines, s as revisionCountRows, t as parseProofStamp } from "../proof-stamp-
|
|
5
|
+
import { n as proofDigest, r as proofLines, s as revisionCountRows, t as parseProofStamp } from "../proof-stamp-Kg-tkM6G.mjs";
|
|
6
6
|
import { readFileSync } from "node:fs";
|
|
7
7
|
import { spawnSync } from "node:child_process";
|
|
8
8
|
import { parseArgs } from "node:util";
|
package/dist/bin/checks.mjs
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
import { n as runCliAsync } from "../cli-4Tv71vYk.mjs";
|
|
3
3
|
import { c as repositoryRoot } from "../files-DJ0TeaTU.mjs";
|
|
4
|
-
import { r as runChecks, t as CHECKS_SKIP_ENV } from "../checks-
|
|
4
|
+
import { r as runChecks, t as CHECKS_SKIP_ENV } from "../checks-DqTjyKCC.mjs";
|
|
5
5
|
import { parseArgs } from "node:util";
|
|
6
6
|
//#region src/bin/checks.ts
|
|
7
7
|
const SIGNAL_EXIT = /* @__PURE__ */ new Map([
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
import { t as runCli } from "../cli-4Tv71vYk.mjs";
|
|
3
3
|
import { c as repositoryRoot } from "../files-DJ0TeaTU.mjs";
|
|
4
|
-
import { c as revisionCounts, i as stampProof, o as compareRevisions } from "../proof-stamp-
|
|
5
|
-
import { a as listsNoFiles, c as packagesAt, n as extendedConfigs, t as emitPackage } from "../typescript-
|
|
4
|
+
import { c as revisionCounts, i as stampProof, o as compareRevisions } from "../proof-stamp-Kg-tkM6G.mjs";
|
|
5
|
+
import { a as listsNoFiles, c as packagesAt, n as extendedConfigs, t as emitPackage } from "../typescript-DhavwHb7.mjs";
|
|
6
6
|
import { copyFileSync, existsSync, mkdirSync } from "node:fs";
|
|
7
7
|
import { dirname, isAbsolute, join, relative, resolve, sep } from "node:path";
|
|
8
8
|
//#region src/guardrails/comment-proof.ts
|
package/dist/bin/ratchet.mjs
CHANGED
|
@@ -3,7 +3,7 @@ import { c as parseCeilings, l as readCeilings, t as CEILINGS_FILE } from "../ce
|
|
|
3
3
|
import { n as renamedPaths } from "../renames-L2owF5GD.mjs";
|
|
4
4
|
import { t as runCli } from "../cli-4Tv71vYk.mjs";
|
|
5
5
|
import { c as repositoryRoot, l as resolveRevision, t as LINT_CONFIG } from "../files-DJ0TeaTU.mjs";
|
|
6
|
-
import { n as ratchet, r as withPreviousTree } from "../ratchet-
|
|
6
|
+
import { n as ratchet, r as withPreviousTree } from "../ratchet-1O8k4Dxu.mjs";
|
|
7
7
|
import { t as lintDiagnostics } from "../oxlint-BbpTFFmf.mjs";
|
|
8
8
|
import { d as stagedAdditions, f as stagedChanges, u as previousLine } from "../suppression-budget-DgYdu6JK.mjs";
|
|
9
9
|
import { n as suppressionBase } from "../suppression-base-DZgUDXiI.mjs";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {}
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { d as toolingRoot } from "../package-DnxZ2CXZ.mjs";
|
|
3
|
+
import { t as runCli } from "../cli-4Tv71vYk.mjs";
|
|
4
|
+
import { c as repositoryRoot } from "../files-DJ0TeaTU.mjs";
|
|
5
|
+
import { mkdirSync, readFileSync, writeFileSync } from "node:fs";
|
|
6
|
+
import { join } from "node:path";
|
|
7
|
+
import { parseArgs } from "node:util";
|
|
8
|
+
//#region src/guardrails/readme-strip.ts
|
|
9
|
+
/** Where a framework repository keeps its strip banner, relative to its root. */
|
|
10
|
+
const STRIP_PATH = ".github/readme/strip.svg";
|
|
11
|
+
/** The kinds of framework repository, in the order the strip label names them. */
|
|
12
|
+
const STRIP_KINDS = [
|
|
13
|
+
"interface",
|
|
14
|
+
"provider",
|
|
15
|
+
"template",
|
|
16
|
+
"tooling"
|
|
17
|
+
];
|
|
18
|
+
const ACCENT = "#4f8cff";
|
|
19
|
+
const BORDER = "rgba(140,160,220,0.18)";
|
|
20
|
+
const NAME = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
|
|
21
|
+
/** Kinds whose repository names start with the kind, such as `interface-email`; the label names the kind once. */
|
|
22
|
+
const REPEATED_KINDS = /* @__PURE__ */ new Set(["interface", "template"]);
|
|
23
|
+
const TAGLINE = "Hexagonal architecture, beyond your own code.";
|
|
24
|
+
const FONTS = [["GeistX", "geist-extrabold.woff2"], ["GeistM", "geist-mono.woff2"]];
|
|
25
|
+
const HEXAGON = {
|
|
26
|
+
x: 750,
|
|
27
|
+
y: 75,
|
|
28
|
+
radius: 40
|
|
29
|
+
};
|
|
30
|
+
const SPOKES = [
|
|
31
|
+
[
|
|
32
|
+
0,
|
|
33
|
+
-44,
|
|
34
|
+
0,
|
|
35
|
+
-60
|
|
36
|
+
],
|
|
37
|
+
[
|
|
38
|
+
0,
|
|
39
|
+
44,
|
|
40
|
+
0,
|
|
41
|
+
60
|
|
42
|
+
],
|
|
43
|
+
[
|
|
44
|
+
38,
|
|
45
|
+
-22,
|
|
46
|
+
78,
|
|
47
|
+
-40
|
|
48
|
+
],
|
|
49
|
+
[
|
|
50
|
+
38,
|
|
51
|
+
22,
|
|
52
|
+
78,
|
|
53
|
+
40
|
|
54
|
+
],
|
|
55
|
+
[
|
|
56
|
+
-38,
|
|
57
|
+
-22,
|
|
58
|
+
-78,
|
|
59
|
+
-40
|
|
60
|
+
],
|
|
61
|
+
[
|
|
62
|
+
-38,
|
|
63
|
+
22,
|
|
64
|
+
-78,
|
|
65
|
+
40
|
|
66
|
+
]
|
|
67
|
+
];
|
|
68
|
+
function isKind(kind) {
|
|
69
|
+
return STRIP_KINDS.some((known) => known === kind);
|
|
70
|
+
}
|
|
71
|
+
/** The label the strip shows for a repository, such as `PROVIDER · FILE STORAGE S3`. */
|
|
72
|
+
function stripLabel(kind, name) {
|
|
73
|
+
if (!isKind(kind)) throw new Error(`unknown strip kind "${kind}": use one of ${STRIP_KINDS.join(", ")}.`);
|
|
74
|
+
if (!NAME.test(name)) throw new Error(`invalid strip name "${name}": use lowercase words joined by hyphens, such as file-storage-s3.`);
|
|
75
|
+
if (REPEATED_KINDS.has(kind) && name.startsWith(`${kind}-`)) throw new Error(`strip name "${name}" repeats the kind: pass --name ${name.slice(kind.length + 1)}, the label reads ${kind.toUpperCase()} · ${name.slice(kind.length + 1).replaceAll("-", " ").toUpperCase()}.`);
|
|
76
|
+
return `${kind} · ${name.replaceAll("-", " ")}`.toUpperCase();
|
|
77
|
+
}
|
|
78
|
+
function fontFaces() {
|
|
79
|
+
const directory = join(toolingRoot(), "assets/readme");
|
|
80
|
+
return FONTS.map(([family, file]) => `@font-face{font-family:'${family}';src:url(data:font/woff2;base64,${readFileSync(join(directory, file)).toString("base64")}) format('woff2')}`).join("");
|
|
81
|
+
}
|
|
82
|
+
function hexagon() {
|
|
83
|
+
const { x, y, radius } = HEXAGON;
|
|
84
|
+
const points = [
|
|
85
|
+
-90,
|
|
86
|
+
-30,
|
|
87
|
+
30,
|
|
88
|
+
90,
|
|
89
|
+
150,
|
|
90
|
+
210
|
|
91
|
+
].map((degrees) => {
|
|
92
|
+
const angle = degrees * Math.PI / 180;
|
|
93
|
+
return `${(x + radius * Math.cos(angle)).toFixed(1)},${(y + radius * Math.sin(angle)).toFixed(1)}`;
|
|
94
|
+
}).join(" ");
|
|
95
|
+
return `${SPOKES.map(([x1, y1, x2, y2]) => `<line x1="${x + x1}" y1="${y + y1}" x2="${x + x2}" y2="${y + y2}" stroke="${BORDER}" stroke-width="2"/><circle cx="${x + x2}" cy="${y + y2}" r="5" fill="#15151b" stroke="${BORDER}"/>`).join("")}<polygon points="${points}" fill="${ACCENT}" fill-opacity=".14" stroke="${ACCENT}" stroke-width="2"/>`;
|
|
96
|
+
}
|
|
97
|
+
/** The 1200x150 strip banner of a framework repository, in the layout and fonts of the DMS strips and the framework blue. */
|
|
98
|
+
function stripSvg(kind, name) {
|
|
99
|
+
const label = stripLabel(kind, name);
|
|
100
|
+
const description = `${label}: part of AntelopeJS, hexagonal architecture beyond your own code. A glowing button reads Star AntelopeJS.`;
|
|
101
|
+
return [
|
|
102
|
+
`<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1200 150" width="1200" height="150" role="img" aria-label="${description}"><title>${description}</title>`,
|
|
103
|
+
`<style>${fontFaces()}.x{font-family:'GeistX',sans-serif;font-weight:800}.m{font-family:'GeistM',monospace}@keyframes a1{0%,8.89%{opacity:0;transform:scale(.7)}11.89%,88.00%{opacity:1;transform:none}92.00%,100%{opacity:0;transform:scale(.7)}}.a1{opacity:0;transform:scale(.7);transform-box:fill-box;transform-origin:center;animation:a1 9.0s cubic-bezier(.2,.8,.2,1) infinite}@keyframes pulse{0%,100%{opacity:.35}50%{opacity:.9}}.pulse{animation:pulse 2s ease-in-out infinite}@media (prefers-reduced-motion:reduce){*{animation:none!important;opacity:1!important}.cover{display:none}}</style>`,
|
|
104
|
+
`<defs><radialGradient id="g" cx="75%" cy="50%" r="60%"><stop offset="0" stop-color="${ACCENT}" stop-opacity=".10"/><stop offset="1" stop-color="#06070d" stop-opacity="0"/></radialGradient></defs>`,
|
|
105
|
+
`<rect width="1200" height="150" rx="16" fill="#06070d"/><rect width="1200" height="150" rx="16" fill="url(#g)"/><rect x=".5" y=".5" width="1199" height="149" rx="16" fill="none" stroke="${BORDER}"/>`,
|
|
106
|
+
`<text x="48" y="50" class="m" fill="${ACCENT}" font-size="15" letter-spacing="3">${label}</text>`,
|
|
107
|
+
`<text x="46" y="98" class="x" fill="#f8f8f9" font-size="32">Part of <tspan fill="${ACCENT}">AntelopeJS</tspan></text>`,
|
|
108
|
+
`<text x="48" y="128" class="m" fill="#9b9ba4" font-size="16">${TAGLINE}</text>`,
|
|
109
|
+
hexagon(),
|
|
110
|
+
`<g class="a1"><rect class="pulse" x="870" y="44" width="290" height="62" rx="31" fill="none" stroke="${ACCENT}" stroke-width="2"/><rect x="876" y="50" width="278" height="50" rx="25" fill="${ACCENT}" fill-opacity=".14"/><text x="1015" y="82" text-anchor="middle" class="x" fill="${ACCENT}" font-size="20">★ Star AntelopeJS</text></g>`,
|
|
111
|
+
"</svg>",
|
|
112
|
+
""
|
|
113
|
+
].join("");
|
|
114
|
+
}
|
|
115
|
+
/** Writes the strip banner of the repository at `root` to `.github/readme/strip.svg`. */
|
|
116
|
+
function writeStrip(root, kind, name) {
|
|
117
|
+
const svg = stripSvg(kind, name);
|
|
118
|
+
mkdirSync(join(root, ".github/readme"), { recursive: true });
|
|
119
|
+
writeFileSync(join(root, STRIP_PATH), svg);
|
|
120
|
+
}
|
|
121
|
+
//#endregion
|
|
122
|
+
//#region src/bin/readme-strip.ts
|
|
123
|
+
const USAGE = `usage: antelopejs-readme-strip --kind <${STRIP_KINDS.join("|")}> --name <label-name>`;
|
|
124
|
+
runCli(() => {
|
|
125
|
+
const { values } = parseArgs({ options: {
|
|
126
|
+
kind: { type: "string" },
|
|
127
|
+
name: { type: "string" }
|
|
128
|
+
} });
|
|
129
|
+
if (values.kind === void 0 || values.name === void 0) throw new Error(USAGE);
|
|
130
|
+
writeStrip(repositoryRoot(), values.kind, values.name);
|
|
131
|
+
return 0;
|
|
132
|
+
});
|
|
133
|
+
//#endregion
|
|
134
|
+
export {};
|