@tailor-platform/erp-kit 0.2.2 → 0.4.0
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/CHANGELOG.md +33 -0
- package/README.md +193 -69
- package/dist/cli.mjs +1038 -398
- package/package.json +7 -5
- package/skills/erp-kit-app-1-requirements/SKILL.md +27 -17
- package/skills/erp-kit-app-2-requirements-review/SKILL.md +5 -4
- package/skills/erp-kit-app-2-requirements-review/references/best-practices-check.md +10 -1
- package/skills/erp-kit-app-2-requirements-review/references/boundary-consistency-check.md +10 -1
- package/skills/erp-kit-app-3-plan/SKILL.md +31 -34
- package/skills/erp-kit-app-3-plan/references/resolver-extraction.md +22 -36
- package/skills/erp-kit-app-3-plan/references/screen-extraction.md +15 -1
- package/skills/erp-kit-app-3-plan/references/story-extraction.md +8 -2
- package/skills/erp-kit-app-4-plan-review/SKILL.md +1 -10
- package/skills/erp-kit-app-5-impl-backend/SKILL.md +10 -19
- package/skills/erp-kit-app-5-impl-backend/references/app-config.md +1 -22
- package/skills/erp-kit-app-5-impl-backend/references/module-wiring.md +0 -1
- package/skills/erp-kit-app-5-impl-backend/references/resolver-patterns.md +13 -4
- package/skills/erp-kit-app-6-impl-frontend/SKILL.md +5 -0
- package/skills/erp-kit-app-6-impl-frontend/references/pages.md +16 -46
- package/skills/erp-kit-app-7-impl-review/SKILL.md +13 -11
- package/skills/erp-kit-app-7-impl-review/references/resolver-doc-code-parity.md +16 -17
- package/skills/erp-kit-app-shared/SKILL.md +15 -0
- package/skills/erp-kit-app-shared/references/link-format-reference.md +13 -0
- package/skills/erp-kit-app-shared/references/naming-conventions.md +21 -0
- package/skills/erp-kit-app-shared/references/resolver-classification.md +23 -0
- package/skills/erp-kit-app-shared/references/schema-constraints.md +25 -0
- package/skills/erp-kit-module-1-requirements/SKILL.md +7 -13
- package/skills/erp-kit-module-1-requirements/references/feature-doc.md +1 -1
- package/skills/erp-kit-module-2-requirements-review/SKILL.md +21 -5
- package/skills/erp-kit-module-2-requirements-review/references/requirements-report-format.md +19 -0
- package/skills/erp-kit-module-3-plan/SKILL.md +6 -8
- package/skills/erp-kit-module-3-plan/references/naming.md +15 -1
- package/skills/erp-kit-module-4-plan-review/SKILL.md +21 -5
- package/skills/erp-kit-module-4-plan-review/references/parity-report-format.md +15 -0
- package/skills/erp-kit-module-5-impl/SKILL.md +12 -10
- package/skills/erp-kit-module-5-impl/references/generated-code.md +2 -2
- package/skills/erp-kit-module-6-impl-review/SKILL.md +21 -7
- package/skills/erp-kit-module-6-impl-review/references/error-implementation-parity.md +1 -1
- package/skills/erp-kit-module-6-impl-review/references/errors.md +1 -1
- package/skills/erp-kit-module-6-impl-review/references/impl-parity-report-format.md +15 -0
- package/skills/erp-kit-module-shared/SKILL.md +4 -0
- package/skills/erp-kit-module-shared/references/errors.md +1 -1
- package/skills/erp-kit-module-shared/references/queries.md +1 -1
- package/skills/erp-kit-module-shared/references/structure.md +1 -1
- package/skills/erp-kit-update/SKILL.md +2 -2
- package/src/commands/app/index.ts +75 -31
- package/src/commands/check.test.ts +1 -1
- package/src/commands/check.ts +2 -35
- package/src/commands/doc/index.ts +83 -0
- package/src/commands/doc/module.test.ts +119 -0
- package/src/commands/doc/module.ts +114 -0
- package/src/commands/doc/modules.test.ts +103 -0
- package/src/commands/doc/modules.ts +98 -0
- package/src/commands/doc/search.test.ts +94 -0
- package/src/commands/doc/search.ts +111 -0
- package/src/commands/generate-doc.test.ts +63 -0
- package/src/commands/generate-doc.ts +105 -0
- package/src/commands/index.ts +20 -8
- package/src/commands/init-module.test.ts +43 -0
- package/src/commands/init-module.ts +74 -0
- package/src/commands/lib/command-result.ts +30 -0
- package/src/commands/lib/discovery.test.ts +74 -0
- package/src/commands/lib/discovery.ts +106 -0
- package/src/commands/lib/paths.ts +22 -0
- package/src/commands/lib/sync-check-source.test.ts +197 -0
- package/src/commands/lib/sync-check-source.ts +100 -0
- package/src/commands/lib/sync-check-tests.test.ts +178 -0
- package/src/commands/lib/sync-check-tests.ts +69 -0
- package/src/commands/mock/index.ts +11 -6
- package/src/commands/module/generate.ts +39 -14
- package/src/commands/module/index.ts +31 -45
- package/src/commands/parse-doc-test-cases.ts +13 -2
- package/src/commands/sync-check.test.ts +6 -364
- package/src/commands/sync-check.ts +7 -251
- package/src/generator/generate-app-code.test.ts +121 -0
- package/src/generator/generate-app-code.ts +51 -0
- package/src/{commands/scaffold.test.ts → generator/generate-code-boilerplate.test.ts} +19 -89
- package/src/generator/generate-code.test.ts +57 -6
- package/src/generator/generate-code.ts +40 -157
- package/src/generator/generate-errors.ts +34 -0
- package/src/generator/generate-permissions.ts +12 -0
- package/src/generator/generate-shells.ts +28 -0
- package/src/generator/generate-stubs.ts +31 -0
- package/src/generator/parse-resolver-doc.test.ts +89 -0
- package/src/generator/parse-resolver-doc.ts +125 -0
- package/src/generator/scaffold.ts +57 -0
- package/src/generator/stub-templates.test.ts +55 -0
- package/src/generator/stub-templates.ts +145 -0
- package/src/integration.test.ts +2 -2
- package/src/modules/audit/README.md +46 -0
- package/src/modules/audit/command/activateAuditPolicy.generated.ts +6 -0
- package/src/modules/audit/command/activateAuditPolicy.test.ts +186 -0
- package/src/modules/audit/command/activateAuditPolicy.ts +97 -0
- package/src/modules/audit/command/createAuditPolicy.generated.ts +6 -0
- package/src/modules/audit/command/createAuditPolicy.test.ts +395 -0
- package/src/modules/audit/command/createAuditPolicy.ts +131 -0
- package/src/modules/audit/command/deactivateAuditPolicy.generated.ts +6 -0
- package/src/modules/audit/command/deactivateAuditPolicy.test.ts +138 -0
- package/src/modules/audit/command/deactivateAuditPolicy.ts +58 -0
- package/src/modules/audit/command/deleteAuditPolicy.generated.ts +6 -0
- package/src/modules/audit/command/deleteAuditPolicy.test.ts +121 -0
- package/src/modules/audit/command/deleteAuditPolicy.ts +52 -0
- package/src/modules/audit/command/logAuditEvent.generated.ts +6 -0
- package/src/modules/audit/command/logAuditEvent.test.ts +991 -0
- package/src/modules/audit/command/logAuditEvent.ts +357 -0
- package/src/modules/audit/command/reactivateAuditPolicy.generated.ts +6 -0
- package/src/modules/audit/command/reactivateAuditPolicy.test.ts +143 -0
- package/src/modules/audit/command/reactivateAuditPolicy.ts +79 -0
- package/src/modules/audit/command/registerAuditableEntity.generated.ts +6 -0
- package/src/modules/audit/command/registerAuditableEntity.test.ts +268 -0
- package/src/modules/audit/command/registerAuditableEntity.ts +94 -0
- package/src/modules/audit/command/replaceAuditPolicy.generated.ts +6 -0
- package/src/modules/audit/command/replaceAuditPolicy.test.ts +242 -0
- package/src/modules/audit/command/replaceAuditPolicy.ts +91 -0
- package/src/modules/audit/command/updateAuditPolicy.generated.ts +6 -0
- package/src/modules/audit/command/updateAuditPolicy.test.ts +284 -0
- package/src/modules/audit/command/updateAuditPolicy.ts +151 -0
- package/src/modules/audit/db/auditEntry.ts +47 -0
- package/src/modules/audit/db/auditPolicy.ts +33 -0
- package/src/modules/audit/db/auditableEntity.ts +22 -0
- package/src/modules/audit/db/changeDetail.ts +28 -0
- package/src/modules/audit/db/policyFieldRule.ts +23 -0
- package/src/modules/audit/docs/commands/ActivateAuditPolicy.md +69 -0
- package/src/modules/audit/docs/commands/CreateAuditPolicy.md +79 -0
- package/src/modules/audit/docs/commands/DeactivateAuditPolicy.md +55 -0
- package/src/modules/audit/docs/commands/DeleteAuditPolicy.md +55 -0
- package/src/modules/audit/docs/commands/LogAuditEvent.md +137 -0
- package/src/modules/audit/docs/commands/ReactivateAuditPolicy.md +58 -0
- package/src/modules/audit/docs/commands/RegisterAuditableEntity.md +62 -0
- package/src/modules/audit/docs/commands/ReplaceAuditPolicy.md +72 -0
- package/src/modules/audit/docs/commands/UpdateAuditPolicy.md +77 -0
- package/src/modules/audit/docs/features/audit-event-logging.md +126 -0
- package/src/modules/audit/docs/features/audit-policy-configuration.md +135 -0
- package/src/modules/audit/docs/features/field-level-change-tracking.md +95 -0
- package/src/modules/audit/docs/models/AuditEntry.md +55 -0
- package/src/modules/audit/docs/models/AuditPolicy.md +79 -0
- package/src/modules/audit/docs/models/AuditableEntity.md +38 -0
- package/src/modules/audit/docs/models/ChangeDetail.md +55 -0
- package/src/modules/audit/docs/models/PolicyFieldRule.md +45 -0
- package/src/modules/audit/docs/queries/GetAuditEntry.md +49 -0
- package/src/modules/audit/docs/queries/GetAuditPolicy.md +54 -0
- package/src/modules/audit/docs/queries/GetAuditSummary.md +84 -0
- package/src/modules/audit/docs/queries/GetChangeDetails.md +56 -0
- package/src/modules/audit/docs/queries/ListAuditPolicies.md +58 -0
- package/src/modules/audit/docs/queries/SearchAuditEntries.md +91 -0
- package/src/modules/audit/generated/kysely-tailordb.ts +92 -0
- package/src/modules/audit/index.ts +2 -0
- package/src/modules/audit/lib/_db_deps.ts +13 -0
- package/src/modules/audit/lib/errors.generated.ts +120 -0
- package/src/modules/audit/lib/permissions.generated.ts +14 -0
- package/src/modules/audit/lib/types.ts +28 -0
- package/src/modules/audit/module.ts +57 -0
- package/src/modules/audit/permissions.ts +39 -0
- package/src/modules/audit/query/getAuditEntry.generated.ts +5 -0
- package/src/modules/audit/query/getAuditEntry.test.ts +123 -0
- package/src/modules/audit/query/getAuditEntry.ts +36 -0
- package/src/modules/audit/query/getAuditPolicy.generated.ts +5 -0
- package/src/modules/audit/query/getAuditPolicy.test.ts +169 -0
- package/src/modules/audit/query/getAuditPolicy.ts +42 -0
- package/src/modules/audit/query/getAuditSummary.generated.ts +5 -0
- package/src/modules/audit/query/getAuditSummary.test.ts +632 -0
- package/src/modules/audit/query/getAuditSummary.ts +164 -0
- package/src/modules/audit/query/getChangeDetails.generated.ts +5 -0
- package/src/modules/audit/query/getChangeDetails.test.ts +195 -0
- package/src/modules/audit/query/getChangeDetails.ts +42 -0
- package/src/modules/audit/query/listAuditPolicies.generated.ts +5 -0
- package/src/modules/audit/query/listAuditPolicies.test.ts +239 -0
- package/src/modules/audit/query/listAuditPolicies.ts +100 -0
- package/src/modules/audit/query/searchAuditEntries.generated.ts +5 -0
- package/src/modules/audit/query/searchAuditEntries.test.ts +424 -0
- package/src/modules/audit/query/searchAuditEntries.ts +121 -0
- package/src/modules/audit/tailor.config.ts +13 -0
- package/src/modules/audit/tailor.d.ts +13 -0
- package/src/modules/audit/testing/fixtures.ts +215 -0
- package/src/modules/business-partner/README.md +60 -0
- package/src/modules/business-partner/command/.gitkeep +0 -0
- package/src/modules/business-partner/command/activatePartner.generated.ts +6 -0
- package/src/modules/business-partner/command/activatePartner.test.ts +59 -0
- package/src/modules/business-partner/command/activatePartner.ts +45 -0
- package/src/modules/business-partner/command/assignRoleToPartner.generated.ts +6 -0
- package/src/modules/business-partner/command/assignRoleToPartner.test.ts +113 -0
- package/src/modules/business-partner/command/assignRoleToPartner.ts +72 -0
- package/src/modules/business-partner/command/createContactPerson.generated.ts +6 -0
- package/src/modules/business-partner/command/createContactPerson.test.ts +193 -0
- package/src/modules/business-partner/command/createContactPerson.ts +98 -0
- package/src/modules/business-partner/command/createPartner.generated.ts +6 -0
- package/src/modules/business-partner/command/createPartner.test.ts +179 -0
- package/src/modules/business-partner/command/createPartner.ts +83 -0
- package/src/modules/business-partner/command/createPartnerAddress.generated.ts +6 -0
- package/src/modules/business-partner/command/createPartnerAddress.test.ts +195 -0
- package/src/modules/business-partner/command/createPartnerAddress.ts +119 -0
- package/src/modules/business-partner/command/createPartnerBankAccount.generated.ts +6 -0
- package/src/modules/business-partner/command/createPartnerBankAccount.test.ts +297 -0
- package/src/modules/business-partner/command/createPartnerBankAccount.ts +114 -0
- package/src/modules/business-partner/command/createPartnerIdentification.generated.ts +6 -0
- package/src/modules/business-partner/command/createPartnerIdentification.test.ts +255 -0
- package/src/modules/business-partner/command/createPartnerIdentification.ts +97 -0
- package/src/modules/business-partner/command/deactivateContactPerson.generated.ts +6 -0
- package/src/modules/business-partner/command/deactivateContactPerson.test.ts +70 -0
- package/src/modules/business-partner/command/deactivateContactPerson.ts +54 -0
- package/src/modules/business-partner/command/deactivatePartner.generated.ts +6 -0
- package/src/modules/business-partner/command/deactivatePartner.test.ts +59 -0
- package/src/modules/business-partner/command/deactivatePartner.ts +46 -0
- package/src/modules/business-partner/command/deleteContactPerson.generated.ts +6 -0
- package/src/modules/business-partner/command/deleteContactPerson.test.ts +61 -0
- package/src/modules/business-partner/command/deleteContactPerson.ts +48 -0
- package/src/modules/business-partner/command/deletePartner.generated.ts +6 -0
- package/src/modules/business-partner/command/deletePartner.test.ts +58 -0
- package/src/modules/business-partner/command/deletePartner.ts +46 -0
- package/src/modules/business-partner/command/deletePartnerAddress.generated.ts +6 -0
- package/src/modules/business-partner/command/deletePartnerAddress.test.ts +74 -0
- package/src/modules/business-partner/command/deletePartnerAddress.ts +52 -0
- package/src/modules/business-partner/command/deletePartnerBankAccount.generated.ts +6 -0
- package/src/modules/business-partner/command/deletePartnerBankAccount.test.ts +55 -0
- package/src/modules/business-partner/command/deletePartnerBankAccount.ts +36 -0
- package/src/modules/business-partner/command/deletePartnerIdentification.generated.ts +6 -0
- package/src/modules/business-partner/command/deletePartnerIdentification.test.ts +47 -0
- package/src/modules/business-partner/command/deletePartnerIdentification.ts +37 -0
- package/src/modules/business-partner/command/reactivateContactPerson.generated.ts +6 -0
- package/src/modules/business-partner/command/reactivateContactPerson.test.ts +48 -0
- package/src/modules/business-partner/command/reactivateContactPerson.ts +48 -0
- package/src/modules/business-partner/command/reactivatePartner.generated.ts +6 -0
- package/src/modules/business-partner/command/reactivatePartner.test.ts +59 -0
- package/src/modules/business-partner/command/reactivatePartner.ts +46 -0
- package/src/modules/business-partner/command/removeRoleFromPartner.generated.ts +6 -0
- package/src/modules/business-partner/command/removeRoleFromPartner.test.ts +82 -0
- package/src/modules/business-partner/command/removeRoleFromPartner.ts +73 -0
- package/src/modules/business-partner/command/setDefaultPartnerAddress.generated.ts +6 -0
- package/src/modules/business-partner/command/setDefaultPartnerAddress.test.ts +60 -0
- package/src/modules/business-partner/command/setDefaultPartnerAddress.ts +48 -0
- package/src/modules/business-partner/command/setDefaultPartnerBankAccount.generated.ts +6 -0
- package/src/modules/business-partner/command/setDefaultPartnerBankAccount.test.ts +56 -0
- package/src/modules/business-partner/command/setDefaultPartnerBankAccount.ts +51 -0
- package/src/modules/business-partner/command/setPrimaryContactPerson.generated.ts +6 -0
- package/src/modules/business-partner/command/setPrimaryContactPerson.test.ts +63 -0
- package/src/modules/business-partner/command/setPrimaryContactPerson.ts +55 -0
- package/src/modules/business-partner/command/updateContactPerson.generated.ts +6 -0
- package/src/modules/business-partner/command/updateContactPerson.test.ts +193 -0
- package/src/modules/business-partner/command/updateContactPerson.ts +92 -0
- package/src/modules/business-partner/command/updatePartner.generated.ts +6 -0
- package/src/modules/business-partner/command/updatePartner.test.ts +101 -0
- package/src/modules/business-partner/command/updatePartner.ts +76 -0
- package/src/modules/business-partner/command/updatePartnerAddress.generated.ts +6 -0
- package/src/modules/business-partner/command/updatePartnerAddress.test.ts +148 -0
- package/src/modules/business-partner/command/updatePartnerAddress.ts +64 -0
- package/src/modules/business-partner/command/updatePartnerBankAccount.generated.ts +6 -0
- package/src/modules/business-partner/command/updatePartnerBankAccount.test.ts +249 -0
- package/src/modules/business-partner/command/updatePartnerBankAccount.ts +109 -0
- package/src/modules/business-partner/command/updatePartnerIdentification.generated.ts +6 -0
- package/src/modules/business-partner/command/updatePartnerIdentification.test.ts +162 -0
- package/src/modules/business-partner/command/updatePartnerIdentification.ts +105 -0
- package/src/modules/business-partner/db/.gitkeep +0 -0
- package/src/modules/business-partner/db/businessPartner.ts +59 -0
- package/src/modules/business-partner/db/contactPerson.ts +49 -0
- package/src/modules/business-partner/db/partnerAddress.ts +45 -0
- package/src/modules/business-partner/db/partnerBankAccount.ts +53 -0
- package/src/modules/business-partner/db/partnerIdentification.ts +53 -0
- package/src/modules/business-partner/db/partnerRole.ts +43 -0
- package/src/modules/business-partner/docs/commands/ActivatePartner.md +39 -0
- package/src/modules/business-partner/docs/commands/AssignRoleToPartner.md +49 -0
- package/src/modules/business-partner/docs/commands/CreateContactPerson.md +59 -0
- package/src/modules/business-partner/docs/commands/CreatePartner.md +54 -0
- package/src/modules/business-partner/docs/commands/CreatePartnerAddress.md +60 -0
- package/src/modules/business-partner/docs/commands/CreatePartnerBankAccount.md +68 -0
- package/src/modules/business-partner/docs/commands/CreatePartnerIdentification.md +59 -0
- package/src/modules/business-partner/docs/commands/DeactivateContactPerson.md +42 -0
- package/src/modules/business-partner/docs/commands/DeactivatePartner.md +39 -0
- package/src/modules/business-partner/docs/commands/DeleteContactPerson.md +43 -0
- package/src/modules/business-partner/docs/commands/DeletePartner.md +40 -0
- package/src/modules/business-partner/docs/commands/DeletePartnerAddress.md +40 -0
- package/src/modules/business-partner/docs/commands/DeletePartnerBankAccount.md +35 -0
- package/src/modules/business-partner/docs/commands/DeletePartnerIdentification.md +33 -0
- package/src/modules/business-partner/docs/commands/ReactivateContactPerson.md +38 -0
- package/src/modules/business-partner/docs/commands/ReactivatePartner.md +39 -0
- package/src/modules/business-partner/docs/commands/RemoveRoleFromPartner.md +46 -0
- package/src/modules/business-partner/docs/commands/SetDefaultPartnerAddress.md +38 -0
- package/src/modules/business-partner/docs/commands/SetDefaultPartnerBankAccount.md +38 -0
- package/src/modules/business-partner/docs/commands/SetPrimaryContactPerson.md +43 -0
- package/src/modules/business-partner/docs/commands/UpdateContactPerson.md +66 -0
- package/src/modules/business-partner/docs/commands/UpdatePartner.md +48 -0
- package/src/modules/business-partner/docs/commands/UpdatePartnerAddress.md +46 -0
- package/src/modules/business-partner/docs/commands/UpdatePartnerBankAccount.md +64 -0
- package/src/modules/business-partner/docs/commands/UpdatePartnerIdentification.md +52 -0
- package/src/modules/business-partner/docs/features/contact-person-management.md +70 -0
- package/src/modules/business-partner/docs/features/partner-address-management.md +96 -0
- package/src/modules/business-partner/docs/features/partner-bank-account.md +70 -0
- package/src/modules/business-partner/docs/features/partner-identification.md +76 -0
- package/src/modules/business-partner/docs/features/partner-lifecycle.md +59 -0
- package/src/modules/business-partner/docs/features/partner-role-classification.md +73 -0
- package/src/modules/business-partner/docs/models/BusinessPartner.md +64 -0
- package/src/modules/business-partner/docs/models/ContactPerson.md +62 -0
- package/src/modules/business-partner/docs/models/PartnerAddress.md +52 -0
- package/src/modules/business-partner/docs/models/PartnerBankAccount.md +50 -0
- package/src/modules/business-partner/docs/models/PartnerIdentification.md +46 -0
- package/src/modules/business-partner/docs/models/PartnerRole.md +42 -0
- package/src/modules/business-partner/docs/queries/GetContactPerson.md +34 -0
- package/src/modules/business-partner/docs/queries/GetDefaultPartnerAddress.md +40 -0
- package/src/modules/business-partner/docs/queries/GetDefaultPartnerBankAccount.md +36 -0
- package/src/modules/business-partner/docs/queries/GetPartner.md +35 -0
- package/src/modules/business-partner/docs/queries/GetPartnerAddress.md +34 -0
- package/src/modules/business-partner/docs/queries/GetPartnerBankAccount.md +34 -0
- package/src/modules/business-partner/docs/queries/GetPartnerIdentification.md +34 -0
- package/src/modules/business-partner/docs/queries/GetPartnerRole.md +34 -0
- package/src/modules/business-partner/docs/queries/GetPrimaryContactPerson.md +36 -0
- package/src/modules/business-partner/docs/queries/ListContactPersonsByPartner.md +39 -0
- package/src/modules/business-partner/docs/queries/ListPartnerAddressesByPartner.md +41 -0
- package/src/modules/business-partner/docs/queries/ListPartnerBankAccountsByPartner.md +39 -0
- package/src/modules/business-partner/docs/queries/ListPartnerIdentificationsByPartner.md +41 -0
- package/src/modules/business-partner/docs/queries/ListPartnersByRole.md +47 -0
- package/src/modules/business-partner/executor/.gitkeep +0 -0
- package/src/modules/business-partner/generated/.gitkeep +0 -0
- package/src/modules/business-partner/generated/enums.ts +60 -0
- package/src/modules/business-partner/generated/kysely-tailordb.ts +114 -0
- package/src/modules/business-partner/index.ts +2 -0
- package/src/modules/business-partner/lib/_db_deps.ts +17 -0
- package/src/modules/business-partner/lib/errors.generated.ts +172 -0
- package/src/modules/business-partner/lib/errors.ts +2 -0
- package/src/modules/business-partner/lib/permissions.generated.ts +30 -0
- package/src/modules/business-partner/lib/types.ts +53 -0
- package/src/modules/business-partner/module.ts +181 -0
- package/src/modules/business-partner/permissions.ts +3 -0
- package/src/modules/business-partner/query/.gitkeep +0 -0
- package/src/modules/business-partner/query/getContactPerson.generated.ts +5 -0
- package/src/modules/business-partner/query/getContactPerson.test.ts +31 -0
- package/src/modules/business-partner/query/getContactPerson.ts +16 -0
- package/src/modules/business-partner/query/getDefaultPartnerAddress.generated.ts +5 -0
- package/src/modules/business-partner/query/getDefaultPartnerAddress.test.ts +45 -0
- package/src/modules/business-partner/query/getDefaultPartnerAddress.ts +30 -0
- package/src/modules/business-partner/query/getDefaultPartnerBankAccount.generated.ts +5 -0
- package/src/modules/business-partner/query/getDefaultPartnerBankAccount.test.ts +43 -0
- package/src/modules/business-partner/query/getDefaultPartnerBankAccount.ts +17 -0
- package/src/modules/business-partner/query/getPartner.generated.ts +5 -0
- package/src/modules/business-partner/query/getPartner.test.ts +31 -0
- package/src/modules/business-partner/query/getPartner.ts +16 -0
- package/src/modules/business-partner/query/getPartnerAddress.generated.ts +5 -0
- package/src/modules/business-partner/query/getPartnerAddress.test.ts +31 -0
- package/src/modules/business-partner/query/getPartnerAddress.ts +16 -0
- package/src/modules/business-partner/query/getPartnerBankAccount.generated.ts +5 -0
- package/src/modules/business-partner/query/getPartnerBankAccount.test.ts +31 -0
- package/src/modules/business-partner/query/getPartnerBankAccount.ts +16 -0
- package/src/modules/business-partner/query/getPartnerIdentification.generated.ts +5 -0
- package/src/modules/business-partner/query/getPartnerIdentification.test.ts +31 -0
- package/src/modules/business-partner/query/getPartnerIdentification.ts +16 -0
- package/src/modules/business-partner/query/getPartnerRole.generated.ts +5 -0
- package/src/modules/business-partner/query/getPartnerRole.test.ts +31 -0
- package/src/modules/business-partner/query/getPartnerRole.ts +19 -0
- package/src/modules/business-partner/query/getPrimaryContactPerson.generated.ts +5 -0
- package/src/modules/business-partner/query/getPrimaryContactPerson.test.ts +43 -0
- package/src/modules/business-partner/query/getPrimaryContactPerson.ts +17 -0
- package/src/modules/business-partner/query/listContactPersonsByPartner.generated.ts +5 -0
- package/src/modules/business-partner/query/listContactPersonsByPartner.test.ts +77 -0
- package/src/modules/business-partner/query/listContactPersonsByPartner.ts +32 -0
- package/src/modules/business-partner/query/listPartnerAddressesByPartner.generated.ts +5 -0
- package/src/modules/business-partner/query/listPartnerAddressesByPartner.test.ts +71 -0
- package/src/modules/business-partner/query/listPartnerAddressesByPartner.ts +37 -0
- package/src/modules/business-partner/query/listPartnerBankAccountsByPartner.generated.ts +5 -0
- package/src/modules/business-partner/query/listPartnerBankAccountsByPartner.test.ts +59 -0
- package/src/modules/business-partner/query/listPartnerBankAccountsByPartner.ts +32 -0
- package/src/modules/business-partner/query/listPartnerIdentificationsByPartner.generated.ts +5 -0
- package/src/modules/business-partner/query/listPartnerIdentificationsByPartner.test.ts +72 -0
- package/src/modules/business-partner/query/listPartnerIdentificationsByPartner.ts +40 -0
- package/src/modules/business-partner/query/listPartnersByRole.generated.ts +5 -0
- package/src/modules/business-partner/query/listPartnersByRole.test.ts +103 -0
- package/src/modules/business-partner/query/listPartnersByRole.ts +47 -0
- package/src/modules/business-partner/tailor.config.ts +13 -0
- package/src/modules/business-partner/tailor.d.ts +13 -0
- package/src/modules/business-partner/testing/fixtures.ts +204 -0
- package/src/modules/coa-management/README.md +61 -0
- package/src/modules/coa-management/command/.gitkeep +0 -0
- package/src/modules/coa-management/command/activateAccount.generated.ts +6 -0
- package/src/modules/coa-management/command/activateAccount.test.ts +125 -0
- package/src/modules/coa-management/command/activateAccount.ts +105 -0
- package/src/modules/coa-management/command/activateChartOfAccounts.generated.ts +6 -0
- package/src/modules/coa-management/command/activateChartOfAccounts.test.ts +113 -0
- package/src/modules/coa-management/command/activateChartOfAccounts.ts +104 -0
- package/src/modules/coa-management/command/createAccount.generated.ts +6 -0
- package/src/modules/coa-management/command/createAccount.test.ts +767 -0
- package/src/modules/coa-management/command/createAccount.ts +247 -0
- package/src/modules/coa-management/command/createAccountGroup.generated.ts +6 -0
- package/src/modules/coa-management/command/createAccountGroup.test.ts +494 -0
- package/src/modules/coa-management/command/createAccountGroup.ts +207 -0
- package/src/modules/coa-management/command/createChartOfAccounts.generated.ts +6 -0
- package/src/modules/coa-management/command/createChartOfAccounts.test.ts +502 -0
- package/src/modules/coa-management/command/createChartOfAccounts.ts +267 -0
- package/src/modules/coa-management/command/deactivateAccount.generated.ts +6 -0
- package/src/modules/coa-management/command/deactivateAccount.test.ts +199 -0
- package/src/modules/coa-management/command/deactivateAccount.ts +142 -0
- package/src/modules/coa-management/command/deactivateChartOfAccounts.generated.ts +6 -0
- package/src/modules/coa-management/command/deactivateChartOfAccounts.test.ts +91 -0
- package/src/modules/coa-management/command/deactivateChartOfAccounts.ts +88 -0
- package/src/modules/coa-management/command/deleteAccount.generated.ts +6 -0
- package/src/modules/coa-management/command/deleteAccount.test.ts +122 -0
- package/src/modules/coa-management/command/deleteAccount.ts +103 -0
- package/src/modules/coa-management/command/deleteAccountGroup.generated.ts +6 -0
- package/src/modules/coa-management/command/deleteAccountGroup.test.ts +120 -0
- package/src/modules/coa-management/command/deleteAccountGroup.ts +113 -0
- package/src/modules/coa-management/command/deleteChartOfAccounts.generated.ts +6 -0
- package/src/modules/coa-management/command/deleteChartOfAccounts.test.ts +154 -0
- package/src/modules/coa-management/command/deleteChartOfAccounts.ts +133 -0
- package/src/modules/coa-management/command/moveAccountGroup.generated.ts +6 -0
- package/src/modules/coa-management/command/moveAccountGroup.test.ts +199 -0
- package/src/modules/coa-management/command/moveAccountGroup.ts +145 -0
- package/src/modules/coa-management/command/reactivateAccount.generated.ts +6 -0
- package/src/modules/coa-management/command/reactivateAccount.test.ts +126 -0
- package/src/modules/coa-management/command/reactivateAccount.ts +123 -0
- package/src/modules/coa-management/command/updateAccount.generated.ts +6 -0
- package/src/modules/coa-management/command/updateAccount.test.ts +669 -0
- package/src/modules/coa-management/command/updateAccount.ts +370 -0
- package/src/modules/coa-management/command/updateAccountGroup.generated.ts +6 -0
- package/src/modules/coa-management/command/updateAccountGroup.test.ts +253 -0
- package/src/modules/coa-management/command/updateAccountGroup.ts +191 -0
- package/src/modules/coa-management/command/updateChartOfAccounts.generated.ts +6 -0
- package/src/modules/coa-management/command/updateChartOfAccounts.test.ts +153 -0
- package/src/modules/coa-management/command/updateChartOfAccounts.ts +133 -0
- package/src/modules/coa-management/db/.gitkeep +0 -0
- package/src/modules/coa-management/db/account.ts +119 -0
- package/src/modules/coa-management/db/accountGroup.ts +57 -0
- package/src/modules/coa-management/db/chartOfAccounts.ts +55 -0
- package/src/modules/coa-management/docs/commands/ActivateAccount.md +49 -0
- package/src/modules/coa-management/docs/commands/ActivateChartOfAccounts.md +47 -0
- package/src/modules/coa-management/docs/commands/CreateAccount.md +94 -0
- package/src/modules/coa-management/docs/commands/CreateAccountGroup.md +70 -0
- package/src/modules/coa-management/docs/commands/CreateChartOfAccounts.md +72 -0
- package/src/modules/coa-management/docs/commands/DeactivateAccount.md +65 -0
- package/src/modules/coa-management/docs/commands/DeactivateChartOfAccounts.md +44 -0
- package/src/modules/coa-management/docs/commands/DeleteAccount.md +52 -0
- package/src/modules/coa-management/docs/commands/DeleteAccountGroup.md +50 -0
- package/src/modules/coa-management/docs/commands/DeleteChartOfAccounts.md +48 -0
- package/src/modules/coa-management/docs/commands/MoveAccountGroup.md +57 -0
- package/src/modules/coa-management/docs/commands/ReactivateAccount.md +50 -0
- package/src/modules/coa-management/docs/commands/UpdateAccount.md +102 -0
- package/src/modules/coa-management/docs/commands/UpdateAccountGroup.md +62 -0
- package/src/modules/coa-management/docs/commands/UpdateChartOfAccounts.md +49 -0
- package/src/modules/coa-management/docs/features/account-group-hierarchy.md +81 -0
- package/src/modules/coa-management/docs/features/account-lifecycle.md +80 -0
- package/src/modules/coa-management/docs/features/account-management.md +114 -0
- package/src/modules/coa-management/docs/features/chart-of-accounts-setup.md +86 -0
- package/src/modules/coa-management/docs/models/Account.md +84 -0
- package/src/modules/coa-management/docs/models/AccountGroup.md +55 -0
- package/src/modules/coa-management/docs/models/ChartOfAccounts.md +65 -0
- package/src/modules/coa-management/docs/queries/DetectCircularReference.md +52 -0
- package/src/modules/coa-management/docs/queries/GetAccount.md +42 -0
- package/src/modules/coa-management/docs/queries/GetAccountGroup.md +42 -0
- package/src/modules/coa-management/docs/queries/GetChartOfAccounts.md +48 -0
- package/src/modules/coa-management/docs/queries/ListAccountGroups.md +42 -0
- package/src/modules/coa-management/docs/queries/ListAccounts.md +54 -0
- package/src/modules/coa-management/docs/queries/ListUnassignedAccounts.md +40 -0
- package/src/modules/coa-management/executor/.gitkeep +0 -0
- package/src/modules/coa-management/generated/.gitkeep +0 -0
- package/src/modules/coa-management/generated/enums.ts +45 -0
- package/src/modules/coa-management/generated/kysely-tailordb.ts +81 -0
- package/src/modules/coa-management/index.ts +2 -0
- package/src/modules/coa-management/lib/_db_deps.ts +17 -0
- package/src/modules/coa-management/lib/errors.generated.ts +162 -0
- package/src/modules/coa-management/lib/errors.ts +0 -0
- package/src/modules/coa-management/lib/permissions.generated.ts +20 -0
- package/src/modules/coa-management/lib/types.ts +22 -0
- package/src/modules/coa-management/module.ts +136 -0
- package/src/modules/coa-management/permissions.ts +3 -0
- package/src/modules/coa-management/query/.gitkeep +0 -0
- package/src/modules/coa-management/query/detectCircularReference.generated.ts +5 -0
- package/src/modules/coa-management/query/detectCircularReference.test.ts +88 -0
- package/src/modules/coa-management/query/detectCircularReference.ts +46 -0
- package/src/modules/coa-management/query/getAccount.generated.ts +5 -0
- package/src/modules/coa-management/query/getAccount.test.ts +55 -0
- package/src/modules/coa-management/query/getAccount.ts +25 -0
- package/src/modules/coa-management/query/getAccountGroup.generated.ts +5 -0
- package/src/modules/coa-management/query/getAccountGroup.test.ts +55 -0
- package/src/modules/coa-management/query/getAccountGroup.ts +25 -0
- package/src/modules/coa-management/query/getChartOfAccounts.generated.ts +5 -0
- package/src/modules/coa-management/query/getChartOfAccounts.test.ts +79 -0
- package/src/modules/coa-management/query/getChartOfAccounts.ts +28 -0
- package/src/modules/coa-management/query/listAccountGroups.generated.ts +5 -0
- package/src/modules/coa-management/query/listAccountGroups.test.ts +72 -0
- package/src/modules/coa-management/query/listAccountGroups.ts +49 -0
- package/src/modules/coa-management/query/listAccounts.generated.ts +5 -0
- package/src/modules/coa-management/query/listAccounts.test.ts +136 -0
- package/src/modules/coa-management/query/listAccounts.ts +82 -0
- package/src/modules/coa-management/query/listUnassignedAccounts.generated.ts +5 -0
- package/src/modules/coa-management/query/listUnassignedAccounts.test.ts +96 -0
- package/src/modules/coa-management/query/listUnassignedAccounts.ts +39 -0
- package/src/modules/coa-management/tailor.config.ts +13 -0
- package/src/modules/coa-management/tailor.d.ts +13 -0
- package/src/modules/coa-management/testing/fixtures.ts +201 -0
- package/src/modules/item-management/README.md +1 -1
- package/src/modules/organization/README.md +57 -0
- package/src/modules/organization/command/.gitkeep +0 -0
- package/src/modules/organization/command/activateCompany.generated.ts +6 -0
- package/src/modules/organization/command/activateCompany.test.ts +184 -0
- package/src/modules/organization/command/activateCompany.ts +92 -0
- package/src/modules/organization/command/createCompany.generated.ts +6 -0
- package/src/modules/organization/command/createCompany.test.ts +156 -0
- package/src/modules/organization/command/createCompany.ts +80 -0
- package/src/modules/organization/command/createDepartment.generated.ts +6 -0
- package/src/modules/organization/command/createDepartment.test.ts +239 -0
- package/src/modules/organization/command/createDepartment.ts +98 -0
- package/src/modules/organization/command/createSite.generated.ts +6 -0
- package/src/modules/organization/command/createSite.test.ts +262 -0
- package/src/modules/organization/command/createSite.ts +155 -0
- package/src/modules/organization/command/deactivateCompany.generated.ts +6 -0
- package/src/modules/organization/command/deactivateCompany.test.ts +58 -0
- package/src/modules/organization/command/deactivateCompany.ts +47 -0
- package/src/modules/organization/command/deactivateDepartment.generated.ts +6 -0
- package/src/modules/organization/command/deactivateDepartment.test.ts +115 -0
- package/src/modules/organization/command/deactivateDepartment.ts +63 -0
- package/src/modules/organization/command/deactivateSite.generated.ts +6 -0
- package/src/modules/organization/command/deactivateSite.test.ts +53 -0
- package/src/modules/organization/command/deactivateSite.ts +47 -0
- package/src/modules/organization/command/deleteCompany.generated.ts +6 -0
- package/src/modules/organization/command/deleteCompany.test.ts +99 -0
- package/src/modules/organization/command/deleteCompany.ts +66 -0
- package/src/modules/organization/command/reactivateCompany.generated.ts +6 -0
- package/src/modules/organization/command/reactivateCompany.test.ts +58 -0
- package/src/modules/organization/command/reactivateCompany.ts +47 -0
- package/src/modules/organization/command/reactivateDepartment.generated.ts +6 -0
- package/src/modules/organization/command/reactivateDepartment.test.ts +59 -0
- package/src/modules/organization/command/reactivateDepartment.ts +47 -0
- package/src/modules/organization/command/reactivateSite.generated.ts +6 -0
- package/src/modules/organization/command/reactivateSite.test.ts +53 -0
- package/src/modules/organization/command/reactivateSite.ts +47 -0
- package/src/modules/organization/command/updateCompany.generated.ts +6 -0
- package/src/modules/organization/command/updateCompany.test.ts +239 -0
- package/src/modules/organization/command/updateCompany.ts +127 -0
- package/src/modules/organization/command/updateDepartment.generated.ts +6 -0
- package/src/modules/organization/command/updateDepartment.test.ts +232 -0
- package/src/modules/organization/command/updateDepartment.ts +120 -0
- package/src/modules/organization/command/updateSite.generated.ts +6 -0
- package/src/modules/organization/command/updateSite.test.ts +274 -0
- package/src/modules/organization/command/updateSite.ts +176 -0
- package/src/modules/organization/db/.gitkeep +0 -0
- package/src/modules/organization/db/company.ts +44 -0
- package/src/modules/organization/db/department.ts +46 -0
- package/src/modules/organization/db/site.ts +44 -0
- package/src/modules/organization/docs/commands/ActivateCompany.md +62 -0
- package/src/modules/organization/docs/commands/CreateCompany.md +49 -0
- package/src/modules/organization/docs/commands/CreateDepartment.md +62 -0
- package/src/modules/organization/docs/commands/CreateSite.md +74 -0
- package/src/modules/organization/docs/commands/DeactivateCompany.md +40 -0
- package/src/modules/organization/docs/commands/DeactivateDepartment.md +44 -0
- package/src/modules/organization/docs/commands/DeactivateSite.md +38 -0
- package/src/modules/organization/docs/commands/DeleteCompany.md +50 -0
- package/src/modules/organization/docs/commands/ReactivateCompany.md +39 -0
- package/src/modules/organization/docs/commands/ReactivateDepartment.md +37 -0
- package/src/modules/organization/docs/commands/ReactivateSite.md +37 -0
- package/src/modules/organization/docs/commands/UpdateCompany.md +58 -0
- package/src/modules/organization/docs/commands/UpdateDepartment.md +64 -0
- package/src/modules/organization/docs/commands/UpdateSite.md +80 -0
- package/src/modules/organization/docs/features/company-lifecycle.md +76 -0
- package/src/modules/organization/docs/features/department-management.md +66 -0
- package/src/modules/organization/docs/features/site-management.md +86 -0
- package/src/modules/organization/docs/models/Company.md +60 -0
- package/src/modules/organization/docs/models/Department.md +57 -0
- package/src/modules/organization/docs/models/Site.md +57 -0
- package/src/modules/organization/docs/queries/DetectDepartmentCircularReference.md +50 -0
- package/src/modules/organization/docs/queries/GetCompany.md +40 -0
- package/src/modules/organization/docs/queries/GetDepartment.md +44 -0
- package/src/modules/organization/docs/queries/GetDepartmentChildren.md +40 -0
- package/src/modules/organization/docs/queries/GetSite.md +37 -0
- package/src/modules/organization/docs/queries/ListDepartmentsByCompany.md +54 -0
- package/src/modules/organization/docs/queries/ListSitesByCompany.md +54 -0
- package/src/modules/organization/executor/.gitkeep +0 -0
- package/src/modules/organization/generated/.gitkeep +0 -0
- package/src/modules/organization/generated/kysely-tailordb.ts +77 -0
- package/src/modules/organization/index.ts +2 -0
- package/src/modules/organization/lib/_db_deps.ts +10 -0
- package/src/modules/organization/lib/errors.generated.ts +117 -0
- package/src/modules/organization/lib/errors.ts +1 -0
- package/src/modules/organization/lib/permissions.generated.ts +19 -0
- package/src/modules/organization/lib/types.ts +16 -0
- package/src/modules/organization/module.ts +89 -0
- package/src/modules/organization/permissions.ts +3 -0
- package/src/modules/organization/query/.gitkeep +0 -0
- package/src/modules/organization/query/detectDepartmentCircularReference.generated.ts +5 -0
- package/src/modules/organization/query/detectDepartmentCircularReference.test.ts +102 -0
- package/src/modules/organization/query/detectDepartmentCircularReference.ts +27 -0
- package/src/modules/organization/query/getCompany.generated.ts +5 -0
- package/src/modules/organization/query/getCompany.test.ts +70 -0
- package/src/modules/organization/query/getCompany.ts +16 -0
- package/src/modules/organization/query/getDepartment.generated.ts +5 -0
- package/src/modules/organization/query/getDepartment.test.ts +85 -0
- package/src/modules/organization/query/getDepartment.ts +17 -0
- package/src/modules/organization/query/getDepartmentChildren.generated.ts +5 -0
- package/src/modules/organization/query/getDepartmentChildren.test.ts +75 -0
- package/src/modules/organization/query/getDepartmentChildren.ts +21 -0
- package/src/modules/organization/query/getSite.generated.ts +5 -0
- package/src/modules/organization/query/getSite.test.ts +55 -0
- package/src/modules/organization/query/getSite.ts +16 -0
- package/src/modules/organization/query/listDepartmentsByCompany.generated.ts +5 -0
- package/src/modules/organization/query/listDepartmentsByCompany.test.ts +124 -0
- package/src/modules/organization/query/listDepartmentsByCompany.ts +43 -0
- package/src/modules/organization/query/listSitesByCompany.generated.ts +5 -0
- package/src/modules/organization/query/listSitesByCompany.test.ts +126 -0
- package/src/modules/organization/query/listSitesByCompany.ts +41 -0
- package/src/modules/organization/tailor.config.ts +13 -0
- package/src/modules/organization/tailor.d.ts +13 -0
- package/src/modules/organization/testing/fixtures.ts +155 -0
- package/src/modules/primitives/README.md +1 -1
- package/src/modules/primitives/command/setBaseCurrency.test.ts +8 -64
- package/src/modules/primitives/command/setBaseCurrency.ts +6 -64
- package/src/modules/primitives/docs/commands/ActivateCategory.md +1 -1
- package/src/modules/primitives/docs/commands/ActivateCurrency.md +1 -1
- package/src/modules/primitives/docs/commands/ActivateUnit.md +1 -1
- package/src/modules/primitives/docs/commands/CreateExchangeRate.md +2 -2
- package/src/modules/primitives/docs/commands/CreateUnit.md +1 -1
- package/src/modules/primitives/docs/commands/DeactivateCategory.md +1 -1
- package/src/modules/primitives/docs/commands/DeactivateCurrency.md +1 -1
- package/src/modules/primitives/docs/commands/DeactivateUnit.md +1 -1
- package/src/modules/primitives/docs/commands/SetBaseCurrency.md +13 -23
- package/src/modules/primitives/docs/commands/SetReferenceUnit.md +1 -1
- package/src/modules/primitives/docs/features/currency-definitions.md +13 -14
- package/src/modules/primitives/docs/models/Currency.md +3 -4
- package/src/modules/primitives/docs/queries/ConvertAmount.md +2 -2
- package/src/modules/primitives/docs/queries/ConvertQuantity.md +2 -2
- package/src/modules/primitives/lib/errors.generated.ts +5 -0
- package/src/modules/product-management/README.md +1 -1
- package/src/modules/user-management/docs/commands/CreatePermission.md +3 -3
- package/src/modules/user-management/docs/commands/CreateRole.md +1 -1
- package/src/modules/user-management/docs/queries/ListRolePermissionsByRole.md +39 -0
- package/src/modules/user-management/docs/queries/ListUserRolesByUser.md +39 -0
- package/src/modules/user-management/generated/enums.ts +0 -15
- package/src/modules/user-management/generated/kysely-tailordb.ts +0 -11
- package/src/shared/createContext.ts +2 -1
- package/src/shared/defineQuery.ts +36 -1
- package/src/shared/requirePermission.ts +3 -3
- package/src/shared/types.ts +3 -0
- package/templates/scaffold/app/backend/package.json +8 -7
- package/templates/scaffold/app/frontend/eslint.config.js +12 -0
- package/templates/scaffold/app/frontend/package.json +19 -16
- package/templates/scaffold/app/frontend/src/hooks/use-toast.ts +30 -0
- package/templates/scaffold/app/frontend/src/pages/user-management/user/create/components/create-user-form.tsx +3 -2
- package/templates/scaffold/app/frontend/vite.config.ts +5 -5
- package/templates/workflows/erp-kit-check.yml +2 -2
- package/src/commands/module/list.test.ts +0 -57
- package/src/commands/module/list.ts +0 -64
- package/src/commands/scaffold.ts +0 -176
- /package/src/modules/{accounting → audit/db}/.gitkeep +0 -0
- /package/src/modules/audit/{.gitkeep → executor/.gitkeep} +0 -0
- /package/src/modules/{coa-management/.gitkeep → audit/lib/errors.ts} +0 -0
- /package/src/modules/{supplier-management → business-partner}/.gitkeep +0 -0
|
@@ -2,384 +2,26 @@ import path from "node:path";
|
|
|
2
2
|
import os from "node:os";
|
|
3
3
|
import fs from "node:fs";
|
|
4
4
|
import { describe, it, expect, beforeEach, afterEach } from "vitest";
|
|
5
|
-
import { runSyncCheck
|
|
6
|
-
import { parseTestCasesFromDoc, parseItDescriptionsFromTest } from "./parse-doc-test-cases";
|
|
5
|
+
import { runSyncCheck } from "./sync-check";
|
|
7
6
|
|
|
8
|
-
describe("runSyncCheck", () => {
|
|
7
|
+
describe("runSyncCheck (integration)", () => {
|
|
9
8
|
let tmpDir: string;
|
|
10
9
|
|
|
11
10
|
beforeEach(() => {
|
|
12
|
-
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "sync-check-"));
|
|
11
|
+
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "sync-check-int-"));
|
|
13
12
|
});
|
|
14
13
|
|
|
15
14
|
afterEach(() => {
|
|
16
15
|
fs.rmSync(tmpDir, { recursive: true, force: true });
|
|
17
16
|
});
|
|
18
17
|
|
|
19
|
-
it("
|
|
20
|
-
const result = await runSyncCheck({ modulesRoot: "modules", appRoot: "examples" }, tmpDir);
|
|
21
|
-
expect(result.exitCode).toBe(0);
|
|
22
|
-
expect(result.errors).toHaveLength(0);
|
|
23
|
-
});
|
|
24
|
-
|
|
25
|
-
it("reports missing doc when source exists without doc", async () => {
|
|
26
|
-
const srcDir = path.join(tmpDir, "modules", "foo", "command");
|
|
27
|
-
fs.mkdirSync(srcDir, { recursive: true });
|
|
28
|
-
fs.writeFileSync(path.join(srcDir, "createOrder.ts"), "export {}");
|
|
29
|
-
|
|
30
|
-
const result = await runSyncCheck({ modulesRoot: "modules", appRoot: "examples" }, tmpDir);
|
|
31
|
-
expect(result.exitCode).toBe(1);
|
|
32
|
-
expect(result.errors).toContainEqual(
|
|
33
|
-
expect.objectContaining({ type: "missing-doc", expectedBasename: "createorder" }),
|
|
34
|
-
);
|
|
35
|
-
});
|
|
36
|
-
|
|
37
|
-
it("reports orphaned doc when doc exists without source", async () => {
|
|
38
|
-
const docDir = path.join(tmpDir, "modules", "foo", "docs", "commands");
|
|
39
|
-
fs.mkdirSync(docDir, { recursive: true });
|
|
40
|
-
fs.writeFileSync(path.join(docDir, "createOrder.md"), "# CreateOrder");
|
|
41
|
-
|
|
42
|
-
const result = await runSyncCheck({ modulesRoot: "modules", appRoot: "examples" }, tmpDir);
|
|
43
|
-
expect(result.exitCode).toBe(1);
|
|
44
|
-
expect(result.errors).toContainEqual(
|
|
45
|
-
expect.objectContaining({ type: "orphaned-doc", expectedBasename: "createorder" }),
|
|
46
|
-
);
|
|
47
|
-
});
|
|
48
|
-
|
|
49
|
-
it("returns 0 when source and doc match", async () => {
|
|
50
|
-
const srcDir = path.join(tmpDir, "modules", "foo", "command");
|
|
51
|
-
const docDir = path.join(tmpDir, "modules", "foo", "docs", "commands");
|
|
52
|
-
fs.mkdirSync(srcDir, { recursive: true });
|
|
53
|
-
fs.mkdirSync(docDir, { recursive: true });
|
|
54
|
-
fs.writeFileSync(path.join(srcDir, "createOrder.ts"), "export {}");
|
|
55
|
-
fs.writeFileSync(path.join(docDir, "createOrder.md"), "# CreateOrder");
|
|
56
|
-
|
|
57
|
-
const result = await runSyncCheck({ modulesRoot: "modules", appRoot: "examples" }, tmpDir);
|
|
58
|
-
expect(result.exitCode).toBe(0);
|
|
59
|
-
expect(result.errors).toHaveLength(0);
|
|
60
|
-
});
|
|
61
|
-
|
|
62
|
-
it("excludes test files from source matching", async () => {
|
|
63
|
-
const srcDir = path.join(tmpDir, "modules", "foo", "command");
|
|
64
|
-
fs.mkdirSync(srcDir, { recursive: true });
|
|
65
|
-
fs.writeFileSync(path.join(srcDir, "createOrder.test.ts"), "test()");
|
|
66
|
-
|
|
67
|
-
const result = await runSyncCheck({ modulesRoot: "modules", appRoot: "examples" }, tmpDir);
|
|
68
|
-
expect(result.exitCode).toBe(0);
|
|
69
|
-
expect(result.errors).toHaveLength(0);
|
|
70
|
-
});
|
|
71
|
-
|
|
72
|
-
it("uses custom modulesRoot to rewrite glob patterns", async () => {
|
|
73
|
-
const srcDir = path.join(tmpDir, "custom-mods", "foo", "command");
|
|
74
|
-
const docDir = path.join(tmpDir, "custom-mods", "foo", "docs", "commands");
|
|
75
|
-
fs.mkdirSync(srcDir, { recursive: true });
|
|
76
|
-
fs.mkdirSync(docDir, { recursive: true });
|
|
77
|
-
fs.writeFileSync(path.join(srcDir, "createOrder.ts"), "export {}");
|
|
78
|
-
fs.writeFileSync(path.join(docDir, "createOrder.md"), "# CreateOrder");
|
|
79
|
-
|
|
80
|
-
const result = await runSyncCheck({ modulesRoot: "custom-mods" }, tmpDir);
|
|
81
|
-
expect(result.exitCode).toBe(0);
|
|
82
|
-
expect(result.summary.totalSources).toBe(1);
|
|
83
|
-
});
|
|
84
|
-
|
|
85
|
-
it("uses custom appRoot to rewrite glob patterns", async () => {
|
|
86
|
-
const srcDir = path.join(
|
|
87
|
-
tmpDir,
|
|
88
|
-
"apps",
|
|
89
|
-
"app1",
|
|
90
|
-
"backend",
|
|
91
|
-
"src",
|
|
92
|
-
"modules",
|
|
93
|
-
"m1",
|
|
94
|
-
"resolvers",
|
|
95
|
-
);
|
|
96
|
-
const docDir = path.join(tmpDir, "apps", "app1", "docs", "resolver");
|
|
97
|
-
fs.mkdirSync(srcDir, { recursive: true });
|
|
98
|
-
fs.mkdirSync(docDir, { recursive: true });
|
|
99
|
-
fs.writeFileSync(path.join(srcDir, "myResolver.ts"), "export {}");
|
|
100
|
-
fs.writeFileSync(path.join(docDir, "myResolver.md"), "# MyResolver");
|
|
101
|
-
|
|
102
|
-
const result = await runSyncCheck({ appRoot: "apps" }, tmpDir);
|
|
103
|
-
expect(result.exitCode).toBe(0);
|
|
104
|
-
expect(result.summary.totalSources).toBe(1);
|
|
105
|
-
});
|
|
106
|
-
|
|
107
|
-
it("reports missing doc for query source without doc", async () => {
|
|
108
|
-
const srcDir = path.join(tmpDir, "modules", "foo", "query");
|
|
109
|
-
fs.mkdirSync(srcDir, { recursive: true });
|
|
110
|
-
fs.writeFileSync(path.join(srcDir, "convertAmount.ts"), "export {}");
|
|
111
|
-
|
|
112
|
-
const result = await runSyncCheck({ modulesRoot: "modules", appRoot: "examples" }, tmpDir);
|
|
113
|
-
expect(result.exitCode).toBe(1);
|
|
114
|
-
expect(result.errors).toContainEqual(
|
|
115
|
-
expect.objectContaining({
|
|
116
|
-
type: "missing-doc",
|
|
117
|
-
category: "query",
|
|
118
|
-
expectedBasename: "convertamount",
|
|
119
|
-
}),
|
|
120
|
-
);
|
|
121
|
-
});
|
|
122
|
-
|
|
123
|
-
it("returns 0 when query source and doc match", async () => {
|
|
124
|
-
const srcDir = path.join(tmpDir, "modules", "foo", "query");
|
|
125
|
-
const docDir = path.join(tmpDir, "modules", "foo", "docs", "queries");
|
|
126
|
-
fs.mkdirSync(srcDir, { recursive: true });
|
|
127
|
-
fs.mkdirSync(docDir, { recursive: true });
|
|
128
|
-
fs.writeFileSync(path.join(srcDir, "convertAmount.ts"), "export {}");
|
|
129
|
-
fs.writeFileSync(path.join(docDir, "convertAmount.md"), "# ConvertAmount");
|
|
130
|
-
|
|
131
|
-
const result = await runSyncCheck({ modulesRoot: "modules", appRoot: "examples" }, tmpDir);
|
|
132
|
-
expect(result.exitCode).toBe(0);
|
|
133
|
-
});
|
|
134
|
-
|
|
135
|
-
it("matches generated query files to docs by stripping .generated suffix", async () => {
|
|
136
|
-
const srcDir = path.join(tmpDir, "modules", "foo", "query");
|
|
137
|
-
const docDir = path.join(tmpDir, "modules", "foo", "docs", "queries");
|
|
138
|
-
fs.mkdirSync(srcDir, { recursive: true });
|
|
139
|
-
fs.mkdirSync(docDir, { recursive: true });
|
|
140
|
-
fs.writeFileSync(path.join(srcDir, "getCurrency.generated.ts"), "export {}");
|
|
141
|
-
fs.writeFileSync(path.join(docDir, "GetCurrency.md"), "# GetCurrency");
|
|
142
|
-
|
|
143
|
-
const result = await runSyncCheck({ modulesRoot: "modules", appRoot: "examples" }, tmpDir);
|
|
144
|
-
expect(result.exitCode).toBe(0);
|
|
145
|
-
expect(result.errors).toHaveLength(0);
|
|
146
|
-
});
|
|
147
|
-
|
|
148
|
-
it("excludes generated command files from source matching", async () => {
|
|
18
|
+
it("combines source sync and test case sync errors", async () => {
|
|
149
19
|
const srcDir = path.join(tmpDir, "modules", "foo", "command");
|
|
150
|
-
const docDir = path.join(tmpDir, "modules", "foo", "docs", "commands");
|
|
151
20
|
fs.mkdirSync(srcDir, { recursive: true });
|
|
152
|
-
fs.mkdirSync(docDir, { recursive: true });
|
|
153
21
|
fs.writeFileSync(path.join(srcDir, "createOrder.ts"), "export {}");
|
|
154
|
-
fs.writeFileSync(path.join(srcDir, "createOrder.generated.ts"), "export {}");
|
|
155
|
-
fs.writeFileSync(path.join(docDir, "createOrder.md"), "# CreateOrder");
|
|
156
|
-
|
|
157
|
-
const result = await runSyncCheck({ modulesRoot: "modules", appRoot: "examples" }, tmpDir);
|
|
158
|
-
expect(result.exitCode).toBe(0);
|
|
159
|
-
});
|
|
160
|
-
|
|
161
|
-
it("checks only module patterns when appRoot is not set", async () => {
|
|
162
|
-
const resolverSrcDir = path.join(
|
|
163
|
-
tmpDir,
|
|
164
|
-
"examples",
|
|
165
|
-
"app1",
|
|
166
|
-
"backend",
|
|
167
|
-
"src",
|
|
168
|
-
"modules",
|
|
169
|
-
"m1",
|
|
170
|
-
"resolvers",
|
|
171
|
-
);
|
|
172
|
-
fs.mkdirSync(resolverSrcDir, { recursive: true });
|
|
173
|
-
fs.writeFileSync(path.join(resolverSrcDir, "myResolver.ts"), "export {}");
|
|
174
|
-
|
|
175
|
-
const result = await runSyncCheck({ modulesRoot: "modules", appRoot: undefined }, tmpDir);
|
|
176
|
-
// Without appRoot, app-compose patterns are not checked
|
|
177
|
-
expect(result.exitCode).toBe(0);
|
|
178
|
-
expect(result.errors).toHaveLength(0);
|
|
179
|
-
});
|
|
180
|
-
});
|
|
181
|
-
|
|
182
|
-
describe("parseTestCasesFromDoc", () => {
|
|
183
|
-
it("extracts test cases from ## Test Cases section", () => {
|
|
184
|
-
const content = `# CreateProduct
|
|
185
|
-
|
|
186
|
-
## Error Scenarios
|
|
187
|
-
|
|
188
|
-
- **DUPLICATE_CODE**: A product with the same code already exists
|
|
189
|
-
|
|
190
|
-
## Test Cases
|
|
191
|
-
|
|
192
|
-
- returns error when code is empty
|
|
193
|
-
- creates product in DRAFT status
|
|
194
|
-
- passes custom fields through
|
|
195
|
-
`;
|
|
196
|
-
const cases = parseTestCasesFromDoc(content);
|
|
197
|
-
expect(cases).toEqual([
|
|
198
|
-
"returns error when code is empty",
|
|
199
|
-
"creates product in DRAFT status",
|
|
200
|
-
"passes custom fields through",
|
|
201
|
-
]);
|
|
202
|
-
});
|
|
203
|
-
|
|
204
|
-
it("returns empty array when no Test Cases section", () => {
|
|
205
|
-
const content = `# CreateProduct\n\n## Overview\n\nSome text.`;
|
|
206
|
-
expect(parseTestCasesFromDoc(content)).toEqual([]);
|
|
207
|
-
});
|
|
208
|
-
|
|
209
|
-
it("stops at next ## heading", () => {
|
|
210
|
-
const content = `## Test Cases
|
|
211
|
-
|
|
212
|
-
- case one
|
|
213
|
-
- case two
|
|
214
|
-
|
|
215
|
-
## Other Section
|
|
216
|
-
|
|
217
|
-
- not a test case
|
|
218
|
-
`;
|
|
219
|
-
expect(parseTestCasesFromDoc(content)).toEqual(["case one", "case two"]);
|
|
220
|
-
});
|
|
221
|
-
});
|
|
222
|
-
|
|
223
|
-
describe("parseItDescriptionsFromTest", () => {
|
|
224
|
-
it("extracts it() descriptions from test file", () => {
|
|
225
|
-
const content = `
|
|
226
|
-
describe("createProduct", () => {
|
|
227
|
-
it("returns error when code is empty", async () => {});
|
|
228
|
-
it("creates product in DRAFT status", async () => {});
|
|
229
|
-
it('passes custom fields through', async () => {});
|
|
230
|
-
});`;
|
|
231
|
-
const descriptions = parseItDescriptionsFromTest(content);
|
|
232
|
-
expect(descriptions).toEqual([
|
|
233
|
-
"returns error when code is empty",
|
|
234
|
-
"creates product in DRAFT status",
|
|
235
|
-
"passes custom fields through",
|
|
236
|
-
]);
|
|
237
|
-
});
|
|
238
|
-
|
|
239
|
-
it("returns empty array when no it() blocks", () => {
|
|
240
|
-
expect(parseItDescriptionsFromTest("const x = 1;")).toEqual([]);
|
|
241
|
-
});
|
|
242
|
-
});
|
|
243
|
-
|
|
244
|
-
describe("runSyncCheck test-case sync", () => {
|
|
245
|
-
let tmpDir: string;
|
|
246
|
-
|
|
247
|
-
beforeEach(() => {
|
|
248
|
-
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "sync-check-tc-"));
|
|
249
|
-
});
|
|
250
|
-
|
|
251
|
-
afterEach(() => {
|
|
252
|
-
fs.rmSync(tmpDir, { recursive: true, force: true });
|
|
253
|
-
});
|
|
254
|
-
|
|
255
|
-
it("reports missing-test-case when doc has case not in test", async () => {
|
|
256
|
-
const docDir = path.join(tmpDir, "modules", "foo", "docs", "commands");
|
|
257
|
-
const testDir = path.join(tmpDir, "modules", "foo", "command");
|
|
258
|
-
fs.mkdirSync(docDir, { recursive: true });
|
|
259
|
-
fs.mkdirSync(testDir, { recursive: true });
|
|
260
|
-
|
|
261
|
-
fs.writeFileSync(
|
|
262
|
-
path.join(docDir, "CreateOrder.md"),
|
|
263
|
-
"# CreateOrder\n\n## Test Cases\n\n- creates order\n- validates input\n",
|
|
264
|
-
);
|
|
265
|
-
fs.writeFileSync(path.join(testDir, "createOrder.ts"), "export {}");
|
|
266
|
-
fs.writeFileSync(
|
|
267
|
-
path.join(testDir, "createOrder.test.ts"),
|
|
268
|
-
'describe("createOrder", () => { it("creates order", async () => {}); });',
|
|
269
|
-
);
|
|
270
22
|
|
|
271
23
|
const result = await runSyncCheck({ modulesRoot: "modules" }, tmpDir);
|
|
272
|
-
expect(result.
|
|
273
|
-
|
|
274
|
-
type: "missing-test-case",
|
|
275
|
-
category: "command-test-case",
|
|
276
|
-
expectedBasename: "validates input",
|
|
277
|
-
}),
|
|
278
|
-
);
|
|
279
|
-
});
|
|
280
|
-
|
|
281
|
-
it("reports extra-test-case when test has case not in doc", async () => {
|
|
282
|
-
const docDir = path.join(tmpDir, "modules", "foo", "docs", "commands");
|
|
283
|
-
const testDir = path.join(tmpDir, "modules", "foo", "command");
|
|
284
|
-
fs.mkdirSync(docDir, { recursive: true });
|
|
285
|
-
fs.mkdirSync(testDir, { recursive: true });
|
|
286
|
-
|
|
287
|
-
fs.writeFileSync(
|
|
288
|
-
path.join(docDir, "CreateOrder.md"),
|
|
289
|
-
"# CreateOrder\n\n## Test Cases\n\n- creates order\n",
|
|
290
|
-
);
|
|
291
|
-
fs.writeFileSync(path.join(testDir, "createOrder.ts"), "export {}");
|
|
292
|
-
fs.writeFileSync(
|
|
293
|
-
path.join(testDir, "createOrder.test.ts"),
|
|
294
|
-
'describe("createOrder", () => { it("creates order", async () => {}); it("extra case", async () => {}); });',
|
|
295
|
-
);
|
|
296
|
-
|
|
297
|
-
const result = await runSyncCheck({ modulesRoot: "modules" }, tmpDir);
|
|
298
|
-
expect(result.errors).toContainEqual(
|
|
299
|
-
expect.objectContaining({
|
|
300
|
-
type: "extra-test-case",
|
|
301
|
-
category: "command-test-case",
|
|
302
|
-
expectedBasename: "extra case",
|
|
303
|
-
}),
|
|
304
|
-
);
|
|
305
|
-
});
|
|
306
|
-
|
|
307
|
-
it("returns 0 when doc test cases match test it() descriptions", async () => {
|
|
308
|
-
const docDir = path.join(tmpDir, "modules", "foo", "docs", "commands");
|
|
309
|
-
const testDir = path.join(tmpDir, "modules", "foo", "command");
|
|
310
|
-
fs.mkdirSync(docDir, { recursive: true });
|
|
311
|
-
fs.mkdirSync(testDir, { recursive: true });
|
|
312
|
-
|
|
313
|
-
fs.writeFileSync(
|
|
314
|
-
path.join(docDir, "CreateOrder.md"),
|
|
315
|
-
"# CreateOrder\n\n## Test Cases\n\n- creates order\n- validates input\n",
|
|
316
|
-
);
|
|
317
|
-
fs.writeFileSync(path.join(testDir, "createOrder.ts"), "export {}");
|
|
318
|
-
fs.writeFileSync(
|
|
319
|
-
path.join(testDir, "createOrder.test.ts"),
|
|
320
|
-
'describe("createOrder", () => { it("creates order", async () => {}); it("validates input", async () => {}); });',
|
|
321
|
-
);
|
|
322
|
-
|
|
323
|
-
const result = await runSyncCheck({ modulesRoot: "modules" }, tmpDir);
|
|
324
|
-
const tcErrors = result.errors.filter(
|
|
325
|
-
(e) => e.type === "missing-test-case" || e.type === "extra-test-case",
|
|
326
|
-
);
|
|
327
|
-
expect(tcErrors).toHaveLength(0);
|
|
328
|
-
});
|
|
329
|
-
|
|
330
|
-
it("skips test-case check when doc has no Test Cases section", async () => {
|
|
331
|
-
const docDir = path.join(tmpDir, "modules", "foo", "docs", "commands");
|
|
332
|
-
const testDir = path.join(tmpDir, "modules", "foo", "command");
|
|
333
|
-
fs.mkdirSync(docDir, { recursive: true });
|
|
334
|
-
fs.mkdirSync(testDir, { recursive: true });
|
|
335
|
-
|
|
336
|
-
fs.writeFileSync(
|
|
337
|
-
path.join(docDir, "CreateOrder.md"),
|
|
338
|
-
"# CreateOrder\n\n## Overview\n\nSome text.\n",
|
|
339
|
-
);
|
|
340
|
-
fs.writeFileSync(path.join(testDir, "createOrder.ts"), "export {}");
|
|
341
|
-
fs.writeFileSync(
|
|
342
|
-
path.join(testDir, "createOrder.test.ts"),
|
|
343
|
-
'describe("createOrder", () => { it("creates order", async () => {}); });',
|
|
344
|
-
);
|
|
345
|
-
|
|
346
|
-
const result = await runSyncCheck({ modulesRoot: "modules" }, tmpDir);
|
|
347
|
-
const tcErrors = result.errors.filter(
|
|
348
|
-
(e) => e.type === "missing-test-case" || e.type === "extra-test-case",
|
|
349
|
-
);
|
|
350
|
-
expect(tcErrors).toHaveLength(0);
|
|
351
|
-
});
|
|
352
|
-
});
|
|
353
|
-
|
|
354
|
-
describe("checkStaleness", () => {
|
|
355
|
-
it("reports stale when doc mtime > generated mtime", () => {
|
|
356
|
-
const errors = checkStaleness(
|
|
357
|
-
[{ docPath: "docs/commands/CreateItem.md", docMtime: 2000 }],
|
|
358
|
-
[{ genPath: "lib/errors.generated.ts", genMtime: 1000 }],
|
|
359
|
-
);
|
|
360
|
-
|
|
361
|
-
expect(errors).toHaveLength(1);
|
|
362
|
-
expect(errors[0].type).toBe("stale-generation");
|
|
363
|
-
});
|
|
364
|
-
|
|
365
|
-
it("reports no staleness when generated is newer", () => {
|
|
366
|
-
const errors = checkStaleness(
|
|
367
|
-
[{ docPath: "docs/commands/CreateItem.md", docMtime: 1000 }],
|
|
368
|
-
[{ genPath: "lib/errors.generated.ts", genMtime: 2000 }],
|
|
369
|
-
);
|
|
370
|
-
|
|
371
|
-
expect(errors).toHaveLength(0);
|
|
372
|
-
});
|
|
373
|
-
|
|
374
|
-
it("returns empty when no generated files", () => {
|
|
375
|
-
const errors = checkStaleness([{ docPath: "docs/commands/CreateItem.md", docMtime: 1000 }], []);
|
|
376
|
-
|
|
377
|
-
expect(errors).toHaveLength(0);
|
|
378
|
-
});
|
|
379
|
-
|
|
380
|
-
it("returns empty when no doc files", () => {
|
|
381
|
-
const errors = checkStaleness([], [{ genPath: "lib/errors.generated.ts", genMtime: 1000 }]);
|
|
382
|
-
|
|
383
|
-
expect(errors).toHaveLength(0);
|
|
24
|
+
expect(result.exitCode).toBe(1);
|
|
25
|
+
expect(result.errors.some((e) => e.type === "missing-doc")).toBe(true);
|
|
384
26
|
});
|
|
385
27
|
});
|
|
@@ -1,264 +1,20 @@
|
|
|
1
|
-
import path from "node:path";
|
|
2
|
-
import fs from "node:fs";
|
|
3
|
-
import fg from "fast-glob";
|
|
4
1
|
import chalk from "chalk";
|
|
5
|
-
import {
|
|
2
|
+
import { runSourceSyncCheck, type SyncCheckResult, type CheckError } from "./lib/sync-check-source";
|
|
3
|
+
import { runTestCaseSyncCheck } from "./lib/sync-check-tests";
|
|
6
4
|
|
|
7
|
-
|
|
8
|
-
name: string;
|
|
9
|
-
sourcePattern: string;
|
|
10
|
-
docPattern: string;
|
|
11
|
-
exclusions: RegExp[];
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
export interface CheckError {
|
|
15
|
-
type: "missing-doc" | "orphaned-doc" | "missing-test-case" | "extra-test-case";
|
|
16
|
-
category: string;
|
|
17
|
-
sourcePath?: string;
|
|
18
|
-
docPath?: string;
|
|
19
|
-
expectedBasename: string;
|
|
20
|
-
}
|
|
21
|
-
|
|
22
|
-
export interface SyncCheckResult {
|
|
23
|
-
exitCode: number;
|
|
24
|
-
errors: CheckError[];
|
|
25
|
-
summary: {
|
|
26
|
-
categoriesChecked: number;
|
|
27
|
-
totalSources: number;
|
|
28
|
-
totalDocs: number;
|
|
29
|
-
};
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
function moduleCategories(root: string): CategoryConfig[] {
|
|
33
|
-
return [
|
|
34
|
-
{
|
|
35
|
-
name: "command",
|
|
36
|
-
sourcePattern: `${root}/*/command/*.ts`,
|
|
37
|
-
docPattern: `${root}/*/docs/commands/*.md`,
|
|
38
|
-
exclusions: [/\.test\.ts$/, /\.generated\.ts$/],
|
|
39
|
-
},
|
|
40
|
-
{
|
|
41
|
-
name: "model",
|
|
42
|
-
sourcePattern: `${root}/*/db/*.ts`,
|
|
43
|
-
docPattern: `${root}/*/docs/models/*.md`,
|
|
44
|
-
exclusions: [/\.test\.ts$/, /^index\.ts$/],
|
|
45
|
-
},
|
|
46
|
-
{
|
|
47
|
-
name: "query",
|
|
48
|
-
sourcePattern: `${root}/*/query/*.ts`,
|
|
49
|
-
docPattern: `${root}/*/docs/queries/*.md`,
|
|
50
|
-
exclusions: [/\.test\.ts$/],
|
|
51
|
-
},
|
|
52
|
-
];
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
function appComposeCategories(root: string): CategoryConfig[] {
|
|
56
|
-
return [
|
|
57
|
-
{
|
|
58
|
-
name: "resolver",
|
|
59
|
-
sourcePattern: `${root}/*/backend/src/modules/**/resolvers/*.ts`,
|
|
60
|
-
docPattern: `${root}/*/docs/resolver/*.md`,
|
|
61
|
-
exclusions: [/\.test\.ts$/, /^index\.ts$/],
|
|
62
|
-
},
|
|
63
|
-
];
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
function shouldExclude(fileName: string, exclusions: RegExp[]): boolean {
|
|
67
|
-
return exclusions.some((pattern) => pattern.test(fileName));
|
|
68
|
-
}
|
|
5
|
+
export type { SyncCheckResult, CheckError } from "./lib/sync-check-source";
|
|
69
6
|
|
|
70
7
|
export async function runSyncCheck(
|
|
71
8
|
config: { modulesRoot?: string; appRoot?: string },
|
|
72
9
|
cwd: string,
|
|
73
10
|
): Promise<SyncCheckResult> {
|
|
74
|
-
const
|
|
75
|
-
let totalSources = 0;
|
|
76
|
-
let totalDocs = 0;
|
|
77
|
-
|
|
78
|
-
const allCategories: CategoryConfig[] = [];
|
|
79
|
-
if (config.modulesRoot) {
|
|
80
|
-
allCategories.push(...moduleCategories(config.modulesRoot));
|
|
81
|
-
}
|
|
82
|
-
if (config.appRoot) {
|
|
83
|
-
allCategories.push(...appComposeCategories(config.appRoot));
|
|
84
|
-
}
|
|
85
|
-
|
|
86
|
-
for (const category of allCategories) {
|
|
87
|
-
const sources = await fg(category.sourcePattern, { cwd });
|
|
88
|
-
const docs = await fg(category.docPattern, { cwd });
|
|
89
|
-
|
|
90
|
-
const sourceBasenames = new Map<string, string>();
|
|
91
|
-
const docBasenames = new Map<string, string>();
|
|
92
|
-
|
|
93
|
-
for (const sourcePath of sources) {
|
|
94
|
-
const fileName = path.basename(sourcePath);
|
|
95
|
-
if (shouldExclude(fileName, category.exclusions)) continue;
|
|
96
|
-
let basename = path.basename(sourcePath, path.extname(sourcePath));
|
|
97
|
-
if (basename.endsWith(".generated")) {
|
|
98
|
-
basename = basename.slice(0, -".generated".length);
|
|
99
|
-
}
|
|
100
|
-
sourceBasenames.set(basename.toLowerCase(), sourcePath);
|
|
101
|
-
}
|
|
102
|
-
|
|
103
|
-
for (const docPath of docs) {
|
|
104
|
-
const basename = path.basename(docPath, path.extname(docPath));
|
|
105
|
-
docBasenames.set(basename.toLowerCase(), docPath);
|
|
106
|
-
}
|
|
107
|
-
|
|
108
|
-
for (const [basename, sourcePath] of sourceBasenames) {
|
|
109
|
-
if (!docBasenames.has(basename)) {
|
|
110
|
-
errors.push({
|
|
111
|
-
type: "missing-doc",
|
|
112
|
-
category: category.name,
|
|
113
|
-
sourcePath,
|
|
114
|
-
expectedBasename: basename,
|
|
115
|
-
});
|
|
116
|
-
}
|
|
117
|
-
}
|
|
118
|
-
|
|
119
|
-
for (const [basename, docPath] of docBasenames) {
|
|
120
|
-
if (!sourceBasenames.has(basename)) {
|
|
121
|
-
errors.push({
|
|
122
|
-
type: "orphaned-doc",
|
|
123
|
-
category: category.name,
|
|
124
|
-
docPath,
|
|
125
|
-
expectedBasename: basename,
|
|
126
|
-
});
|
|
127
|
-
}
|
|
128
|
-
}
|
|
129
|
-
|
|
130
|
-
totalSources += sourceBasenames.size;
|
|
131
|
-
totalDocs += docBasenames.size;
|
|
132
|
-
}
|
|
133
|
-
|
|
11
|
+
const sourceResult = await runSourceSyncCheck(config, cwd);
|
|
134
12
|
if (config.modulesRoot) {
|
|
135
13
|
const testCaseErrors = await runTestCaseSyncCheck(config.modulesRoot, cwd);
|
|
136
|
-
errors.push(...testCaseErrors);
|
|
14
|
+
sourceResult.errors.push(...testCaseErrors);
|
|
15
|
+
sourceResult.exitCode = sourceResult.errors.length > 0 ? 1 : 0;
|
|
137
16
|
}
|
|
138
|
-
|
|
139
|
-
return {
|
|
140
|
-
exitCode: errors.length > 0 ? 1 : 0,
|
|
141
|
-
errors,
|
|
142
|
-
summary: {
|
|
143
|
-
categoriesChecked: allCategories.length,
|
|
144
|
-
totalSources,
|
|
145
|
-
totalDocs,
|
|
146
|
-
},
|
|
147
|
-
};
|
|
148
|
-
}
|
|
149
|
-
|
|
150
|
-
interface TestCaseCategoryConfig {
|
|
151
|
-
name: string;
|
|
152
|
-
docPattern: string;
|
|
153
|
-
testDir: string;
|
|
154
|
-
}
|
|
155
|
-
|
|
156
|
-
function testCaseCategories(root: string): TestCaseCategoryConfig[] {
|
|
157
|
-
return [
|
|
158
|
-
{
|
|
159
|
-
name: "command-test-case",
|
|
160
|
-
docPattern: `${root}/*/docs/commands/*.md`,
|
|
161
|
-
testDir: "command",
|
|
162
|
-
},
|
|
163
|
-
{
|
|
164
|
-
name: "query-test-case",
|
|
165
|
-
docPattern: `${root}/*/docs/queries/*.md`,
|
|
166
|
-
testDir: "query",
|
|
167
|
-
},
|
|
168
|
-
];
|
|
169
|
-
}
|
|
170
|
-
|
|
171
|
-
function toCamelCase(pascalCase: string): string {
|
|
172
|
-
return pascalCase.charAt(0).toLowerCase() + pascalCase.slice(1);
|
|
173
|
-
}
|
|
174
|
-
|
|
175
|
-
async function runTestCaseSyncCheck(root: string, cwd: string): Promise<CheckError[]> {
|
|
176
|
-
const errors: CheckError[] = [];
|
|
177
|
-
const categories = testCaseCategories(root);
|
|
178
|
-
|
|
179
|
-
for (const category of categories) {
|
|
180
|
-
const docPaths = await fg(category.docPattern, { cwd });
|
|
181
|
-
|
|
182
|
-
for (const docPath of docPaths) {
|
|
183
|
-
const docFullPath = path.join(cwd, docPath);
|
|
184
|
-
const docContent = fs.readFileSync(docFullPath, "utf-8");
|
|
185
|
-
const docTestCases = parseTestCasesFromDoc(docContent);
|
|
186
|
-
|
|
187
|
-
if (docTestCases.length === 0) continue;
|
|
188
|
-
|
|
189
|
-
const docBasename = path.basename(docPath, ".md");
|
|
190
|
-
const docsIndex = docPath.indexOf("/docs/");
|
|
191
|
-
if (docsIndex === -1) continue;
|
|
192
|
-
const modulePath = docPath.substring(0, docsIndex);
|
|
193
|
-
const testFileName = `${toCamelCase(docBasename)}.test.ts`;
|
|
194
|
-
const testPath = path.join(modulePath, category.testDir, testFileName);
|
|
195
|
-
const testFullPath = path.join(cwd, testPath);
|
|
196
|
-
|
|
197
|
-
if (!fs.existsSync(testFullPath)) continue;
|
|
198
|
-
|
|
199
|
-
const testContent = fs.readFileSync(testFullPath, "utf-8");
|
|
200
|
-
const itDescriptions = parseItDescriptionsFromTest(testContent);
|
|
201
|
-
|
|
202
|
-
const docSet = new Set(docTestCases);
|
|
203
|
-
const testSet = new Set(itDescriptions);
|
|
204
|
-
|
|
205
|
-
for (const docCase of docSet) {
|
|
206
|
-
if (!testSet.has(docCase)) {
|
|
207
|
-
errors.push({
|
|
208
|
-
type: "missing-test-case",
|
|
209
|
-
category: category.name,
|
|
210
|
-
docPath,
|
|
211
|
-
sourcePath: testPath,
|
|
212
|
-
expectedBasename: docCase,
|
|
213
|
-
});
|
|
214
|
-
}
|
|
215
|
-
}
|
|
216
|
-
|
|
217
|
-
for (const testCase of testSet) {
|
|
218
|
-
if (!docSet.has(testCase)) {
|
|
219
|
-
errors.push({
|
|
220
|
-
type: "extra-test-case",
|
|
221
|
-
category: category.name,
|
|
222
|
-
docPath,
|
|
223
|
-
sourcePath: testPath,
|
|
224
|
-
expectedBasename: testCase,
|
|
225
|
-
});
|
|
226
|
-
}
|
|
227
|
-
}
|
|
228
|
-
}
|
|
229
|
-
}
|
|
230
|
-
|
|
231
|
-
return errors;
|
|
232
|
-
}
|
|
233
|
-
|
|
234
|
-
export interface StalenessError {
|
|
235
|
-
type: "stale-generation";
|
|
236
|
-
docPath: string;
|
|
237
|
-
genPath: string;
|
|
238
|
-
}
|
|
239
|
-
|
|
240
|
-
export function checkStaleness(
|
|
241
|
-
docs: { docPath: string; docMtime: number }[],
|
|
242
|
-
generated: { genPath: string; genMtime: number }[],
|
|
243
|
-
): StalenessError[] {
|
|
244
|
-
const errors: StalenessError[] = [];
|
|
245
|
-
|
|
246
|
-
if (generated.length === 0 || docs.length === 0) return errors;
|
|
247
|
-
|
|
248
|
-
const latestDocMtime = Math.max(...docs.map((d) => d.docMtime));
|
|
249
|
-
const oldestGenMtime = Math.min(...generated.map((g) => g.genMtime));
|
|
250
|
-
|
|
251
|
-
if (latestDocMtime > oldestGenMtime) {
|
|
252
|
-
const newestDoc = docs.find((d) => d.docMtime === latestDocMtime)!;
|
|
253
|
-
const oldestGen = generated.find((g) => g.genMtime === oldestGenMtime)!;
|
|
254
|
-
errors.push({
|
|
255
|
-
type: "stale-generation",
|
|
256
|
-
docPath: newestDoc.docPath,
|
|
257
|
-
genPath: oldestGen.genPath,
|
|
258
|
-
});
|
|
259
|
-
}
|
|
260
|
-
|
|
261
|
-
return errors;
|
|
17
|
+
return sourceResult;
|
|
262
18
|
}
|
|
263
19
|
|
|
264
20
|
export function formatSyncCheckReport(result: SyncCheckResult): string {
|