@shivaedev/quality 0.76.0 → 0.78.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 +80 -0
- package/README.md +66 -64
- package/dist/adapters/biome/pluginContract.d.ts +1 -1
- package/dist/adapters/biome/pluginContract.d.ts.map +1 -1
- package/dist/adapters/biome/pluginContract.js +2 -5
- package/dist/adapters/biome/pluginContract.js.map +1 -1
- package/dist/adapters/biome/run.d.ts.map +1 -1
- package/dist/adapters/biome/run.js +2 -0
- package/dist/adapters/biome/run.js.map +1 -1
- package/dist/adapters/biome/withExceptionConfig.d.ts.map +1 -1
- package/dist/adapters/biome/withExceptionConfig.js +21 -4
- package/dist/adapters/biome/withExceptionConfig.js.map +1 -1
- package/dist/adapters/changeKeyCheck.d.ts +10 -0
- package/dist/adapters/changeKeyCheck.d.ts.map +1 -0
- package/dist/adapters/{changeKeyFindings.js → changeKeyCheck.js} +8 -22
- package/dist/adapters/changeKeyCheck.js.map +1 -0
- package/dist/adapters/commandLine.d.ts +2 -0
- package/dist/adapters/commandLine.d.ts.map +1 -1
- package/dist/adapters/contextCaptureCheck.d.ts +9 -0
- package/dist/adapters/contextCaptureCheck.d.ts.map +1 -0
- package/dist/adapters/contextCaptureCheck.js +91 -0
- package/dist/adapters/contextCaptureCheck.js.map +1 -0
- package/dist/adapters/databaseUrlFindings.d.ts +1 -1
- package/dist/adapters/databaseUrlFindings.d.ts.map +1 -1
- package/dist/adapters/declaration-files/initialize.d.ts +6 -0
- package/dist/adapters/declaration-files/initialize.d.ts.map +1 -0
- package/dist/adapters/declaration-files/initialize.js +4 -0
- package/dist/adapters/declaration-files/initialize.js.map +1 -0
- package/dist/adapters/declaration-files/parse.d.ts +5 -0
- package/dist/adapters/declaration-files/parse.d.ts.map +1 -0
- package/dist/adapters/declaration-files/parse.js +6 -0
- package/dist/adapters/declaration-files/parse.js.map +1 -0
- package/dist/adapters/declaration-files/reader.d.ts +5 -0
- package/dist/adapters/declaration-files/reader.d.ts.map +1 -0
- package/dist/adapters/declaration-files/reader.js +23 -0
- package/dist/adapters/declaration-files/reader.js.map +1 -0
- package/dist/adapters/declaration-files/service.d.ts +9 -0
- package/dist/adapters/declaration-files/service.d.ts.map +1 -0
- package/dist/adapters/declaration-files/service.js +14 -0
- package/dist/adapters/declaration-files/service.js.map +1 -0
- package/dist/adapters/declarationTagParameter.d.ts.map +1 -1
- package/dist/adapters/declarationTagParameter.js +4 -0
- package/dist/adapters/declarationTagParameter.js.map +1 -1
- package/dist/adapters/foreignResources.d.ts.map +1 -1
- package/dist/adapters/foreignResources.js +0 -4
- package/dist/adapters/foreignResources.js.map +1 -1
- package/dist/adapters/import-compiler/graph.d.ts +8 -2
- package/dist/adapters/import-compiler/graph.d.ts.map +1 -1
- package/dist/adapters/import-compiler/graph.js +4 -1
- package/dist/adapters/import-compiler/graph.js.map +1 -1
- package/dist/adapters/import-compiler/service.d.ts +7 -1
- package/dist/adapters/import-compiler/service.d.ts.map +1 -1
- package/dist/adapters/imports/graph.d.ts +6 -3
- package/dist/adapters/imports/graph.d.ts.map +1 -1
- package/dist/adapters/imports/graph.js +31 -18
- package/dist/adapters/imports/graph.js.map +1 -1
- package/dist/adapters/imports/resolve.d.ts.map +1 -1
- package/dist/adapters/imports/resolve.js +29 -5
- package/dist/adapters/imports/resolve.js.map +1 -1
- package/dist/adapters/knip/configuration.d.ts +1 -1
- package/dist/adapters/knip/configuration.d.ts.map +1 -1
- package/dist/adapters/knip/configuration.js +6 -4
- package/dist/adapters/knip/configuration.js.map +1 -1
- package/dist/adapters/knip/entryPointFindings.d.ts +1 -1
- package/dist/adapters/knip/entryPointFindings.d.ts.map +1 -1
- package/dist/adapters/knip/run.d.ts.map +1 -1
- package/dist/adapters/knip/run.js +4 -1
- package/dist/adapters/knip/run.js.map +1 -1
- package/dist/adapters/outsideImportFindings.d.ts +4 -2
- package/dist/adapters/outsideImportFindings.d.ts.map +1 -1
- package/dist/adapters/outsideImportFindings.js +12 -52
- package/dist/adapters/outsideImportFindings.js.map +1 -1
- package/dist/adapters/presenceCheck.d.ts +3 -0
- package/dist/adapters/presenceCheck.d.ts.map +1 -0
- package/dist/adapters/presenceCheck.js +15 -0
- package/dist/adapters/presenceCheck.js.map +1 -0
- package/dist/adapters/queueReadoutFindings.d.ts +1 -1
- package/dist/adapters/queueReadoutFindings.d.ts.map +1 -1
- package/dist/adapters/rule.d.ts +9 -1
- package/dist/adapters/rule.d.ts.map +1 -1
- package/dist/adapters/rule.js +21 -6
- package/dist/adapters/rule.js.map +1 -1
- package/dist/adapters/runMain.d.ts +3 -4
- package/dist/adapters/runMain.d.ts.map +1 -1
- package/dist/adapters/runMain.js +2 -1
- package/dist/adapters/runMain.js.map +1 -1
- package/dist/adapters/serviceModelCheck.d.ts +9 -0
- package/dist/adapters/serviceModelCheck.d.ts.map +1 -0
- package/dist/adapters/{serviceModelFindings.js → serviceModelCheck.js} +9 -23
- package/dist/adapters/serviceModelCheck.js.map +1 -0
- package/dist/adapters/sharedErrorCatalog.d.ts +13 -0
- package/dist/adapters/sharedErrorCatalog.d.ts.map +1 -0
- package/dist/adapters/sharedErrorCatalog.js +28 -0
- package/dist/adapters/sharedErrorCatalog.js.map +1 -0
- package/dist/adapters/sharedErrorModules.d.ts +1 -1
- package/dist/adapters/sharedErrorModules.d.ts.map +1 -1
- package/dist/adapters/sharedErrorModules.js.map +1 -1
- package/dist/adapters/specReaderSources.d.ts +3 -2
- package/dist/adapters/specReaderSources.d.ts.map +1 -1
- package/dist/adapters/specReaderSources.js +6 -3
- package/dist/adapters/specReaderSources.js.map +1 -1
- package/dist/adapters/storyProgram.d.ts +2 -0
- package/dist/adapters/storyProgram.d.ts.map +1 -1
- package/dist/adapters/storyProgram.js +13 -3
- package/dist/adapters/storyProgram.js.map +1 -1
- package/dist/adapters/typeScriptProgram.d.ts +5 -0
- package/dist/adapters/typeScriptProgram.d.ts.map +1 -0
- package/dist/adapters/typeScriptProgram.js +43 -0
- package/dist/adapters/typeScriptProgram.js.map +1 -0
- package/dist/baseline/compare.d.ts +2 -0
- package/dist/baseline/compare.d.ts.map +1 -1
- package/dist/baseline/compare.js +43 -17
- package/dist/baseline/compare.js.map +1 -1
- package/dist/baseline/format.d.ts +1 -0
- package/dist/baseline/format.d.ts.map +1 -1
- package/dist/baseline/format.js +6 -2
- package/dist/baseline/format.js.map +1 -1
- package/dist/baseline/merge.d.ts.map +1 -1
- package/dist/baseline/merge.js +14 -1
- package/dist/baseline/merge.js.map +1 -1
- package/dist/baseline/rewrite.d.ts.map +1 -1
- package/dist/baseline/rewrite.js +3 -1
- package/dist/baseline/rewrite.js.map +1 -1
- package/dist/baseline/update.d.ts +7 -0
- package/dist/baseline/update.d.ts.map +1 -1
- package/dist/baseline/update.js +29 -8
- package/dist/baseline/update.js.map +1 -1
- package/dist/biome/exceptionConfig.d.ts +3 -0
- package/dist/biome/exceptionConfig.d.ts.map +1 -1
- package/dist/biome/exceptionConfig.js +15 -1
- package/dist/biome/exceptionConfig.js.map +1 -1
- package/dist/biome/scannerRules.d.ts +3 -0
- package/dist/biome/scannerRules.d.ts.map +1 -0
- package/dist/biome/scannerRules.js +42 -0
- package/dist/biome/scannerRules.js.map +1 -0
- package/dist/cli/args.d.ts +2 -0
- package/dist/cli/args.d.ts.map +1 -1
- package/dist/cli/args.js +10 -1
- package/dist/cli/args.js.map +1 -1
- package/dist/cli/baseline.d.ts.map +1 -1
- package/dist/cli/baseline.js +5 -1
- package/dist/cli/baseline.js.map +1 -1
- package/dist/cli/lint.d.ts +3 -2
- package/dist/cli/lint.d.ts.map +1 -1
- package/dist/cli/lint.js +13 -5
- package/dist/cli/lint.js.map +1 -1
- package/dist/cli/misplaced.d.ts +6 -0
- package/dist/cli/misplaced.d.ts.map +1 -1
- package/dist/cli/misplaced.js +4 -2
- package/dist/cli/misplaced.js.map +1 -1
- package/dist/cli/program.js +1 -1
- package/dist/cli/program.js.map +1 -1
- package/dist/cli/runSet.d.ts +5 -0
- package/dist/cli/runSet.d.ts.map +1 -0
- package/dist/cli/runSet.js +15 -0
- package/dist/cli/runSet.js.map +1 -0
- package/dist/cli/shrink.d.ts +4 -4
- package/dist/cli/shrink.d.ts.map +1 -1
- package/dist/cli/shrink.js.map +1 -1
- package/dist/cli/usage.d.ts +1 -1
- package/dist/cli/usage.d.ts.map +1 -1
- package/dist/cli/usage.js +7 -2
- package/dist/cli/usage.js.map +1 -1
- package/dist/config/decode.d.ts +1 -0
- package/dist/config/decode.d.ts.map +1 -1
- package/dist/config/decode.js +1 -0
- package/dist/config/decode.js.map +1 -1
- package/dist/config/load.d.ts +2 -0
- package/dist/config/load.d.ts.map +1 -1
- package/dist/config/load.js +1 -0
- package/dist/config/load.js.map +1 -1
- package/dist/config/resolve.d.ts +2 -1
- package/dist/config/resolve.d.ts.map +1 -1
- package/dist/config/resolve.js +9 -4
- package/dist/config/resolve.js.map +1 -1
- package/dist/config.d.ts +2 -0
- package/dist/config.d.ts.map +1 -1
- package/dist/config.js.map +1 -1
- package/dist/engine/childStarted.d.ts +4 -0
- package/dist/engine/childStarted.d.ts.map +1 -0
- package/dist/engine/childStarted.js +7 -0
- package/dist/engine/childStarted.js.map +1 -0
- package/dist/engine/evaluate.d.ts +1 -0
- package/dist/engine/evaluate.d.ts.map +1 -1
- package/dist/engine/evaluate.js +2 -1
- package/dist/engine/evaluate.js.map +1 -1
- package/dist/engine/generateFirst.d.ts +5 -0
- package/dist/engine/generateFirst.d.ts.map +1 -0
- package/dist/engine/generateFirst.js +25 -0
- package/dist/engine/generateFirst.js.map +1 -0
- package/dist/engine/projectScripts.d.ts +11 -0
- package/dist/engine/projectScripts.d.ts.map +1 -0
- package/dist/engine/projectScripts.js +18 -0
- package/dist/engine/projectScripts.js.map +1 -0
- package/dist/engine/runRule.d.ts +21 -0
- package/dist/engine/runRule.d.ts.map +1 -0
- package/dist/engine/runRule.js +70 -0
- package/dist/engine/runRule.js.map +1 -0
- package/dist/engine/runRules.d.ts +5 -12
- package/dist/engine/runRules.d.ts.map +1 -1
- package/dist/engine/runRules.js +49 -65
- package/dist/engine/runRules.js.map +1 -1
- package/dist/engine/session.d.ts +2 -1
- package/dist/engine/session.d.ts.map +1 -1
- package/dist/engine/session.js +22 -6
- package/dist/engine/session.js.map +1 -1
- package/dist/engine/violation.d.ts +7 -0
- package/dist/engine/violation.d.ts.map +1 -1
- package/dist/engine/violation.js +9 -0
- package/dist/engine/violation.js.map +1 -1
- package/dist/exceptions/biomeFindings.d.ts +5 -1
- package/dist/exceptions/biomeFindings.d.ts.map +1 -1
- package/dist/exceptions/biomeFindings.js +17 -18
- package/dist/exceptions/biomeFindings.js.map +1 -1
- package/dist/exceptions/registry.d.ts.map +1 -1
- package/dist/exceptions/registry.js +2 -2
- package/dist/exceptions/registry.js.map +1 -1
- package/dist/hooks/preCommit.d.ts +1 -2
- package/dist/hooks/preCommit.d.ts.map +1 -1
- package/dist/hooks/preCommit.js +16 -19
- package/dist/hooks/preCommit.js.map +1 -1
- package/dist/hooks/stagedCheck.d.ts +5 -0
- package/dist/hooks/stagedCheck.d.ts.map +1 -0
- package/dist/hooks/stagedCheck.js +43 -0
- package/dist/hooks/stagedCheck.js.map +1 -0
- package/dist/hooks/withStagedContent.d.ts +5 -0
- package/dist/hooks/withStagedContent.d.ts.map +1 -0
- package/dist/hooks/withStagedContent.js +84 -0
- package/dist/hooks/withStagedContent.js.map +1 -0
- package/dist/imports/browserGlobals.d.ts +1 -1
- package/dist/imports/browserGlobals.d.ts.map +1 -1
- package/dist/imports/browserNames.d.ts +1 -1
- package/dist/imports/browserNames.d.ts.map +1 -1
- package/dist/imports/browserNames.js +5 -3
- package/dist/imports/browserNames.js.map +1 -1
- package/dist/imports/callsDefineModule.d.ts +3 -0
- package/dist/imports/callsDefineModule.d.ts.map +1 -0
- package/dist/imports/callsDefineModule.js +36 -0
- package/dist/imports/callsDefineModule.js.map +1 -0
- package/dist/imports/fences/check.d.ts +1 -1
- package/dist/imports/fences/check.d.ts.map +1 -1
- package/dist/imports/fences/check.js +3 -1
- package/dist/imports/fences/check.js.map +1 -1
- package/dist/imports/fences/compilePolicy.js +1 -1
- package/dist/imports/fences/compilePolicy.js.map +1 -1
- package/dist/imports/fences/evaluate.d.ts +1 -1
- package/dist/imports/fences/evaluate.d.ts.map +1 -1
- package/dist/imports/fences/evaluate.js +1 -1
- package/dist/imports/fences/evaluate.js.map +1 -1
- package/dist/imports/generatedFolders.d.ts +7 -0
- package/dist/imports/generatedFolders.d.ts.map +1 -0
- package/dist/imports/generatedFolders.js +21 -0
- package/dist/imports/generatedFolders.js.map +1 -0
- package/dist/imports/graph.d.ts +6 -1
- package/dist/imports/graph.d.ts.map +1 -1
- package/dist/imports/graph.js +30 -2
- package/dist/imports/graph.js.map +1 -1
- package/dist/imports/runtime.d.ts +1 -1
- package/dist/imports/runtime.d.ts.map +1 -1
- package/dist/imports/runtime.js +3 -2
- package/dist/imports/runtime.js.map +1 -1
- package/dist/inventory/programmaticBuilds.d.ts +1 -1
- package/dist/inventory/programmaticBuilds.d.ts.map +1 -1
- package/dist/inventory/trackedPaths.d.ts +1 -0
- package/dist/inventory/trackedPaths.d.ts.map +1 -1
- package/dist/inventory/trackedPaths.js +9 -3
- package/dist/inventory/trackedPaths.js.map +1 -1
- package/dist/naming/isOperationFile.d.ts +3 -0
- package/dist/naming/isOperationFile.d.ts.map +1 -0
- package/dist/naming/isOperationFile.js +42 -0
- package/dist/naming/isOperationFile.js.map +1 -0
- package/dist/naming/repeatedFolder.d.ts +2 -0
- package/dist/naming/repeatedFolder.d.ts.map +1 -0
- package/dist/naming/repeatedFolder.js +13 -0
- package/dist/naming/repeatedFolder.js.map +1 -0
- package/dist/naming/testCode.d.ts +1 -1
- package/dist/naming/testCode.d.ts.map +1 -1
- package/dist/report/render.d.ts +1 -0
- package/dist/report/render.d.ts.map +1 -1
- package/dist/report/render.js +10 -3
- package/dist/report/render.js.map +1 -1
- package/dist/report/runSetLine.d.ts +3 -0
- package/dist/report/runSetLine.d.ts.map +1 -0
- package/dist/report/runSetLine.js +13 -0
- package/dist/report/runSetLine.js.map +1 -0
- package/dist/report/staleSections.d.ts.map +1 -1
- package/dist/report/staleSections.js +13 -0
- package/dist/report/staleSections.js.map +1 -1
- package/dist/rule.d.ts +30 -4
- package/dist/rule.d.ts.map +1 -1
- package/dist/rule.js +4 -2
- package/dist/rule.js.map +1 -1
- package/dist/rules/biome.d.ts +18 -1
- package/dist/rules/biome.d.ts.map +1 -1
- package/dist/rules/biome.js +32 -7
- package/dist/rules/biome.js.map +1 -1
- package/dist/rules/builtIn.d.ts +7 -9
- package/dist/rules/builtIn.d.ts.map +1 -1
- package/dist/rules/builtIn.js +2 -2
- package/dist/rules/builtIn.js.map +1 -1
- package/dist/rules/effect/adapterImports.d.ts +1 -1
- package/dist/rules/effect/adapterImports.d.ts.map +1 -1
- package/dist/rules/effect/adapterImports.js +1 -1
- package/dist/rules/effect/adapterImports.js.map +1 -1
- package/dist/rules/effect/boundary.d.ts +1 -1
- package/dist/rules/effect/boundary.d.ts.map +1 -1
- package/dist/rules/effect/boundary.js +60 -75
- package/dist/rules/effect/boundary.js.map +1 -1
- package/dist/rules/effect/boundaryFindings.d.ts +4 -0
- package/dist/rules/effect/boundaryFindings.d.ts.map +1 -0
- package/dist/rules/effect/boundaryFindings.js +63 -0
- package/dist/rules/effect/boundaryFindings.js.map +1 -0
- package/dist/rules/effect/boundaryReference.d.ts +4 -0
- package/dist/rules/effect/boundaryReference.d.ts.map +1 -1
- package/dist/rules/effect/boundaryReference.js +6 -3
- package/dist/rules/effect/boundaryReference.js.map +1 -1
- package/dist/rules/effect/contextCapture.d.ts.map +1 -1
- package/dist/rules/effect/contextCapture.js +3 -2
- package/dist/rules/effect/contextCapture.js.map +1 -1
- package/dist/rules/effect/errorTags.d.ts +10 -0
- package/dist/rules/effect/errorTags.d.ts.map +1 -0
- package/dist/rules/effect/errorTags.js +57 -0
- package/dist/rules/effect/errorTags.js.map +1 -0
- package/dist/rules/effect/failureHonesty.d.ts +1 -1
- package/dist/rules/effect/failureHonesty.d.ts.map +1 -1
- package/dist/rules/effect/failureHonesty.js +6 -5
- package/dist/rules/effect/failureHonesty.js.map +1 -1
- package/dist/rules/effect/policy.d.ts +1 -1
- package/dist/rules/effect/policy.d.ts.map +1 -1
- package/dist/rules/effect/policy.js +0 -2
- package/dist/rules/effect/policy.js.map +1 -1
- package/dist/rules/effect/promiseBridge.d.ts +3 -0
- package/dist/rules/effect/promiseBridge.d.ts.map +1 -0
- package/dist/rules/effect/promiseBridge.js +60 -0
- package/dist/rules/effect/promiseBridge.js.map +1 -0
- package/dist/rules/effect/rpcBoundary.d.ts.map +1 -1
- package/dist/rules/effect/rpcBoundary.js +92 -3
- package/dist/rules/effect/rpcBoundary.js.map +1 -1
- package/dist/rules/effect/serviceModel.d.ts.map +1 -1
- package/dist/rules/effect/serviceModel.js +3 -2
- package/dist/rules/effect/serviceModel.js.map +1 -1
- package/dist/rules/effect/serviceParameterCheck.d.ts +7 -0
- package/dist/rules/effect/serviceParameterCheck.d.ts.map +1 -0
- package/dist/rules/effect/serviceParameterCheck.js +15 -0
- package/dist/rules/effect/serviceParameterCheck.js.map +1 -0
- package/dist/rules/effect/serviceParameters.d.ts.map +1 -1
- package/dist/rules/effect/serviceParameters.js +4 -36
- package/dist/rules/effect/serviceParameters.js.map +1 -1
- package/dist/rules/effect/sharedErrorClasses.d.ts.map +1 -1
- package/dist/rules/effect/sharedErrorClasses.js +31 -2
- package/dist/rules/effect/sharedErrorClasses.js.map +1 -1
- package/dist/rules/effect/workspaceProgram.d.ts +5 -0
- package/dist/rules/effect/workspaceProgram.d.ts.map +1 -0
- package/dist/rules/effect/workspaceProgram.js +32 -0
- package/dist/rules/effect/workspaceProgram.js.map +1 -0
- package/dist/rules/files/namedAfterExport.d.ts.map +1 -1
- package/dist/rules/files/namedAfterExport.js +11 -12
- package/dist/rules/files/namedAfterExport.js.map +1 -1
- package/dist/rules/imports/adminPaths.d.ts +1 -1
- package/dist/rules/imports/adminPaths.d.ts.map +1 -1
- package/dist/rules/imports/cycles.d.ts +1 -1
- package/dist/rules/imports/cycles.d.ts.map +1 -1
- package/dist/rules/imports/fences.d.ts +1 -1
- package/dist/rules/imports/fences.d.ts.map +1 -1
- package/dist/rules/imports/manifest.d.ts +1 -1
- package/dist/rules/imports/manifest.d.ts.map +1 -1
- package/dist/rules/imports/noTestCode.d.ts +1 -1
- package/dist/rules/imports/noTestCode.d.ts.map +1 -1
- package/dist/rules/imports/resolvable.d.ts +1 -3
- package/dist/rules/imports/resolvable.d.ts.map +1 -1
- package/dist/rules/imports/resolvable.js +12 -10
- package/dist/rules/imports/resolvable.js.map +1 -1
- package/dist/rules/imports/runtime.d.ts +1 -1
- package/dist/rules/imports/runtime.d.ts.map +1 -1
- package/dist/rules/imports/runtime.js +49 -9
- package/dist/rules/imports/runtime.js.map +1 -1
- package/dist/rules/manifestsNoTestKits.js +1 -1
- package/dist/rules/manifestsNoTestKits.js.map +1 -1
- package/dist/rules/maxLines.d.ts +1 -1
- package/dist/rules/maxLines.d.ts.map +1 -1
- package/dist/rules/packageFindings.d.ts +31 -0
- package/dist/rules/packageFindings.d.ts.map +1 -0
- package/dist/rules/packageFindings.js +65 -0
- package/dist/rules/packageFindings.js.map +1 -0
- package/dist/rules/parse.d.ts +4 -1
- package/dist/rules/parse.d.ts.map +1 -1
- package/dist/rules/parse.js +35 -2
- package/dist/rules/parse.js.map +1 -1
- package/dist/rules/rootedFindings.d.ts +5 -0
- package/dist/rules/rootedFindings.d.ts.map +1 -0
- package/dist/rules/rootedFindings.js +16 -0
- package/dist/rules/rootedFindings.js.map +1 -0
- package/dist/rules/stories/adapterOnlyFakes.d.ts +1 -1
- package/dist/rules/stories/adapterOnlyFakes.d.ts.map +1 -1
- package/dist/rules/stories/adapterOnlyFakes.js +1 -0
- package/dist/rules/stories/adapterOnlyFakes.js.map +1 -1
- package/dist/rules/stories/databaseUrl.d.ts +1 -1
- package/dist/rules/stories/databaseUrl.d.ts.map +1 -1
- package/dist/rules/stories/databaseUrl.js +1 -0
- package/dist/rules/stories/databaseUrl.js.map +1 -1
- package/dist/rules/stories/domainOutcomes.d.ts +1 -1
- package/dist/rules/stories/domainOutcomes.d.ts.map +1 -1
- package/dist/rules/stories/domainOutcomes.js +1 -0
- package/dist/rules/stories/domainOutcomes.js.map +1 -1
- package/dist/rules/stories/engine.d.ts +1 -1
- package/dist/rules/stories/engine.d.ts.map +1 -1
- package/dist/rules/stories/engine.js +1 -0
- package/dist/rules/stories/engine.js.map +1 -1
- package/dist/rules/stories/globalRetries.d.ts +1 -1
- package/dist/rules/stories/globalRetries.d.ts.map +1 -1
- package/dist/rules/stories/globalRetries.js +1 -0
- package/dist/rules/stories/globalRetries.js.map +1 -1
- package/dist/rules/stories/groupedOutcomes.d.ts +1 -1
- package/dist/rules/stories/groupedOutcomes.d.ts.map +1 -1
- package/dist/rules/stories/groupedOutcomes.js +1 -0
- package/dist/rules/stories/groupedOutcomes.js.map +1 -1
- package/dist/rules/stories/importedChangeKeys.js +2 -2
- package/dist/rules/stories/importedChangeKeys.js.map +1 -1
- package/dist/rules/stories/namedValues.d.ts +1 -1
- package/dist/rules/stories/namedValues.d.ts.map +1 -1
- package/dist/rules/stories/namedValues.js +1 -0
- package/dist/rules/stories/namedValues.js.map +1 -1
- package/dist/rules/stories/noExpect.d.ts +1 -1
- package/dist/rules/stories/noExpect.d.ts.map +1 -1
- package/dist/rules/stories/noLimitImports.d.ts +1 -1
- package/dist/rules/stories/noLimitImports.d.ts.map +1 -1
- package/dist/rules/stories/noLimitImports.js +1 -0
- package/dist/rules/stories/noLimitImports.js.map +1 -1
- package/dist/rules/stories/positiveRefusals.d.ts +1 -1
- package/dist/rules/stories/positiveRefusals.d.ts.map +1 -1
- package/dist/rules/stories/positiveRefusals.js +1 -0
- package/dist/rules/stories/positiveRefusals.js.map +1 -1
- package/dist/rules/stories/queueReadouts.d.ts +1 -1
- package/dist/rules/stories/queueReadouts.d.ts.map +1 -1
- package/dist/rules/stories/queueReadouts.js +1 -0
- package/dist/rules/stories/queueReadouts.js.map +1 -1
- package/dist/rules/stories/rawServers.d.ts +2 -0
- package/dist/rules/stories/rawServers.d.ts.map +1 -0
- package/dist/rules/stories/rawServers.js +100 -0
- package/dist/rules/stories/rawServers.js.map +1 -0
- package/dist/rules/stories/sources.d.ts +2 -2
- package/dist/rules/stories/sources.d.ts.map +1 -1
- package/dist/rules/stories/specHelpers.d.ts +1 -1
- package/dist/rules/stories/specHelpers.d.ts.map +1 -1
- package/dist/rules/stories/specHelpers.js +3 -2
- package/dist/rules/stories/specHelpers.js.map +1 -1
- package/dist/rules/stories/specs.d.ts +1 -1
- package/dist/rules/stories/specs.d.ts.map +1 -1
- package/dist/rules/stories/specs.js +1 -0
- package/dist/rules/stories/specs.js.map +1 -1
- package/dist/rules/stories/waitOnEvents.d.ts +1 -1
- package/dist/rules/stories/waitOnEvents.d.ts.map +1 -1
- package/dist/rules/stories/waitOnEvents.js +3 -3
- package/dist/rules/stories/waitOnEvents.js.map +1 -1
- package/dist/rules/suppressions/noDoubleCast.d.ts.map +1 -1
- package/dist/rules/suppressions/noDoubleCast.js +4 -49
- package/dist/rules/suppressions/noDoubleCast.js.map +1 -1
- package/dist/rules/suppressions/typedCastCheck.d.ts +10 -0
- package/dist/rules/suppressions/typedCastCheck.d.ts.map +1 -0
- package/dist/rules/suppressions/typedCastCheck.js +48 -0
- package/dist/rules/suppressions/typedCastCheck.js.map +1 -0
- package/dist/rules/unusedCode.d.ts.map +1 -1
- package/dist/rules/unusedCode.js +1 -0
- package/dist/rules/unusedCode.js.map +1 -1
- package/dist/testing/adapters/cli.d.ts +1 -0
- package/dist/testing/adapters/cli.d.ts.map +1 -1
- package/dist/testing/adapters/cli.js +10 -8
- package/dist/testing/adapters/cli.js.map +1 -1
- package/dist/testing/adapters/git.d.ts +1 -16
- package/dist/testing/adapters/git.d.ts.map +1 -1
- package/dist/testing/adapters/git.js +5 -10
- package/dist/testing/adapters/git.js.map +1 -1
- package/dist/testing/adapters/hookRepository.d.ts +3 -2
- package/dist/testing/adapters/hookRepository.d.ts.map +1 -1
- package/dist/testing/adapters/hookRepository.js +11 -8
- package/dist/testing/adapters/hookRepository.js.map +1 -1
- package/dist/testing/adapters/imports.d.ts.map +1 -1
- package/dist/testing/adapters/imports.js +4 -1
- package/dist/testing/adapters/imports.js.map +1 -1
- package/dist/testing/ruleStory.d.ts +1 -1
- package/dist/testing/ruleStory.js +2 -2
- package/dist/testing/ruleStory.js.map +1 -1
- package/docs/debt-and-hooks.md +5 -3
- package/docs/north-star.md +1 -1
- package/package.json +19 -19
- package/src/adapters/biome/pluginContract.ts +2 -5
- package/src/adapters/biome/run.ts +2 -0
- package/src/adapters/biome/withExceptionConfig.ts +26 -5
- package/src/adapters/{changeKeyFindings.ts → changeKeyCheck.ts} +8 -24
- package/src/adapters/contextCaptureCheck.ts +106 -0
- package/src/adapters/declaration-files/initialize.ts +4 -0
- package/src/adapters/declaration-files/parse.ts +9 -0
- package/src/adapters/declaration-files/reader.ts +28 -0
- package/src/adapters/declaration-files/service.ts +16 -0
- package/src/adapters/declarationTagParameter.ts +4 -0
- package/src/adapters/foreignResources.ts +0 -4
- package/src/adapters/import-compiler/graph.ts +7 -2
- package/src/adapters/imports/graph.ts +43 -18
- package/src/adapters/imports/resolve.ts +31 -5
- package/src/adapters/knip/configuration.ts +6 -4
- package/src/adapters/knip/run.ts +4 -1
- package/src/adapters/outsideImportFindings.ts +21 -65
- package/src/adapters/presenceCheck.ts +17 -0
- package/src/adapters/rule.ts +29 -6
- package/src/adapters/runMain.ts +7 -6
- package/src/adapters/{serviceModelFindings.ts → serviceModelCheck.ts} +10 -25
- package/src/adapters/sharedErrorCatalog.ts +43 -0
- package/src/adapters/sharedErrorModules.ts +1 -1
- package/src/adapters/specReaderSources.ts +6 -3
- package/src/adapters/storyProgram.ts +20 -3
- package/src/adapters/typeScriptProgram.ts +57 -0
- package/src/baseline/compare.ts +59 -19
- package/src/baseline/format.ts +7 -2
- package/src/baseline/merge.ts +15 -1
- package/src/baseline/rewrite.ts +3 -1
- package/src/baseline/update.ts +38 -8
- package/src/biome/exceptionConfig.ts +24 -3
- package/src/biome/scannerRules.ts +42 -0
- package/src/cli/args.ts +13 -2
- package/src/cli/baseline.ts +7 -1
- package/src/cli/lint.ts +14 -6
- package/src/cli/misplaced.ts +4 -2
- package/src/cli/program.ts +1 -1
- package/src/cli/runSet.ts +17 -0
- package/src/cli/shrink.ts +4 -11
- package/src/cli/usage.ts +7 -2
- package/src/config/decode.ts +1 -0
- package/src/config/load.ts +3 -0
- package/src/config/resolve.ts +11 -6
- package/src/config.ts +3 -0
- package/src/engine/childStarted.ts +8 -0
- package/src/engine/evaluate.ts +3 -1
- package/src/engine/generateFirst.ts +32 -0
- package/src/engine/projectScripts.ts +25 -0
- package/src/engine/runRule.ts +103 -0
- package/src/engine/runRules.ts +64 -86
- package/src/engine/session.ts +25 -5
- package/src/engine/violation.ts +16 -0
- package/src/exceptions/biomeFindings.ts +24 -21
- package/src/exceptions/registry.ts +2 -2
- package/src/hooks/preCommit.ts +24 -24
- package/src/hooks/stagedCheck.ts +54 -0
- package/src/hooks/withStagedContent.ts +111 -0
- package/src/imports/browserNames.ts +7 -5
- package/src/imports/callsDefineModule.ts +43 -0
- package/src/imports/fences/check.ts +3 -1
- package/src/imports/fences/compilePolicy.ts +1 -1
- package/src/imports/fences/evaluate.ts +2 -2
- package/src/imports/generatedFolders.ts +28 -0
- package/src/imports/graph.ts +47 -3
- package/src/imports/runtime.ts +7 -2
- package/src/inventory/trackedPaths.ts +10 -3
- package/src/naming/isOperationFile.ts +52 -0
- package/src/naming/repeatedFolder.ts +14 -0
- package/src/report/render.ts +12 -3
- package/src/report/runSetLine.ts +14 -0
- package/src/report/staleSections.ts +14 -0
- package/src/rule.ts +38 -7
- package/src/rules/biome.ts +53 -7
- package/src/rules/builtIn.ts +2 -2
- package/src/rules/effect/adapterImports.ts +1 -1
- package/src/rules/effect/boundary.ts +82 -83
- package/src/rules/effect/boundaryFindings.ts +71 -0
- package/src/rules/effect/boundaryReference.ts +7 -3
- package/src/rules/effect/contextCapture.ts +3 -2
- package/src/rules/effect/errorTags.ts +72 -0
- package/src/rules/effect/failureHonesty.ts +9 -5
- package/src/rules/effect/policy.ts +0 -2
- package/src/rules/effect/promiseBridge.ts +65 -0
- package/src/rules/effect/rpcBoundary.ts +111 -4
- package/src/rules/effect/serviceModel.ts +3 -2
- package/src/rules/effect/serviceParameterCheck.ts +22 -0
- package/src/rules/effect/serviceParameters.ts +5 -37
- package/src/rules/effect/sharedErrorClasses.ts +41 -3
- package/src/rules/effect/workspaceProgram.ts +34 -0
- package/src/rules/files/namedAfterExport.ts +14 -13
- package/src/rules/imports/resolvable.ts +13 -11
- package/src/rules/imports/runtime.ts +71 -10
- package/src/rules/manifestsNoTestKits.ts +1 -1
- package/src/rules/packageFindings.ts +103 -0
- package/src/rules/parse.ts +54 -3
- package/src/rules/rootedFindings.ts +19 -0
- package/src/rules/stories/adapterOnlyFakes.ts +1 -0
- package/src/rules/stories/databaseUrl.ts +1 -0
- package/src/rules/stories/domainOutcomes.ts +1 -0
- package/src/rules/stories/engine.ts +1 -0
- package/src/rules/stories/globalRetries.ts +1 -0
- package/src/rules/stories/groupedOutcomes.ts +1 -0
- package/src/rules/stories/importedChangeKeys.ts +2 -2
- package/src/rules/stories/namedValues.ts +1 -0
- package/src/rules/stories/noLimitImports.ts +1 -0
- package/src/rules/stories/positiveRefusals.ts +1 -0
- package/src/rules/stories/queueReadouts.ts +1 -0
- package/src/rules/stories/rawServers.ts +118 -0
- package/src/rules/stories/specHelpers.ts +8 -5
- package/src/rules/stories/specs.ts +1 -0
- package/src/rules/stories/waitOnEvents.ts +6 -3
- package/src/rules/suppressions/noDoubleCast.ts +5 -55
- package/src/rules/suppressions/typedCastCheck.ts +55 -0
- package/src/rules/unusedCode.ts +1 -0
- package/src/testing/adapters/cli.ts +13 -9
- package/src/testing/adapters/git.ts +6 -11
- package/src/testing/adapters/hookRepository.ts +12 -7
- package/src/testing/adapters/imports.ts +4 -1
- package/src/testing/ruleStory.ts +2 -2
- package/dist/adapters/biome/presetConfig.d.ts +0 -21
- package/dist/adapters/biome/presetConfig.d.ts.map +0 -1
- package/dist/adapters/biome/presetConfig.js +0 -32
- package/dist/adapters/biome/presetConfig.js.map +0 -1
- package/dist/adapters/changeKeyFindings.d.ts +0 -4
- package/dist/adapters/changeKeyFindings.d.ts.map +0 -1
- package/dist/adapters/changeKeyFindings.js.map +0 -1
- package/dist/adapters/contextCaptureFindings.d.ts +0 -4
- package/dist/adapters/contextCaptureFindings.d.ts.map +0 -1
- package/dist/adapters/contextCaptureFindings.js +0 -51
- package/dist/adapters/contextCaptureFindings.js.map +0 -1
- package/dist/adapters/nativeTransactionFindings.d.ts +0 -4
- package/dist/adapters/nativeTransactionFindings.d.ts.map +0 -1
- package/dist/adapters/nativeTransactionFindings.js +0 -98
- package/dist/adapters/nativeTransactionFindings.js.map +0 -1
- package/dist/adapters/rpcBoundaryFindings.d.ts +0 -4
- package/dist/adapters/rpcBoundaryFindings.d.ts.map +0 -1
- package/dist/adapters/rpcBoundaryFindings.js +0 -90
- package/dist/adapters/rpcBoundaryFindings.js.map +0 -1
- package/dist/adapters/serviceModelFindings.d.ts +0 -4
- package/dist/adapters/serviceModelFindings.d.ts.map +0 -1
- package/dist/adapters/serviceModelFindings.js.map +0 -1
- package/dist/adapters/sharedErrorFindings.d.ts +0 -4
- package/dist/adapters/sharedErrorFindings.d.ts.map +0 -1
- package/dist/adapters/sharedErrorFindings.js +0 -71
- package/dist/adapters/sharedErrorFindings.js.map +0 -1
- package/dist/adapters/transactionChanges.d.ts +0 -3
- package/dist/adapters/transactionChanges.d.ts.map +0 -1
- package/dist/adapters/transactionChanges.js +0 -81
- package/dist/adapters/transactionChanges.js.map +0 -1
- package/dist/adapters/vitePort.d.ts +0 -2
- package/dist/adapters/vitePort.d.ts.map +0 -1
- package/dist/adapters/vitePort.js +0 -5
- package/dist/adapters/vitePort.js.map +0 -1
- package/dist/appTestConfig.d.ts +0 -4
- package/dist/appTestConfig.d.ts.map +0 -1
- package/dist/appTestConfig.js +0 -9
- package/dist/appTestConfig.js.map +0 -1
- package/dist/appViteConfig.d.ts +0 -23
- package/dist/appViteConfig.d.ts.map +0 -1
- package/dist/appViteConfig.js +0 -17
- package/dist/appViteConfig.js.map +0 -1
- package/dist/biome/recommendedRules.d.ts +0 -3
- package/dist/biome/recommendedRules.d.ts.map +0 -1
- package/dist/biome/recommendedRules.js +0 -20
- package/dist/biome/recommendedRules.js.map +0 -1
- package/dist/imports/withoutGenerated.d.ts +0 -8
- package/dist/imports/withoutGenerated.d.ts.map +0 -1
- package/dist/imports/withoutGenerated.js +0 -65
- package/dist/imports/withoutGenerated.js.map +0 -1
- package/dist/rules/effect/program.d.ts +0 -8
- package/dist/rules/effect/program.d.ts.map +0 -1
- package/dist/rules/effect/program.js +0 -53
- package/dist/rules/effect/program.js.map +0 -1
- package/dist/rules/effect/sqlTransact.d.ts +0 -2
- package/dist/rules/effect/sqlTransact.d.ts.map +0 -1
- package/dist/rules/effect/sqlTransact.js +0 -9
- package/dist/rules/effect/sqlTransact.js.map +0 -1
- package/dist/rules/suppressions/biomeRecommended.d.ts +0 -7
- package/dist/rules/suppressions/biomeRecommended.d.ts.map +0 -1
- package/dist/rules/suppressions/biomeRecommended.js +0 -47
- package/dist/rules/suppressions/biomeRecommended.js.map +0 -1
- package/src/adapters/biome/presetConfig.ts +0 -34
- package/src/adapters/contextCaptureFindings.ts +0 -60
- package/src/adapters/nativeTransactionFindings.ts +0 -108
- package/src/adapters/rpcBoundaryFindings.ts +0 -98
- package/src/adapters/sharedErrorFindings.ts +0 -84
- package/src/adapters/transactionChanges.ts +0 -85
- package/src/adapters/vitePort.ts +0 -5
- package/src/appTestConfig.ts +0 -10
- package/src/appViteConfig.ts +0 -24
- package/src/biome/recommendedRules.ts +0 -27
- package/src/imports/withoutGenerated.ts +0 -82
- package/src/rules/effect/program.ts +0 -57
- package/src/rules/effect/sqlTransact.ts +0 -10
- package/src/rules/suppressions/biomeRecommended.ts +0 -60
|
@@ -97,8 +97,8 @@ export function boundaryEntryPoint(path: string, source: ts.SourceFile, checker:
|
|
|
97
97
|
return RUNNER_HOST.test(path) || entryModule(path, source, checker);
|
|
98
98
|
}
|
|
99
99
|
|
|
100
|
-
//
|
|
101
|
-
export function
|
|
100
|
+
// Imports name their modules, so each module binds on its own without resolving the program behind it: local names resolve, imports stay unresolved.
|
|
101
|
+
export function moduleBinder(sources: readonly SourceFile[]) {
|
|
102
102
|
const options: ts.CompilerOptions = { allowJs: true, noLib: true, noResolve: true, types: [] };
|
|
103
103
|
const host = ts.createCompilerHost(options);
|
|
104
104
|
const parsed = new Map(
|
|
@@ -108,6 +108,10 @@ export function entryModules(sources: readonly SourceFile[]): ReadonlySet<string
|
|
|
108
108
|
}),
|
|
109
109
|
);
|
|
110
110
|
host.getSourceFile = (path) => parsed.get(path);
|
|
111
|
-
|
|
111
|
+
return { checker: ts.createProgram([...parsed.keys()], options, host).getTypeChecker(), parsed };
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
export function entryModules(sources: readonly SourceFile[]): ReadonlySet<string> {
|
|
115
|
+
const { checker, parsed } = moduleBinder(sources);
|
|
112
116
|
return new Set([...parsed].flatMap(([path, source]) => (entryModule(path, source, checker) ? [path] : [])));
|
|
113
117
|
}
|
|
@@ -1,8 +1,9 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { contextCaptureCheck } from "#adapters/contextCaptureCheck.ts";
|
|
2
2
|
import { defineRule } from "#rule.ts";
|
|
3
|
+
import { rootedFindings } from "#rules/rootedFindings.ts";
|
|
3
4
|
|
|
4
5
|
export const contextCapture = defineRule({
|
|
5
|
-
check:
|
|
6
|
+
check: (inputs) => rootedFindings(inputs, contextCaptureCheck),
|
|
6
7
|
description:
|
|
7
8
|
"Core code yields dependencies and the caller rather than re-providing captured contexts with Effect.provideContext, runPromiseWith, runForkWith or the Context overload of provide. Contexts assembled from Layers at composition roots and fully provided application harnesses are accepted. Runtime bridges belong in adapters/ or test-support/.",
|
|
8
9
|
id: "effect/context-capture",
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import ts from "typescript";
|
|
2
|
+
import { type ImportBinding, importBindings } from "#rules/stories/importBindings.ts";
|
|
3
|
+
import { memberName, nodesWhere, unwrapped } from "#rules/stories/syntax.ts";
|
|
4
|
+
|
|
5
|
+
export interface TaggedClass {
|
|
6
|
+
readonly name: string | undefined;
|
|
7
|
+
readonly node: ts.ClassLikeDeclaration;
|
|
8
|
+
readonly tag: string;
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
export type ImportedTag = (binding: ImportBinding, member: string | undefined) => string | undefined;
|
|
12
|
+
|
|
13
|
+
const CONSTRUCTORS: ReadonlySet<string> = new Set(["TaggedError", "TaggedErrorClass"]);
|
|
14
|
+
|
|
15
|
+
function constructorTag(heritage: ts.Expression): string | undefined {
|
|
16
|
+
const call = unwrapped(heritage);
|
|
17
|
+
if (!ts.isCallExpression(call)) {
|
|
18
|
+
return undefined;
|
|
19
|
+
}
|
|
20
|
+
const inner = ts.isCallExpression(call.expression) ? call.expression.expression : call.expression;
|
|
21
|
+
const name = ts.isIdentifier(inner) ? inner.text : memberName(inner);
|
|
22
|
+
const [first] = call.arguments;
|
|
23
|
+
return CONSTRUCTORS.has(name ?? "") && first !== undefined && ts.isStringLiteralLike(first) ? first.text : undefined;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
function propertyTag(node: ts.ClassLikeDeclaration): string | undefined {
|
|
27
|
+
for (const member of node.members) {
|
|
28
|
+
if (!(ts.isPropertyDeclaration(member) && ts.isIdentifier(member.name) && member.name.text === "_tag")) {
|
|
29
|
+
continue;
|
|
30
|
+
}
|
|
31
|
+
const readonly = member.modifiers?.some((modifier) => modifier.kind === ts.SyntaxKind.ReadonlyKeyword) === true;
|
|
32
|
+
const literal = member.type !== undefined && ts.isLiteralTypeNode(member.type) ? member.type.literal : member.initializer;
|
|
33
|
+
return readonly && literal !== undefined && ts.isStringLiteralLike(literal) ? literal.text : undefined;
|
|
34
|
+
}
|
|
35
|
+
return undefined;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
function extended(node: ts.ClassLikeDeclaration): ts.Expression | undefined {
|
|
39
|
+
return node.heritageClauses?.find((clause) => clause.token === ts.SyntaxKind.ExtendsKeyword)?.types[0]?.expression;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
function importedBase(base: ts.Expression, bindings: ReadonlyMap<string, ImportBinding>, imported: ImportedTag): string | undefined {
|
|
43
|
+
const namespace = ts.isPropertyAccessExpression(base) && ts.isIdentifier(base.expression) ? base.expression : undefined;
|
|
44
|
+
const root = namespace ?? base;
|
|
45
|
+
const binding = ts.isIdentifier(root) ? bindings.get(root.text) : undefined;
|
|
46
|
+
return binding === undefined ? undefined : imported(binding, namespace === undefined ? undefined : memberName(base));
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
// A tagged error is a class built by a TaggedError constructor with a literal tag, an Error subclass with a readonly literal _tag, or a subclass of either.
|
|
50
|
+
export function taggedClasses(source: ts.SourceFile, imported: ImportedTag): readonly TaggedClass[] {
|
|
51
|
+
const bindings = importBindings(source);
|
|
52
|
+
const classes = nodesWhere(source, ts.isClassLike).filter(ts.isClassLike);
|
|
53
|
+
const named = new Map(classes.flatMap((node) => (node.name === undefined ? [] : [[node.name.text, node] as const])));
|
|
54
|
+
function tagOf(node: ts.ClassLikeDeclaration, seen: ReadonlySet<ts.Node>): string | undefined {
|
|
55
|
+
const heritage = extended(node);
|
|
56
|
+
if (heritage === undefined || seen.has(node)) {
|
|
57
|
+
return undefined;
|
|
58
|
+
}
|
|
59
|
+
const base = unwrapped(heritage);
|
|
60
|
+
const local = ts.isIdentifier(base) && !bindings.has(base.text) ? named.get(base.text) : undefined;
|
|
61
|
+
return (
|
|
62
|
+
constructorTag(heritage)
|
|
63
|
+
?? propertyTag(node)
|
|
64
|
+
?? importedBase(base, bindings, imported)
|
|
65
|
+
?? (local === undefined ? undefined : tagOf(local, new Set([...seen, node])))
|
|
66
|
+
);
|
|
67
|
+
}
|
|
68
|
+
return classes.flatMap((node) => {
|
|
69
|
+
const tag = tagOf(node, new Set());
|
|
70
|
+
return tag === undefined ? [] : [{ name: node.name?.text, node, tag }];
|
|
71
|
+
});
|
|
72
|
+
}
|
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
import { join } from "node:path";
|
|
2
|
+
import { Effect } from "effect";
|
|
2
3
|
import ts from "typescript";
|
|
3
4
|
import { defineRule, type Finding, type RuleInputs } from "#rule.ts";
|
|
4
5
|
import { failureFindings } from "#rules/effect/failureFindings.ts";
|
|
5
|
-
import {
|
|
6
|
+
import { workspaceProgram } from "#rules/effect/workspaceProgram.ts";
|
|
6
7
|
|
|
7
|
-
|
|
8
|
-
const program =
|
|
8
|
+
const checkFailures = Effect.fn("FailureHonesty.checkFailures")(function* (inputs: RuleInputs) {
|
|
9
|
+
const program = yield* workspaceProgram(inputs);
|
|
9
10
|
const checker = program.getTypeChecker();
|
|
10
11
|
return inputs.sources.flatMap((file) => {
|
|
11
12
|
const source = program.getSourceFile(join(inputs.root, file.path));
|
|
@@ -32,7 +33,7 @@ function checkFailures(inputs: RuleInputs): readonly Finding[] {
|
|
|
32
33
|
}
|
|
33
34
|
return findings;
|
|
34
35
|
});
|
|
35
|
-
}
|
|
36
|
+
});
|
|
36
37
|
|
|
37
38
|
export const failureHonesty = defineRule({
|
|
38
39
|
check: (inputs) => {
|
|
@@ -51,7 +52,10 @@ export const failureHonesty = defineRule({
|
|
|
51
52
|
sources.push(source);
|
|
52
53
|
groups.set(group, sources);
|
|
53
54
|
}
|
|
54
|
-
return
|
|
55
|
+
return Effect.map(
|
|
56
|
+
Effect.forEach(groups.values(), (sources) => checkFailures({ ...inputs, sources })),
|
|
57
|
+
(found) => found.flat(),
|
|
58
|
+
);
|
|
55
59
|
},
|
|
56
60
|
description:
|
|
57
61
|
"Keep failures typed and observable: no forked forever/orDie loops, retry({ while }) without times or a pacing Schedule, blanket catch-to-success, or FileSystem option/orElseSucceed. Catch a named reason, use a Schedule that paces retries or model an explicit unavailable state. In test-support/, a blanket catch whose handler derives its value from the caught error is a readout translation and is accepted. No config exceptions or inline suppressions; baseline existing debt.",
|
|
@@ -9,7 +9,6 @@ import { serviceIds } from "#rules/effect/serviceIds.ts";
|
|
|
9
9
|
import { serviceModel } from "#rules/effect/serviceModel.ts";
|
|
10
10
|
import { serviceParameters } from "#rules/effect/serviceParameters.ts";
|
|
11
11
|
import { sharedErrorClasses } from "#rules/effect/sharedErrorClasses.ts";
|
|
12
|
-
import { sqlTransact } from "#rules/effect/sqlTransact.ts";
|
|
13
12
|
|
|
14
13
|
export const effectPolicy = [
|
|
15
14
|
adapterImports,
|
|
@@ -23,5 +22,4 @@ export const effectPolicy = [
|
|
|
23
22
|
serviceModel,
|
|
24
23
|
serviceParameters,
|
|
25
24
|
sharedErrorClasses,
|
|
26
|
-
sqlTransact,
|
|
27
25
|
] as const;
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import ts from "typescript";
|
|
2
|
+
import { serviceProperty } from "#adapters/serviceAssemblySyntax.ts";
|
|
3
|
+
import { packageNameOf } from "#imports/packageName.ts";
|
|
4
|
+
import { boundaryReference } from "#rules/effect/boundaryReference.ts";
|
|
5
|
+
|
|
6
|
+
function rootIdentifier(expression: ts.Expression): ts.Identifier | undefined {
|
|
7
|
+
if (ts.isIdentifier(expression)) {
|
|
8
|
+
return expression;
|
|
9
|
+
}
|
|
10
|
+
return ts.isPropertyAccessExpression(expression) || ts.isElementAccessExpression(expression) || ts.isCallExpression(expression)
|
|
11
|
+
? rootIdentifier(expression.expression)
|
|
12
|
+
: undefined;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
function calleeOf(node: ts.Node): ts.Identifier | undefined {
|
|
16
|
+
if (ts.isTaggedTemplateExpression(node)) {
|
|
17
|
+
return rootIdentifier(node.tag);
|
|
18
|
+
}
|
|
19
|
+
return ts.isCallExpression(node) ? rootIdentifier(node.expression) : undefined;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
function moduleOf(declaration: ts.Declaration): string | undefined {
|
|
23
|
+
if (!(ts.isImportSpecifier(declaration) || ts.isNamespaceImport(declaration) || ts.isImportClause(declaration))) {
|
|
24
|
+
return undefined;
|
|
25
|
+
}
|
|
26
|
+
const module = ts.findAncestor(declaration, ts.isImportDeclaration)?.moduleSpecifier;
|
|
27
|
+
return module !== undefined && ts.isStringLiteral(module) ? module.text : undefined;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
// Library types stay out of this rule's program, so a library's Promise is recognised by the bridge that consumes it, from its import.
|
|
31
|
+
export function promiseBridge(checker: ts.TypeChecker, workspace: ReadonlySet<string>) {
|
|
32
|
+
function outsideLibrary(identifier: ts.Identifier): string | undefined {
|
|
33
|
+
const specifier = (checker.getSymbolAtLocation(identifier)?.declarations ?? []).map(moduleOf).find((found) => found !== undefined);
|
|
34
|
+
if (specifier === undefined || /^[.#/]/u.test(specifier)) {
|
|
35
|
+
return undefined;
|
|
36
|
+
}
|
|
37
|
+
const name = packageNameOf(specifier);
|
|
38
|
+
return name === "effect" || name.startsWith("@effect/") || name.startsWith("@shivaedev/") || name.startsWith("node:") || workspace.has(name)
|
|
39
|
+
? undefined
|
|
40
|
+
: specifier;
|
|
41
|
+
}
|
|
42
|
+
function bridged(callback: ts.Node): string | undefined {
|
|
43
|
+
const root = ts.isExpression(callback) && !ts.isFunctionLike(callback) ? rootIdentifier(callback) : undefined;
|
|
44
|
+
const direct = root === undefined ? undefined : outsideLibrary(root);
|
|
45
|
+
if (direct !== undefined) {
|
|
46
|
+
return direct;
|
|
47
|
+
}
|
|
48
|
+
function visit(node: ts.Node): string | undefined {
|
|
49
|
+
const callee = calleeOf(node);
|
|
50
|
+
return (callee === undefined ? undefined : outsideLibrary(callee)) ?? ts.forEachChild(node, visit);
|
|
51
|
+
}
|
|
52
|
+
return ts.forEachChild(callback, visit);
|
|
53
|
+
}
|
|
54
|
+
return (node: ts.Node): string | undefined => {
|
|
55
|
+
if (
|
|
56
|
+
!(ts.isCallExpression(node) && /^effect(?:\.Effect|\/Effect)\.(?:tryPromise|promise)$/u.test(boundaryReference(checker, node.expression) ?? ""))
|
|
57
|
+
) {
|
|
58
|
+
return undefined;
|
|
59
|
+
}
|
|
60
|
+
const [argument] = node.arguments;
|
|
61
|
+
const callback = argument !== undefined && ts.isObjectLiteralExpression(argument) ? serviceProperty(argument, "try") : argument;
|
|
62
|
+
const library = callback === undefined ? undefined : bridged(callback);
|
|
63
|
+
return library === undefined ? undefined : `Promise bridge to the library ${library}`;
|
|
64
|
+
};
|
|
65
|
+
}
|
|
@@ -1,10 +1,117 @@
|
|
|
1
|
-
import
|
|
2
|
-
import {
|
|
1
|
+
import ts from "typescript";
|
|
2
|
+
import { isTestSupport } from "#naming/testName.ts";
|
|
3
|
+
import { defineRule, type Finding, type SourceFile } from "#rule.ts";
|
|
4
|
+
import { parse } from "#rules/parse.ts";
|
|
5
|
+
import { type ImportBinding, importBindings } from "#rules/stories/importBindings.ts";
|
|
6
|
+
import { findingAt, memberName, nodesWhere, unwrapped } from "#rules/stories/syntax.ts";
|
|
7
|
+
|
|
8
|
+
const BOUNDARIES: ReadonlyMap<string, string> = new Map([
|
|
9
|
+
["@shivaedev/errors/boundary.ts", "rpcBoundary"],
|
|
10
|
+
["@shivaedev/errors/rpcBoundaryHandlers.ts", "rpcBoundaryHandlers"],
|
|
11
|
+
]);
|
|
12
|
+
const BUILDERS: ReadonlySet<string> = new Set(["toLayer", "toLayerHandler", "toHandlers", "of"]);
|
|
13
|
+
const EFFECT_MODULE = /^(?:effect|@effect\/[^/]+)(?:\/|$)/u;
|
|
14
|
+
const RPC_MODULE = /^(?:effect\/(?:unstable\/)?rpc|@effect\/rpc)(?:\/|$)/u;
|
|
15
|
+
|
|
16
|
+
function rootIdentifier(expression: ts.Expression): ts.Identifier | undefined {
|
|
17
|
+
const value = unwrapped(expression);
|
|
18
|
+
if (ts.isIdentifier(value)) {
|
|
19
|
+
return value;
|
|
20
|
+
}
|
|
21
|
+
return ts.isPropertyAccessExpression(value) || ts.isElementAccessExpression(value) || ts.isCallExpression(value)
|
|
22
|
+
? rootIdentifier(value.expression)
|
|
23
|
+
: undefined;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
function localValues(source: ts.SourceFile): ReadonlyMap<string, ts.Expression | undefined> {
|
|
27
|
+
const values = new Map<string, ts.Expression | undefined>();
|
|
28
|
+
for (const node of nodesWhere(source, (candidate) => ts.isVariableDeclaration(candidate) || ts.isClassLike(candidate))) {
|
|
29
|
+
if (ts.isVariableDeclaration(node) && ts.isIdentifier(node.name)) {
|
|
30
|
+
values.set(node.name.text, node.initializer);
|
|
31
|
+
} else if (ts.isClassLike(node) && node.name !== undefined) {
|
|
32
|
+
values.set(node.name.text, node.heritageClauses?.find((clause) => clause.token === ts.SyntaxKind.ExtendsKeyword)?.types[0]?.expression);
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
return values;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
type Origin = "effect" | "elsewhere" | "rpc" | "value";
|
|
39
|
+
|
|
40
|
+
interface Scope {
|
|
41
|
+
readonly bindings: ReadonlyMap<string, ImportBinding>;
|
|
42
|
+
readonly locals: ReadonlyMap<string, ts.Expression | undefined>;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
function moduleOrigin(module: string): Origin {
|
|
46
|
+
if (RPC_MODULE.test(module)) {
|
|
47
|
+
return "rpc";
|
|
48
|
+
}
|
|
49
|
+
return EFFECT_MODULE.test(module) ? "effect" : "elsewhere";
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
function origin(root: ts.Identifier | undefined, scope: Scope, hops: number): Origin {
|
|
53
|
+
const binding = root === undefined ? undefined : scope.bindings.get(root.text);
|
|
54
|
+
if (binding !== undefined) {
|
|
55
|
+
return moduleOrigin(binding.module);
|
|
56
|
+
}
|
|
57
|
+
if (root !== undefined && !scope.locals.has(root.text)) {
|
|
58
|
+
return "elsewhere";
|
|
59
|
+
}
|
|
60
|
+
const value = root === undefined ? undefined : scope.locals.get(root.text);
|
|
61
|
+
return value === undefined || hops > 8 ? "value" : origin(rootIdentifier(value), scope, hops + 1);
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
// A group often arrives as an import or a parameter, so any such receiver builds handlers, except that a service tag's of shares the name and only a visible group or a member chain such as a contract's application counts for it.
|
|
65
|
+
function buildsHandlers(source: ts.SourceFile, bindings: ReadonlyMap<string, ImportBinding>): boolean {
|
|
66
|
+
const scope: Scope = { bindings, locals: localValues(source) };
|
|
67
|
+
return nodesWhere(source, ts.isCallExpression).some((call) => {
|
|
68
|
+
const callee = ts.isCallExpression(call) ? unwrapped(call.expression) : undefined;
|
|
69
|
+
if (callee === undefined || !ts.isPropertyAccessExpression(callee) || !BUILDERS.has(callee.name.text)) {
|
|
70
|
+
return false;
|
|
71
|
+
}
|
|
72
|
+
const from = origin(rootIdentifier(callee.expression), scope, 0);
|
|
73
|
+
const chained = !ts.isIdentifier(unwrapped(callee.expression));
|
|
74
|
+
return from === "rpc" || (from === "elsewhere" && (callee.name.text !== "of" || chained));
|
|
75
|
+
});
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
function boundaryCalled(call: ts.CallExpression, bindings: ReadonlyMap<string, ImportBinding>): string | undefined {
|
|
79
|
+
const callee = unwrapped(call.expression);
|
|
80
|
+
if (ts.isIdentifier(callee)) {
|
|
81
|
+
const binding = bindings.get(callee.text);
|
|
82
|
+
return binding !== undefined && BOUNDARIES.get(binding.module) === binding.imported ? binding.imported : undefined;
|
|
83
|
+
}
|
|
84
|
+
const namespace = ts.isPropertyAccessExpression(callee) && ts.isIdentifier(callee.expression) ? bindings.get(callee.expression.text) : undefined;
|
|
85
|
+
return namespace?.imported === "*" && BOUNDARIES.get(namespace.module) === memberName(callee) ? memberName(callee) : undefined;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
function findings(file: SourceFile): readonly Finding[] {
|
|
89
|
+
const source = isTestSupport(file.path) || !file.text.includes("rpcBoundary") ? undefined : parse(file);
|
|
90
|
+
if (source === undefined) {
|
|
91
|
+
return [];
|
|
92
|
+
}
|
|
93
|
+
const bindings = importBindings(source);
|
|
94
|
+
if (![...bindings.values()].some((binding) => BOUNDARIES.has(binding.module)) || buildsHandlers(source, bindings)) {
|
|
95
|
+
return [];
|
|
96
|
+
}
|
|
97
|
+
return nodesWhere(source, ts.isCallExpression).flatMap((call) => {
|
|
98
|
+
const name = ts.isCallExpression(call) ? boundaryCalled(call, bindings) : undefined;
|
|
99
|
+
return name === undefined
|
|
100
|
+
? []
|
|
101
|
+
: [
|
|
102
|
+
findingAt(
|
|
103
|
+
source,
|
|
104
|
+
call,
|
|
105
|
+
`Uses ${name} outside a module that builds RPC handlers. Move the boundary into the module calling the RPC group's toLayer, toLayerHandler, toHandlers or of; services must keep their own typed failures.`,
|
|
106
|
+
),
|
|
107
|
+
];
|
|
108
|
+
});
|
|
109
|
+
}
|
|
3
110
|
|
|
4
111
|
export const rpcBoundary = defineRule({
|
|
5
|
-
check:
|
|
112
|
+
check: ({ sources }) => sources.flatMap(findings),
|
|
6
113
|
description:
|
|
7
|
-
"Apply rpcBoundary and rpcBoundaryHandlers only in modules building native RPC handlers; services keep their typed failures. Test-support kits
|
|
114
|
+
"Apply rpcBoundary and rpcBoundaryHandlers, imported from @shivaedev/errors, only in modules building native RPC handlers; services keep their typed failures. Test-support kits are accepted. No config exceptions or inline suppressions; baseline existing debt.",
|
|
8
115
|
id: "effect/rpc-boundary",
|
|
9
116
|
registrable: false,
|
|
10
117
|
});
|
|
@@ -1,8 +1,9 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { serviceModelCheck } from "#adapters/serviceModelCheck.ts";
|
|
2
2
|
import { defineRule } from "#rule.ts";
|
|
3
|
+
import { rootedFindings } from "#rules/rootedFindings.ts";
|
|
3
4
|
|
|
4
5
|
export const serviceModel = defineRule({
|
|
5
|
-
check:
|
|
6
|
+
check: (inputs) => rootedFindings(inputs, serviceModelCheck),
|
|
6
7
|
description:
|
|
7
8
|
"defineService initializer state owns lifetime state, never dependencies. Every inventoried operation, including factory returns and piped bodies, is a sibling Effect.fn export with its Service.operation span. Dependencies and the caller come from the environment; the Layer registration chooses lifetime.",
|
|
8
9
|
id: "effect/service-model",
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { Effect } from "effect";
|
|
2
|
+
import { readPackageManifest } from "#adapters/manifestInventory.ts";
|
|
3
|
+
import { workspacePackages } from "#imports/workspace.ts";
|
|
4
|
+
import type { RuleInputs, SourceFile, TypeScriptProgram } from "#rule.ts";
|
|
5
|
+
import { serviceCatalog } from "#rules/effect/serviceCatalog.ts";
|
|
6
|
+
import { serviceFindings } from "#rules/effect/serviceFindings.ts";
|
|
7
|
+
|
|
8
|
+
export const serviceParameterCheck = Effect.fn("Services.serviceParameterCheck")(function* (inputs: RuleInputs) {
|
|
9
|
+
const packages = yield* workspacePackages(inputs);
|
|
10
|
+
const root = yield* readPackageManifest(inputs.readText, "package.json");
|
|
11
|
+
const names = [...packages.map((owner) => owner.name), ...(root?.name === undefined ? [] : [root.name])];
|
|
12
|
+
return {
|
|
13
|
+
checks: (file: SourceFile) => !/(?:^|\/)test-support\//u.test(file.path),
|
|
14
|
+
findings: (files: readonly SourceFile[], { checker, program, sourceFile }: TypeScriptProgram) =>
|
|
15
|
+
serviceFindings(
|
|
16
|
+
inputs.root,
|
|
17
|
+
files.flatMap((file) => sourceFile(file.path) ?? []),
|
|
18
|
+
checker,
|
|
19
|
+
serviceCatalog(program, checker, names),
|
|
20
|
+
),
|
|
21
|
+
};
|
|
22
|
+
});
|
|
@@ -1,43 +1,11 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import { readPackageManifest } from "#adapters/manifestInventory.ts";
|
|
4
|
-
import { packageOf, workspacePackages } from "#imports/workspace.ts";
|
|
5
|
-
import { defineRule, type Finding, type RuleInputs } from "#rule.ts";
|
|
6
|
-
import { effectPrograms } from "#rules/effect/program.ts";
|
|
7
|
-
import { serviceCatalog } from "#rules/effect/serviceCatalog.ts";
|
|
8
|
-
import { serviceFindings } from "#rules/effect/serviceFindings.ts";
|
|
1
|
+
import { defineRule } from "#rule.ts";
|
|
2
|
+
import { packageFindings } from "#rules/packageFindings.ts";
|
|
9
3
|
|
|
10
4
|
export const serviceParameters = defineRule({
|
|
11
|
-
check:
|
|
12
|
-
|
|
13
|
-
const root = yield* readPackageManifest(inputs.readText, "package.json");
|
|
14
|
-
const names = [...packages.map((owner) => owner.name), ...(root?.name === undefined ? [] : [root.name])];
|
|
15
|
-
const groups = new Map<string, RuleInputs["sources"][number][]>();
|
|
16
|
-
for (const source of inputs.sources) {
|
|
17
|
-
if (/(?:^|\/)test-support\//u.test(source.path)) {
|
|
18
|
-
continue;
|
|
19
|
-
}
|
|
20
|
-
const group = packageOf(packages, source.path)?.directory ?? ".";
|
|
21
|
-
const files = groups.get(group) ?? [];
|
|
22
|
-
files.push(source);
|
|
23
|
-
groups.set(group, files);
|
|
24
|
-
}
|
|
25
|
-
const programs = effectPrograms(inputs);
|
|
26
|
-
const findings: Finding[] = [];
|
|
27
|
-
for (const files of groups.values()) {
|
|
28
|
-
const program = programs.create(files);
|
|
29
|
-
const checker = program.getTypeChecker();
|
|
30
|
-
const sources = files.flatMap((file) => {
|
|
31
|
-
const source = program.getSourceFile(join(inputs.root, file.path));
|
|
32
|
-
return source === undefined ? [] : [source];
|
|
33
|
-
});
|
|
34
|
-
findings.push(...serviceFindings(inputs.root, sources, checker, serviceCatalog(program, checker, names)));
|
|
35
|
-
programs.release();
|
|
36
|
-
}
|
|
37
|
-
return findings;
|
|
38
|
-
}),
|
|
5
|
+
check: (inputs) => packageFindings(inputs, "effect/service-parameters"),
|
|
6
|
+
depth: "deep",
|
|
39
7
|
description:
|
|
40
|
-
"Exported and local functions and public methods take services from Effect's environment, including aliases, constraints, inferred/destructured parameters and factory returns. Service keys/classes, non-empty Contexts and implementation shapes are services; Effect/Stream requirements are computations. Service implementation methods, framework callbacks, module-level React components and their props, owned initializer state, foreign host callbacks in object literals and classes, owned foreign
|
|
8
|
+
"Exported and local functions and public methods take services from Effect's environment, including aliases, constraints, inferred/destructured parameters and factory returns. Service keys/classes, non-empty Contexts and implementation shapes are services; Effect/Stream requirements are computations. Service implementation methods, framework callbacks, module-level React components and their props, owned initializer state, foreign host callbacks in object literals and classes, owned foreign resources, Layer constructors, registries and RPC clients held by plain functions outside Effect bodies, and tags only handed to middleware declarations or Context.pick, besides comparing them with undefined or null, are accepted. Within Effect code, test-support/ folders are exempt. adapters/ folders still follow this rule and the ambient runtime bans. No config exceptions or inline suppressions; baseline existing debt.",
|
|
41
9
|
id: "effect/service-parameters",
|
|
42
10
|
registrable: false,
|
|
43
11
|
});
|
|
@@ -1,8 +1,46 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
1
|
+
import { Effect } from "effect";
|
|
2
|
+
import { type SharedErrorCatalog, sharedErrorCatalog } from "#adapters/sharedErrorCatalog.ts";
|
|
3
|
+
import { defineRule, type Finding, type SourceFile } from "#rule.ts";
|
|
4
|
+
import { taggedClasses } from "#rules/effect/errorTags.ts";
|
|
5
|
+
import { parse } from "#rules/parse.ts";
|
|
6
|
+
import { findingAt } from "#rules/stories/syntax.ts";
|
|
7
|
+
|
|
8
|
+
function declaresErrors(source: SourceFile): boolean {
|
|
9
|
+
return /\bclass\b/u.test(source.text) && /TaggedError|_tag|@shivaedev\/errors/u.test(source.text);
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
function findings(file: SourceFile, catalog: SharedErrorCatalog): readonly Finding[] {
|
|
13
|
+
const source = parse(file);
|
|
14
|
+
if (source === undefined) {
|
|
15
|
+
return [];
|
|
16
|
+
}
|
|
17
|
+
const classes = taggedClasses(source, (binding, member) =>
|
|
18
|
+
catalog.tagOf(binding.module, binding.imported === "*" ? (member ?? "") : binding.imported),
|
|
19
|
+
);
|
|
20
|
+
return classes.flatMap(({ name, node, tag }) => {
|
|
21
|
+
const shared = catalog.byTag.get(tag);
|
|
22
|
+
return shared === undefined || (shared.path === file.path && shared.name === name)
|
|
23
|
+
? []
|
|
24
|
+
: [
|
|
25
|
+
findingAt(
|
|
26
|
+
source,
|
|
27
|
+
node,
|
|
28
|
+
`Tagged error ${name ?? "anonymous class"} reuses the shared tag "${tag}". Import ${shared.name} from "${shared.specifier}" and use that class instead.`,
|
|
29
|
+
),
|
|
30
|
+
];
|
|
31
|
+
});
|
|
32
|
+
}
|
|
3
33
|
|
|
4
34
|
export const sharedErrorClasses = defineRule({
|
|
5
|
-
check:
|
|
35
|
+
check: (inputs) =>
|
|
36
|
+
Effect.gen(function* () {
|
|
37
|
+
const sources = inputs.sources.filter(declaresErrors);
|
|
38
|
+
if (sources.length === 0) {
|
|
39
|
+
return [];
|
|
40
|
+
}
|
|
41
|
+
const catalog = yield* sharedErrorCatalog({ ...inputs, sources });
|
|
42
|
+
return catalog.byTag.size === 0 ? [] : sources.flatMap((file) => findings(file, catalog));
|
|
43
|
+
}),
|
|
6
44
|
description:
|
|
7
45
|
"A tagged error with a tag exported by @shivaedev/errors must use that exported class. Import the shared class instead of declaring another error or subclass with its tag.",
|
|
8
46
|
id: "effect/shared-error-classes",
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { join } from "node:path";
|
|
2
|
+
import { Effect } from "effect";
|
|
3
|
+
import ts from "typescript";
|
|
4
|
+
import { DeclarationFiles } from "#adapters/declaration-files/service.ts";
|
|
5
|
+
import { projectsFor } from "#adapters/imports/projects.ts";
|
|
6
|
+
import type { RuleInputs } from "#rule.ts";
|
|
7
|
+
|
|
8
|
+
// Imports of installed packages stay unresolved: these rules judge the repository's own code and treat outside libraries as untyped.
|
|
9
|
+
export const workspaceProgram = Effect.fn("WorkspaceProgram.workspaceProgram")(function* (inputs: RuleInputs) {
|
|
10
|
+
const projectOf = projectsFor(inputs.root);
|
|
11
|
+
const options: ts.CompilerOptions = {
|
|
12
|
+
allowJs: true,
|
|
13
|
+
jsx: ts.JsxEmit.Preserve,
|
|
14
|
+
skipLibCheck: true,
|
|
15
|
+
strict: true,
|
|
16
|
+
target: ts.ScriptTarget.ESNext,
|
|
17
|
+
types: [],
|
|
18
|
+
};
|
|
19
|
+
const host = ts.createCompilerHost(options);
|
|
20
|
+
const texts = new Map(inputs.sources.map((source) => [join(inputs.root, source.path), source.text]));
|
|
21
|
+
const read = host.readFile;
|
|
22
|
+
host.readFile = (path) => texts.get(path) ?? read(path);
|
|
23
|
+
host.resolveModuleNames = (names, from) =>
|
|
24
|
+
names.map((name) => {
|
|
25
|
+
if (!(name.startsWith(".") || name.startsWith("#") || name.startsWith("@shivaedev/"))) {
|
|
26
|
+
return undefined;
|
|
27
|
+
}
|
|
28
|
+
const project = projectOf(from);
|
|
29
|
+
return ts.resolveModuleName(name, from, project.typesOptions, host, project.typesCache).resolvedModule;
|
|
30
|
+
});
|
|
31
|
+
const declarations = yield* DeclarationFiles;
|
|
32
|
+
host.getSourceFile = yield* declarations.reader(host, options);
|
|
33
|
+
return ts.createProgram([...texts.keys()], options, host);
|
|
34
|
+
});
|
|
@@ -11,11 +11,13 @@ import { knownDataExports } from "#naming/adapters/plainData.ts";
|
|
|
11
11
|
import { constantModule } from "#naming/constantModule.ts";
|
|
12
12
|
import { exportFits } from "#naming/exportFits.ts";
|
|
13
13
|
import { isMigrationFile } from "#naming/isMigrationFile.ts";
|
|
14
|
+
import { isOperationFile } from "#naming/isOperationFile.ts";
|
|
14
15
|
import { mainExport } from "#naming/mainExport.ts";
|
|
15
16
|
import { moduleRoot } from "#naming/moduleRoot.ts";
|
|
16
17
|
import { ownExports } from "#naming/ownExports.ts";
|
|
17
18
|
import { type PackageLayout, packageLayout } from "#naming/packageLayout.ts";
|
|
18
|
-
import {
|
|
19
|
+
import { repeatedFolder } from "#naming/repeatedFolder.ts";
|
|
20
|
+
import { CAMEL, KEBAB } from "#naming/words.ts";
|
|
19
21
|
import { defineRule, type Finding, type SourceFile } from "#rule.ts";
|
|
20
22
|
import { parse } from "#rules/parse.ts";
|
|
21
23
|
|
|
@@ -36,14 +38,6 @@ function stemOf(path: string): string {
|
|
|
36
38
|
return posix.basename(path).replace(/\.[^.]+$/u, "");
|
|
37
39
|
}
|
|
38
40
|
|
|
39
|
-
function repeated(stem: string, folders: readonly string[]): string | undefined {
|
|
40
|
-
if (folders.at(-1) === stem) {
|
|
41
|
-
return undefined;
|
|
42
|
-
}
|
|
43
|
-
const words = wordsOf(stem);
|
|
44
|
-
return folders.find((folder) => wordsOf(folder).some((word) => words.some((own) => sameWord(own, word))));
|
|
45
|
-
}
|
|
46
|
-
|
|
47
41
|
function nameFinding(file: SourceFile, stem: string, folders: readonly string[]): string | undefined {
|
|
48
42
|
const source = parse(file);
|
|
49
43
|
const exports = source === undefined ? [] : ownExports(source);
|
|
@@ -85,8 +79,12 @@ function nameFinding(file: SourceFile, stem: string, folders: readonly string[])
|
|
|
85
79
|
}
|
|
86
80
|
|
|
87
81
|
function findingsOf(file: SourceFile, layout: PackageLayout): readonly Finding[] {
|
|
88
|
-
const source =
|
|
89
|
-
if (
|
|
82
|
+
const source = parse(file);
|
|
83
|
+
if (
|
|
84
|
+
posix.basename(file.path) === "service.ts"
|
|
85
|
+
&& source !== undefined
|
|
86
|
+
&& directServiceDefinitions(source, serviceAssemblyImports(source).definitions).length > 0
|
|
87
|
+
) {
|
|
90
88
|
return [];
|
|
91
89
|
}
|
|
92
90
|
const stem = stemOf(file.path);
|
|
@@ -103,7 +101,10 @@ function findingsOf(file: SourceFile, layout: PackageLayout): readonly Finding[]
|
|
|
103
101
|
}
|
|
104
102
|
const root = moduleRoot(file.path);
|
|
105
103
|
const admin = root === undefined ? undefined : /^(?:client|server)\/(?<path>admin\/.+)$/u.exec(file.path.slice(root.length + 1))?.groups?.path;
|
|
106
|
-
const folder =
|
|
104
|
+
const folder =
|
|
105
|
+
source !== undefined && isOperationFile(source)
|
|
106
|
+
? undefined
|
|
107
|
+
: repeatedFolder(stem, admin === undefined ? folders : posix.dirname(admin).split("/"));
|
|
107
108
|
const messages = [
|
|
108
109
|
nameFinding(file, stem, folders),
|
|
109
110
|
folder === undefined ? undefined : `"${stem}" repeats its folder "${folder}". The folder is the prefix: items/listItems.ts is items/list.ts.`,
|
|
@@ -134,7 +135,7 @@ export const namedAfterExport = defineRule({
|
|
|
134
135
|
.flatMap((file) => findingsOf(file, layout));
|
|
135
136
|
}),
|
|
136
137
|
description:
|
|
137
|
-
"A file is named after its main runtime export, ignoring private constants and plain-data constants beside it, with its folders as the prefix, including in test-support; module client/admin and server/admin files may repeat names from above the admin folder. defineService declarations use service.ts; TanStack Router configuration owns route filenames; programmatic bundler entries and tool configs keep their role names. A constants module holds only plain data and derived types, in a camelCase file named for words every constant shares (timeouts.ts), limits for max/min/limit constants, or defaults for default constants. Split unrelated constants. A file of several non-constant exports is a camelCase topic file, and a script is kebab-case. Rename the file or the export; nothing renames them for you.",
|
|
138
|
+
"A file is named after its main runtime export, ignoring private constants and plain-data constants beside it, with its folders as the prefix, including in test-support; module client/admin and server/admin files may repeat names from above the admin folder. A file named like its own folder, ignoring case and separators, does not repeat it: notes/Notes.ts exports Notes and reading-lists/ReadingLists.ts exports ReadingLists. A file whose one export is a query or command from @shivaedev/contract/operation.ts may repeat words of the folders above it: reading-lists/server/List.ts exports List. defineService declarations use service.ts; TanStack Router configuration owns route filenames; programmatic bundler entries and tool configs keep their role names. A constants module holds only plain data and derived types, in a camelCase file named for words every constant shares (timeouts.ts), limits for max/min/limit constants, or defaults for default constants. Split unrelated constants. A file of several non-constant exports is a camelCase topic file, and a script is kebab-case. Rename the file or the export; nothing renames them for you.",
|
|
138
139
|
id: "files/named-after-export",
|
|
139
140
|
options: Schema.toStandardSchemaV1(NamedAfterExportOptions, {
|
|
140
141
|
parseOptions: { errors: "all", onExcessProperty: "error" },
|
|
@@ -1,27 +1,29 @@
|
|
|
1
|
-
import { Effect
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
1
|
+
import { Effect } from "effect";
|
|
2
|
+
import { generatedFolders, generatedFrom } from "#imports/generatedFolders.ts";
|
|
3
|
+
import { importGraph, type UnresolvedImport } from "#imports/graph.ts";
|
|
4
4
|
import { defineRule } from "#rule.ts";
|
|
5
5
|
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
6
|
+
function repair(folders: readonly string[], request: UnresolvedImport): string {
|
|
7
|
+
const module = request.missing === undefined ? undefined : generatedFrom(folders, request.missing);
|
|
8
|
+
return module === undefined
|
|
9
|
+
? "Fix the path, install or declare the package, or declare the module in a .d.ts file among the sources."
|
|
10
|
+
: `The project's generate script writes ${request.missing} only when ${module} defines a module. Fix the path, or define the module there.`;
|
|
11
|
+
}
|
|
9
12
|
|
|
10
13
|
export const importsResolvable = defineRule({
|
|
11
|
-
check: Effect.fn("Imports.check")(function* (
|
|
14
|
+
check: Effect.fn("Imports.check")(function* (inputs) {
|
|
12
15
|
const graph = yield* importGraph(inputs);
|
|
13
|
-
const
|
|
16
|
+
const folders = generatedFolders(graph.packages);
|
|
14
17
|
return [
|
|
15
18
|
...graph.configFindings,
|
|
16
|
-
...unresolved.map((request) => ({
|
|
19
|
+
...graph.unresolved.map((request) => ({
|
|
17
20
|
file: request.from,
|
|
18
21
|
line: request.line,
|
|
19
|
-
message: `Cannot resolve "${request.specifier}".
|
|
22
|
+
message: `Cannot resolve "${request.specifier}". ${repair(folders, request)}`,
|
|
20
23
|
subject: request.specifier,
|
|
21
24
|
})),
|
|
22
25
|
];
|
|
23
26
|
}),
|
|
24
27
|
description: "Every import resolves to a file, a package or a declared module, so no edge of the import graph goes unchecked.",
|
|
25
28
|
id: "imports/resolvable",
|
|
26
|
-
options: Schema.toStandardSchemaV1(ResolvableOptions, { parseOptions: { errors: "all", onExcessProperty: "error" } }),
|
|
27
29
|
});
|