NodetteHQ/PureXML
1
0
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases 1 Wiki Activity
0ff46f6b78
PureXML/docs/rules
History
Mihaela Mihaljevic 54a731e190 Mirror mandatory Swift rules
2026-06-18 22:00:41 +02:00
..
rules-swift Mirror mandatory Swift rules 2026-06-18 22:00:41 +02:00
code-style.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
commits.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
concurrency.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
cross-platform.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
dependency-injection.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
documentation.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
engineering.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
file-naming.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
folder-grouping.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
git-discipline.md ci: split workflows for truthful badges and attribution gates 2026-06-08 04:37:32 +02:00
mermaid.md docs(roadmap): add Apple-palette mermaid roadmap and the roadmap gate 2026-06-08 00:58:50 +02:00
namespacing.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
package-architecture.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
package-structure.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
README.md Mirror mandatory Swift rules 2026-06-18 22:00:41 +02:00
research-first.md docs(rules): research-first rule, consult research repo and literature before guessing 2026-06-15 00:30:01 +02:00
shared-protocols.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
systematic-debugging.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
testing-discipline.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
testing.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00
verification.md chore: scaffold PureXML pure-Swift XML package 2026-06-07 23:20:20 +02:00

README.md

PureXML Rules

Load these rules before changing code:

  • code-style.md
  • namespacing.md
  • cross-platform.md
  • testing.md
  • verification.md
  • commits.md
  • research-first.md

Project-specific overrides:

  • PureXML uses a root Package.swift.
  • Sources live directly under Sources.
  • Tests live in Tests (test target PureXMLTests).
  • Package.swift must keep dependencies: [].
  • Public API must live under the PureXML namespace tree.
  • The package must build on macOS, Linux, Windows, and WASI.
  • Validation coverage gates: docs/validation-coverage-registry.txt (public types), docs/validation-field-registry.txt (document/subject fields), enforced by scripts/check-validation-coverage.sh and scripts/check-validation-fields.sh.

The broader rule files are retained for detailed guidance. When they include generic examples, apply the PureXML-specific overrides above.

Canonical Swift rules are vendored at docs/rules/rules-swift/ and mirrored from /Volumes/Code/DeveloperExt/public/rules-swift (especially validation-rules.md, parsing-rules.md, and the core/ spine). Prefer that vendored source when root docs/rules/ copies are missing or have drifted, but do not let its generic Tiledown examples weaken PureXML's root-package, dependency-free, Windows, and WASI requirements. PureXML's committed .swiftlint.yml and .swiftformat are the coherent project tuning of that canon: they adopt its opt-in rule set and shared formatter directives, keep stricter safety (force_unwrapping/force_try/force_cast = error), and resolve the canon's --commas always vs default-trailing_comma mismatch by mandating trailing commas in both tools.