@shivaedev/quality 0.45.0 → 0.46.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 +36 -0
- package/README.md +13 -7
- package/dist/PackageManifest.d.ts +25 -0
- package/dist/PackageManifest.d.ts.map +1 -0
- package/dist/PackageManifest.js +21 -0
- package/dist/PackageManifest.js.map +1 -0
- package/dist/adapters/TestOutput.d.ts +8 -0
- package/dist/adapters/TestOutput.d.ts.map +1 -0
- package/dist/adapters/TestOutput.js +5 -0
- package/dist/adapters/TestOutput.js.map +1 -0
- package/dist/adapters/knip/configuration.d.ts.map +1 -1
- package/dist/adapters/knip/configuration.js +2 -9
- package/dist/adapters/knip/configuration.js.map +1 -1
- package/dist/adapters/knip/entryPointFindings.d.ts.map +1 -1
- package/dist/adapters/knip/entryPointFindings.js +2 -1
- package/dist/adapters/knip/entryPointFindings.js.map +1 -1
- package/dist/adapters/knip/run.d.ts +3 -1
- package/dist/adapters/knip/run.d.ts.map +1 -1
- package/dist/adapters/knip/run.js +8 -8
- package/dist/adapters/knip/run.js.map +1 -1
- package/dist/adapters/manifestInventory.d.ts +23 -0
- package/dist/adapters/manifestInventory.d.ts.map +1 -0
- package/dist/adapters/manifestInventory.js +63 -0
- package/dist/adapters/manifestInventory.js.map +1 -0
- package/dist/adapters/manifestReader.d.ts +3 -0
- package/dist/adapters/manifestReader.d.ts.map +1 -0
- package/dist/adapters/manifestReader.js +8 -0
- package/dist/adapters/manifestReader.js.map +1 -0
- package/dist/adapters/testProjects.d.ts.map +1 -0
- package/dist/{testProjects.js → adapters/testProjects.js} +4 -3
- package/dist/adapters/testProjects.js.map +1 -0
- package/dist/appTestConfig.d.ts +1 -1
- package/dist/appTestConfig.d.ts.map +1 -1
- package/dist/appTestConfig.js +1 -1
- package/dist/appTestConfig.js.map +1 -1
- package/dist/baseline/format.js +2 -2
- package/dist/baseline/format.js.map +1 -1
- package/dist/baseline/legacy.js +2 -2
- package/dist/baseline/legacy.js.map +1 -1
- package/dist/baseline/merge.js +1 -1
- package/dist/baseline/merge.js.map +1 -1
- package/dist/baseline/shards.js +1 -1
- package/dist/baseline/shards.js.map +1 -1
- package/dist/biome/exceptionConfig.d.ts +7 -1
- package/dist/biome/exceptionConfig.d.ts.map +1 -1
- package/dist/biome/exceptionConfig.js +11 -25
- package/dist/biome/exceptionConfig.js.map +1 -1
- package/dist/biome/recommendedRules.d.ts +2 -1
- package/dist/biome/recommendedRules.d.ts.map +1 -1
- package/dist/biome/recommendedRules.js +10 -13
- package/dist/biome/recommendedRules.js.map +1 -1
- package/dist/biome/relocateConfig.d.ts +6 -0
- package/dist/biome/relocateConfig.d.ts.map +1 -0
- package/dist/biome/relocateConfig.js +49 -0
- package/dist/biome/relocateConfig.js.map +1 -0
- package/dist/biome/report.d.ts +27 -3
- package/dist/biome/report.d.ts.map +1 -1
- package/dist/biome/report.js +12 -10
- package/dist/biome/report.js.map +1 -1
- package/dist/biome/run.d.ts +12 -2
- package/dist/biome/run.d.ts.map +1 -1
- package/dist/biome/run.js +11 -15
- package/dist/biome/run.js.map +1 -1
- package/dist/biome/withoutEntryPointImports.d.ts.map +1 -1
- package/dist/biome/withoutEntryPointImports.js +2 -12
- package/dist/biome/withoutEntryPointImports.js.map +1 -1
- package/dist/cli/baseline.d.ts +4 -3
- package/dist/cli/baseline.d.ts.map +1 -1
- package/dist/cli/baseline.js.map +1 -1
- package/dist/cli/fix.d.ts +2 -1
- package/dist/cli/fix.d.ts.map +1 -1
- package/dist/cli/fix.js +3 -9
- package/dist/cli/fix.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.map +1 -1
- package/dist/cli/migrateBaseline.d.ts +3 -2
- package/dist/cli/migrateBaseline.d.ts.map +1 -1
- package/dist/cli/migrateBaseline.js +2 -2
- package/dist/cli/migrateBaseline.js.map +1 -1
- package/dist/cli/migrateExceptions.d.ts.map +1 -1
- package/dist/cli/migrateExceptions.js +6 -4
- package/dist/cli/migrateExceptions.js.map +1 -1
- package/dist/cli/program.d.ts +1 -1
- package/dist/cli/program.d.ts.map +1 -1
- package/dist/config/decode.d.ts +1 -1
- package/dist/config/decode.d.ts.map +1 -1
- package/dist/config/decode.js +1 -2
- package/dist/config/decode.js.map +1 -1
- package/dist/config/load.js +2 -2
- package/dist/config/load.js.map +1 -1
- package/dist/config/resolve.d.ts +1 -1
- package/dist/decoded.d.ts +2 -3
- package/dist/decoded.d.ts.map +1 -1
- package/dist/decoded.js +6 -4
- package/dist/decoded.js.map +1 -1
- package/dist/docs/documentedModule.d.ts +0 -2
- package/dist/docs/documentedModule.d.ts.map +1 -1
- package/dist/docs/documentedModule.js +0 -3
- package/dist/docs/documentedModule.js.map +1 -1
- package/dist/docs/importFindings.d.ts.map +1 -1
- package/dist/docs/importFindings.js +0 -3
- package/dist/docs/importFindings.js.map +1 -1
- package/dist/engine/baselineFile.js +2 -2
- package/dist/engine/baselineFile.js.map +1 -1
- package/dist/engine/runRules.d.ts +3 -4
- package/dist/engine/runRules.d.ts.map +1 -1
- package/dist/engine/runRules.js +23 -8
- package/dist/engine/runRules.js.map +1 -1
- package/dist/engine/session.d.ts +4 -3
- package/dist/engine/session.d.ts.map +1 -1
- package/dist/engine/session.js +6 -7
- package/dist/engine/session.js.map +1 -1
- package/dist/exceptions/declaration.js +2 -2
- package/dist/exceptions/declaration.js.map +1 -1
- package/dist/exceptions/registry.d.ts.map +1 -1
- package/dist/exceptions/registry.js +2 -4
- package/dist/exceptions/registry.js.map +1 -1
- package/dist/failure.d.ts +5 -0
- package/dist/failure.d.ts.map +1 -1
- package/dist/failure.js +4 -0
- package/dist/failure.js.map +1 -1
- package/dist/git/command.js +1 -1
- package/dist/git/command.js.map +1 -1
- package/dist/hooks/install.js +2 -2
- package/dist/hooks/install.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 +10 -11
- package/dist/hooks/preCommit.js.map +1 -1
- package/dist/hooks/status.js +1 -1
- package/dist/hooks/status.js.map +1 -1
- package/dist/hooks/uninstall.js +3 -3
- package/dist/hooks/uninstall.js.map +1 -1
- package/dist/imports/classifyRuntime.d.ts +10 -0
- package/dist/imports/classifyRuntime.d.ts.map +1 -0
- package/dist/imports/classifyRuntime.js +22 -0
- package/dist/imports/classifyRuntime.js.map +1 -0
- package/dist/imports/fences/declarations.d.ts.map +1 -1
- package/dist/imports/fences/declarations.js +1 -2
- package/dist/imports/fences/declarations.js.map +1 -1
- package/dist/imports/pnpmWorkspacePatterns.d.ts.map +1 -1
- package/dist/imports/pnpmWorkspacePatterns.js +2 -1
- package/dist/imports/pnpmWorkspacePatterns.js.map +1 -1
- package/dist/imports/runtime.d.ts +4 -3
- package/dist/imports/runtime.d.ts.map +1 -1
- package/dist/imports/runtime.js +35 -64
- package/dist/imports/runtime.js.map +1 -1
- package/dist/imports/workspace.d.ts.map +1 -1
- package/dist/imports/workspace.js +9 -19
- package/dist/imports/workspace.js.map +1 -1
- package/dist/inventory/collect.d.ts +1 -0
- package/dist/inventory/collect.d.ts.map +1 -1
- package/dist/inventory/collect.js +2 -1
- package/dist/inventory/collect.js.map +1 -1
- package/dist/inventory/filesystem.d.ts.map +1 -1
- package/dist/inventory/filesystem.js +2 -8
- package/dist/inventory/filesystem.js.map +1 -1
- package/dist/manifests/entryPoints.d.ts.map +1 -1
- package/dist/manifests/entryPoints.js +2 -12
- package/dist/manifests/entryPoints.js.map +1 -1
- package/dist/manifests/sorted.d.ts +2 -3
- package/dist/manifests/sorted.d.ts.map +1 -1
- package/dist/manifests/sorted.js +14 -8
- package/dist/manifests/sorted.js.map +1 -1
- package/dist/naming/packageLayout.d.ts.map +1 -1
- package/dist/naming/packageLayout.js +2 -12
- package/dist/naming/packageLayout.js.map +1 -1
- package/dist/rule.d.ts +15 -10
- package/dist/rule.d.ts.map +1 -1
- package/dist/rule.js +9 -1
- package/dist/rule.js.map +1 -1
- package/dist/rules/biome.d.ts.map +1 -1
- package/dist/rules/biome.js +7 -4
- package/dist/rules/biome.js.map +1 -1
- package/dist/rules/builtIn.d.ts +14 -14
- package/dist/rules/builtIn.d.ts.map +1 -1
- package/dist/rules/builtIn.js +2 -0
- package/dist/rules/builtIn.js.map +1 -1
- package/dist/rules/comments/maxPerFile.d.ts +1 -1
- package/dist/rules/comments/maxPerFile.d.ts.map +1 -1
- package/dist/rules/comments/noBanner.d.ts +1 -1
- package/dist/rules/comments/noBanner.d.ts.map +1 -1
- package/dist/rules/comments/noEnvironmentPragma.d.ts +1 -1
- package/dist/rules/comments/noEnvironmentPragma.d.ts.map +1 -1
- package/dist/rules/comments/noEnvironmentPragma.js +1 -1
- package/dist/rules/comments/noEnvironmentPragma.js.map +1 -1
- package/dist/rules/comments/noJsdoc.d.ts +1 -1
- package/dist/rules/comments/noJsdoc.d.ts.map +1 -1
- package/dist/rules/comments/noLineReference.d.ts +1 -1
- package/dist/rules/comments/noLineReference.d.ts.map +1 -1
- package/dist/rules/comments/noPrReference.d.ts +1 -1
- package/dist/rules/comments/noPrReference.d.ts.map +1 -1
- package/dist/rules/comments/noTodo.d.ts +1 -1
- package/dist/rules/comments/noTodo.d.ts.map +1 -1
- package/dist/rules/docs/references.d.ts +1 -1
- package/dist/rules/docs/references.d.ts.map +1 -1
- package/dist/rules/docs/references.js +5 -8
- package/dist/rules/docs/references.js.map +1 -1
- package/dist/rules/docs/unversionedInstalls.d.ts +1 -1
- package/dist/rules/docs/unversionedInstalls.d.ts.map +1 -1
- package/dist/rules/docs/unversionedInstalls.js +1 -1
- package/dist/rules/docs/unversionedInstalls.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/serviceParameters.d.ts +1 -1
- package/dist/rules/effect/serviceParameters.d.ts.map +1 -1
- package/dist/rules/effect/serviceTypes.d.ts.map +1 -1
- package/dist/rules/effect/serviceTypes.js +10 -0
- package/dist/rules/effect/serviceTypes.js.map +1 -1
- package/dist/rules/files/distinctCase.d.ts +1 -1
- package/dist/rules/files/distinctCase.d.ts.map +1 -1
- package/dist/rules/files/folderNames.d.ts +1 -1
- package/dist/rules/files/folderNames.d.ts.map +1 -1
- package/dist/rules/files/namedAfterExport.d.ts +1 -1
- package/dist/rules/files/namedAfterExport.d.ts.map +1 -1
- package/dist/rules/files/otherNames.d.ts +1 -1
- package/dist/rules/files/otherNames.d.ts.map +1 -1
- package/dist/rules/files/packageImports.d.ts.map +1 -1
- package/dist/rules/files/packageImports.js +2 -13
- package/dist/rules/files/packageImports.js.map +1 -1
- package/dist/rules/imports/aliased.d.ts +1 -1
- package/dist/rules/imports/aliased.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/manifest.js +14 -32
- package/dist/rules/imports/manifest.js.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 -1
- package/dist/rules/imports/resolvable.d.ts.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 +29 -25
- package/dist/rules/imports/runtime.js.map +1 -1
- package/dist/rules/manifestsApplication.d.ts +1 -1
- package/dist/rules/manifestsApplication.d.ts.map +1 -1
- package/dist/rules/manifestsApplication.js +2 -12
- package/dist/rules/manifestsApplication.js.map +1 -1
- package/dist/rules/manifestsExportsShape.d.ts +1 -1
- package/dist/rules/manifestsExportsShape.d.ts.map +1 -1
- package/dist/rules/manifestsExportsShape.js +12 -7
- package/dist/rules/manifestsExportsShape.js.map +1 -1
- package/dist/rules/manifestsSorted.d.ts +1 -1
- package/dist/rules/manifestsSorted.d.ts.map +1 -1
- package/dist/rules/manifestsSorted.js +10 -14
- package/dist/rules/manifestsSorted.js.map +1 -1
- package/dist/rules/manifestsSourceFirst.d.ts +1 -1
- package/dist/rules/manifestsSourceFirst.d.ts.map +1 -1
- package/dist/rules/manifestsSourceFirst.js +20 -23
- package/dist/rules/manifestsSourceFirst.js.map +1 -1
- package/dist/rules/manifestsValid.d.ts +2 -0
- package/dist/rules/manifestsValid.d.ts.map +1 -0
- package/dist/rules/manifestsValid.js +10 -0
- package/dist/rules/manifestsValid.js.map +1 -0
- package/dist/rules/maxDepth.d.ts +1 -1
- package/dist/rules/maxDepth.d.ts.map +1 -1
- package/dist/rules/maxLines.d.ts +1 -1
- package/dist/rules/maxLines.d.ts.map +1 -1
- package/dist/rules/noBarrel.d.ts +1 -1
- package/dist/rules/noBarrel.d.ts.map +1 -1
- package/dist/rules/react/jsxConditionals.d.ts +1 -1
- package/dist/rules/react/jsxConditionals.d.ts.map +1 -1
- package/dist/rules/stories/authSql.d.ts +1 -1
- package/dist/rules/stories/authSql.d.ts.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 +3 -3
- 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/groupedOutcomes.d.ts +1 -1
- package/dist/rules/stories/groupedOutcomes.d.ts.map +1 -1
- package/dist/rules/stories/groupedOutcomes.js +2 -2
- package/dist/rules/stories/groupedOutcomes.js.map +1 -1
- package/dist/rules/stories/httpStatus.d.ts +1 -1
- package/dist/rules/stories/httpStatus.d.ts.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/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/prerequisites.d.ts.map +1 -1
- package/dist/rules/stories/prerequisites.js +3 -6
- package/dist/rules/stories/prerequisites.js.map +1 -1
- package/dist/rules/stories/queueSql.d.ts +1 -1
- package/dist/rules/stories/queueSql.d.ts.map +1 -1
- package/dist/rules/stories/setup.d.ts +1 -1
- package/dist/rules/stories/setup.d.ts.map +1 -1
- package/dist/rules/stories/sources.d.ts +4 -0
- package/dist/rules/stories/sources.d.ts.map +1 -0
- package/dist/rules/stories/{specSources.js → sources.js} +6 -6
- package/dist/rules/stories/sources.js.map +1 -0
- package/dist/rules/stories/specHelpers.d.ts +1 -1
- package/dist/rules/stories/specHelpers.d.ts.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/waitOnEvents.d.ts +1 -1
- package/dist/rules/stories/waitOnEvents.d.ts.map +1 -1
- package/dist/rules/stories/waitOnEvents.js +4 -4
- package/dist/rules/stories/waitOnEvents.js.map +1 -1
- package/dist/rules/suppressions/biome/declarations.d.ts.map +1 -1
- package/dist/rules/suppressions/biome/declarations.js +2 -4
- package/dist/rules/suppressions/biome/declarations.js.map +1 -1
- package/dist/rules/suppressions/biome/resolvePackage.d.ts.map +1 -1
- package/dist/rules/suppressions/biome/resolvePackage.js +3 -15
- package/dist/rules/suppressions/biome/resolvePackage.js.map +1 -1
- package/dist/rules/suppressions/biomeOverrides.d.ts +1 -1
- package/dist/rules/suppressions/biomeOverrides.d.ts.map +1 -1
- package/dist/rules/suppressions/biomeRecommended.d.ts +6 -3
- package/dist/rules/suppressions/biomeRecommended.d.ts.map +1 -1
- package/dist/rules/suppressions/biomeRecommended.js +10 -7
- package/dist/rules/suppressions/biomeRecommended.js.map +1 -1
- package/dist/rules/suppressions/noDoubleCast.d.ts +1 -1
- package/dist/rules/suppressions/noDoubleCast.d.ts.map +1 -1
- package/dist/rules/suppressions/noIgnoreDeprecations.d.ts +1 -1
- package/dist/rules/suppressions/noIgnoreDeprecations.d.ts.map +1 -1
- package/dist/rules/suppressions/noIgnoreDeprecations.js +7 -7
- package/dist/rules/suppressions/noIgnoreDeprecations.js.map +1 -1
- package/dist/rules/suppressions/noInline.d.ts +1 -1
- package/dist/rules/suppressions/noInline.d.ts.map +1 -1
- package/dist/rules/test-names/colocated.d.ts +1 -1
- package/dist/rules/test-names/colocated.d.ts.map +1 -1
- package/dist/rules/test-names/follow.d.ts +1 -1
- package/dist/rules/test-names/follow.d.ts.map +1 -1
- package/dist/rules/unusedCode.d.ts +1 -1
- package/dist/rules/unusedCode.d.ts.map +1 -1
- package/package.json +2 -9
- package/src/PackageManifest.ts +24 -0
- package/src/adapters/TestOutput.ts +9 -0
- package/src/adapters/knip/configuration.ts +2 -10
- package/src/adapters/knip/entryPointFindings.ts +2 -1
- package/src/adapters/knip/run.ts +42 -44
- package/src/adapters/manifestInventory.ts +87 -0
- package/src/adapters/manifestReader.ts +11 -0
- package/src/{testProjects.ts → adapters/testProjects.ts} +4 -3
- package/src/appTestConfig.ts +1 -1
- package/src/baseline/format.ts +2 -2
- package/src/baseline/legacy.ts +2 -2
- package/src/baseline/merge.ts +1 -1
- package/src/baseline/shards.ts +1 -1
- package/src/biome/exceptionConfig.ts +19 -34
- package/src/biome/recommendedRules.ts +18 -16
- package/src/biome/relocateConfig.ts +59 -0
- package/src/biome/report.ts +17 -11
- package/src/biome/run.ts +22 -18
- package/src/biome/withoutEntryPointImports.ts +2 -12
- package/src/cli/baseline.ts +3 -2
- package/src/cli/fix.ts +15 -17
- package/src/cli/lint.ts +3 -2
- package/src/cli/migrateBaseline.ts +4 -3
- package/src/cli/migrateExceptions.ts +6 -4
- package/src/config/decode.ts +1 -3
- package/src/config/load.ts +2 -2
- package/src/decoded.ts +9 -5
- package/src/docs/documentedModule.ts +1 -4
- package/src/docs/importFindings.ts +0 -5
- package/src/engine/baselineFile.ts +2 -2
- package/src/engine/runRules.ts +34 -15
- package/src/engine/session.ts +11 -10
- package/src/exceptions/declaration.ts +2 -2
- package/src/exceptions/registry.ts +2 -4
- package/src/failure.ts +6 -1
- package/src/git/command.ts +1 -1
- package/src/hooks/install.ts +2 -2
- package/src/hooks/preCommit.ts +10 -16
- package/src/hooks/status.ts +1 -1
- package/src/hooks/uninstall.ts +3 -3
- package/src/imports/classifyRuntime.ts +30 -0
- package/src/imports/fences/declarations.ts +1 -3
- package/src/imports/pnpmWorkspacePatterns.ts +3 -1
- package/src/imports/runtime.ts +48 -60
- package/src/imports/workspace.ts +9 -20
- package/src/inventory/collect.ts +3 -1
- package/src/inventory/filesystem.ts +2 -10
- package/src/manifests/entryPoints.ts +2 -12
- package/src/manifests/sorted.ts +21 -9
- package/src/naming/packageLayout.ts +2 -12
- package/src/rule.ts +38 -19
- package/src/rules/biome.ts +9 -5
- package/src/rules/builtIn.ts +2 -0
- package/src/rules/comments/noEnvironmentPragma.ts +1 -1
- package/src/rules/docs/references.ts +8 -10
- package/src/rules/docs/unversionedInstalls.ts +1 -1
- package/src/rules/effect/serviceTypes.ts +13 -0
- package/src/rules/files/packageImports.ts +2 -13
- package/src/rules/imports/manifest.ts +15 -32
- package/src/rules/imports/runtime.ts +41 -35
- package/src/rules/manifestsApplication.ts +2 -12
- package/src/rules/manifestsExportsShape.ts +11 -8
- package/src/rules/manifestsSorted.ts +13 -16
- package/src/rules/manifestsSourceFirst.ts +24 -24
- package/src/rules/manifestsValid.ts +14 -0
- package/src/rules/stories/domainOutcomes.ts +3 -4
- package/src/rules/stories/groupedOutcomes.ts +2 -3
- package/src/rules/stories/prerequisites.ts +4 -8
- package/src/rules/stories/{specSources.ts → sources.ts} +5 -5
- package/src/rules/stories/waitOnEvents.ts +4 -5
- package/src/rules/suppressions/biome/declarations.ts +2 -4
- package/src/rules/suppressions/biome/resolvePackage.ts +5 -21
- package/src/rules/suppressions/biomeRecommended.ts +14 -9
- package/src/rules/suppressions/noIgnoreDeprecations.ts +11 -8
- package/dist/rules/stories/specSources.d.ts +0 -4
- package/dist/rules/stories/specSources.d.ts.map +0 -1
- package/dist/rules/stories/specSources.js.map +0 -1
- package/dist/testProjects.d.ts.map +0 -1
- package/dist/testProjects.js.map +0 -1
- /package/dist/{testProjects.d.ts → adapters/testProjects.d.ts} +0 -0
package/src/manifests/sorted.ts
CHANGED
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
import { basename, join, relative } from "node:path";
|
|
2
2
|
import { Effect, FileSystem } from "effect";
|
|
3
3
|
import { sortPackageJson } from "sort-package-json";
|
|
4
|
+
import { ManifestFailure, manifestEntry } from "#adapters/manifestInventory.ts";
|
|
5
|
+
import { manifestReader } from "#adapters/manifestReader.ts";
|
|
4
6
|
import { FilesystemFailure } from "#inventory/filesystem.ts";
|
|
5
7
|
import { posix } from "#inventory/ignoreScope.ts";
|
|
6
8
|
import { walk } from "#inventory/walk.ts";
|
|
7
9
|
|
|
8
|
-
export type Sorting = { readonly _tag: "
|
|
10
|
+
export type Sorting = { readonly _tag: "Sorted" } | { readonly _tag: "Unsorted"; readonly sorted: string };
|
|
9
11
|
|
|
10
12
|
export function manifestsIn(root: string): Effect.Effect<readonly string[], FilesystemFailure, FileSystem.FileSystem> {
|
|
11
13
|
return Effect.map(walk(root), (paths) =>
|
|
@@ -17,30 +19,40 @@ export function manifestsIn(root: string): Effect.Effect<readonly string[], File
|
|
|
17
19
|
}
|
|
18
20
|
|
|
19
21
|
export function sortingOf(text: string): Sorting {
|
|
20
|
-
try {
|
|
21
|
-
JSON.parse(text);
|
|
22
|
-
} catch {
|
|
23
|
-
return { _tag: "Invalid" };
|
|
24
|
-
}
|
|
25
22
|
const sorted = sortPackageJson(text);
|
|
26
23
|
return sorted === text ? { _tag: "Sorted" } : { _tag: "Unsorted", sorted };
|
|
27
24
|
}
|
|
28
25
|
|
|
29
26
|
export const sortManifests = Effect.fn("Manifests.sortManifests")(function* (
|
|
30
27
|
root: string,
|
|
31
|
-
): Effect.fn.Return<number, FilesystemFailure, FileSystem.FileSystem> {
|
|
28
|
+
): Effect.fn.Return<number, FilesystemFailure | ManifestFailure, FileSystem.FileSystem> {
|
|
32
29
|
const fs = yield* FileSystem.FileSystem;
|
|
33
30
|
const manifests = yield* manifestsIn(root);
|
|
31
|
+
const readText = yield* manifestReader(root);
|
|
34
32
|
const written = yield* Effect.forEach(manifests, (path) =>
|
|
35
33
|
Effect.gen(function* () {
|
|
36
34
|
const absolute = join(root, path);
|
|
37
|
-
const
|
|
35
|
+
const entry = yield* Effect.tryPromise({
|
|
36
|
+
catch: (cause) =>
|
|
37
|
+
cause instanceof ManifestFailure ? cause : new FilesystemFailure({ message: cause instanceof Error ? cause.message : String(cause), path }),
|
|
38
|
+
try: () => manifestEntry(readText, path),
|
|
39
|
+
});
|
|
40
|
+
if (entry === undefined) {
|
|
41
|
+
return false;
|
|
42
|
+
}
|
|
43
|
+
const sorting = sortingOf(entry.text);
|
|
38
44
|
if (sorting._tag !== "Unsorted") {
|
|
39
45
|
return false;
|
|
40
46
|
}
|
|
41
47
|
yield* fs.writeFileString(absolute, sorting.sorted);
|
|
42
48
|
return true;
|
|
43
|
-
}).pipe(
|
|
49
|
+
}).pipe(
|
|
50
|
+
Effect.mapError((error) =>
|
|
51
|
+
error instanceof ManifestFailure
|
|
52
|
+
? new ManifestFailure({ message: `cannot sort ${path}: ${error.message}`, path })
|
|
53
|
+
: new FilesystemFailure({ message: `cannot sort ${path}: ${error.message}`, path }),
|
|
54
|
+
),
|
|
55
|
+
),
|
|
44
56
|
);
|
|
45
57
|
return written.filter(Boolean).length;
|
|
46
58
|
});
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { posix } from "node:path";
|
|
2
|
+
import { readPackageManifest } from "#adapters/manifestInventory.ts";
|
|
2
3
|
import type { RuleInputs } from "#rule.ts";
|
|
3
4
|
|
|
4
5
|
export interface PackageLayout {
|
|
@@ -15,17 +16,6 @@ const RUNNABLE = /\.[cm]?[jt]sx?$/u;
|
|
|
15
16
|
|
|
16
17
|
const BUILT = /^dist\/(?<entry>.+)\.[cm]?js$/u;
|
|
17
18
|
|
|
18
|
-
function parsed(text: string | undefined): unknown {
|
|
19
|
-
if (text === undefined) {
|
|
20
|
-
return undefined;
|
|
21
|
-
}
|
|
22
|
-
try {
|
|
23
|
-
return JSON.parse(text);
|
|
24
|
-
} catch {
|
|
25
|
-
return undefined;
|
|
26
|
-
}
|
|
27
|
-
}
|
|
28
|
-
|
|
29
19
|
function field(value: unknown, key: string): unknown {
|
|
30
20
|
return typeof value === "object" && value !== null && key in value ? Reflect.get(value, key) : undefined;
|
|
31
21
|
}
|
|
@@ -57,7 +47,7 @@ export async function packageLayout({ files, readText }: Pick<RuleInputs, "files
|
|
|
57
47
|
const manifests = await Promise.all(
|
|
58
48
|
[...new Set(directories)].map(async (directory) => ({
|
|
59
49
|
directory: directory === "." ? "" : directory,
|
|
60
|
-
manifest:
|
|
50
|
+
manifest: await readPackageManifest(readText, directory === "" ? MANIFEST : `${directory}/${MANIFEST}`),
|
|
61
51
|
})),
|
|
62
52
|
);
|
|
63
53
|
const present = manifests.filter((entry) => entry.manifest !== undefined);
|
package/src/rule.ts
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { Effect, type FileSystem } from "effect";
|
|
2
|
+
import type { ChildProcessSpawner } from "effect/process";
|
|
1
3
|
import type { Bivariant } from "@shivaedev/types/Bivariant.ts";
|
|
2
4
|
import type { ExceptionDeclaration } from "#exceptions/declaration.ts";
|
|
3
5
|
import { describeIssue, type StandardSchemaV1 } from "./standardSchema.ts";
|
|
@@ -25,6 +27,7 @@ export interface RuleInputs {
|
|
|
25
27
|
readonly files: readonly string[];
|
|
26
28
|
readonly readText: (path: string) => Promise<string | undefined>;
|
|
27
29
|
readonly root: string;
|
|
30
|
+
readonly signal?: AbortSignal;
|
|
28
31
|
readonly sources: readonly SourceFile[];
|
|
29
32
|
}
|
|
30
33
|
|
|
@@ -32,31 +35,35 @@ export interface RuleContext<TOptions> extends RuleInputs {
|
|
|
32
35
|
readonly options: TOptions;
|
|
33
36
|
}
|
|
34
37
|
|
|
35
|
-
export type
|
|
38
|
+
export type RuleServices = FileSystem.FileSystem | ChildProcessSpawner.ChildProcessSpawner;
|
|
39
|
+
|
|
40
|
+
export type RuleCheck<TServices = RuleServices> = (inputs: RuleInputs) => Effect.Effect<Findings, unknown, TServices>;
|
|
41
|
+
|
|
42
|
+
export type Configured<TServices = RuleServices> =
|
|
36
43
|
| { readonly _tag: "Invalid"; readonly issues: readonly string[] }
|
|
37
|
-
| { readonly _tag: "Ready"; readonly check:
|
|
44
|
+
| { readonly _tag: "Ready"; readonly check: RuleCheck<TServices> };
|
|
38
45
|
|
|
39
|
-
export interface Rule<TId extends string = string, TInput = unknown> {
|
|
46
|
+
export interface Rule<TId extends string = string, TInput = unknown, TServices = RuleServices> {
|
|
40
47
|
// Bivariance keeps rules with different options in one list; configure validates its input at runtime.
|
|
41
|
-
configure: Bivariant<(options: TInput | undefined) => Promise<Configured
|
|
48
|
+
configure: Bivariant<(options: TInput | undefined) => Promise<Configured<TServices>>>;
|
|
42
49
|
readonly description: string;
|
|
43
50
|
readonly family?: boolean;
|
|
44
51
|
readonly id: TId;
|
|
45
52
|
readonly registrable?: boolean;
|
|
46
53
|
}
|
|
47
54
|
|
|
48
|
-
interface RuleDefinition<TId extends string, TOptions> {
|
|
49
|
-
readonly check: (context: RuleContext<TOptions>) => Findings | PromiseLike<Findings>;
|
|
55
|
+
interface RuleDefinition<TId extends string, TOptions, TServices> {
|
|
56
|
+
readonly check: (context: RuleContext<TOptions>) => Findings | PromiseLike<Findings> | Effect.Effect<Findings, unknown, TServices>;
|
|
50
57
|
readonly description: string;
|
|
51
58
|
readonly id: TId;
|
|
52
59
|
readonly registrable?: false;
|
|
53
60
|
}
|
|
54
61
|
|
|
55
|
-
interface RuleDefinitionWithOptions<TId extends string, TInput, TOptions> extends RuleDefinition<TId, TOptions> {
|
|
62
|
+
interface RuleDefinitionWithOptions<TId extends string, TInput, TOptions, TServices> extends RuleDefinition<TId, TOptions, TServices> {
|
|
56
63
|
readonly options: StandardSchemaV1<TInput, TOptions>;
|
|
57
64
|
}
|
|
58
65
|
|
|
59
|
-
interface RuleDefinitionWithoutOptions<TId extends string> extends RuleDefinition<TId, undefined> {
|
|
66
|
+
interface RuleDefinitionWithoutOptions<TId extends string, TServices> extends RuleDefinition<TId, undefined, TServices> {
|
|
60
67
|
readonly options?: undefined;
|
|
61
68
|
}
|
|
62
69
|
|
|
@@ -68,28 +75,40 @@ const noOptions: StandardSchemaV1<undefined, undefined> = {
|
|
|
68
75
|
},
|
|
69
76
|
};
|
|
70
77
|
|
|
71
|
-
function configureWith<TInput, TOptions>(
|
|
78
|
+
function configureWith<TInput, TOptions, TServices>(
|
|
72
79
|
schema: StandardSchemaV1<TInput, TOptions>,
|
|
73
|
-
check: RuleDefinition<string, TOptions>["check"],
|
|
80
|
+
check: RuleDefinition<string, TOptions, TServices>["check"],
|
|
74
81
|
absent: unknown,
|
|
75
82
|
) {
|
|
76
|
-
return async (options: unknown): Promise<Configured
|
|
83
|
+
return async (options: unknown): Promise<Configured<TServices>> => {
|
|
77
84
|
const result = await schema["~standard"].validate(options ?? absent);
|
|
78
85
|
if (result.issues !== undefined) {
|
|
79
86
|
return { _tag: "Invalid", issues: result.issues.map(describeIssue) };
|
|
80
87
|
}
|
|
81
88
|
const value = result.value;
|
|
82
|
-
return {
|
|
89
|
+
return {
|
|
90
|
+
_tag: "Ready",
|
|
91
|
+
check: (inputs) =>
|
|
92
|
+
Effect.scoped(
|
|
93
|
+
Effect.gen(function* () {
|
|
94
|
+
const signal = yield* Effect.abortSignal;
|
|
95
|
+
const checked = check({ ...inputs, options: value, signal });
|
|
96
|
+
return yield* Effect.isEffect(checked) ? checked : Effect.promise(() => Promise.resolve(checked));
|
|
97
|
+
}),
|
|
98
|
+
),
|
|
99
|
+
};
|
|
83
100
|
};
|
|
84
101
|
}
|
|
85
102
|
|
|
86
|
-
export function defineRule<const TId extends string, TInput, TOptions>(
|
|
87
|
-
definition: RuleDefinitionWithOptions<TId, TInput, TOptions>,
|
|
88
|
-
): Rule<TId, TInput>;
|
|
89
|
-
export function defineRule<const TId extends string
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
103
|
+
export function defineRule<const TId extends string, TInput, TOptions, TServices = never>(
|
|
104
|
+
definition: RuleDefinitionWithOptions<TId, TInput, TOptions, TServices>,
|
|
105
|
+
): Rule<TId, TInput, TServices>;
|
|
106
|
+
export function defineRule<const TId extends string, TServices = never>(
|
|
107
|
+
definition: RuleDefinitionWithoutOptions<TId, TServices>,
|
|
108
|
+
): Rule<TId, undefined, TServices>;
|
|
109
|
+
export function defineRule<const TId extends string, TInput, TOptions, TServices = never>(
|
|
110
|
+
definition: RuleDefinitionWithOptions<TId, TInput, TOptions, TServices> | RuleDefinitionWithoutOptions<TId, TServices>,
|
|
111
|
+
): Rule<TId, TInput, TServices> | Rule<TId, undefined, TServices> {
|
|
93
112
|
const configure =
|
|
94
113
|
definition.options === undefined
|
|
95
114
|
? configureWith(noOptions, definition.check, undefined)
|
package/src/rules/biome.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { Effect } from "effect";
|
|
1
2
|
import { biomeReport, type Diagnostic, FAILING } from "#biome/report.ts";
|
|
2
3
|
import { withoutEntryPointImports } from "#biome/withoutEntryPointImports.ts";
|
|
3
4
|
import { defineRule, type Finding, type Rule, type RuleInputs } from "#rule.ts";
|
|
@@ -42,11 +43,14 @@ async function presetFinding(readText: RuleInputs["readText"]): Promise<readonly
|
|
|
42
43
|
}
|
|
43
44
|
|
|
44
45
|
const bridge = defineRule({
|
|
45
|
-
check:
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
46
|
+
check: ({ exceptions, readText, root }) =>
|
|
47
|
+
Effect.gen(function* () {
|
|
48
|
+
const [preset, report] = yield* Effect.all([Effect.promise(() => presetFinding(readText)), biomeReport(root, ["check"], exceptions)], {
|
|
49
|
+
concurrency: "unbounded",
|
|
50
|
+
});
|
|
51
|
+
const failing = report.diagnostics.filter((diagnostic) => FAILING.has(diagnostic.severity));
|
|
52
|
+
return [...preset, ...(yield* Effect.promise(() => withoutEntryPointImports(readText, failing))).map(findingOf)];
|
|
53
|
+
}),
|
|
50
54
|
description:
|
|
51
55
|
"Biome's lint, format and assist findings under the shared preset, except undeclared-dependency findings for a piece that an application's entry point brings. `quality fix` applies Biome's lint fixes, unsafe ones included, its assist actions and formatting.",
|
|
52
56
|
id: "biome",
|
package/src/rules/builtIn.ts
CHANGED
|
@@ -46,6 +46,7 @@ import { manifestsApplication } from "./manifestsApplication.ts";
|
|
|
46
46
|
import { manifestsExportsShape } from "./manifestsExportsShape.ts";
|
|
47
47
|
import { manifestsSorted } from "./manifestsSorted.ts";
|
|
48
48
|
import { manifestsSourceFirst } from "./manifestsSourceFirst.ts";
|
|
49
|
+
import { manifestsValid } from "./manifestsValid.ts";
|
|
49
50
|
import { maxDepth } from "./maxDepth.ts";
|
|
50
51
|
import { maxLines } from "./maxLines.ts";
|
|
51
52
|
import { noBarrel } from "./noBarrel.ts";
|
|
@@ -81,6 +82,7 @@ export const builtInRules = [
|
|
|
81
82
|
importsManifest,
|
|
82
83
|
importsAliased,
|
|
83
84
|
noTestCode,
|
|
85
|
+
manifestsValid,
|
|
84
86
|
manifestsSorted,
|
|
85
87
|
manifestsSourceFirst,
|
|
86
88
|
manifestsExportsShape,
|
|
@@ -2,7 +2,7 @@ import { definePatternRule } from "./definePattern.ts";
|
|
|
2
2
|
|
|
3
3
|
export const noEnvironmentPragma = definePatternRule({
|
|
4
4
|
description:
|
|
5
|
-
"A test file gets its environment from its name, not from a pragma: `*.dom.test.ts` runs in a DOM, every other test in Node. `@shivaedev/quality/testProjects.ts` sets up the Vitest projects that read the name.",
|
|
5
|
+
"A test file gets its environment from its name, not from a pragma: `*.dom.test.ts` runs in a DOM, every other test in Node. `@shivaedev/quality/adapters/testProjects.ts` sets up the Vitest projects that read the name.",
|
|
6
6
|
id: "comments/no-environment-pragma",
|
|
7
7
|
message: (match) => `Sets the test environment with "${match}". Name the file *.dom.test.ts or *.dom.test.tsx instead.`,
|
|
8
8
|
patterns: [/^@(?:vitest|jest)-environment(?:-options)?(?=\s|$)/mu],
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { join, posix } from "node:path";
|
|
2
|
-
import { Effect
|
|
2
|
+
import { Effect } from "effect";
|
|
3
3
|
import ts from "typescript";
|
|
4
|
+
import { readPackageManifest } from "#adapters/manifestInventory.ts";
|
|
4
5
|
import { headingAnchors } from "#docs/headingAnchors.ts";
|
|
5
6
|
import { importFindings } from "#docs/importFindings.ts";
|
|
6
7
|
import { isDocument } from "#docs/isDocument.ts";
|
|
@@ -10,8 +11,6 @@ import { repositoryOf } from "#docs/repositoryLink.ts";
|
|
|
10
11
|
import { type WorkspacePackage, workspacePackages } from "#imports/workspace.ts";
|
|
11
12
|
import { defineRule, type Finding, type RuleInputs } from "#rule.ts";
|
|
12
13
|
|
|
13
|
-
const decodeJson = Schema.decodeUnknownOption(Schema.fromJsonString(Schema.Unknown));
|
|
14
|
-
|
|
15
14
|
function field(value: unknown, key: string): unknown {
|
|
16
15
|
return typeof value === "object" && value !== null && key in value ? Reflect.get(value, key) : undefined;
|
|
17
16
|
}
|
|
@@ -26,10 +25,6 @@ function reader(inputs: RuleInputs): (path: string) => Effect.Effect<string | un
|
|
|
26
25
|
return (path) => Effect.promise(() => inputs.readText(path));
|
|
27
26
|
}
|
|
28
27
|
|
|
29
|
-
function jsonAt(read: ReturnType<typeof reader>, path: string): Effect.Effect<unknown> {
|
|
30
|
-
return Effect.map(read(path), (text) => (text === undefined ? undefined : Option.getOrUndefined(decodeJson(text))));
|
|
31
|
-
}
|
|
32
|
-
|
|
33
28
|
function anchorsReader(read: ReturnType<typeof reader>): (path: string) => Effect.Effect<ReadonlySet<string> | undefined> {
|
|
34
29
|
const known = new Map<string, ReadonlySet<string> | undefined>();
|
|
35
30
|
return (path) =>
|
|
@@ -47,7 +42,10 @@ const references = Effect.fn("Docs.references")(function* (inputs: RuleInputs) {
|
|
|
47
42
|
const packages: readonly WorkspacePackage[] = yield* Effect.promise(() => workspacePackages(inputs));
|
|
48
43
|
const manifests = new Map(
|
|
49
44
|
yield* Effect.forEach(packages, (owner) =>
|
|
50
|
-
Effect.map(
|
|
45
|
+
Effect.map(
|
|
46
|
+
Effect.promise(() => readPackageManifest(inputs.readText, posix.join(owner.directory, "package.json"))),
|
|
47
|
+
(manifest) => [owner.name, manifest] as const,
|
|
48
|
+
),
|
|
51
49
|
),
|
|
52
50
|
);
|
|
53
51
|
const shared = {
|
|
@@ -55,7 +53,7 @@ const references = Effect.fn("Docs.references")(function* (inputs: RuleInputs) {
|
|
|
55
53
|
exports: new Map([...manifests].map(([name, manifest]) => [name, field(manifest, "exports")])),
|
|
56
54
|
packages: new Map(packages.map((owner) => [owner.name, owner])),
|
|
57
55
|
readText: read,
|
|
58
|
-
repository: repositoryOf(yield*
|
|
56
|
+
repository: repositoryOf(yield* Effect.promise(() => readPackageManifest(inputs.readText, "package.json"))),
|
|
59
57
|
root: inputs.root,
|
|
60
58
|
};
|
|
61
59
|
const documents = inputs.files.filter((file) => isDocument(file) && !isLink(inputs.root, file));
|
|
@@ -76,7 +74,7 @@ const references = Effect.fn("Docs.references")(function* (inputs: RuleInputs) {
|
|
|
76
74
|
});
|
|
77
75
|
|
|
78
76
|
export const docsReferences = defineRule({
|
|
79
|
-
check:
|
|
77
|
+
check: references,
|
|
80
78
|
description:
|
|
81
79
|
"Links, heading anchors and documented modules and exports in Markdown resolve, so documentation cannot point at a file, a heading or an API that no longer exists.",
|
|
82
80
|
id: "docs/references",
|
|
@@ -46,7 +46,7 @@ const unversionedInstalls = Effect.fn("Docs.unversionedInstalls")(function* (inp
|
|
|
46
46
|
});
|
|
47
47
|
|
|
48
48
|
export const docsUnversionedInstalls = defineRule({
|
|
49
|
-
check:
|
|
49
|
+
check: unversionedInstalls,
|
|
50
50
|
description:
|
|
51
51
|
"Install commands in Markdown name packages without versions, so documentation never tells a reader to install a release it has already left behind.",
|
|
52
52
|
id: "docs/unversioned-installs",
|
|
@@ -10,6 +10,18 @@ export function serviceTypes(checker: ts.TypeChecker) {
|
|
|
10
10
|
const property = type.getProperty(name);
|
|
11
11
|
return property === undefined ? undefined : checker.getTypeOfSymbol(property);
|
|
12
12
|
}
|
|
13
|
+
function options(type: ts.Type): boolean {
|
|
14
|
+
if (type.getCallSignatures().length > 0) {
|
|
15
|
+
return false;
|
|
16
|
+
}
|
|
17
|
+
return type
|
|
18
|
+
.getProperties()
|
|
19
|
+
.every(
|
|
20
|
+
(property) =>
|
|
21
|
+
(property.flags & ts.SymbolFlags.Optional) !== 0
|
|
22
|
+
&& checker.getNonNullableType(checker.getTypeOfSymbol(property)).getCallSignatures().length === 0,
|
|
23
|
+
);
|
|
24
|
+
}
|
|
13
25
|
function remember(type: ts.Type): void {
|
|
14
26
|
if (type.getProperty(SERVICE) === undefined) {
|
|
15
27
|
return;
|
|
@@ -20,6 +32,7 @@ export function serviceTypes(checker: ts.TypeChecker) {
|
|
|
20
32
|
&& shape.flags & ts.TypeFlags.Object
|
|
21
33
|
&& (shape.getProperties().length > 0 || shape.getCallSignatures().length > 0)
|
|
22
34
|
&& checker.getIndexInfosOfType(shape).length === 0
|
|
35
|
+
&& !options(shape)
|
|
23
36
|
&& (shape.getCallSignatures().length === 0 || type.getProperty("~effect/Context/Reference") === undefined)
|
|
24
37
|
) {
|
|
25
38
|
shapes.add(shape);
|
|
@@ -1,22 +1,11 @@
|
|
|
1
1
|
import { posix } from "node:path";
|
|
2
|
+
import { readPackageManifest } from "#adapters/manifestInventory.ts";
|
|
2
3
|
import type { RuleInputs } from "#rule.ts";
|
|
3
4
|
|
|
4
5
|
export type PackageImports = (importer: string, specifier: string) => string | undefined;
|
|
5
6
|
|
|
6
7
|
const MANIFEST = "package.json";
|
|
7
8
|
|
|
8
|
-
function importsField(text: string | undefined): unknown {
|
|
9
|
-
if (text === undefined) {
|
|
10
|
-
return undefined;
|
|
11
|
-
}
|
|
12
|
-
try {
|
|
13
|
-
const manifest: unknown = JSON.parse(text);
|
|
14
|
-
return typeof manifest === "object" && manifest !== null ? Reflect.get(manifest, "imports") : undefined;
|
|
15
|
-
} catch {
|
|
16
|
-
return undefined;
|
|
17
|
-
}
|
|
18
|
-
}
|
|
19
|
-
|
|
20
9
|
function targetsIn(value: unknown): readonly string[] {
|
|
21
10
|
if (typeof value === "string") {
|
|
22
11
|
return [value];
|
|
@@ -52,7 +41,7 @@ function matched(imports: unknown, specifier: string): readonly string[] {
|
|
|
52
41
|
export async function packageImports({ files, readText }: Pick<RuleInputs, "files" | "readText">): Promise<PackageImports> {
|
|
53
42
|
const directories = files.filter((path) => posix.basename(path) === MANIFEST).map((path) => posix.dirname(path));
|
|
54
43
|
const manifests = await Promise.all(
|
|
55
|
-
directories.map(async (directory) => ({ directory, imports:
|
|
44
|
+
directories.map(async (directory) => ({ directory, imports: (await readPackageManifest(readText, posix.join(directory, MANIFEST)))?.imports })),
|
|
56
45
|
);
|
|
57
46
|
const deepestFirst = manifests.toSorted((left, right) => right.directory.length - left.directory.length);
|
|
58
47
|
const present = new Set(files);
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
import { posix } from "node:path";
|
|
2
|
+
import { readPackageManifest } from "#adapters/manifestInventory.ts";
|
|
2
3
|
import { type ImportGraph, importGraph } from "#imports/graph.ts";
|
|
3
4
|
import { isTooling } from "#imports/isTooling.ts";
|
|
4
5
|
import { builtinName } from "#imports/packageName.ts";
|
|
5
6
|
import { packageOf, type WorkspacePackage } from "#imports/workspace.ts";
|
|
6
|
-
import { type EntryPoint, entryPointsOf, isApplication, provider, SHIPPED_FIELDS } from "#manifests/entryPoints.ts";
|
|
7
|
+
import { dependencyNames, type EntryPoint, entryPointsOf, isApplication, provider, SHIPPED_FIELDS } from "#manifests/entryPoints.ts";
|
|
7
8
|
import { isTestCode } from "#naming/testName.ts";
|
|
8
9
|
import { defineRule, type RuleInputs } from "#rule.ts";
|
|
9
10
|
import { bundleInputs } from "./bundleInputs.ts";
|
|
@@ -31,17 +32,6 @@ interface ManifestDependencies {
|
|
|
31
32
|
readonly shipped: ReadonlySet<string>;
|
|
32
33
|
}
|
|
33
34
|
|
|
34
|
-
function names(manifest: object, field: string): readonly string[] {
|
|
35
|
-
const value: unknown = Reflect.get(manifest, field);
|
|
36
|
-
if (value === undefined) {
|
|
37
|
-
return [];
|
|
38
|
-
}
|
|
39
|
-
if (typeof value !== "object" || value === null || Array.isArray(value)) {
|
|
40
|
-
throw new Error(`${field} must be an object`);
|
|
41
|
-
}
|
|
42
|
-
return Object.keys(value);
|
|
43
|
-
}
|
|
44
|
-
|
|
45
35
|
async function manifestDependencies(
|
|
46
36
|
inputs: RuleInputs,
|
|
47
37
|
owner: WorkspacePackage,
|
|
@@ -49,26 +39,18 @@ async function manifestDependencies(
|
|
|
49
39
|
workspace: ReadonlyMap<string, string>,
|
|
50
40
|
): Promise<ManifestDependencies> {
|
|
51
41
|
const path = posix.join(owner.directory, "package.json");
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
throw new Error("the manifest is missing");
|
|
56
|
-
}
|
|
57
|
-
const manifest: unknown = JSON.parse(text);
|
|
58
|
-
if (typeof manifest !== "object" || manifest === null || Array.isArray(manifest)) {
|
|
59
|
-
throw new Error("the manifest must be an object");
|
|
60
|
-
}
|
|
61
|
-
return {
|
|
62
|
-
...bundleInputs(graph, owner, manifest, (candidate) => developmentFile(owner, candidate)),
|
|
63
|
-
application: isApplication(manifest),
|
|
64
|
-
development: new Set(names(manifest, "devDependencies")),
|
|
65
|
-
entryPoints: await entryPointsOf(inputs, owner.directory, manifest, workspace),
|
|
66
|
-
private: Reflect.get(manifest, "private") === true,
|
|
67
|
-
shipped: new Set(SHIPPED_FIELDS.flatMap((field) => names(manifest, field))),
|
|
68
|
-
};
|
|
69
|
-
} catch (cause) {
|
|
70
|
-
throw new Error(`cannot read dependency policy at ${path}: ${cause instanceof Error ? cause.message : String(cause)}`, { cause });
|
|
42
|
+
const manifest = await readPackageManifest(inputs.readText, path);
|
|
43
|
+
if (manifest === undefined) {
|
|
44
|
+
throw new Error("the manifest is missing");
|
|
71
45
|
}
|
|
46
|
+
return {
|
|
47
|
+
...bundleInputs(graph, owner, manifest, (candidate) => developmentFile(owner, candidate)),
|
|
48
|
+
application: isApplication(manifest),
|
|
49
|
+
development: new Set(dependencyNames(manifest, "devDependencies")),
|
|
50
|
+
entryPoints: await entryPointsOf(inputs, owner.directory, manifest, workspace),
|
|
51
|
+
private: Reflect.get(manifest, "private") === true,
|
|
52
|
+
shipped: new Set(SHIPPED_FIELDS.flatMap((field) => dependencyNames(manifest, field))),
|
|
53
|
+
};
|
|
72
54
|
}
|
|
73
55
|
|
|
74
56
|
function developmentFile(owner: WorkspacePackage, path: string): boolean {
|
|
@@ -105,7 +87,8 @@ function undeclared(owner: WorkspacePackage, policy: ManifestDependencies | unde
|
|
|
105
87
|
export const importsManifest = defineRule({
|
|
106
88
|
check: async (inputs) => {
|
|
107
89
|
const graph = await importGraph(inputs);
|
|
108
|
-
const root: WorkspacePackage | undefined =
|
|
90
|
+
const root: WorkspacePackage | undefined =
|
|
91
|
+
(await readPackageManifest(inputs.readText, "package.json")) === undefined ? undefined : { directory: ".", name: "." };
|
|
109
92
|
const owners = [...graph.packages, ...(root === undefined ? [] : [root])];
|
|
110
93
|
const workspace = new Map(graph.packages.map((owner) => [owner.name, owner.directory]));
|
|
111
94
|
const policies = new Map(
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { Effect } from "effect";
|
|
2
|
+
import { type ImportGraph, importGraph } from "#imports/graph.ts";
|
|
2
3
|
import { builtinName } from "#imports/packageName.ts";
|
|
3
4
|
import { type Runtime, runtimeDeclarationProblems, runtimeOf } from "#imports/runtime.ts";
|
|
4
5
|
import { isTestCode } from "#naming/testName.ts";
|
|
@@ -11,42 +12,47 @@ function forbiddenImport(from: Runtime, to: Runtime | undefined, builtin: boolea
|
|
|
11
12
|
return from === "client" && (to === "server" || builtin);
|
|
12
13
|
}
|
|
13
14
|
|
|
15
|
+
function runtimeFindings(graph: ImportGraph, runtime: (path: string) => Runtime | undefined) {
|
|
16
|
+
return graph.edges.flatMap((edge) => {
|
|
17
|
+
const from = runtime(edge.from);
|
|
18
|
+
if (from === undefined || isTestCode(edge.from)) {
|
|
19
|
+
return [];
|
|
20
|
+
}
|
|
21
|
+
const to = edge.to.kind === "file" ? runtime(edge.to.path) : undefined;
|
|
22
|
+
const builtin = edge.to.kind === "external" && builtinName(edge.to.specifier) !== undefined;
|
|
23
|
+
if (!forbiddenImport(from, to, builtin)) {
|
|
24
|
+
return [];
|
|
25
|
+
}
|
|
26
|
+
return [
|
|
27
|
+
{
|
|
28
|
+
file: edge.from,
|
|
29
|
+
line: edge.line,
|
|
30
|
+
message: `${from === "client" ? "Client" : "Shared"} code imports ${builtin ? "Node built-in" : `${to} code`} through "${edge.specifier}". Move runtime-dependent code into src/client/ or src/server/ and keep shared code independent of both runtimes.`,
|
|
31
|
+
subject: edge.specifier,
|
|
32
|
+
},
|
|
33
|
+
];
|
|
34
|
+
});
|
|
35
|
+
}
|
|
36
|
+
|
|
14
37
|
export const importsRuntime = defineRule({
|
|
15
|
-
check:
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
const
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
38
|
+
check: (inputs) =>
|
|
39
|
+
Effect.gen(function* () {
|
|
40
|
+
const graph = yield* Effect.promise(() => importGraph(inputs));
|
|
41
|
+
const runtime = yield* runtimeOf(inputs, graph.packages);
|
|
42
|
+
const imports = runtimeFindings(graph, runtime);
|
|
43
|
+
const declarations = (yield* runtimeDeclarationProblems(inputs, graph.packages)).map(({ directory, message }) => ({
|
|
44
|
+
file: directory === "." ? "package.json" : `${directory}/package.json`,
|
|
45
|
+
line: 1,
|
|
46
|
+
message,
|
|
47
|
+
subject: "quality.runtime",
|
|
48
|
+
}));
|
|
49
|
+
const shared = inputs.sources.filter((file) => !isTestCode(file.path) && runtime(file.path) === "shared");
|
|
50
|
+
if (shared.length === 0) {
|
|
51
|
+
return [...imports, ...declarations];
|
|
27
52
|
}
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
line: edge.line,
|
|
32
|
-
message: `${from === "client" ? "Client" : "Shared"} code imports ${builtin ? "Node built-in" : `${to} code`} through "${edge.specifier}". Move runtime-dependent code into src/client/ or src/server/ and keep shared code independent of both runtimes.`,
|
|
33
|
-
subject: edge.specifier,
|
|
34
|
-
},
|
|
35
|
-
];
|
|
36
|
-
});
|
|
37
|
-
const declarations = runtimeDeclarationProblems(inputs, graph.packages).map(({ directory, message }) => ({
|
|
38
|
-
file: directory === "." ? "package.json" : `${directory}/package.json`,
|
|
39
|
-
line: 1,
|
|
40
|
-
message,
|
|
41
|
-
subject: "quality.runtime",
|
|
42
|
-
}));
|
|
43
|
-
const shared = inputs.sources.filter((file) => !isTestCode(file.path) && runtime(file.path) === "shared");
|
|
44
|
-
if (shared.length === 0) {
|
|
45
|
-
return [...imports, ...declarations];
|
|
46
|
-
}
|
|
47
|
-
const { browserGlobals } = await import("#imports/browserGlobals.ts");
|
|
48
|
-
return [...imports, ...declarations, ...shared.flatMap(browserGlobals)];
|
|
49
|
-
},
|
|
53
|
+
const { browserGlobals } = yield* Effect.promise(() => import("#imports/browserGlobals.ts"));
|
|
54
|
+
return [...imports, ...declarations, ...shared.flatMap(browserGlobals)];
|
|
55
|
+
}),
|
|
50
56
|
description:
|
|
51
57
|
"Runtime folders define client, server and shared code. A manifest's quality.runtime declares a single-runtime package whole; executable packages without runtime folders and package-root tooling are server code.",
|
|
52
58
|
id: "imports/runtime",
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { dirname, posix, relative, resolve, sep } from "node:path";
|
|
2
|
+
import { readPackageManifest } from "#adapters/manifestInventory.ts";
|
|
2
3
|
import { pnpmWorkspaceList } from "#imports/pnpmWorkspacePatterns.ts";
|
|
3
4
|
import { workspacePackages } from "#imports/workspace.ts";
|
|
4
5
|
import { DEPENDENCY_FIELDS, dependencyNames, entryPointsOf, isApplication, PLATFORM } from "#manifests/entryPoints.ts";
|
|
@@ -17,17 +18,6 @@ function hoists(pattern: string): boolean {
|
|
|
17
18
|
return new RegExp(`^${source}$`, "u").test(PROBE);
|
|
18
19
|
}
|
|
19
20
|
|
|
20
|
-
function parsed(text: string | undefined): unknown {
|
|
21
|
-
if (text === undefined) {
|
|
22
|
-
return undefined;
|
|
23
|
-
}
|
|
24
|
-
try {
|
|
25
|
-
return JSON.parse(text);
|
|
26
|
-
} catch {
|
|
27
|
-
return undefined;
|
|
28
|
-
}
|
|
29
|
-
}
|
|
30
|
-
|
|
31
21
|
function ancestors(root: string, directory: string): readonly string[] {
|
|
32
22
|
const start = resolve(root, directory);
|
|
33
23
|
const parent = dirname(start);
|
|
@@ -100,7 +90,7 @@ export const manifestsApplication = defineRule({
|
|
|
100
90
|
const findings = await Promise.all(
|
|
101
91
|
directories.map(async (directory) => {
|
|
102
92
|
const manifestPath = posix.join(directory, "package.json");
|
|
103
|
-
const manifest =
|
|
93
|
+
const manifest = await readPackageManifest(inputs.readText, manifestPath);
|
|
104
94
|
if (!isApplication(manifest)) {
|
|
105
95
|
return [];
|
|
106
96
|
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { posix } from "node:path";
|
|
2
|
+
import { readPackageManifest } from "#adapters/manifestInventory.ts";
|
|
2
3
|
import { workspacePackages } from "#imports/workspace.ts";
|
|
3
4
|
import { defineRule, type Finding } from "#rule.ts";
|
|
4
5
|
|
|
@@ -52,11 +53,14 @@ function findingsIn(file: string, exports: unknown): readonly Finding[] {
|
|
|
52
53
|
: [finding(file, "exports", `The exports field needs exactly one non-null wildcard; found ${patterns.length}.`)];
|
|
53
54
|
return [
|
|
54
55
|
...count,
|
|
55
|
-
...entries.flatMap(([key, value]) =>
|
|
56
|
-
value === null
|
|
56
|
+
...entries.flatMap(([key, value]) => {
|
|
57
|
+
if (value === null) {
|
|
58
|
+
return [finding(file, key, `Export "${key}" blocks module imports with null. Remove the null entry so callers can import each module.`)];
|
|
59
|
+
}
|
|
60
|
+
return key === "." || exactAsset(key, value) || standardPattern(key, value)
|
|
57
61
|
? []
|
|
58
|
-
: [finding(file, key, `Export "${key}" does not preserve the module's file path.`)]
|
|
59
|
-
),
|
|
62
|
+
: [finding(file, key, `Export "${key}" does not preserve the module's file path.`)];
|
|
63
|
+
}),
|
|
60
64
|
];
|
|
61
65
|
}
|
|
62
66
|
|
|
@@ -66,18 +70,17 @@ export const manifestsExportsShape = defineRule({
|
|
|
66
70
|
const files = ["package.json", ...packages.map((owner) => posix.join(owner.directory, "package.json"))];
|
|
67
71
|
const findings = await Promise.all(
|
|
68
72
|
files.map(async (file) => {
|
|
69
|
-
const
|
|
70
|
-
if (file === "package.json" &&
|
|
73
|
+
const manifest = await readPackageManifest(inputs.readText, file);
|
|
74
|
+
if (file === "package.json" && manifest === undefined) {
|
|
71
75
|
return [];
|
|
72
76
|
}
|
|
73
|
-
const manifest: unknown = JSON.parse(text ?? "");
|
|
74
77
|
return findingsIn(file, isMap(manifest) ? manifest.exports : undefined);
|
|
75
78
|
}),
|
|
76
79
|
);
|
|
77
80
|
return findings.flat();
|
|
78
81
|
},
|
|
79
82
|
description:
|
|
80
|
-
"Workspace packages export
|
|
83
|
+
"Workspace packages export every module through one file-preserving wildcard, with optional root and exact non-code assets; null entries are rejected, and a package without modules exports only exact assets.",
|
|
81
84
|
id: "manifests/exports-shape",
|
|
82
85
|
registrable: false,
|
|
83
86
|
});
|