Skip to content

Commit 4e7d59f

Browse files
authored
Clarify typeid spec (#445)
## Summary Clarify the typeid spec, and add some additional examples of invalid typeids. ## How was it tested? N/A ## Community Contribution License All community contributions in this pull request are licensed to the project maintainers under the terms of the [Apache 2 license](https://www.apache.org/licenses/LICENSE-2.0). By creating this pull request I represent that I have the right to license the contributions to the project maintainers under the Apache 2 license. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Improved the overall clarity and structure of project documentation. - Expanded the TypeID specification with a new section on length constraints, refined rules for identifier components, and updated examples. - Reorganized community implementation details for better presentation. - **Tests** - Enhanced validation coverage by introducing new cases for empty or improperly formatted identifiers. - Removed an outdated test case to streamline internal validations. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent bb034b3 commit 4e7d59f

6 files changed

Lines changed: 196 additions & 136 deletions

File tree

devbox.lock

Lines changed: 4 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
}
5151
},
5252
"github:NixOS/nixpkgs/nixpkgs-unstable": {
53-
"resolved": "github:NixOS/nixpkgs/d9b69c3ec2a2e2e971c534065bdd53374bd68b97?lastModified=1740396192&narHash=sha256-ATMHHrg3sG1KgpQA5x8I%2BzcYpp5Sf17FaFj%2FfN%2B8OoQ%3D"
53+
"resolved": "github:NixOS/nixpkgs/b58e19b11fe72175fd7a9e014a4786a91e99da5f?lastModified=1740916017&narHash=sha256-Ze%2F3XCElkVljFCnBKezLldOz2ZaGp7eozxRqFzACnMI%3D"
5454
},
5555
"go@latest": {
5656
"last_modified": "2025-02-12T00:10:52Z",
@@ -100,53 +100,9 @@
100100
}
101101
}
102102
},
103-
"golangci-lint@latest": {
104-
"last_modified": "2025-02-14T06:00:41Z",
105-
"resolved": "github:NixOS/nixpkgs/fada727ee7c0bd487e311dede0a2b0725a0f7765#golangci-lint",
106-
"source": "devbox-search",
107-
"version": "1.64.4",
108-
"systems": {
109-
"aarch64-darwin": {
110-
"outputs": [
111-
{
112-
"name": "out",
113-
"path": "/nix/store/bkr8ci8dx0ly9x1fpbd5j5grg7m1cshk-golangci-lint-1.64.4",
114-
"default": true
115-
}
116-
],
117-
"store_path": "/nix/store/bkr8ci8dx0ly9x1fpbd5j5grg7m1cshk-golangci-lint-1.64.4"
118-
},
119-
"aarch64-linux": {
120-
"outputs": [
121-
{
122-
"name": "out",
123-
"path": "/nix/store/28cismn6xhr01p8larm05g01nlinm9gx-golangci-lint-1.64.4",
124-
"default": true
125-
}
126-
],
127-
"store_path": "/nix/store/28cismn6xhr01p8larm05g01nlinm9gx-golangci-lint-1.64.4"
128-
},
129-
"x86_64-darwin": {
130-
"outputs": [
131-
{
132-
"name": "out",
133-
"path": "/nix/store/831s0i15adpsirb5rv2yvdbng0z0d2br-golangci-lint-1.64.4",
134-
"default": true
135-
}
136-
],
137-
"store_path": "/nix/store/831s0i15adpsirb5rv2yvdbng0z0d2br-golangci-lint-1.64.4"
138-
},
139-
"x86_64-linux": {
140-
"outputs": [
141-
{
142-
"name": "out",
143-
"path": "/nix/store/mpl65c3g74wjcs68qz4962jjg9va0h7j-golangci-lint-1.64.4",
144-
"default": true
145-
}
146-
],
147-
"store_path": "/nix/store/mpl65c3g74wjcs68qz4962jjg9va0h7j-golangci-lint-1.64.4"
148-
}
149-
}
103+
"runx:golangci/golangci-lint@latest": {
104+
"resolved": "golangci/golangci-lint@v1.64.6",
105+
"version": "v1.64.6"
150106
},
151107
"runx:mvdan/gofumpt@latest": {
152108
"resolved": "mvdan/gofumpt@v0.7.0",

typeid/typeid-go/testdata/invalid.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,6 @@
9898
typeid: "prefix__00000000000000000000000000"
9999
description: "The prefix can't end with an underscore"
100100

101-
# Tests specific to our golang implementation, consider promoting to the
102-
# spec tests
103101
- name: empty
104102
typeid: ""
105103
description: "The empty string is not a valid typeid"

0 commit comments

Comments
 (0)