diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index d1f79f9..1b31749 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -15,6 +15,15 @@ repos: files: ^((packages|crates)/[^/]+/)?README[^/]*$|^docs/ types: [text] stages: [pre-commit] + - id: no-retired-names + name: No retired product names or wrong package names in docs + # The hosted service is "CacheKit Cloud" in prose; `CachekitIO` is only a code identifier. + # Naming rules: https://docs.cachekit.io/contributing/#names + language: pygrep + entry: '(?i:\bCachekitIO[ -](?:Cloud|SaaS|backend|service|server|API)s?\b)|\bSaaS\b|(?i:(? -[Protocol Repo](https://github.com/cachekit-io/protocol) · [SDK Feature Matrix](sdk-feature-matrix.md) · [Cache Key Format](spec/cache-key-format.md) · [Wire Format](spec/wire-format.md) · [Encryption](spec/encryption.md) · [SaaS API](spec/saas-api.md) +[Protocol Repo](https://github.com/cachekit-io/protocol) · [SDK Feature Matrix](sdk-feature-matrix.md) · [Cache Key Format](spec/cache-key-format.md) · [Wire Format](spec/wire-format.md) · [Encryption](spec/encryption.md) · [CacheKit Cloud API](spec/saas-api.md) diff --git a/conformance/README.md b/conformance/README.md index 578f84c..ed3d6b3 100644 --- a/conformance/README.md +++ b/conformance/README.md @@ -139,7 +139,7 @@ and its `retired` ids. Each requirement entry has these fields: | Field | Meaning | | :--- | :--- | | `section` | The heading the id sits under. `check` compares it with the spec. | -| `binds` | Who must comply: `sdk`, `server` (the CachekitIO service) or `caller` (application code that uses an SDK, or its deployment). | +| `binds` | Who must comply: `sdk`, `server` (CacheKit Cloud) or `caller` (application code that uses an SDK, or its deployment). | | `sdks` | Optional. The SDKs a requirement binds when it binds only some of them, such as `["cachekit-ts"]`: one that is language-specific, or conditional on a format or feature only those SDKs implement. Omitted, it binds every SDK. | | `vectors` | Vectors that exercise the requirement: `.json:`, or `.json` for every vector in the fixture. A `path-encoding.json` vector is named by its `key`. A name that holds a control character is written with JSON's escapes (`"path-encoding.json:.\t."`, and DEL as `\u007f`, though JSON allows it raw), and `coverage.md` shows a name as its JSON string literal when it is not all printable, is not in Unicode normal form C, starts with a quote, or starts or ends with a space. | | `tests` | Tests in this repository's tools that exercise it, as `tools/:`. `` must be a function the tool defines: a `def` in a `.py` tool (found with Python's `ast`), or a `function` declared at the start of a line in a `.mjs` tool, outside comments, strings, template literals and regular expressions. These run only against the reference implementations. |