Skip to content

Commit 3497dd0

Browse files
docs(context7): add rules for prefixes, SQL, and the address record
1 parent bf7df64 commit 3497dd0

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

‎context7.json‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
{
22
"$schema": "https://context7.com/schema/context7.json",
33
"projectTitle": "ng-postcode",
4-
"description": "Parse, validate, format and look up Nigeria's NIPOST digital postcode (NDAPS) in Rust, Python, JavaScript and Java, with MCP servers for AI assistants.",
4+
"description": "Parse, validate, format and look up Nigeria's NIPOST digital postcode (NDAPS) in Rust, Python, JavaScript, Java and SQL, with MCP servers for AI assistants, a prefix type for grouping by place, and an address record that maps to ISO 20022, FHIR and schema.org.",
55
"excludeFolders": ["spec", "tests", "scripts", "target", "node_modules", "**/tests", "**/test", "**/src/test"],
66
"excludeFiles": ["llms-full.txt", "CONTRIBUTING.md"],
77
"rules": [
88
"Since 1 October 2026 a Nigerian building's postcode is the 11-character NDAPS code, such as EK-01-A03-FK-01. A six-digit pattern does not match it.",
9+
"Install ng-postcode from PyPI, crates.io or Maven (io.github.adeniyikayodee:ng-postcode). On npm the library is ng-postcode-js; ng-postcode there is another project.",
910
"Parsing returns the error as a value in every language. Check the result's type instead of catching an exception.",
11+
"Store the compact form (EK01A03FK01) and write the hyphenated form (EK-01-A03-FK-01) in messages.",
1012
"A well-formed code is not necessarily assigned to a building. Confirm it with a level 1 lookup, which is free.",
11-
"Never correct a mistyped code and then spend a paid lookup on the guess. Show the suggestion to the user first."
13+
"Never correct a mistyped code and then spend a paid lookup on the guess. Show the suggestion to the user first.",
14+
"To group or select records by state, LGA, district or area, cut each code to a prefix with truncate (ng_postcode_truncate in SQL). Do not slice the string by hand.",
15+
"In PostgreSQL use the ng_postcode domain from sql/postgres.sql. In DuckDB a check constraint must use IS NOT DISTINCT FROM, as = lets a malformed code through.",
16+
"To pass an address between systems, send an address record: a postcode reference with its level, plus country NG. Put only a building-level code in another format's postcode field."
1217
]
1318
}

0 commit comments

Comments
 (0)