@codeperfect/eslint-plugin 1.0.0 → 2.0.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/README.md +26 -4
- package/dist/.tsbuildinfo +1 -1
- package/dist/{custom-rules.d.ts → application/custom-rules.d.ts} +3 -0
- package/dist/application/custom-rules.d.ts.map +1 -0
- package/dist/application/custom-rules.js +74 -0
- package/dist/application/index.d.ts +4 -0
- package/dist/application/index.d.ts.map +1 -0
- package/dist/application/index.js +3 -0
- package/dist/codeperfect-eslint-plugin-1.0.0.tgz +0 -0
- package/dist/domain/architecture/consistent-barrel-files/barrel-file-utilities.d.ts +56 -0
- package/dist/domain/architecture/consistent-barrel-files/barrel-file-utilities.d.ts.map +1 -0
- package/dist/domain/architecture/consistent-barrel-files/barrel-file-utilities.js +149 -0
- package/dist/{architecture → domain/architecture}/consistent-barrel-files/consistent-barrel-files-listeners.d.ts +4 -4
- package/dist/domain/architecture/consistent-barrel-files/consistent-barrel-files-listeners.d.ts.map +1 -0
- package/dist/domain/architecture/consistent-barrel-files/consistent-barrel-files-listeners.js +98 -0
- package/dist/domain/architecture/consistent-barrel-files/consistent-barrel-files-options.d.ts +45 -0
- package/dist/domain/architecture/consistent-barrel-files/consistent-barrel-files-options.d.ts.map +1 -0
- package/dist/domain/architecture/consistent-barrel-files/consistent-barrel-files-options.js +64 -0
- package/dist/{architecture → domain/architecture}/consistent-barrel-files/exports-only-rule-test-utilities.d.ts +5 -4
- package/dist/domain/architecture/consistent-barrel-files/exports-only-rule-test-utilities.d.ts.map +1 -0
- package/dist/domain/architecture/consistent-barrel-files/exports-only-rule-test-utilities.js +87 -0
- package/dist/domain/architecture/consistent-barrel-files/exports-only-rule.d.ts.map +1 -0
- package/dist/domain/architecture/consistent-barrel-files/exports-only-rule.js +140 -0
- package/dist/domain/architecture/consistent-barrel-files/index.d.ts +5 -0
- package/dist/domain/architecture/consistent-barrel-files/index.d.ts.map +1 -0
- package/dist/domain/architecture/consistent-barrel-files/index.js +4 -0
- package/dist/domain/architecture/consistent-barrel-files/no-reexports-outside-barrels-rule.d.ts.map +1 -0
- package/dist/domain/architecture/consistent-barrel-files/no-reexports-outside-barrels-rule.js +85 -0
- package/dist/{architecture → domain/architecture}/consistent-barrel-files/no-reexports-outside-barrels-test-utilities.d.ts +1 -1
- package/dist/domain/architecture/consistent-barrel-files/no-reexports-outside-barrels-test-utilities.d.ts.map +1 -0
- package/dist/domain/architecture/consistent-barrel-files/no-reexports-outside-barrels-test-utilities.js +91 -0
- package/dist/{architecture → domain/architecture}/consistent-barrel-files/no-reexports-outside-barrels-utilities.d.ts +4 -6
- package/dist/domain/architecture/consistent-barrel-files/no-reexports-outside-barrels-utilities.d.ts.map +1 -0
- package/dist/domain/architecture/consistent-barrel-files/no-reexports-outside-barrels-utilities.js +95 -0
- package/dist/domain/architecture/consistent-barrel-files/rule.d.ts.map +1 -0
- package/dist/domain/architecture/consistent-barrel-files/rule.js +43 -0
- package/dist/domain/architecture/consistent-barrel-files/rule.repeat-runs.d.ts +4 -0
- package/dist/domain/architecture/consistent-barrel-files/rule.repeat-runs.d.ts.map +1 -0
- package/dist/domain/architecture/consistent-barrel-files/rule.repeat-runs.js +4 -0
- package/dist/{architecture → domain/architecture}/consistent-barrel-files/test-helpers.d.ts +48 -48
- package/dist/domain/architecture/consistent-barrel-files/test-helpers.d.ts.map +1 -0
- package/dist/domain/architecture/consistent-barrel-files/test-helpers.file-writers.d.ts +20 -0
- package/dist/domain/architecture/consistent-barrel-files/test-helpers.file-writers.d.ts.map +1 -0
- package/dist/domain/architecture/consistent-barrel-files/test-helpers.file-writers.js +25 -0
- package/dist/domain/architecture/consistent-barrel-files/test-helpers.js +235 -0
- package/dist/domain/architecture/consistent-barrel-files/types.d.ts +19 -0
- package/dist/domain/architecture/consistent-barrel-files/types.d.ts.map +1 -0
- package/dist/domain/architecture/consistent-barrel-files/types.js +2 -0
- package/dist/{architecture → domain/architecture}/index.d.ts +1 -1
- package/dist/domain/architecture/index.d.ts.map +1 -0
- package/dist/domain/architecture/index.js +2 -0
- package/dist/{core → domain/core}/index.d.ts +2 -2
- package/dist/domain/core/index.d.ts.map +1 -0
- package/dist/domain/core/index.js +3 -0
- package/dist/domain/core/no-multiple-declarators/index.d.ts +2 -0
- package/dist/domain/core/no-multiple-declarators/index.d.ts.map +1 -0
- package/dist/domain/core/no-multiple-declarators/index.js +2 -0
- package/dist/domain/core/no-multiple-declarators/rule-test-helpers.d.ts +101 -0
- package/dist/domain/core/no-multiple-declarators/rule-test-helpers.d.ts.map +1 -0
- package/dist/domain/core/no-multiple-declarators/rule-test-helpers.js +108 -0
- package/dist/{core → domain/core}/no-multiple-declarators/rule.d.ts +1 -0
- package/dist/domain/core/no-multiple-declarators/rule.d.ts.map +1 -0
- package/dist/domain/core/no-multiple-declarators/rule.fixes.d.ts +35 -0
- package/dist/domain/core/no-multiple-declarators/rule.fixes.d.ts.map +1 -0
- package/dist/domain/core/no-multiple-declarators/rule.fixes.js +95 -0
- package/dist/domain/core/no-multiple-declarators/rule.guardrails.d.ts +4 -0
- package/dist/domain/core/no-multiple-declarators/rule.guardrails.d.ts.map +1 -0
- package/dist/domain/core/no-multiple-declarators/rule.guardrails.js +4 -0
- package/dist/domain/core/no-multiple-declarators/rule.js +219 -0
- package/dist/domain/core/no-multiple-declarators/rule.mocked-types.d.ts +4 -0
- package/dist/domain/core/no-multiple-declarators/rule.mocked-types.d.ts.map +1 -0
- package/dist/domain/core/no-multiple-declarators/rule.mocked-types.js +4 -0
- package/dist/domain/core/no-multiple-declarators/types.d.ts +77 -0
- package/dist/domain/core/no-multiple-declarators/types.d.ts.map +1 -0
- package/dist/domain/core/no-multiple-declarators/types.js +38 -0
- package/dist/domain/core/prefer-interface-types/index.d.ts +2 -0
- package/dist/domain/core/prefer-interface-types/index.d.ts.map +1 -0
- package/dist/domain/core/prefer-interface-types/index.js +2 -0
- package/dist/domain/core/prefer-interface-types/rule.d.ts.map +1 -0
- package/dist/domain/core/prefer-interface-types/rule.js +145 -0
- package/dist/domain/core/prefer-interface-types/test-helpers.d.ts.map +1 -0
- package/dist/domain/core/prefer-interface-types/test-helpers.js +116 -0
- package/dist/{custom-rule-documentation.d.ts → domain/custom-rule-documentation.d.ts} +1 -1
- package/dist/domain/custom-rule-documentation.d.ts.map +1 -0
- package/dist/domain/custom-rule-documentation.js +35 -0
- package/dist/domain/docs/index.d.ts +4 -0
- package/dist/domain/docs/index.d.ts.map +1 -0
- package/dist/domain/docs/index.js +4 -0
- package/dist/domain/docs/no-interface-member-docs/comment-utilities-test-helpers.d.ts.map +1 -0
- package/dist/domain/docs/no-interface-member-docs/comment-utilities-test-helpers.js +129 -0
- package/dist/{docs → domain/docs}/no-interface-member-docs/comment-utilities.d.ts +1 -1
- package/dist/domain/docs/no-interface-member-docs/comment-utilities.d.ts.map +1 -0
- package/dist/domain/docs/no-interface-member-docs/comment-utilities.js +146 -0
- package/dist/domain/docs/no-interface-member-docs/index.d.ts +2 -0
- package/dist/domain/docs/no-interface-member-docs/index.d.ts.map +1 -0
- package/dist/domain/docs/no-interface-member-docs/index.js +2 -0
- package/dist/{docs → domain/docs}/no-interface-member-docs/parameter-tags.d.ts +1 -1
- package/dist/domain/docs/no-interface-member-docs/parameter-tags.d.ts.map +1 -0
- package/dist/domain/docs/no-interface-member-docs/parameter-tags.js +101 -0
- package/dist/{docs → domain/docs}/no-interface-member-docs/parameter-utilities.d.ts +1 -1
- package/dist/domain/docs/no-interface-member-docs/parameter-utilities.d.ts.map +1 -0
- package/dist/domain/docs/no-interface-member-docs/parameter-utilities.js +125 -0
- package/dist/domain/docs/no-interface-member-docs/rule.d.ts.map +1 -0
- package/dist/domain/docs/no-interface-member-docs/rule.js +168 -0
- package/dist/domain/docs/no-interface-member-docs/test-helpers.d.ts.map +1 -0
- package/dist/domain/docs/no-interface-member-docs/test-helpers.js +157 -0
- package/dist/{docs → domain/docs}/no-interface-member-docs/types.d.ts +2 -2
- package/dist/domain/docs/no-interface-member-docs/types.d.ts.map +1 -0
- package/dist/domain/docs/no-interface-member-docs/types.js +2 -0
- package/dist/domain/docs/require-example-language/create-fixer.d.ts +5 -0
- package/dist/domain/docs/require-example-language/create-fixer.d.ts.map +1 -0
- package/dist/domain/docs/require-example-language/create-fixer.js +5 -0
- package/dist/domain/docs/require-example-language/empty-fence-fixes.d.ts.map +1 -0
- package/dist/domain/docs/require-example-language/empty-fence-fixes.js +169 -0
- package/dist/domain/docs/require-example-language/example-utilities.d.ts.map +1 -0
- package/dist/domain/docs/require-example-language/example-utilities.js +76 -0
- package/dist/{docs → domain/docs}/require-example-language/examples.d.ts +1 -1
- package/dist/domain/docs/require-example-language/examples.d.ts.map +1 -0
- package/dist/domain/docs/require-example-language/examples.js +181 -0
- package/dist/{docs → domain/docs}/require-example-language/fixes.d.ts +2 -2
- package/dist/domain/docs/require-example-language/fixes.d.ts.map +1 -0
- package/dist/domain/docs/require-example-language/fixes.js +182 -0
- package/dist/domain/docs/require-example-language/index.d.ts +3 -0
- package/dist/domain/docs/require-example-language/index.d.ts.map +1 -0
- package/dist/domain/docs/require-example-language/index.js +2 -0
- package/dist/{docs → domain/docs}/require-example-language/reporting.d.ts +1 -1
- package/dist/domain/docs/require-example-language/reporting.d.ts.map +1 -0
- package/dist/domain/docs/require-example-language/reporting.js +148 -0
- package/dist/domain/docs/require-example-language/rule.d.ts.map +1 -0
- package/dist/domain/docs/require-example-language/rule.js +34 -0
- package/dist/domain/docs/require-example-language/types.d.ts.map +1 -0
- package/dist/domain/docs/require-example-language/types.js +2 -0
- package/dist/domain/docs/single-line-jsdoc/index.d.ts +2 -0
- package/dist/domain/docs/single-line-jsdoc/index.d.ts.map +1 -0
- package/dist/domain/docs/single-line-jsdoc/index.js +2 -0
- package/dist/domain/docs/single-line-jsdoc/rule.d.ts.map +1 -0
- package/dist/domain/docs/single-line-jsdoc/rule.edge-cases.d.ts +4 -0
- package/dist/domain/docs/single-line-jsdoc/rule.edge-cases.d.ts.map +1 -0
- package/dist/domain/docs/single-line-jsdoc/rule.edge-cases.js +5 -0
- package/dist/domain/docs/single-line-jsdoc/rule.js +196 -0
- package/dist/domain/docs/single-line-jsdoc/rule.node-lookups.d.ts +4 -0
- package/dist/domain/docs/single-line-jsdoc/rule.node-lookups.d.ts.map +1 -0
- package/dist/domain/docs/single-line-jsdoc/rule.node-lookups.js +5 -0
- package/dist/domain/docs/single-line-jsdoc/single-line-jsdoc-content.d.ts.map +1 -0
- package/dist/domain/docs/single-line-jsdoc/single-line-jsdoc-content.js +95 -0
- package/dist/{docs → domain/docs}/single-line-jsdoc/single-line-jsdoc-utilities.d.ts +1 -1
- package/dist/domain/docs/single-line-jsdoc/single-line-jsdoc-utilities.d.ts.map +1 -0
- package/dist/domain/docs/single-line-jsdoc/single-line-jsdoc-utilities.js +140 -0
- package/dist/domain/docs/test-helpers.d.ts.map +1 -0
- package/dist/domain/docs/test-helpers.js +107 -0
- package/dist/domain/index.d.ts +6 -0
- package/dist/domain/index.d.ts.map +1 -0
- package/dist/domain/index.js +6 -0
- package/dist/domain/testing/aaa/analyzer.analysis.d.ts +92 -0
- package/dist/domain/testing/aaa/analyzer.analysis.d.ts.map +1 -0
- package/dist/domain/testing/aaa/analyzer.analysis.helpers.d.ts +4 -0
- package/dist/domain/testing/aaa/analyzer.analysis.helpers.d.ts.map +1 -0
- package/dist/domain/testing/aaa/analyzer.analysis.helpers.js +4 -0
- package/dist/domain/testing/aaa/analyzer.analysis.js +247 -0
- package/dist/domain/testing/aaa/analyzer.assertions.d.ts +93 -0
- package/dist/domain/testing/aaa/analyzer.assertions.d.ts.map +1 -0
- package/dist/domain/testing/aaa/analyzer.assertions.js +283 -0
- package/dist/domain/testing/aaa/analyzer.classification.d.ts +75 -0
- package/dist/domain/testing/aaa/analyzer.classification.d.ts.map +1 -0
- package/dist/domain/testing/aaa/analyzer.classification.js +201 -0
- package/dist/domain/testing/aaa/analyzer.classification.member-patterns.d.ts +9 -0
- package/dist/domain/testing/aaa/analyzer.classification.member-patterns.d.ts.map +1 -0
- package/dist/domain/testing/aaa/analyzer.classification.member-patterns.js +10 -0
- package/dist/domain/testing/aaa/analyzer.d.ts +46 -0
- package/dist/domain/testing/aaa/analyzer.d.ts.map +1 -0
- package/dist/domain/testing/aaa/analyzer.js +59 -0
- package/dist/domain/testing/aaa/analyzer.super.d.ts +107 -0
- package/dist/domain/testing/aaa/analyzer.super.d.ts.map +1 -0
- package/dist/domain/testing/aaa/analyzer.super.js +228 -0
- package/dist/{testing → domain/testing}/aaa/index.d.ts +2 -2
- package/dist/domain/testing/aaa/index.d.ts.map +1 -0
- package/dist/domain/testing/aaa/index.js +2 -0
- package/dist/domain/testing/aaa/types.d.ts +58 -0
- package/dist/domain/testing/aaa/types.d.ts.map +1 -0
- package/dist/domain/testing/aaa/types.js +2 -0
- package/dist/domain/testing/assert-actual-expected-names/index.d.ts +2 -0
- package/dist/domain/testing/assert-actual-expected-names/index.d.ts.map +1 -0
- package/dist/domain/testing/assert-actual-expected-names/index.js +2 -0
- package/dist/{testing → domain/testing}/assert-actual-expected-names/rule.d.ts +1 -0
- package/dist/domain/testing/assert-actual-expected-names/rule.d.ts.map +1 -0
- package/dist/domain/testing/assert-actual-expected-names/rule.js +113 -0
- package/dist/domain/testing/enforce-aaa-phase-purity/index.d.ts +2 -0
- package/dist/domain/testing/enforce-aaa-phase-purity/index.d.ts.map +1 -0
- package/dist/domain/testing/enforce-aaa-phase-purity/index.js +2 -0
- package/dist/domain/testing/enforce-aaa-phase-purity/pattern-identifiers.d.ts +13 -0
- package/dist/domain/testing/enforce-aaa-phase-purity/pattern-identifiers.d.ts.map +1 -0
- package/dist/domain/testing/enforce-aaa-phase-purity/pattern-identifiers.js +134 -0
- package/dist/domain/testing/enforce-aaa-phase-purity/phase-purity-identifiers.d.ts +25 -0
- package/dist/domain/testing/enforce-aaa-phase-purity/phase-purity-identifiers.d.ts.map +1 -0
- package/dist/domain/testing/enforce-aaa-phase-purity/phase-purity-identifiers.js +138 -0
- package/dist/domain/testing/enforce-aaa-phase-purity/phase-purity-reporting.behavior.d.ts +4 -0
- package/dist/domain/testing/enforce-aaa-phase-purity/phase-purity-reporting.behavior.d.ts.map +1 -0
- package/dist/domain/testing/enforce-aaa-phase-purity/phase-purity-reporting.behavior.js +4 -0
- package/dist/domain/testing/enforce-aaa-phase-purity/phase-purity-reporting.d.ts +14 -0
- package/dist/domain/testing/enforce-aaa-phase-purity/phase-purity-reporting.d.ts.map +1 -0
- package/dist/domain/testing/enforce-aaa-phase-purity/phase-purity-reporting.js +180 -0
- package/dist/domain/testing/enforce-aaa-phase-purity/rule-test-helpers.d.ts +42 -0
- package/dist/domain/testing/enforce-aaa-phase-purity/rule-test-helpers.d.ts.map +1 -0
- package/dist/domain/testing/enforce-aaa-phase-purity/rule-test-helpers.js +188 -0
- package/dist/{testing → domain/testing}/enforce-aaa-phase-purity/rule.d.ts +1 -0
- package/dist/domain/testing/enforce-aaa-phase-purity/rule.d.ts.map +1 -0
- package/dist/domain/testing/enforce-aaa-phase-purity/rule.js +34 -0
- package/dist/domain/testing/enforce-aaa-structure/index.d.ts +2 -0
- package/dist/domain/testing/enforce-aaa-structure/index.d.ts.map +1 -0
- package/dist/domain/testing/enforce-aaa-structure/index.js +2 -0
- package/dist/{testing → domain/testing}/enforce-aaa-structure/rule.d.ts +1 -0
- package/dist/domain/testing/enforce-aaa-structure/rule.d.ts.map +1 -0
- package/dist/domain/testing/enforce-aaa-structure/rule.js +85 -0
- package/dist/{testing → domain/testing}/index.d.ts +9 -8
- package/dist/domain/testing/index.d.ts.map +1 -0
- package/dist/domain/testing/index.js +10 -0
- package/dist/domain/testing/prefer-vi-mocked-import/fix-import-statements.d.ts +29 -0
- package/dist/domain/testing/prefer-vi-mocked-import/fix-import-statements.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vi-mocked-import/fix-import-statements.js +90 -0
- package/dist/domain/testing/prefer-vi-mocked-import/fix-import-updates.d.ts +31 -0
- package/dist/domain/testing/prefer-vi-mocked-import/fix-import-updates.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vi-mocked-import/fix-import-updates.js +43 -0
- package/dist/domain/testing/prefer-vi-mocked-import/fix-imports.d.ts +16 -0
- package/dist/domain/testing/prefer-vi-mocked-import/fix-imports.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vi-mocked-import/fix-imports.js +205 -0
- package/dist/domain/testing/prefer-vi-mocked-import/fix.d.ts +28 -0
- package/dist/domain/testing/prefer-vi-mocked-import/fix.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vi-mocked-import/fix.js +171 -0
- package/dist/domain/testing/prefer-vi-mocked-import/index.d.ts +2 -0
- package/dist/domain/testing/prefer-vi-mocked-import/index.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vi-mocked-import/index.js +2 -0
- package/dist/{testing → domain/testing}/prefer-vi-mocked-import/match-bindings.d.ts +1 -1
- package/dist/domain/testing/prefer-vi-mocked-import/match-bindings.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vi-mocked-import/match-bindings.js +52 -0
- package/dist/{testing → domain/testing}/prefer-vi-mocked-import/match-declarations.d.ts +2 -1
- package/dist/domain/testing/prefer-vi-mocked-import/match-declarations.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vi-mocked-import/match-declarations.js +131 -0
- package/dist/domain/testing/prefer-vi-mocked-import/match-helpers.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vi-mocked-import/match-helpers.js +102 -0
- package/dist/{testing → domain/testing}/prefer-vi-mocked-import/match-imports.d.ts +1 -1
- package/dist/domain/testing/prefer-vi-mocked-import/match-imports.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vi-mocked-import/match-imports.js +156 -0
- package/dist/{testing → domain/testing}/prefer-vi-mocked-import/match-rewrites.d.ts +1 -1
- package/dist/domain/testing/prefer-vi-mocked-import/match-rewrites.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vi-mocked-import/match-rewrites.js +119 -0
- package/dist/domain/testing/prefer-vi-mocked-import/match-walk.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vi-mocked-import/match-walk.js +62 -0
- package/dist/domain/testing/prefer-vi-mocked-import/match.d.ts +26 -0
- package/dist/domain/testing/prefer-vi-mocked-import/match.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vi-mocked-import/match.js +198 -0
- package/dist/domain/testing/prefer-vi-mocked-import/rule-test-helpers.d.ts +20 -0
- package/dist/domain/testing/prefer-vi-mocked-import/rule-test-helpers.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vi-mocked-import/rule-test-helpers.js +39 -0
- package/dist/domain/testing/prefer-vi-mocked-import/rule.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vi-mocked-import/rule.js +36 -0
- package/dist/{testing → domain/testing}/prefer-vi-mocked-import/types.d.ts +1 -1
- package/dist/domain/testing/prefer-vi-mocked-import/types.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vi-mocked-import/types.js +2 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/ast-helpers.d.ts +86 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/ast-helpers.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/ast-helpers.js +150 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/index.d.ts +2 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/index.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/index.js +2 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/match-input.d.ts +14 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/match-input.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/match-input.js +81 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/match.d.ts +13 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/match.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/match.js +189 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/replacement-helpers.d.ts +25 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/replacement-helpers.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/replacement-helpers.js +92 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/rule-test-helpers.d.ts +32 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/rule-test-helpers.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/rule-test-helpers.js +164 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/rule.d.ts +5 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/rule.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/rule.guardrails.d.ts +4 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/rule.guardrails.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/rule.guardrails.js +4 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/rule.input-shapes.d.ts +4 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/rule.input-shapes.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/rule.input-shapes.js +4 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/rule.js +62 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/rule.signature-fallback.d.ts +4 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/rule.signature-fallback.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/rule.signature-fallback.js +4 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/type-helpers.d.ts +24 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/type-helpers.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/type-helpers.js +113 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/type-shape-helpers.d.ts +36 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/type-shape-helpers.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/type-shape-helpers.js +138 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/types.d.ts +203 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/types.d.ts.map +1 -0
- package/dist/domain/testing/prefer-vitest-incremental-casts/types.js +2 -0
- package/dist/domain/testing/require-aaa-sections/index.d.ts +2 -0
- package/dist/domain/testing/require-aaa-sections/index.d.ts.map +1 -0
- package/dist/domain/testing/require-aaa-sections/index.js +2 -0
- package/dist/domain/testing/require-aaa-sections/missing-section-fixes.d.ts +17 -0
- package/dist/domain/testing/require-aaa-sections/missing-section-fixes.d.ts.map +1 -0
- package/dist/domain/testing/require-aaa-sections/missing-section-fixes.js +150 -0
- package/dist/{testing → domain/testing}/require-aaa-sections/rule.d.ts +1 -0
- package/dist/domain/testing/require-aaa-sections/rule.d.ts.map +1 -0
- package/dist/domain/testing/require-aaa-sections/rule.js +129 -0
- package/dist/domain/testing/require-aaa-sections/rule.reporting.d.ts +104 -0
- package/dist/domain/testing/require-aaa-sections/rule.reporting.d.ts.map +1 -0
- package/dist/domain/testing/require-aaa-sections/rule.reporting.js +217 -0
- package/dist/domain/testing/require-act-result-capture/index.d.ts +2 -0
- package/dist/domain/testing/require-act-result-capture/index.d.ts.map +1 -0
- package/dist/domain/testing/require-act-result-capture/index.js +2 -0
- package/dist/{testing → domain/testing}/require-act-result-capture/rule.d.ts +1 -0
- package/dist/domain/testing/require-act-result-capture/rule.d.ts.map +1 -0
- package/dist/domain/testing/require-act-result-capture/rule.js +106 -0
- package/dist/domain/testing/require-test-companion/index.d.ts +3 -0
- package/dist/domain/testing/require-test-companion/index.d.ts.map +1 -0
- package/dist/domain/testing/require-test-companion/index.js +3 -0
- package/dist/{testing → domain/testing}/require-test-companion/require-test-companion-listeners.d.ts +1 -1
- package/dist/domain/testing/require-test-companion/require-test-companion-listeners.d.ts.map +1 -0
- package/dist/domain/testing/require-test-companion/require-test-companion-listeners.js +145 -0
- package/dist/domain/testing/require-test-companion/require-test-companion-options.d.ts.map +1 -0
- package/dist/domain/testing/require-test-companion/require-test-companion-options.js +113 -0
- package/dist/{testing → domain/testing}/require-test-companion/require-test-companion-test-helpers.d.ts +1 -1
- package/dist/domain/testing/require-test-companion/require-test-companion-test-helpers.d.ts.map +1 -0
- package/dist/domain/testing/require-test-companion/require-test-companion-test-helpers.js +184 -0
- package/dist/{testing → domain/testing}/require-test-companion/require-test-companion-utilities.d.ts +1 -1
- package/dist/domain/testing/require-test-companion/require-test-companion-utilities.d.ts.map +1 -0
- package/dist/domain/testing/require-test-companion/require-test-companion-utilities.js +26 -0
- package/dist/domain/testing/require-test-companion/rule.d.ts.map +1 -0
- package/dist/domain/testing/require-test-companion/rule.js +57 -0
- package/dist/domain/testing/require-test-companion/types.d.ts.map +1 -0
- package/dist/domain/testing/require-test-companion/types.js +2 -0
- package/dist/domain/testing/single-act-statement/index.d.ts +2 -0
- package/dist/domain/testing/single-act-statement/index.d.ts.map +1 -0
- package/dist/domain/testing/single-act-statement/index.js +2 -0
- package/dist/{testing → domain/testing}/single-act-statement/rule.d.ts +1 -0
- package/dist/domain/testing/single-act-statement/rule.d.ts.map +1 -0
- package/dist/domain/testing/single-act-statement/rule.js +34 -0
- package/dist/index.d.ts +4 -5
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -6
- package/dist/{codeperfect-plugin.d.ts → infrastructure/codeperfect-plugin.d.ts} +2 -0
- package/dist/infrastructure/codeperfect-plugin.d.ts.map +1 -0
- package/dist/infrastructure/codeperfect-plugin.js +30 -0
- package/dist/infrastructure/index.d.ts +5 -0
- package/dist/infrastructure/index.d.ts.map +1 -0
- package/dist/infrastructure/index.js +4 -0
- package/dist/infrastructure/presets.d.ts +18 -0
- package/dist/infrastructure/presets.d.ts.map +1 -0
- package/dist/infrastructure/presets.js +81 -0
- package/package.json +54 -27
- package/dist/architecture/consistent-barrel-files/consistent-barrel-files-listeners.d.ts.map +0 -1
- package/dist/architecture/consistent-barrel-files/consistent-barrel-files-listeners.js +0 -131
- package/dist/architecture/consistent-barrel-files/consistent-barrel-files-options.d.ts +0 -48
- package/dist/architecture/consistent-barrel-files/consistent-barrel-files-options.d.ts.map +0 -1
- package/dist/architecture/consistent-barrel-files/consistent-barrel-files-options.js +0 -126
- package/dist/architecture/consistent-barrel-files/exports-only-rule-test-utilities.d.ts.map +0 -1
- package/dist/architecture/consistent-barrel-files/exports-only-rule-test-utilities.js +0 -90
- package/dist/architecture/consistent-barrel-files/exports-only-rule.d.ts.map +0 -1
- package/dist/architecture/consistent-barrel-files/exports-only-rule.js +0 -218
- package/dist/architecture/consistent-barrel-files/index.d.ts +0 -5
- package/dist/architecture/consistent-barrel-files/index.d.ts.map +0 -1
- package/dist/architecture/consistent-barrel-files/index.js +0 -4
- package/dist/architecture/consistent-barrel-files/no-reexports-outside-barrels-rule.d.ts.map +0 -1
- package/dist/architecture/consistent-barrel-files/no-reexports-outside-barrels-rule.js +0 -100
- package/dist/architecture/consistent-barrel-files/no-reexports-outside-barrels-test-utilities.d.ts.map +0 -1
- package/dist/architecture/consistent-barrel-files/no-reexports-outside-barrels-test-utilities.js +0 -90
- package/dist/architecture/consistent-barrel-files/no-reexports-outside-barrels-utilities.d.ts.map +0 -1
- package/dist/architecture/consistent-barrel-files/no-reexports-outside-barrels-utilities.js +0 -154
- package/dist/architecture/consistent-barrel-files/rule.d.ts.map +0 -1
- package/dist/architecture/consistent-barrel-files/rule.js +0 -58
- package/dist/architecture/consistent-barrel-files/test-helpers.d.ts.map +0 -1
- package/dist/architecture/consistent-barrel-files/test-helpers.js +0 -229
- package/dist/architecture/consistent-barrel-files/types.d.ts +0 -25
- package/dist/architecture/consistent-barrel-files/types.d.ts.map +0 -1
- package/dist/architecture/consistent-barrel-files/types.js +0 -2
- package/dist/architecture/index.d.ts.map +0 -1
- package/dist/architecture/index.js +0 -2
- package/dist/benchmark-rules.d.ts +0 -83
- package/dist/benchmark-rules.d.ts.map +0 -1
- package/dist/benchmark-rules.js +0 -175
- package/dist/codeperfect-plugin.d.ts.map +0 -1
- package/dist/codeperfect-plugin.js +0 -29
- package/dist/core/index.d.ts.map +0 -1
- package/dist/core/index.js +0 -3
- package/dist/core/no-multiple-declarators/index.d.ts +0 -2
- package/dist/core/no-multiple-declarators/index.d.ts.map +0 -1
- package/dist/core/no-multiple-declarators/index.js +0 -2
- package/dist/core/no-multiple-declarators/rule.d.ts.map +0 -1
- package/dist/core/no-multiple-declarators/rule.js +0 -100
- package/dist/core/prefer-interface-types/index.d.ts +0 -2
- package/dist/core/prefer-interface-types/index.d.ts.map +0 -1
- package/dist/core/prefer-interface-types/index.js +0 -2
- package/dist/core/prefer-interface-types/rule.d.ts.map +0 -1
- package/dist/core/prefer-interface-types/rule.js +0 -145
- package/dist/core/prefer-interface-types/test-helpers.d.ts.map +0 -1
- package/dist/core/prefer-interface-types/test-helpers.js +0 -116
- package/dist/custom-rule-documentation.d.ts.map +0 -1
- package/dist/custom-rule-documentation.js +0 -35
- package/dist/custom-rules.d.ts.map +0 -1
- package/dist/custom-rules.js +0 -70
- package/dist/docs/index.d.ts +0 -4
- package/dist/docs/index.d.ts.map +0 -1
- package/dist/docs/index.js +0 -4
- package/dist/docs/no-interface-member-docs/comment-utilities-test-helpers.d.ts.map +0 -1
- package/dist/docs/no-interface-member-docs/comment-utilities-test-helpers.js +0 -129
- package/dist/docs/no-interface-member-docs/comment-utilities.d.ts.map +0 -1
- package/dist/docs/no-interface-member-docs/comment-utilities.js +0 -146
- package/dist/docs/no-interface-member-docs/index.d.ts +0 -2
- package/dist/docs/no-interface-member-docs/index.d.ts.map +0 -1
- package/dist/docs/no-interface-member-docs/index.js +0 -2
- package/dist/docs/no-interface-member-docs/parameter-tags.d.ts.map +0 -1
- package/dist/docs/no-interface-member-docs/parameter-tags.js +0 -101
- package/dist/docs/no-interface-member-docs/parameter-utilities.d.ts.map +0 -1
- package/dist/docs/no-interface-member-docs/parameter-utilities.js +0 -125
- package/dist/docs/no-interface-member-docs/rule.d.ts.map +0 -1
- package/dist/docs/no-interface-member-docs/rule.js +0 -168
- package/dist/docs/no-interface-member-docs/test-helpers.d.ts.map +0 -1
- package/dist/docs/no-interface-member-docs/test-helpers.js +0 -157
- package/dist/docs/no-interface-member-docs/types.d.ts.map +0 -1
- package/dist/docs/no-interface-member-docs/types.js +0 -2
- package/dist/docs/require-example-language/empty-fence-fixes.d.ts.map +0 -1
- package/dist/docs/require-example-language/empty-fence-fixes.js +0 -169
- package/dist/docs/require-example-language/example-utilities.d.ts.map +0 -1
- package/dist/docs/require-example-language/example-utilities.js +0 -76
- package/dist/docs/require-example-language/examples.d.ts.map +0 -1
- package/dist/docs/require-example-language/examples.js +0 -181
- package/dist/docs/require-example-language/fixes.d.ts.map +0 -1
- package/dist/docs/require-example-language/fixes.js +0 -182
- package/dist/docs/require-example-language/index.d.ts +0 -3
- package/dist/docs/require-example-language/index.d.ts.map +0 -1
- package/dist/docs/require-example-language/index.js +0 -2
- package/dist/docs/require-example-language/reporting.d.ts.map +0 -1
- package/dist/docs/require-example-language/reporting.js +0 -145
- package/dist/docs/require-example-language/rule.d.ts.map +0 -1
- package/dist/docs/require-example-language/rule.js +0 -34
- package/dist/docs/require-example-language/types.d.ts.map +0 -1
- package/dist/docs/require-example-language/types.js +0 -2
- package/dist/docs/single-line-jsdoc/index.d.ts +0 -2
- package/dist/docs/single-line-jsdoc/index.d.ts.map +0 -1
- package/dist/docs/single-line-jsdoc/index.js +0 -2
- package/dist/docs/single-line-jsdoc/rule.d.ts.map +0 -1
- package/dist/docs/single-line-jsdoc/rule.js +0 -196
- package/dist/docs/single-line-jsdoc/single-line-jsdoc-content.d.ts.map +0 -1
- package/dist/docs/single-line-jsdoc/single-line-jsdoc-content.js +0 -95
- package/dist/docs/single-line-jsdoc/single-line-jsdoc-utilities.d.ts.map +0 -1
- package/dist/docs/single-line-jsdoc/single-line-jsdoc-utilities.js +0 -140
- package/dist/docs/test-helpers.d.ts.map +0 -1
- package/dist/docs/test-helpers.js +0 -107
- package/dist/presets.d.ts +0 -10
- package/dist/presets.d.ts.map +0 -1
- package/dist/presets.js +0 -50
- package/dist/rules/index.d.ts +0 -5
- package/dist/rules/index.d.ts.map +0 -1
- package/dist/rules/index.js +0 -6
- package/dist/testing/aaa/analyzer.d.ts +0 -36
- package/dist/testing/aaa/analyzer.d.ts.map +0 -1
- package/dist/testing/aaa/analyzer.js +0 -490
- package/dist/testing/aaa/index.d.ts.map +0 -1
- package/dist/testing/aaa/index.js +0 -2
- package/dist/testing/aaa/types.d.ts +0 -31
- package/dist/testing/aaa/types.d.ts.map +0 -1
- package/dist/testing/aaa/types.js +0 -2
- package/dist/testing/assert-actual-expected-names/index.d.ts +0 -2
- package/dist/testing/assert-actual-expected-names/index.d.ts.map +0 -1
- package/dist/testing/assert-actual-expected-names/index.js +0 -2
- package/dist/testing/assert-actual-expected-names/rule.d.ts.map +0 -1
- package/dist/testing/assert-actual-expected-names/rule.js +0 -54
- package/dist/testing/enforce-aaa-phase-purity/index.d.ts +0 -2
- package/dist/testing/enforce-aaa-phase-purity/index.d.ts.map +0 -1
- package/dist/testing/enforce-aaa-phase-purity/index.js +0 -2
- package/dist/testing/enforce-aaa-phase-purity/rule.d.ts.map +0 -1
- package/dist/testing/enforce-aaa-phase-purity/rule.js +0 -110
- package/dist/testing/enforce-aaa-structure/index.d.ts +0 -2
- package/dist/testing/enforce-aaa-structure/index.d.ts.map +0 -1
- package/dist/testing/enforce-aaa-structure/index.js +0 -2
- package/dist/testing/enforce-aaa-structure/rule.d.ts.map +0 -1
- package/dist/testing/enforce-aaa-structure/rule.js +0 -48
- package/dist/testing/index.d.ts.map +0 -1
- package/dist/testing/index.js +0 -9
- package/dist/testing/prefer-vi-mocked-import/fix.d.ts +0 -16
- package/dist/testing/prefer-vi-mocked-import/fix.d.ts.map +0 -1
- package/dist/testing/prefer-vi-mocked-import/fix.js +0 -224
- package/dist/testing/prefer-vi-mocked-import/index.d.ts +0 -2
- package/dist/testing/prefer-vi-mocked-import/index.d.ts.map +0 -1
- package/dist/testing/prefer-vi-mocked-import/index.js +0 -2
- package/dist/testing/prefer-vi-mocked-import/match-bindings.d.ts.map +0 -1
- package/dist/testing/prefer-vi-mocked-import/match-bindings.js +0 -52
- package/dist/testing/prefer-vi-mocked-import/match-declarations.d.ts.map +0 -1
- package/dist/testing/prefer-vi-mocked-import/match-declarations.js +0 -99
- package/dist/testing/prefer-vi-mocked-import/match-helpers.d.ts.map +0 -1
- package/dist/testing/prefer-vi-mocked-import/match-helpers.js +0 -102
- package/dist/testing/prefer-vi-mocked-import/match-imports.d.ts.map +0 -1
- package/dist/testing/prefer-vi-mocked-import/match-imports.js +0 -156
- package/dist/testing/prefer-vi-mocked-import/match-rewrites.d.ts.map +0 -1
- package/dist/testing/prefer-vi-mocked-import/match-rewrites.js +0 -119
- package/dist/testing/prefer-vi-mocked-import/match-walk.d.ts.map +0 -1
- package/dist/testing/prefer-vi-mocked-import/match-walk.js +0 -62
- package/dist/testing/prefer-vi-mocked-import/match.d.ts +0 -15
- package/dist/testing/prefer-vi-mocked-import/match.d.ts.map +0 -1
- package/dist/testing/prefer-vi-mocked-import/match.js +0 -193
- package/dist/testing/prefer-vi-mocked-import/rule.d.ts.map +0 -1
- package/dist/testing/prefer-vi-mocked-import/rule.js +0 -32
- package/dist/testing/prefer-vi-mocked-import/types.d.ts.map +0 -1
- package/dist/testing/prefer-vi-mocked-import/types.js +0 -2
- package/dist/testing/require-aaa-sections/index.d.ts +0 -2
- package/dist/testing/require-aaa-sections/index.d.ts.map +0 -1
- package/dist/testing/require-aaa-sections/index.js +0 -2
- package/dist/testing/require-aaa-sections/rule.d.ts.map +0 -1
- package/dist/testing/require-aaa-sections/rule.js +0 -111
- package/dist/testing/require-act-result-capture/index.d.ts +0 -2
- package/dist/testing/require-act-result-capture/index.d.ts.map +0 -1
- package/dist/testing/require-act-result-capture/index.js +0 -2
- package/dist/testing/require-act-result-capture/rule.d.ts.map +0 -1
- package/dist/testing/require-act-result-capture/rule.js +0 -34
- package/dist/testing/require-test-companion/index.d.ts +0 -3
- package/dist/testing/require-test-companion/index.d.ts.map +0 -1
- package/dist/testing/require-test-companion/index.js +0 -3
- package/dist/testing/require-test-companion/require-test-companion-listeners.d.ts.map +0 -1
- package/dist/testing/require-test-companion/require-test-companion-listeners.js +0 -145
- package/dist/testing/require-test-companion/require-test-companion-options.d.ts.map +0 -1
- package/dist/testing/require-test-companion/require-test-companion-options.js +0 -112
- package/dist/testing/require-test-companion/require-test-companion-test-helpers.d.ts.map +0 -1
- package/dist/testing/require-test-companion/require-test-companion-test-helpers.js +0 -183
- package/dist/testing/require-test-companion/require-test-companion-utilities.d.ts.map +0 -1
- package/dist/testing/require-test-companion/require-test-companion-utilities.js +0 -26
- package/dist/testing/require-test-companion/rule.d.ts.map +0 -1
- package/dist/testing/require-test-companion/rule.js +0 -57
- package/dist/testing/require-test-companion/types.d.ts.map +0 -1
- package/dist/testing/require-test-companion/types.js +0 -2
- package/dist/testing/single-act-statement/index.d.ts +0 -2
- package/dist/testing/single-act-statement/index.d.ts.map +0 -1
- package/dist/testing/single-act-statement/index.js +0 -2
- package/dist/testing/single-act-statement/rule.d.ts.map +0 -1
- package/dist/testing/single-act-statement/rule.js +0 -33
- /package/dist/{architecture → domain/architecture}/consistent-barrel-files/exports-only-rule.d.ts +0 -0
- /package/dist/{architecture → domain/architecture}/consistent-barrel-files/no-reexports-outside-barrels-rule.d.ts +0 -0
- /package/dist/{architecture → domain/architecture}/consistent-barrel-files/rule.d.ts +0 -0
- /package/dist/{core → domain/core}/prefer-interface-types/rule.d.ts +0 -0
- /package/dist/{core → domain/core}/prefer-interface-types/test-helpers.d.ts +0 -0
- /package/dist/{docs → domain/docs}/no-interface-member-docs/comment-utilities-test-helpers.d.ts +0 -0
- /package/dist/{docs → domain/docs}/no-interface-member-docs/rule.d.ts +0 -0
- /package/dist/{docs → domain/docs}/no-interface-member-docs/test-helpers.d.ts +0 -0
- /package/dist/{docs → domain/docs}/require-example-language/empty-fence-fixes.d.ts +0 -0
- /package/dist/{docs → domain/docs}/require-example-language/example-utilities.d.ts +0 -0
- /package/dist/{docs → domain/docs}/require-example-language/rule.d.ts +0 -0
- /package/dist/{docs → domain/docs}/require-example-language/types.d.ts +0 -0
- /package/dist/{docs → domain/docs}/single-line-jsdoc/rule.d.ts +0 -0
- /package/dist/{docs → domain/docs}/single-line-jsdoc/single-line-jsdoc-content.d.ts +0 -0
- /package/dist/{docs → domain/docs}/test-helpers.d.ts +0 -0
- /package/dist/{testing → domain/testing}/prefer-vi-mocked-import/match-helpers.d.ts +0 -0
- /package/dist/{testing → domain/testing}/prefer-vi-mocked-import/match-walk.d.ts +0 -0
- /package/dist/{testing → domain/testing}/prefer-vi-mocked-import/rule.d.ts +0 -0
- /package/dist/{testing → domain/testing}/require-test-companion/require-test-companion-options.d.ts +0 -0
- /package/dist/{testing → domain/testing}/require-test-companion/rule.d.ts +0 -0
- /package/dist/{testing → domain/testing}/require-test-companion/types.d.ts +0 -0
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { createRuleDocumentation } from "../../custom-rule-documentation.js";
|
|
2
|
+
import { getExamples } from "./examples.js";
|
|
3
|
+
import { reportExample } from "./reporting.js";
|
|
4
|
+
/**
|
|
5
|
+
* ESLint rule requiring \@example tags to use fenced code blocks with a language.
|
|
6
|
+
*/
|
|
7
|
+
const requireExampleLanguageRule = {
|
|
8
|
+
create(context) {
|
|
9
|
+
const { sourceCode } = context;
|
|
10
|
+
for (const comment of sourceCode.getAllComments()) {
|
|
11
|
+
if (comment.type === "Block" && comment.value.startsWith("*")) {
|
|
12
|
+
const examples = getExamples(comment.value);
|
|
13
|
+
const hasOtherExamples = examples.length > 1;
|
|
14
|
+
for (const example of examples) {
|
|
15
|
+
reportExample({ comment, context, example, hasOtherExamples });
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
return {};
|
|
20
|
+
},
|
|
21
|
+
meta: {
|
|
22
|
+
docs: createRuleDocumentation("require-example-language", "Require @example tags to use fenced code blocks with a language."),
|
|
23
|
+
fixable: "code",
|
|
24
|
+
messages: {
|
|
25
|
+
emptyExample: "@example must include example content.",
|
|
26
|
+
missingFence: "@example must include a fenced code block with a language (e.g. ```typescript).",
|
|
27
|
+
missingLanguage: "@example fenced code blocks must specify a language (e.g. ```typescript).",
|
|
28
|
+
},
|
|
29
|
+
schema: [],
|
|
30
|
+
type: "problem",
|
|
31
|
+
},
|
|
32
|
+
};
|
|
33
|
+
export { requireExampleLanguageRule };
|
|
34
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicnVsZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9kb21haW4vZG9jcy9yZXF1aXJlLWV4YW1wbGUtbGFuZ3VhZ2UvcnVsZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFFQSxPQUFPLEVBQUUsdUJBQXVCLEVBQUUsTUFBTSxpQ0FBaUMsQ0FBQztBQUMxRSxPQUFPLEVBQUUsV0FBVyxFQUFFLE1BQU0sWUFBWSxDQUFDO0FBQ3pDLE9BQU8sRUFBRSxhQUFhLEVBQUUsTUFBTSxhQUFhLENBQUM7QUFFNUM7O0dBRUc7QUFDSCxNQUFNLDBCQUEwQixHQUFvQjtJQUNsRCxNQUFNLENBQUMsT0FBeUI7UUFDOUIsTUFBTSxFQUFFLFVBQVUsRUFBRSxHQUFHLE9BQU8sQ0FBQztRQUUvQixLQUFLLE1BQU0sT0FBTyxJQUFJLFVBQVUsQ0FBQyxjQUFjLEVBQUUsRUFBRSxDQUFDO1lBQ2xELElBQUksT0FBTyxDQUFDLElBQUksS0FBSyxPQUFPLElBQUksT0FBTyxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQztnQkFDOUQsTUFBTSxRQUFRLEdBQUcsV0FBVyxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQztnQkFFNUMsTUFBTSxnQkFBZ0IsR0FBRyxRQUFRLENBQUMsTUFBTSxHQUFHLENBQUMsQ0FBQztnQkFFN0MsS0FBSyxNQUFNLE9BQU8sSUFBSSxRQUFRLEVBQUUsQ0FBQztvQkFDL0IsYUFBYSxDQUFDLEVBQUUsT0FBTyxFQUFFLE9BQU8sRUFBRSxPQUFPLEVBQUUsZ0JBQWdCLEVBQUUsQ0FBQyxDQUFDO2dCQUNqRSxDQUFDO1lBQ0gsQ0FBQztRQUNILENBQUM7UUFFRCxPQUFPLEVBQUUsQ0FBQztJQUNaLENBQUM7SUFDRCxJQUFJLEVBQUU7UUFDSixJQUFJLEVBQUUsdUJBQXVCLENBQzNCLDBCQUEwQixFQUMxQixrRUFBa0UsQ0FDbkU7UUFDRCxPQUFPLEVBQUUsTUFBTTtRQUNmLFFBQVEsRUFBRTtZQUNSLFlBQVksRUFBRSx3Q0FBd0M7WUFDdEQsWUFBWSxFQUNWLGlGQUFpRjtZQUNuRixlQUFlLEVBQ2IsMkVBQTJFO1NBQzlFO1FBQ0QsTUFBTSxFQUFFLEVBQUU7UUFDVixJQUFJLEVBQUUsU0FBUztLQUNoQjtDQUNGLENBQUM7QUFFRixPQUFPLEVBQUUsMEJBQTBCLEVBQUUsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB0eXBlIHsgUnVsZSB9IGZyb20gXCJlc2xpbnRcIjtcblxuaW1wb3J0IHsgY3JlYXRlUnVsZURvY3VtZW50YXRpb24gfSBmcm9tIFwiLi4vLi4vY3VzdG9tLXJ1bGUtZG9jdW1lbnRhdGlvblwiO1xuaW1wb3J0IHsgZ2V0RXhhbXBsZXMgfSBmcm9tIFwiLi9leGFtcGxlc1wiO1xuaW1wb3J0IHsgcmVwb3J0RXhhbXBsZSB9IGZyb20gXCIuL3JlcG9ydGluZ1wiO1xuXG4vKipcbiAqIEVTTGludCBydWxlIHJlcXVpcmluZyBcXEBleGFtcGxlIHRhZ3MgdG8gdXNlIGZlbmNlZCBjb2RlIGJsb2NrcyB3aXRoIGEgbGFuZ3VhZ2UuXG4gKi9cbmNvbnN0IHJlcXVpcmVFeGFtcGxlTGFuZ3VhZ2VSdWxlOiBSdWxlLlJ1bGVNb2R1bGUgPSB7XG4gIGNyZWF0ZShjb250ZXh0OiBSdWxlLlJ1bGVDb250ZXh0KTogUnVsZS5SdWxlTGlzdGVuZXIge1xuICAgIGNvbnN0IHsgc291cmNlQ29kZSB9ID0gY29udGV4dDtcblxuICAgIGZvciAoY29uc3QgY29tbWVudCBvZiBzb3VyY2VDb2RlLmdldEFsbENvbW1lbnRzKCkpIHtcbiAgICAgIGlmIChjb21tZW50LnR5cGUgPT09IFwiQmxvY2tcIiAmJiBjb21tZW50LnZhbHVlLnN0YXJ0c1dpdGgoXCIqXCIpKSB7XG4gICAgICAgIGNvbnN0IGV4YW1wbGVzID0gZ2V0RXhhbXBsZXMoY29tbWVudC52YWx1ZSk7XG5cbiAgICAgICAgY29uc3QgaGFzT3RoZXJFeGFtcGxlcyA9IGV4YW1wbGVzLmxlbmd0aCA+IDE7XG5cbiAgICAgICAgZm9yIChjb25zdCBleGFtcGxlIG9mIGV4YW1wbGVzKSB7XG4gICAgICAgICAgcmVwb3J0RXhhbXBsZSh7IGNvbW1lbnQsIGNvbnRleHQsIGV4YW1wbGUsIGhhc090aGVyRXhhbXBsZXMgfSk7XG4gICAgICAgIH1cbiAgICAgIH1cbiAgICB9XG5cbiAgICByZXR1cm4ge307XG4gIH0sXG4gIG1ldGE6IHtcbiAgICBkb2NzOiBjcmVhdGVSdWxlRG9jdW1lbnRhdGlvbihcbiAgICAgIFwicmVxdWlyZS1leGFtcGxlLWxhbmd1YWdlXCIsXG4gICAgICBcIlJlcXVpcmUgQGV4YW1wbGUgdGFncyB0byB1c2UgZmVuY2VkIGNvZGUgYmxvY2tzIHdpdGggYSBsYW5ndWFnZS5cIixcbiAgICApLFxuICAgIGZpeGFibGU6IFwiY29kZVwiLFxuICAgIG1lc3NhZ2VzOiB7XG4gICAgICBlbXB0eUV4YW1wbGU6IFwiQGV4YW1wbGUgbXVzdCBpbmNsdWRlIGV4YW1wbGUgY29udGVudC5cIixcbiAgICAgIG1pc3NpbmdGZW5jZTpcbiAgICAgICAgXCJAZXhhbXBsZSBtdXN0IGluY2x1ZGUgYSBmZW5jZWQgY29kZSBibG9jayB3aXRoIGEgbGFuZ3VhZ2UgKGUuZy4gYGBgdHlwZXNjcmlwdCkuXCIsXG4gICAgICBtaXNzaW5nTGFuZ3VhZ2U6XG4gICAgICAgIFwiQGV4YW1wbGUgZmVuY2VkIGNvZGUgYmxvY2tzIG11c3Qgc3BlY2lmeSBhIGxhbmd1YWdlIChlLmcuIGBgYHR5cGVzY3JpcHQpLlwiLFxuICAgIH0sXG4gICAgc2NoZW1hOiBbXSxcbiAgICB0eXBlOiBcInByb2JsZW1cIixcbiAgfSxcbn07XG5cbmV4cG9ydCB7IHJlcXVpcmVFeGFtcGxlTGFuZ3VhZ2VSdWxlIH07XG4iXX0=
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/domain/docs/require-example-language/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,qCAAqC;AACrC,KAAK,OAAO,GAAG,UAAU,CACvB,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,gBAAgB,CAAC,CACjD,CAAC,MAAM,CAAC,CAAC;AAEV,qCAAqC;AACrC,UAAU,OAAO;IACf,2BAA2B;IAC3B,OAAO,EAAE,MAAM,CAAC;IAEhB,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;IAEjB,6BAA6B;IAC7B,SAAS,EAAE,MAAM,CAAC;IAElB,6BAA6B;IAC7B,SAAS,EAAE,MAAM,CAAC;IAElB,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAC;IAEf,+BAA+B;IAC/B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,qCAAqC;AACrC,KAAK,OAAO,GAAG,cAAc,GAAG,cAAc,GAAG,iBAAiB,CAAC;AAEnE,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC"}
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
export {};
|
|
2
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvZG9tYWluL2RvY3MvcmVxdWlyZS1leGFtcGxlLWxhbmd1YWdlL3R5cGVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgdHlwZSB7IFJ1bGUgfSBmcm9tIFwiZXNsaW50XCI7XG5cbi8qKiBUeXBlIGRlZmluaXRpb24gZm9yIHJ1bGUgZGF0YS4gKi9cbnR5cGUgQ29tbWVudCA9IFJldHVyblR5cGU8XG4gIFJ1bGUuUnVsZUNvbnRleHRbXCJzb3VyY2VDb2RlXCJdW1wiZ2V0QWxsQ29tbWVudHNcIl1cbj5bbnVtYmVyXTtcblxuLyoqIFR5cGUgZGVmaW5pdGlvbiBmb3IgcnVsZSBkYXRhLiAqL1xuaW50ZXJmYWNlIEV4YW1wbGUge1xuICAvKiogQ29udGVudCBmaWVsZCB2YWx1ZS4gKi9cbiAgY29udGVudDogc3RyaW5nO1xuXG4gIC8qKiBFbmRJbmRleCBmaWVsZCB2YWx1ZS4gKi9cbiAgZW5kSW5kZXg6IG51bWJlcjtcblxuICAvKiogRW5kT2Zmc2V0IGZpZWxkIHZhbHVlLiAqL1xuICBlbmRPZmZzZXQ6IG51bWJlcjtcblxuICAvKiogTGluZUluZGV4IGZpZWxkIHZhbHVlLiAqL1xuICBsaW5lSW5kZXg6IG51bWJlcjtcblxuICAvKiogUHJlZml4IGZpZWxkIHZhbHVlLiAqL1xuICBwcmVmaXg6IHN0cmluZztcblxuICAvKiogU3RhcnRPZmZzZXQgZmllbGQgdmFsdWUuICovXG4gIHN0YXJ0T2Zmc2V0OiBudW1iZXI7XG59XG5cbi8qKiBUeXBlIGRlZmluaXRpb24gZm9yIHJ1bGUgZGF0YS4gKi9cbnR5cGUgUHJvYmxlbSA9IFwiZW1wdHlFeGFtcGxlXCIgfCBcIm1pc3NpbmdGZW5jZVwiIHwgXCJtaXNzaW5nTGFuZ3VhZ2VcIjtcblxuZXhwb3J0IHR5cGUgeyBDb21tZW50LCBFeGFtcGxlLCBQcm9ibGVtIH07XG4iXX0=
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/domain/docs/single-line-jsdoc/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC"}
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
export { singleLineJsdocRule } from "./rule.js";
|
|
2
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvZG9tYWluL2RvY3Mvc2luZ2xlLWxpbmUtanNkb2MvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLG1CQUFtQixFQUFFLE1BQU0sUUFBUSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0IHsgc2luZ2xlTGluZUpzZG9jUnVsZSB9IGZyb20gXCIuL3J1bGVcIjtcbiJdfQ==
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rule.d.ts","sourceRoot":"","sources":["../../../../src/domain/docs/single-line-jsdoc/rule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAoQnC,4DAA4D;AAC5D,QAAA,MAAM,mBAAmB,EAAE,IAAI,CAAC,UAmC/B,CAAC;AAEF,OAAO,EAAE,mBAAmB,EAAE,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rule.edge-cases.d.ts","sourceRoot":"","sources":["../../../../src/domain/docs/single-line-jsdoc/rule.edge-cases.ts"],"names":[],"mappings":"AAEA,8DAA8D;AAC9D,QAAA,MAAM,4BAA4B,kCAAsB,CAAC;AAEzD,OAAO,EAAE,4BAA4B,EAAE,CAAC"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { singleLineJsdocRule } from "./rule.js";
|
|
2
|
+
/** Companion module for single-line-jsdoc edge-case tests. */
|
|
3
|
+
const singleLineJsdocRuleEdgeCases = singleLineJsdocRule;
|
|
4
|
+
export { singleLineJsdocRuleEdgeCases };
|
|
5
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicnVsZS5lZGdlLWNhc2VzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2RvbWFpbi9kb2NzL3NpbmdsZS1saW5lLWpzZG9jL3J1bGUuZWRnZS1jYXNlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsbUJBQW1CLEVBQUUsTUFBTSxRQUFRLENBQUM7QUFFN0MsOERBQThEO0FBQzlELE1BQU0sNEJBQTRCLEdBQUcsbUJBQW1CLENBQUM7QUFFekQsT0FBTyxFQUFFLDRCQUE0QixFQUFFLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBzaW5nbGVMaW5lSnNkb2NSdWxlIH0gZnJvbSBcIi4vcnVsZVwiO1xyXG5cclxuLyoqIENvbXBhbmlvbiBtb2R1bGUgZm9yIHNpbmdsZS1saW5lLWpzZG9jIGVkZ2UtY2FzZSB0ZXN0cy4gKi9cclxuY29uc3Qgc2luZ2xlTGluZUpzZG9jUnVsZUVkZ2VDYXNlcyA9IHNpbmdsZUxpbmVKc2RvY1J1bGU7XHJcblxyXG5leHBvcnQgeyBzaW5nbGVMaW5lSnNkb2NSdWxlRWRnZUNhc2VzIH07Il19
|
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
import { createRuleDocumentation } from "../../custom-rule-documentation.js";
|
|
2
|
+
import { normalizeMaxLineLength, reportIfSingleLine, } from "./single-line-jsdoc-utilities.js";
|
|
3
|
+
/**
|
|
4
|
+
* Resolves the token after a comment when available.
|
|
5
|
+
* @param sourceCode Source code accessors.
|
|
6
|
+
* @param comment Comment node to inspect.
|
|
7
|
+
* @returns Token range metadata when available.
|
|
8
|
+
* @example
|
|
9
|
+
* ```typescript
|
|
10
|
+
* getTokenAfterRange({} as SourceCodeAccess, {} as SourceComment);
|
|
11
|
+
* ```
|
|
12
|
+
*/
|
|
13
|
+
const getTokenAfterRange = (sourceCode, comment) => {
|
|
14
|
+
if (typeof sourceCode.getTokenAfter !== "function") {
|
|
15
|
+
return void 0;
|
|
16
|
+
}
|
|
17
|
+
const tokenAfter = sourceCode.getTokenAfter(comment, {
|
|
18
|
+
includeComments: false,
|
|
19
|
+
});
|
|
20
|
+
if (tokenAfter?.range === void 0) {
|
|
21
|
+
return void 0;
|
|
22
|
+
}
|
|
23
|
+
return { range: tokenAfter.range };
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
* Function-like node types handled directly.
|
|
27
|
+
* @example
|
|
28
|
+
* ```typescript
|
|
29
|
+
* functionLikeTypes.has("TSFunctionType");
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
const functionLikeTypes = new Set([
|
|
33
|
+
"TSCallSignatureDeclaration",
|
|
34
|
+
"TSConstructSignatureDeclaration",
|
|
35
|
+
"TSFunctionType",
|
|
36
|
+
]);
|
|
37
|
+
/**
|
|
38
|
+
* Checks if a node is a function expression or arrow function.
|
|
39
|
+
* @param node Node to inspect.
|
|
40
|
+
* @returns True when the node is a function expression.
|
|
41
|
+
* @example
|
|
42
|
+
* ```typescript
|
|
43
|
+
* isFunctionExpression({ type: "FunctionExpression" } as EstreeNode);
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
const isFunctionExpression = (node) => node?.type === "FunctionExpression" || node?.type === "ArrowFunctionExpression";
|
|
47
|
+
/**
|
|
48
|
+
* Checks if a node is a function declaration or TS declaration signature.
|
|
49
|
+
* @param node Node to inspect.
|
|
50
|
+
* @returns True when the node is a function declaration.
|
|
51
|
+
* @example
|
|
52
|
+
* ```typescript
|
|
53
|
+
* isFunctionDeclaration({ type: "FunctionDeclaration" } as EstreeNode);
|
|
54
|
+
* ```
|
|
55
|
+
*/
|
|
56
|
+
const isFunctionDeclaration = (node) => node?.type === "FunctionDeclaration" || node?.type === "TSDeclareFunction";
|
|
57
|
+
/**
|
|
58
|
+
* Checks if a node is a method-like declaration.
|
|
59
|
+
* @param node Node to inspect.
|
|
60
|
+
* @returns True when the node is a method-like declaration.
|
|
61
|
+
* @example
|
|
62
|
+
* ```typescript
|
|
63
|
+
* isMethodLike({ type: "MethodDefinition" } as EstreeNode);
|
|
64
|
+
* ```
|
|
65
|
+
*/
|
|
66
|
+
const isMethodLike = (node) => node?.type === "MethodDefinition" || node?.type === "TSMethodSignature";
|
|
67
|
+
/**
|
|
68
|
+
* Checks if a node is a property with a function initializer.
|
|
69
|
+
* @param node Node to inspect.
|
|
70
|
+
* @returns True when the property value is a function.
|
|
71
|
+
* @example
|
|
72
|
+
* ```typescript
|
|
73
|
+
* isPropertyWithFunctionValue({ type: "Property" } as EstreeNode);
|
|
74
|
+
* ```
|
|
75
|
+
*/
|
|
76
|
+
const isPropertyWithFunctionValue = (node) => {
|
|
77
|
+
if (node.type !== "PropertyDefinition" && node.type !== "Property") {
|
|
78
|
+
return false;
|
|
79
|
+
}
|
|
80
|
+
const { value } = node;
|
|
81
|
+
return isFunctionExpression(value);
|
|
82
|
+
};
|
|
83
|
+
/**
|
|
84
|
+
* Checks if a variable declaration contains a function initializer.
|
|
85
|
+
* @param node Node to inspect.
|
|
86
|
+
* @returns True when any initializer is a function.
|
|
87
|
+
* @example
|
|
88
|
+
* ```typescript
|
|
89
|
+
* isVariableWithFunctionInit({ type: "VariableDeclaration" } as EstreeNode);
|
|
90
|
+
* ```
|
|
91
|
+
*/
|
|
92
|
+
const isVariableWithFunctionInit = (node) => {
|
|
93
|
+
if (node.type !== "VariableDeclaration") {
|
|
94
|
+
return false;
|
|
95
|
+
}
|
|
96
|
+
const { declarations } = node;
|
|
97
|
+
const initialized = declarations ?? [];
|
|
98
|
+
return initialized.some((declaration) => isFunctionExpression(declaration.init));
|
|
99
|
+
};
|
|
100
|
+
/**
|
|
101
|
+
* Checks if an export wraps a function-like declaration.
|
|
102
|
+
* @param node Node to inspect.
|
|
103
|
+
* @returns True when the exported declaration is function-like.
|
|
104
|
+
* @example
|
|
105
|
+
* ```typescript
|
|
106
|
+
* isExportedFunctionLike({ type: "ExportNamedDeclaration" } as EstreeNode);
|
|
107
|
+
* ```
|
|
108
|
+
*/
|
|
109
|
+
const isExportedFunctionLike = (node) => {
|
|
110
|
+
if (node.type !== "ExportNamedDeclaration" &&
|
|
111
|
+
node.type !== "ExportDefaultDeclaration") {
|
|
112
|
+
return false;
|
|
113
|
+
}
|
|
114
|
+
const { declaration } = node;
|
|
115
|
+
return isFunctionLikeNode(declaration);
|
|
116
|
+
};
|
|
117
|
+
/**
|
|
118
|
+
* Checks if a node represents any supported function-like declaration.
|
|
119
|
+
* @param node Node to inspect.
|
|
120
|
+
* @returns True when the node is function-like.
|
|
121
|
+
* @example
|
|
122
|
+
* ```typescript
|
|
123
|
+
* isFunctionLikeNode({ type: "FunctionDeclaration" } as EstreeNode);
|
|
124
|
+
* ```
|
|
125
|
+
*/
|
|
126
|
+
const isFunctionLikeNode = (node) => {
|
|
127
|
+
if (node === null || node === void 0) {
|
|
128
|
+
return false;
|
|
129
|
+
}
|
|
130
|
+
return (isFunctionDeclaration(node) ||
|
|
131
|
+
isFunctionExpression(node) ||
|
|
132
|
+
isMethodLike(node) ||
|
|
133
|
+
functionLikeTypes.has(node.type) ||
|
|
134
|
+
isPropertyWithFunctionValue(node) ||
|
|
135
|
+
isVariableWithFunctionInit(node) ||
|
|
136
|
+
isExportedFunctionLike(node));
|
|
137
|
+
};
|
|
138
|
+
/**
|
|
139
|
+
* Determines whether a JSDoc comment should be skipped for function targets.
|
|
140
|
+
* @param context Rule context.
|
|
141
|
+
* @param comment Comment node to inspect.
|
|
142
|
+
* @returns True when the comment targets a function-like node.
|
|
143
|
+
* @example
|
|
144
|
+
* ```typescript
|
|
145
|
+
* shouldSkipForFunction({} as Rule.RuleContext, {} as SourceComment);
|
|
146
|
+
* ```
|
|
147
|
+
*/
|
|
148
|
+
const shouldSkipForFunction = (context, comment) => {
|
|
149
|
+
const sourceCode = context.sourceCode;
|
|
150
|
+
if (typeof sourceCode.getNodeByRangeIndex !== "function") {
|
|
151
|
+
return false;
|
|
152
|
+
}
|
|
153
|
+
const tokenAfter = getTokenAfterRange(sourceCode, comment);
|
|
154
|
+
if (tokenAfter === void 0) {
|
|
155
|
+
return false;
|
|
156
|
+
}
|
|
157
|
+
const [rangeStart] = tokenAfter.range;
|
|
158
|
+
const node = sourceCode.getNodeByRangeIndex(rangeStart);
|
|
159
|
+
return isFunctionLikeNode(node);
|
|
160
|
+
};
|
|
161
|
+
/** Rule module enforcing single-line JSDoc when it fits. */
|
|
162
|
+
const singleLineJsdocRule = {
|
|
163
|
+
create(context) {
|
|
164
|
+
const { options, sourceCode } = context;
|
|
165
|
+
const maxLineLength = normalizeMaxLineLength(options);
|
|
166
|
+
const comments = sourceCode.getAllComments();
|
|
167
|
+
for (const comment of comments) {
|
|
168
|
+
if (!shouldSkipForFunction(context, comment)) {
|
|
169
|
+
reportIfSingleLine(context, comment, maxLineLength);
|
|
170
|
+
}
|
|
171
|
+
}
|
|
172
|
+
return {};
|
|
173
|
+
},
|
|
174
|
+
meta: {
|
|
175
|
+
docs: createRuleDocumentation("single-line-jsdoc", "Require JSDoc comments to use a single line when they fit."),
|
|
176
|
+
fixable: "code",
|
|
177
|
+
messages: {
|
|
178
|
+
singleLine: "Use a single-line JSDoc comment when it fits on one line.",
|
|
179
|
+
},
|
|
180
|
+
schema: [
|
|
181
|
+
{
|
|
182
|
+
additionalProperties: false,
|
|
183
|
+
properties: {
|
|
184
|
+
maxLineLength: {
|
|
185
|
+
minimum: 1,
|
|
186
|
+
type: "number",
|
|
187
|
+
},
|
|
188
|
+
},
|
|
189
|
+
type: "object",
|
|
190
|
+
},
|
|
191
|
+
],
|
|
192
|
+
type: "layout",
|
|
193
|
+
},
|
|
194
|
+
};
|
|
195
|
+
export { singleLineJsdocRule };
|
|
196
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"rule.js","sourceRoot":"","sources":["../../../../src/domain/docs/single-line-jsdoc/rule.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,EACL,sBAAsB,EACtB,kBAAkB,GACnB,MAAM,+BAA+B,CAAC;AA0DvC;;;;;;;;;GASG;AACH,MAAM,kBAAkB,GAAG,CACzB,UAA4B,EAC5B,OAAsB,EACM,EAAE;IAC9B,IAAI,OAAO,UAAU,CAAC,aAAa,KAAK,UAAU,EAAE,CAAC;QACnD,OAAO,KAAK,CAAC,CAAC;IAChB,CAAC;IAED,MAAM,UAAU,GAAG,UAAU,CAAC,aAAa,CAAC,OAAO,EAAE;QACnD,eAAe,EAAE,KAAK;KACvB,CAAC,CAAC;IAEH,IAAI,UAAU,EAAE,KAAK,KAAK,KAAK,CAAC,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC,CAAC;IAChB,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,CAAC;AACrC,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAS;IACxC,4BAA4B;IAC5B,iCAAiC;IACjC,gBAAgB;CACjB,CAAC,CAAC;AAEH;;;;;;;;GAQG;AACH,MAAM,oBAAoB,GAAG,CAAC,IAAe,EAAW,EAAE,CACxD,IAAI,EAAE,IAAI,KAAK,oBAAoB,IAAI,IAAI,EAAE,IAAI,KAAK,yBAAyB,CAAC;AAElF;;;;;;;;GAQG;AACH,MAAM,qBAAqB,GAAG,CAAC,IAAe,EAAW,EAAE,CACzD,IAAI,EAAE,IAAI,KAAK,qBAAqB,IAAI,IAAI,EAAE,IAAI,KAAK,mBAAmB,CAAC;AAE7E;;;;;;;;GAQG;AACH,MAAM,YAAY,GAAG,CAAC,IAAe,EAAW,EAAE,CAChD,IAAI,EAAE,IAAI,KAAK,kBAAkB,IAAI,IAAI,EAAE,IAAI,KAAK,mBAAmB,CAAC;AAE1E;;;;;;;;GAQG;AACH,MAAM,2BAA2B,GAAG,CAAC,IAAgB,EAAW,EAAE;IAChE,IAAI,IAAI,CAAC,IAAI,KAAK,oBAAoB,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QACnE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,EAAE,KAAK,EAAE,GAAG,IAAqB,CAAC;IAExC,OAAO,oBAAoB,CAAC,KAAK,CAAC,CAAC;AACrC,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,0BAA0B,GAAG,CAAC,IAAgB,EAAW,EAAE;IAC/D,IAAI,IAAI,CAAC,IAAI,KAAK,qBAAqB,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,EAAE,YAAY,EAAE,GAAG,IAA4B,CAAC;IACtD,MAAM,WAAW,GAAG,YAAY,IAAI,EAAE,CAAC;IAEvC,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CACtC,oBAAoB,CAAC,WAAW,CAAC,IAAI,CAAC,CACvC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,sBAAsB,GAAG,CAAC,IAAgB,EAAW,EAAE;IAC3D,IACE,IAAI,CAAC,IAAI,KAAK,wBAAwB;QACtC,IAAI,CAAC,IAAI,KAAK,0BAA0B,EACxC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,EAAE,WAAW,EAAE,GAAG,IAA2B,CAAC;IAEpD,OAAO,kBAAkB,CAAC,WAAW,CAAC,CAAC;AACzC,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,kBAAkB,GAAG,CAAC,IAAe,EAAW,EAAE;IACtD,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QACrC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CACL,qBAAqB,CAAC,IAAI,CAAC;QAC3B,oBAAoB,CAAC,IAAI,CAAC;QAC1B,YAAY,CAAC,IAAI,CAAC;QAClB,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC;QAChC,2BAA2B,CAAC,IAAkB,CAAC;QAC/C,0BAA0B,CAAC,IAAkB,CAAC;QAC9C,sBAAsB,CAAC,IAAkB,CAAC,CAC3C,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,qBAAqB,GAAG,CAC5B,OAAyB,EACzB,OAAsB,EACb,EAAE;IACX,MAAM,UAAU,GAAG,OAAO,CAAC,UAA8B,CAAC;IAC1D,IAAI,OAAO,UAAU,CAAC,mBAAmB,KAAK,UAAU,EAAE,CAAC;QACzD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,UAAU,GAAG,kBAAkB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC3D,IAAI,UAAU,KAAK,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC;IACtC,MAAM,IAAI,GAAG,UAAU,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IACxD,OAAO,kBAAkB,CAAC,IAAI,CAAC,CAAC;AAClC,CAAC,CAAC;AAEF,4DAA4D;AAC5D,MAAM,mBAAmB,GAAoB;IAC3C,MAAM,CAAC,OAAyB;QAC9B,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;QACxC,MAAM,aAAa,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAC;QAEtD,MAAM,QAAQ,GAAG,UAAU,CAAC,cAAc,EAAE,CAAC;QAE7C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC;gBAC7C,kBAAkB,CAAC,OAAO,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,EAAE;QACJ,IAAI,EAAE,uBAAuB,CAAC,mBAAmB,EAAE,4DAA4D,CAAC;QAChH,OAAO,EAAE,MAAM;QACf,QAAQ,EAAE;YACR,UAAU,EAAE,2DAA2D;SACxE;QACD,MAAM,EAAE;YACN;gBACE,oBAAoB,EAAE,KAAK;gBAC3B,UAAU,EAAE;oBACV,aAAa,EAAE;wBACb,OAAO,EAAE,CAAC;wBACV,IAAI,EAAE,QAAQ;qBACf;iBACF;gBACD,IAAI,EAAE,QAAQ;aACf;SACF;QACD,IAAI,EAAE,QAAQ;KACf;CACF,CAAC;AAEF,OAAO,EAAE,mBAAmB,EAAE,CAAC","sourcesContent":["import type { Rule } from \"eslint\";\nimport type { Comment as EstreeComment, Node as EstreeNode } from \"estree\";\n\nimport { createRuleDocumentation } from \"../../custom-rule-documentation\";\nimport {\n  normalizeMaxLineLength,\n  reportIfSingleLine,\n} from \"./single-line-jsdoc-utilities\";\n/** Type union for nodes that may be missing. */\ntype MaybeNode = EstreeNode | NodeWithType | null | undefined;\n\n/** Shape for export nodes that wrap a declaration. */\ninterface NodeWithDeclaration {\n  /** Declaration wrapped by the export. */\n  declaration?: MaybeNode;\n}\n/** Shape for nodes that have declarations. */\ninterface NodeWithDeclarations {\n  /** Variable declarations for a declaration list. */\n  declarations?: VariableDeclarationEntry[];\n}\n/** Shape for minimal nodes that only expose a type. */\ninterface NodeWithType {\n  /** Node type discriminator. */\n  type: string;\n}\n/** Shape for nodes that have a value. */\ninterface NodeWithValue {\n  /** Value node used for property initializers. */\n  value?: MaybeNode;\n}\n/** SourceCode accessors used by this rule. */\ninterface SourceCodeAccess {\n  /** Returns the node at a range index. */\n  getNodeByRangeIndex: (index: number) => EstreeNode | null;\n\n  /** Returns the first token after a comment. */\n  getTokenAfter: (\n    node: EstreeComment,\n    options?: TokenAfterOptions,\n  ) => null | TokenWithOptionalRange;\n}\n/** Type alias for comment nodes provided by ESLint. */\ntype SourceComment = EstreeComment;\n/** Options used when fetching tokens after comments. */\ninterface TokenAfterOptions {\n  /** Whether to include comment tokens. */\n  includeComments?: boolean;\n}\n/** Shape for tokens that may include a range. */\ninterface TokenWithOptionalRange {\n  /** Token range used for lookups. */\n  range?: [number, number];\n}\n/** Shape for tokens with range metadata. */\ninterface TokenWithRange {\n  /** Token range used for lookups. */\n  range: [number, number];\n}\n/** Shape for variable declaration entries. */\ninterface VariableDeclarationEntry {\n  /** Optional initializer for the declaration. */\n  init?: MaybeNode;\n}\n\n/**\n * Resolves the token after a comment when available.\n * @param sourceCode Source code accessors.\n * @param comment Comment node to inspect.\n * @returns Token range metadata when available.\n * @example\n * ```typescript\n * getTokenAfterRange({} as SourceCodeAccess, {} as SourceComment);\n * ```\n */\nconst getTokenAfterRange = (\n  sourceCode: SourceCodeAccess,\n  comment: SourceComment,\n): TokenWithRange | undefined => {\n  if (typeof sourceCode.getTokenAfter !== \"function\") {\n    return void 0;\n  }\n\n  const tokenAfter = sourceCode.getTokenAfter(comment, {\n    includeComments: false,\n  });\n\n  if (tokenAfter?.range === void 0) {\n    return void 0;\n  }\n\n  return { range: tokenAfter.range };\n};\n\n/**\n * Function-like node types handled directly.\n * @example\n * ```typescript\n * functionLikeTypes.has(\"TSFunctionType\");\n * ```\n */\nconst functionLikeTypes = new Set<string>([\n  \"TSCallSignatureDeclaration\",\n  \"TSConstructSignatureDeclaration\",\n  \"TSFunctionType\",\n]);\n\n/**\n * Checks if a node is a function expression or arrow function.\n * @param node Node to inspect.\n * @returns True when the node is a function expression.\n * @example\n * ```typescript\n * isFunctionExpression({ type: \"FunctionExpression\" } as EstreeNode);\n * ```\n */\nconst isFunctionExpression = (node: MaybeNode): boolean =>\n  node?.type === \"FunctionExpression\" || node?.type === \"ArrowFunctionExpression\";\n\n/**\n * Checks if a node is a function declaration or TS declaration signature.\n * @param node Node to inspect.\n * @returns True when the node is a function declaration.\n * @example\n * ```typescript\n * isFunctionDeclaration({ type: \"FunctionDeclaration\" } as EstreeNode);\n * ```\n */\nconst isFunctionDeclaration = (node: MaybeNode): boolean =>\n  node?.type === \"FunctionDeclaration\" || node?.type === \"TSDeclareFunction\";\n\n/**\n * Checks if a node is a method-like declaration.\n * @param node Node to inspect.\n * @returns True when the node is a method-like declaration.\n * @example\n * ```typescript\n * isMethodLike({ type: \"MethodDefinition\" } as EstreeNode);\n * ```\n */\nconst isMethodLike = (node: MaybeNode): boolean =>\n  node?.type === \"MethodDefinition\" || node?.type === \"TSMethodSignature\";\n\n/**\n * Checks if a node is a property with a function initializer.\n * @param node Node to inspect.\n * @returns True when the property value is a function.\n * @example\n * ```typescript\n * isPropertyWithFunctionValue({ type: \"Property\" } as EstreeNode);\n * ```\n */\nconst isPropertyWithFunctionValue = (node: EstreeNode): boolean => {\n  if (node.type !== \"PropertyDefinition\" && node.type !== \"Property\") {\n    return false;\n  }\n\n  const { value } = node as NodeWithValue;\n\n  return isFunctionExpression(value);\n};\n\n/**\n * Checks if a variable declaration contains a function initializer.\n * @param node Node to inspect.\n * @returns True when any initializer is a function.\n * @example\n * ```typescript\n * isVariableWithFunctionInit({ type: \"VariableDeclaration\" } as EstreeNode);\n * ```\n */\nconst isVariableWithFunctionInit = (node: EstreeNode): boolean => {\n  if (node.type !== \"VariableDeclaration\") {\n    return false;\n  }\n\n  const { declarations } = node as NodeWithDeclarations;\n  const initialized = declarations ?? [];\n\n  return initialized.some((declaration) =>\n    isFunctionExpression(declaration.init),\n  );\n};\n\n/**\n * Checks if an export wraps a function-like declaration.\n * @param node Node to inspect.\n * @returns True when the exported declaration is function-like.\n * @example\n * ```typescript\n * isExportedFunctionLike({ type: \"ExportNamedDeclaration\" } as EstreeNode);\n * ```\n */\nconst isExportedFunctionLike = (node: EstreeNode): boolean => {\n  if (\n    node.type !== \"ExportNamedDeclaration\" &&\n    node.type !== \"ExportDefaultDeclaration\"\n  ) {\n    return false;\n  }\n\n  const { declaration } = node as NodeWithDeclaration;\n\n  return isFunctionLikeNode(declaration);\n};\n\n/**\n * Checks if a node represents any supported function-like declaration.\n * @param node Node to inspect.\n * @returns True when the node is function-like.\n * @example\n * ```typescript\n * isFunctionLikeNode({ type: \"FunctionDeclaration\" } as EstreeNode);\n * ```\n */\nconst isFunctionLikeNode = (node: MaybeNode): boolean => {\n  if (node === null || node === void 0) {\n    return false;\n  }\n\n  return (\n    isFunctionDeclaration(node) ||\n    isFunctionExpression(node) ||\n    isMethodLike(node) ||\n    functionLikeTypes.has(node.type) ||\n    isPropertyWithFunctionValue(node as EstreeNode) ||\n    isVariableWithFunctionInit(node as EstreeNode) ||\n    isExportedFunctionLike(node as EstreeNode)\n  );\n};\n\n/**\n * Determines whether a JSDoc comment should be skipped for function targets.\n * @param context Rule context.\n * @param comment Comment node to inspect.\n * @returns True when the comment targets a function-like node.\n * @example\n * ```typescript\n * shouldSkipForFunction({} as Rule.RuleContext, {} as SourceComment);\n * ```\n */\nconst shouldSkipForFunction = (\n  context: Rule.RuleContext,\n  comment: SourceComment,\n): boolean => {\n  const sourceCode = context.sourceCode as SourceCodeAccess;\n  if (typeof sourceCode.getNodeByRangeIndex !== \"function\") {\n    return false;\n  }\n\n  const tokenAfter = getTokenAfterRange(sourceCode, comment);\n  if (tokenAfter === void 0) {\n    return false;\n  }\n\n  const [rangeStart] = tokenAfter.range;\n  const node = sourceCode.getNodeByRangeIndex(rangeStart);\n  return isFunctionLikeNode(node);\n};\n\n/** Rule module enforcing single-line JSDoc when it fits. */\nconst singleLineJsdocRule: Rule.RuleModule = {\n  create(context: Rule.RuleContext): Rule.RuleListener {\n    const { options, sourceCode } = context;\n    const maxLineLength = normalizeMaxLineLength(options);\n\n    const comments = sourceCode.getAllComments();\n\n    for (const comment of comments) {\n      if (!shouldSkipForFunction(context, comment)) {\n        reportIfSingleLine(context, comment, maxLineLength);\n      }\n    }\n\n    return {};\n  },\n  meta: {\n    docs: createRuleDocumentation(\"single-line-jsdoc\", \"Require JSDoc comments to use a single line when they fit.\"),\n    fixable: \"code\",\n    messages: {\n      singleLine: \"Use a single-line JSDoc comment when it fits on one line.\",\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          maxLineLength: {\n            minimum: 1,\n            type: \"number\",\n          },\n        },\n        type: \"object\",\n      },\n    ],\n    type: \"layout\",\n  },\n};\n\nexport { singleLineJsdocRule };"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rule.node-lookups.d.ts","sourceRoot":"","sources":["../../../../src/domain/docs/single-line-jsdoc/rule.node-lookups.ts"],"names":[],"mappings":"AAEA,qEAAqE;AACrE,QAAA,MAAM,8BAA8B,kCAAsB,CAAC;AAE3D,OAAO,EAAE,8BAA8B,EAAE,CAAC"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { singleLineJsdocRule } from "./rule.js";
|
|
2
|
+
/** Companion module for single-line-jsdoc lookup edge-case tests. */
|
|
3
|
+
const singleLineJsdocRuleNodeLookups = singleLineJsdocRule;
|
|
4
|
+
export { singleLineJsdocRuleNodeLookups };
|
|
5
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicnVsZS5ub2RlLWxvb2t1cHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvZG9tYWluL2RvY3Mvc2luZ2xlLWxpbmUtanNkb2MvcnVsZS5ub2RlLWxvb2t1cHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLG1CQUFtQixFQUFFLE1BQU0sUUFBUSxDQUFDO0FBRTdDLHFFQUFxRTtBQUNyRSxNQUFNLDhCQUE4QixHQUFHLG1CQUFtQixDQUFDO0FBRTNELE9BQU8sRUFBRSw4QkFBOEIsRUFBRSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgc2luZ2xlTGluZUpzZG9jUnVsZSB9IGZyb20gXCIuL3J1bGVcIjtcclxuXHJcbi8qKiBDb21wYW5pb24gbW9kdWxlIGZvciBzaW5nbGUtbGluZS1qc2RvYyBsb29rdXAgZWRnZS1jYXNlIHRlc3RzLiAqL1xyXG5jb25zdCBzaW5nbGVMaW5lSnNkb2NSdWxlTm9kZUxvb2t1cHMgPSBzaW5nbGVMaW5lSnNkb2NSdWxlO1xyXG5cclxuZXhwb3J0IHsgc2luZ2xlTGluZUpzZG9jUnVsZU5vZGVMb29rdXBzIH07Il19
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"single-line-jsdoc-content.d.ts","sourceRoot":"","sources":["../../../../src/domain/docs/single-line-jsdoc/single-line-jsdoc-content.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,qCAAqC;AACrC,KAAK,OAAO,GAAG,UAAU,CACvB,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,gBAAgB,CAAC,CACjD,CAAC,MAAM,CAAC,CAAC;AAyFV;;;;;;;;GAQG;AACH,QAAA,MAAM,mBAAmB,GAAI,SAAS,OAAO,KAAG,MAAM,GAAG,SAYxD,CAAC;AAEF,OAAO,EAAE,mBAAmB,EAAE,CAAC;AAC/B,YAAY,EAAE,OAAO,EAAE,CAAC"}
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Defines stripJsdocLine.
|
|
3
|
+
* @param line Input line value.
|
|
4
|
+
* @returns Return value output.
|
|
5
|
+
* @example
|
|
6
|
+
* ```typescript
|
|
7
|
+
* stripJsdocLine();
|
|
8
|
+
* ```
|
|
9
|
+
*/
|
|
10
|
+
const stripJsdocLine = (line) => line.replace(/^\s*\*? ?/u, "").trimEnd();
|
|
11
|
+
/**
|
|
12
|
+
* Defines trimEmptyEdges.
|
|
13
|
+
* @param lines Input lines value.
|
|
14
|
+
* @returns Return value output.
|
|
15
|
+
* @example
|
|
16
|
+
* ```typescript
|
|
17
|
+
* trimEmptyEdges();
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
20
|
+
const trimEmptyEdges = (lines) => {
|
|
21
|
+
let start = 0;
|
|
22
|
+
let end = lines.length - 1;
|
|
23
|
+
while (start <= end && lines[start]?.length === 0) {
|
|
24
|
+
start += 1;
|
|
25
|
+
}
|
|
26
|
+
while (end >= start && lines[end]?.length === 0) {
|
|
27
|
+
end -= 1;
|
|
28
|
+
}
|
|
29
|
+
return lines.slice(start, end + 1);
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* Gets getContentLines.
|
|
33
|
+
* @param commentValue Input commentValue value.
|
|
34
|
+
* @returns Return value output.
|
|
35
|
+
* @example
|
|
36
|
+
* ```typescript
|
|
37
|
+
* getContentLines();
|
|
38
|
+
* ```
|
|
39
|
+
*/
|
|
40
|
+
const getContentLines = (commentValue) => {
|
|
41
|
+
const lines = commentValue
|
|
42
|
+
.split(/\r?\n/u)
|
|
43
|
+
.map((line) => stripJsdocLine(line))
|
|
44
|
+
.map((line) => line.trim());
|
|
45
|
+
return trimEmptyEdges(lines);
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* Checks shouldSkipContent.
|
|
49
|
+
* @param lines Input lines value.
|
|
50
|
+
* @returns Return value output.
|
|
51
|
+
* @example
|
|
52
|
+
* ```typescript
|
|
53
|
+
* shouldSkipContent();
|
|
54
|
+
* ```
|
|
55
|
+
*/
|
|
56
|
+
const shouldSkipContent = (lines) => {
|
|
57
|
+
if (lines.length === 0) {
|
|
58
|
+
return true;
|
|
59
|
+
}
|
|
60
|
+
if (lines.some((line) => line.length === 0)) {
|
|
61
|
+
return true;
|
|
62
|
+
}
|
|
63
|
+
return lines.some((line) => line.startsWith("@"));
|
|
64
|
+
};
|
|
65
|
+
/**
|
|
66
|
+
* Defines collapseContent.
|
|
67
|
+
* @param lines Input lines value.
|
|
68
|
+
* @returns Return value output.
|
|
69
|
+
* @example
|
|
70
|
+
* ```typescript
|
|
71
|
+
* collapseContent();
|
|
72
|
+
* ```
|
|
73
|
+
*/
|
|
74
|
+
const collapseContent = (lines) => lines.join(" ").replaceAll(/\s+/gu, " ").trim();
|
|
75
|
+
/**
|
|
76
|
+
* Gets getCollapsedContent.
|
|
77
|
+
* @param comment Input comment value.
|
|
78
|
+
* @returns Return value output.
|
|
79
|
+
* @example
|
|
80
|
+
* ```typescript
|
|
81
|
+
* getCollapsedContent();
|
|
82
|
+
* ```
|
|
83
|
+
*/
|
|
84
|
+
const getCollapsedContent = (comment) => {
|
|
85
|
+
const contentLines = getContentLines(comment.value);
|
|
86
|
+
if (shouldSkipContent(contentLines)) {
|
|
87
|
+
return void 0;
|
|
88
|
+
}
|
|
89
|
+
if (contentLines.length !== 1) {
|
|
90
|
+
return void 0;
|
|
91
|
+
}
|
|
92
|
+
return collapseContent(contentLines);
|
|
93
|
+
};
|
|
94
|
+
export { getCollapsedContent };
|
|
95
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2luZ2xlLWxpbmUtanNkb2MtY29udGVudC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9kb21haW4vZG9jcy9zaW5nbGUtbGluZS1qc2RvYy9zaW5nbGUtbGluZS1qc2RvYy1jb250ZW50LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQU9BOzs7Ozs7OztHQVFHO0FBQ0gsTUFBTSxjQUFjLEdBQUcsQ0FBQyxJQUFZLEVBQVUsRUFBRSxDQUM5QyxJQUFJLENBQUMsT0FBTyxDQUFDLFlBQVksRUFBRSxFQUFFLENBQUMsQ0FBQyxPQUFPLEVBQUUsQ0FBQztBQUUzQzs7Ozs7Ozs7R0FRRztBQUNILE1BQU0sY0FBYyxHQUFHLENBQUMsS0FBZSxFQUFZLEVBQUU7SUFDbkQsSUFBSSxLQUFLLEdBQUcsQ0FBQyxDQUFDO0lBQ2QsSUFBSSxHQUFHLEdBQUcsS0FBSyxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUM7SUFFM0IsT0FBTyxLQUFLLElBQUksR0FBRyxJQUFJLEtBQUssQ0FBQyxLQUFLLENBQUMsRUFBRSxNQUFNLEtBQUssQ0FBQyxFQUFFLENBQUM7UUFDbEQsS0FBSyxJQUFJLENBQUMsQ0FBQztJQUNiLENBQUM7SUFFRCxPQUFPLEdBQUcsSUFBSSxLQUFLLElBQUksS0FBSyxDQUFDLEdBQUcsQ0FBQyxFQUFFLE1BQU0sS0FBSyxDQUFDLEVBQUUsQ0FBQztRQUNoRCxHQUFHLElBQUksQ0FBQyxDQUFDO0lBQ1gsQ0FBQztJQUVELE9BQU8sS0FBSyxDQUFDLEtBQUssQ0FBQyxLQUFLLEVBQUUsR0FBRyxHQUFHLENBQUMsQ0FBQyxDQUFDO0FBQ3JDLENBQUMsQ0FBQztBQUVGOzs7Ozs7OztHQVFHO0FBQ0gsTUFBTSxlQUFlLEdBQUcsQ0FBQyxZQUFvQixFQUFZLEVBQUU7SUFDekQsTUFBTSxLQUFLLEdBQUcsWUFBWTtTQUN2QixLQUFLLENBQUMsUUFBUSxDQUFDO1NBQ2YsR0FBRyxDQUFDLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FBQyxjQUFjLENBQUMsSUFBSSxDQUFDLENBQUM7U0FDbkMsR0FBRyxDQUFDLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FBQyxJQUFJLENBQUMsSUFBSSxFQUFFLENBQUMsQ0FBQztJQUU5QixPQUFPLGNBQWMsQ0FBQyxLQUFLLENBQUMsQ0FBQztBQUMvQixDQUFDLENBQUM7QUFFRjs7Ozs7Ozs7R0FRRztBQUNILE1BQU0saUJBQWlCLEdBQUcsQ0FBQyxLQUFlLEVBQVcsRUFBRTtJQUNyRCxJQUFJLEtBQUssQ0FBQyxNQUFNLEtBQUssQ0FBQyxFQUFFLENBQUM7UUFDdkIsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQsSUFBSSxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FBQyxJQUFJLENBQUMsTUFBTSxLQUFLLENBQUMsQ0FBQyxFQUFFLENBQUM7UUFDNUMsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQsT0FBTyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7QUFDcEQsQ0FBQyxDQUFDO0FBRUY7Ozs7Ozs7O0dBUUc7QUFDSCxNQUFNLGVBQWUsR0FBRyxDQUFDLEtBQWUsRUFBVSxFQUFFLENBQ2xELEtBQUssQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUMsVUFBVSxDQUFDLE9BQU8sRUFBRSxHQUFHLENBQUMsQ0FBQyxJQUFJLEVBQUUsQ0FBQztBQUVsRDs7Ozs7Ozs7R0FRRztBQUNILE1BQU0sbUJBQW1CLEdBQUcsQ0FBQyxPQUFnQixFQUFzQixFQUFFO0lBQ25FLE1BQU0sWUFBWSxHQUFHLGVBQWUsQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLENBQUM7SUFFcEQsSUFBSSxpQkFBaUIsQ0FBQyxZQUFZLENBQUMsRUFBRSxDQUFDO1FBQ3BDLE9BQU8sS0FBSyxDQUFDLENBQUM7SUFDaEIsQ0FBQztJQUVELElBQUksWUFBWSxDQUFDLE1BQU0sS0FBSyxDQUFDLEVBQUUsQ0FBQztRQUM5QixPQUFPLEtBQUssQ0FBQyxDQUFDO0lBQ2hCLENBQUM7SUFFRCxPQUFPLGVBQWUsQ0FBQyxZQUFZLENBQUMsQ0FBQztBQUN2QyxDQUFDLENBQUM7QUFFRixPQUFPLEVBQUUsbUJBQW1CLEVBQUUsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB0eXBlIHsgUnVsZSB9IGZyb20gXCJlc2xpbnRcIjtcblxuLyoqIFR5cGUgZGVmaW5pdGlvbiBmb3IgcnVsZSBkYXRhLiAqL1xudHlwZSBDb21tZW50ID0gUmV0dXJuVHlwZTxcbiAgUnVsZS5SdWxlQ29udGV4dFtcInNvdXJjZUNvZGVcIl1bXCJnZXRBbGxDb21tZW50c1wiXVxuPltudW1iZXJdO1xuXG4vKipcbiAqIERlZmluZXMgc3RyaXBKc2RvY0xpbmUuXG4gKiBAcGFyYW0gbGluZSBJbnB1dCBsaW5lIHZhbHVlLlxuICogQHJldHVybnMgUmV0dXJuIHZhbHVlIG91dHB1dC5cbiAqIEBleGFtcGxlXG4gKiBgYGB0eXBlc2NyaXB0XG4gKiBzdHJpcEpzZG9jTGluZSgpO1xuICogYGBgXG4gKi9cbmNvbnN0IHN0cmlwSnNkb2NMaW5lID0gKGxpbmU6IHN0cmluZyk6IHN0cmluZyA9PlxuICBsaW5lLnJlcGxhY2UoL15cXHMqXFwqPyA/L3UsIFwiXCIpLnRyaW1FbmQoKTtcblxuLyoqXG4gKiBEZWZpbmVzIHRyaW1FbXB0eUVkZ2VzLlxuICogQHBhcmFtIGxpbmVzIElucHV0IGxpbmVzIHZhbHVlLlxuICogQHJldHVybnMgUmV0dXJuIHZhbHVlIG91dHB1dC5cbiAqIEBleGFtcGxlXG4gKiBgYGB0eXBlc2NyaXB0XG4gKiB0cmltRW1wdHlFZGdlcygpO1xuICogYGBgXG4gKi9cbmNvbnN0IHRyaW1FbXB0eUVkZ2VzID0gKGxpbmVzOiBzdHJpbmdbXSk6IHN0cmluZ1tdID0+IHtcbiAgbGV0IHN0YXJ0ID0gMDtcbiAgbGV0IGVuZCA9IGxpbmVzLmxlbmd0aCAtIDE7XG5cbiAgd2hpbGUgKHN0YXJ0IDw9IGVuZCAmJiBsaW5lc1tzdGFydF0/Lmxlbmd0aCA9PT0gMCkge1xuICAgIHN0YXJ0ICs9IDE7XG4gIH1cblxuICB3aGlsZSAoZW5kID49IHN0YXJ0ICYmIGxpbmVzW2VuZF0/Lmxlbmd0aCA9PT0gMCkge1xuICAgIGVuZCAtPSAxO1xuICB9XG5cbiAgcmV0dXJuIGxpbmVzLnNsaWNlKHN0YXJ0LCBlbmQgKyAxKTtcbn07XG5cbi8qKlxuICogR2V0cyBnZXRDb250ZW50TGluZXMuXG4gKiBAcGFyYW0gY29tbWVudFZhbHVlIElucHV0IGNvbW1lbnRWYWx1ZSB2YWx1ZS5cbiAqIEByZXR1cm5zIFJldHVybiB2YWx1ZSBvdXRwdXQuXG4gKiBAZXhhbXBsZVxuICogYGBgdHlwZXNjcmlwdFxuICogZ2V0Q29udGVudExpbmVzKCk7XG4gKiBgYGBcbiAqL1xuY29uc3QgZ2V0Q29udGVudExpbmVzID0gKGNvbW1lbnRWYWx1ZTogc3RyaW5nKTogc3RyaW5nW10gPT4ge1xuICBjb25zdCBsaW5lcyA9IGNvbW1lbnRWYWx1ZVxuICAgIC5zcGxpdCgvXFxyP1xcbi91KVxuICAgIC5tYXAoKGxpbmUpID0+IHN0cmlwSnNkb2NMaW5lKGxpbmUpKVxuICAgIC5tYXAoKGxpbmUpID0+IGxpbmUudHJpbSgpKTtcblxuICByZXR1cm4gdHJpbUVtcHR5RWRnZXMobGluZXMpO1xufTtcblxuLyoqXG4gKiBDaGVja3Mgc2hvdWxkU2tpcENvbnRlbnQuXG4gKiBAcGFyYW0gbGluZXMgSW5wdXQgbGluZXMgdmFsdWUuXG4gKiBAcmV0dXJucyBSZXR1cm4gdmFsdWUgb3V0cHV0LlxuICogQGV4YW1wbGVcbiAqIGBgYHR5cGVzY3JpcHRcbiAqIHNob3VsZFNraXBDb250ZW50KCk7XG4gKiBgYGBcbiAqL1xuY29uc3Qgc2hvdWxkU2tpcENvbnRlbnQgPSAobGluZXM6IHN0cmluZ1tdKTogYm9vbGVhbiA9PiB7XG4gIGlmIChsaW5lcy5sZW5ndGggPT09IDApIHtcbiAgICByZXR1cm4gdHJ1ZTtcbiAgfVxuXG4gIGlmIChsaW5lcy5zb21lKChsaW5lKSA9PiBsaW5lLmxlbmd0aCA9PT0gMCkpIHtcbiAgICByZXR1cm4gdHJ1ZTtcbiAgfVxuXG4gIHJldHVybiBsaW5lcy5zb21lKChsaW5lKSA9PiBsaW5lLnN0YXJ0c1dpdGgoXCJAXCIpKTtcbn07XG5cbi8qKlxuICogRGVmaW5lcyBjb2xsYXBzZUNvbnRlbnQuXG4gKiBAcGFyYW0gbGluZXMgSW5wdXQgbGluZXMgdmFsdWUuXG4gKiBAcmV0dXJucyBSZXR1cm4gdmFsdWUgb3V0cHV0LlxuICogQGV4YW1wbGVcbiAqIGBgYHR5cGVzY3JpcHRcbiAqIGNvbGxhcHNlQ29udGVudCgpO1xuICogYGBgXG4gKi9cbmNvbnN0IGNvbGxhcHNlQ29udGVudCA9IChsaW5lczogc3RyaW5nW10pOiBzdHJpbmcgPT5cbiAgbGluZXMuam9pbihcIiBcIikucmVwbGFjZUFsbCgvXFxzKy9ndSwgXCIgXCIpLnRyaW0oKTtcblxuLyoqXG4gKiBHZXRzIGdldENvbGxhcHNlZENvbnRlbnQuXG4gKiBAcGFyYW0gY29tbWVudCBJbnB1dCBjb21tZW50IHZhbHVlLlxuICogQHJldHVybnMgUmV0dXJuIHZhbHVlIG91dHB1dC5cbiAqIEBleGFtcGxlXG4gKiBgYGB0eXBlc2NyaXB0XG4gKiBnZXRDb2xsYXBzZWRDb250ZW50KCk7XG4gKiBgYGBcbiAqL1xuY29uc3QgZ2V0Q29sbGFwc2VkQ29udGVudCA9IChjb21tZW50OiBDb21tZW50KTogc3RyaW5nIHwgdW5kZWZpbmVkID0+IHtcbiAgY29uc3QgY29udGVudExpbmVzID0gZ2V0Q29udGVudExpbmVzKGNvbW1lbnQudmFsdWUpO1xuXG4gIGlmIChzaG91bGRTa2lwQ29udGVudChjb250ZW50TGluZXMpKSB7XG4gICAgcmV0dXJuIHZvaWQgMDtcbiAgfVxuXG4gIGlmIChjb250ZW50TGluZXMubGVuZ3RoICE9PSAxKSB7XG4gICAgcmV0dXJuIHZvaWQgMDtcbiAgfVxuXG4gIHJldHVybiBjb2xsYXBzZUNvbnRlbnQoY29udGVudExpbmVzKTtcbn07XG5cbmV4cG9ydCB7IGdldENvbGxhcHNlZENvbnRlbnQgfTtcbmV4cG9ydCB0eXBlIHsgQ29tbWVudCB9O1xuIl19
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"single-line-jsdoc-utilities.d.ts","sourceRoot":"","sources":["../../../../src/domain/docs/single-line-jsdoc/single-line-jsdoc-utilities.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AAa3D;;;;;;;;GAQG;AACH,QAAA,MAAM,sBAAsB,GAAI,SAAS,SAAS,OAAO,EAAE,KAAG,MAU7D,CAAC;AAiHF;;;;;;;;;GASG;AACH,QAAA,MAAM,kBAAkB,GACtB,SAAS,IAAI,CAAC,WAAW,EACzB,SAAS,OAAO,EAChB,eAAe,MAAM,KACpB,IAsBF,CAAC;AAEF,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,CAAC"}
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
import { getCollapsedContent } from "./single-line-jsdoc-content.js";
|
|
2
|
+
/** Default value used by this module. */
|
|
3
|
+
const DEFAULT_MAX_LINE_LENGTH = 80;
|
|
4
|
+
/**
|
|
5
|
+
* Normalizes normalizeMaxLineLength.
|
|
6
|
+
* @param options Input options value.
|
|
7
|
+
* @returns Return value output.
|
|
8
|
+
* @example
|
|
9
|
+
* ```typescript
|
|
10
|
+
* normalizeMaxLineLength();
|
|
11
|
+
* ```
|
|
12
|
+
*/
|
|
13
|
+
const normalizeMaxLineLength = (options) => {
|
|
14
|
+
const rawOptions = options[0];
|
|
15
|
+
const maxLineLength = rawOptions?.maxLineLength;
|
|
16
|
+
if (typeof maxLineLength === "number" && Number.isFinite(maxLineLength)) {
|
|
17
|
+
const normalized = Math.floor(maxLineLength);
|
|
18
|
+
return normalized > 0 ? normalized : DEFAULT_MAX_LINE_LENGTH;
|
|
19
|
+
}
|
|
20
|
+
return DEFAULT_MAX_LINE_LENGTH;
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* Checks isMultilineComment.
|
|
24
|
+
* @param comment Input comment value.
|
|
25
|
+
* @returns Return value output.
|
|
26
|
+
* @example
|
|
27
|
+
* ```typescript
|
|
28
|
+
* isMultilineComment();
|
|
29
|
+
* ```
|
|
30
|
+
*/
|
|
31
|
+
const isMultilineComment = (comment) => {
|
|
32
|
+
const { loc, value } = comment;
|
|
33
|
+
if (loc === null || loc === void 0) {
|
|
34
|
+
return /\r|\n/u.test(value);
|
|
35
|
+
}
|
|
36
|
+
return loc.start.line !== loc.end.line;
|
|
37
|
+
};
|
|
38
|
+
/**
|
|
39
|
+
* Build a single-line JSDoc string from content.
|
|
40
|
+
* @param content Input content value.
|
|
41
|
+
* @returns Return value output.
|
|
42
|
+
* @example
|
|
43
|
+
* ```typescript
|
|
44
|
+
* const text = buildSingleLineText("ok");
|
|
45
|
+
* ```
|
|
46
|
+
*/
|
|
47
|
+
const buildSingleLineText = (content) => `/** ${content} */`;
|
|
48
|
+
/**
|
|
49
|
+
* Creates a fixer for replacing a JSDoc range.
|
|
50
|
+
* @param range Input range value.
|
|
51
|
+
* @param replacementText Input replacementText value.
|
|
52
|
+
* @returns Fixer function for ESLint.
|
|
53
|
+
* @example
|
|
54
|
+
* ```typescript
|
|
55
|
+
* const fixer = createFix([0, 1], "/** ok *\\/");
|
|
56
|
+
* ```
|
|
57
|
+
*/
|
|
58
|
+
const createFix = (range, replacementText) => {
|
|
59
|
+
return (fixer) => fixer.replaceTextRange(range, replacementText);
|
|
60
|
+
};
|
|
61
|
+
/**
|
|
62
|
+
* Checks isJsdocComment.
|
|
63
|
+
* @param comment Input comment value.
|
|
64
|
+
* @returns Return value output.
|
|
65
|
+
* @example
|
|
66
|
+
* ```typescript
|
|
67
|
+
* isJsdocComment();
|
|
68
|
+
* ```
|
|
69
|
+
*/
|
|
70
|
+
const isJsdocComment = (comment) => comment.type === "Block" && comment.value.startsWith("*");
|
|
71
|
+
/**
|
|
72
|
+
* Gets getStartColumn.
|
|
73
|
+
* @param comment Input comment value.
|
|
74
|
+
* @returns Return value output.
|
|
75
|
+
* @example
|
|
76
|
+
* ```typescript
|
|
77
|
+
* getStartColumn();
|
|
78
|
+
* ```
|
|
79
|
+
*/
|
|
80
|
+
const getStartColumn = (comment) => {
|
|
81
|
+
const { loc } = comment;
|
|
82
|
+
if (loc === null || loc === void 0) {
|
|
83
|
+
return void 0;
|
|
84
|
+
}
|
|
85
|
+
return loc.start.column;
|
|
86
|
+
};
|
|
87
|
+
/**
|
|
88
|
+
* Builds a single-line replacement when it fits.
|
|
89
|
+
* @param comment Input comment value.
|
|
90
|
+
* @param maxLineLength Input maxLineLength value.
|
|
91
|
+
* @returns Replacement text when available.
|
|
92
|
+
* @example
|
|
93
|
+
* ```typescript
|
|
94
|
+
* const text = getSingleLineReplacement(comment, 80);
|
|
95
|
+
* ```
|
|
96
|
+
*/
|
|
97
|
+
const getSingleLineReplacement = (comment, maxLineLength) => {
|
|
98
|
+
if (!isMultilineComment(comment)) {
|
|
99
|
+
return void 0;
|
|
100
|
+
}
|
|
101
|
+
const content = getCollapsedContent(comment);
|
|
102
|
+
const startColumn = getStartColumn(comment);
|
|
103
|
+
if (content === void 0 || startColumn === void 0) {
|
|
104
|
+
return void 0;
|
|
105
|
+
}
|
|
106
|
+
const singleLineText = buildSingleLineText(content);
|
|
107
|
+
return startColumn + singleLineText.length > maxLineLength
|
|
108
|
+
? void 0
|
|
109
|
+
: singleLineText;
|
|
110
|
+
};
|
|
111
|
+
/**
|
|
112
|
+
* Reports a comment when it can be collapsed to a single line.
|
|
113
|
+
* @param context Input context value.
|
|
114
|
+
* @param comment Input comment value.
|
|
115
|
+
* @param maxLineLength Input maxLineLength value.
|
|
116
|
+
* @example
|
|
117
|
+
* ```typescript
|
|
118
|
+
* reportIfSingleLine(context, comment, 80);
|
|
119
|
+
* ```
|
|
120
|
+
*/
|
|
121
|
+
const reportIfSingleLine = (context, comment, maxLineLength) => {
|
|
122
|
+
if (!isJsdocComment(comment)) {
|
|
123
|
+
return;
|
|
124
|
+
}
|
|
125
|
+
const singleLineText = getSingleLineReplacement(comment, maxLineLength);
|
|
126
|
+
if (singleLineText === void 0) {
|
|
127
|
+
return;
|
|
128
|
+
}
|
|
129
|
+
const { loc, range } = comment;
|
|
130
|
+
if (loc === null || loc === void 0 || range === void 0) {
|
|
131
|
+
return;
|
|
132
|
+
}
|
|
133
|
+
context.report({
|
|
134
|
+
fix: createFix(range, singleLineText),
|
|
135
|
+
loc,
|
|
136
|
+
messageId: "singleLine",
|
|
137
|
+
});
|
|
138
|
+
};
|
|
139
|
+
export { normalizeMaxLineLength, reportIfSingleLine };
|
|
140
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"single-line-jsdoc-utilities.js","sourceRoot":"","sources":["../../../../src/domain/docs/single-line-jsdoc/single-line-jsdoc-utilities.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAElE,yCAAyC;AACzC,MAAM,uBAAuB,GAAG,EAAE,CAAC;AAQnC;;;;;;;;GAQG;AACH,MAAM,sBAAsB,GAAG,CAAC,OAA2B,EAAU,EAAE;IACrE,MAAM,UAAU,GAAG,OAAO,CAAC,CAAC,CAAuC,CAAC;IACpE,MAAM,aAAa,GAAG,UAAU,EAAE,aAAa,CAAC;IAEhD,IAAI,OAAO,aAAa,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;QACxE,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,uBAAuB,CAAC;IAC/D,CAAC;IAED,OAAO,uBAAuB,CAAC;AACjC,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAAW,EAAE;IACvD,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IAE/B,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,KAAK,CAAC,EAAE,CAAC;QACnC,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED,OAAO,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC;AACzC,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,mBAAmB,GAAG,CAAC,OAAe,EAAU,EAAE,CAAC,OAAO,OAAO,KAAK,CAAC;AAE7E;;;;;;;;;GASG;AACH,MAAM,SAAS,GAAG,CAChB,KAAuB,EACvB,eAAuB,EACL,EAAE;IACpB,OAAO,CAAC,KAAqB,EAAY,EAAE,CACzC,KAAK,CAAC,gBAAgB,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;AACnD,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,cAAc,GAAG,CAAC,OAAgB,EAAW,EAAE,CACnD,OAAO,CAAC,IAAI,KAAK,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;AAE5D;;;;;;;;GAQG;AACH,MAAM,cAAc,GAAG,CAAC,OAAgB,EAAsB,EAAE;IAC9D,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IAExB,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,KAAK,CAAC,EAAE,CAAC;QACnC,OAAO,KAAK,CAAC,CAAC;IAChB,CAAC;IAED,OAAO,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC;AAC1B,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,wBAAwB,GAAG,CAC/B,OAAgB,EAChB,aAAqB,EACD,EAAE;IACtB,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC,CAAC;IAChB,CAAC;IAED,MAAM,OAAO,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAC7C,MAAM,WAAW,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IAE5C,IAAI,OAAO,KAAK,KAAK,CAAC,IAAI,WAAW,KAAK,KAAK,CAAC,EAAE,CAAC;QACjD,OAAO,KAAK,CAAC,CAAC;IAChB,CAAC;IAED,MAAM,cAAc,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAEpD,OAAO,WAAW,GAAG,cAAc,CAAC,MAAM,GAAG,aAAa;QACxD,CAAC,CAAC,KAAK,CAAC;QACR,CAAC,CAAC,cAAc,CAAC;AACrB,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,kBAAkB,GAAG,CACzB,OAAyB,EACzB,OAAgB,EAChB,aAAqB,EACf,EAAE;IACR,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7B,OAAO;IACT,CAAC;IAED,MAAM,cAAc,GAAG,wBAAwB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAExE,IAAI,cAAc,KAAK,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO;IACT,CAAC;IAED,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IAE/B,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,KAAK,CAAC,IAAI,KAAK,KAAK,KAAK,CAAC,EAAE,CAAC;QACvD,OAAO;IACT,CAAC;IAED,OAAO,CAAC,MAAM,CAAC;QACb,GAAG,EAAE,SAAS,CAAC,KAAK,EAAE,cAAc,CAAC;QACrC,GAAG;QACH,SAAS,EAAE,YAAY;KACxB,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,CAAC","sourcesContent":["import type { Rule } from \"eslint\";\n\nimport type { Comment } from \"./single-line-jsdoc-content\";\n\nimport { getCollapsedContent } from \"./single-line-jsdoc-content\";\n\n/** Default value used by this module. */\nconst DEFAULT_MAX_LINE_LENGTH = 80;\n\n/** Type definition for rule data. */\ninterface SingleLineJsdocOptions {\n  /** MaxLineLength helper value. */\n  maxLineLength?: number;\n}\n\n/**\n * Normalizes normalizeMaxLineLength.\n * @param options Input options value.\n * @returns Return value output.\n * @example\n * ```typescript\n * normalizeMaxLineLength();\n * ```\n */\nconst normalizeMaxLineLength = (options: readonly unknown[]): number => {\n  const rawOptions = options[0] as SingleLineJsdocOptions | undefined;\n  const maxLineLength = rawOptions?.maxLineLength;\n\n  if (typeof maxLineLength === \"number\" && Number.isFinite(maxLineLength)) {\n    const normalized = Math.floor(maxLineLength);\n    return normalized > 0 ? normalized : DEFAULT_MAX_LINE_LENGTH;\n  }\n\n  return DEFAULT_MAX_LINE_LENGTH;\n};\n\n/**\n * Checks isMultilineComment.\n * @param comment Input comment value.\n * @returns Return value output.\n * @example\n * ```typescript\n * isMultilineComment();\n * ```\n */\nconst isMultilineComment = (comment: Comment): boolean => {\n  const { loc, value } = comment;\n\n  if (loc === null || loc === void 0) {\n    return /\\r|\\n/u.test(value);\n  }\n\n  return loc.start.line !== loc.end.line;\n};\n\n/**\n * Build a single-line JSDoc string from content.\n * @param content Input content value.\n * @returns Return value output.\n * @example\n * ```typescript\n * const text = buildSingleLineText(\"ok\");\n * ```\n */\nconst buildSingleLineText = (content: string): string => `/** ${content} */`;\n\n/**\n * Creates a fixer for replacing a JSDoc range.\n * @param range Input range value.\n * @param replacementText Input replacementText value.\n * @returns Fixer function for ESLint.\n * @example\n * ```typescript\n * const fixer = createFix([0, 1], \"/** ok *\\\\/\");\n * ```\n */\nconst createFix = (\n  range: [number, number],\n  replacementText: string,\n): Rule.ReportFixer => {\n  return (fixer: Rule.RuleFixer): Rule.Fix =>\n    fixer.replaceTextRange(range, replacementText);\n};\n\n/**\n * Checks isJsdocComment.\n * @param comment Input comment value.\n * @returns Return value output.\n * @example\n * ```typescript\n * isJsdocComment();\n * ```\n */\nconst isJsdocComment = (comment: Comment): boolean =>\n  comment.type === \"Block\" && comment.value.startsWith(\"*\");\n\n/**\n * Gets getStartColumn.\n * @param comment Input comment value.\n * @returns Return value output.\n * @example\n * ```typescript\n * getStartColumn();\n * ```\n */\nconst getStartColumn = (comment: Comment): number | undefined => {\n  const { loc } = comment;\n\n  if (loc === null || loc === void 0) {\n    return void 0;\n  }\n\n  return loc.start.column;\n};\n\n/**\n * Builds a single-line replacement when it fits.\n * @param comment Input comment value.\n * @param maxLineLength Input maxLineLength value.\n * @returns Replacement text when available.\n * @example\n * ```typescript\n * const text = getSingleLineReplacement(comment, 80);\n * ```\n */\nconst getSingleLineReplacement = (\n  comment: Comment,\n  maxLineLength: number,\n): string | undefined => {\n  if (!isMultilineComment(comment)) {\n    return void 0;\n  }\n\n  const content = getCollapsedContent(comment);\n  const startColumn = getStartColumn(comment);\n\n  if (content === void 0 || startColumn === void 0) {\n    return void 0;\n  }\n\n  const singleLineText = buildSingleLineText(content);\n\n  return startColumn + singleLineText.length > maxLineLength\n    ? void 0\n    : singleLineText;\n};\n\n/**\n * Reports a comment when it can be collapsed to a single line.\n * @param context Input context value.\n * @param comment Input comment value.\n * @param maxLineLength Input maxLineLength value.\n * @example\n * ```typescript\n * reportIfSingleLine(context, comment, 80);\n * ```\n */\nconst reportIfSingleLine = (\n  context: Rule.RuleContext,\n  comment: Comment,\n  maxLineLength: number,\n): void => {\n  if (!isJsdocComment(comment)) {\n    return;\n  }\n\n  const singleLineText = getSingleLineReplacement(comment, maxLineLength);\n\n  if (singleLineText === void 0) {\n    return;\n  }\n\n  const { loc, range } = comment;\n\n  if (loc === null || loc === void 0 || range === void 0) {\n    return;\n  }\n\n  context.report({\n    fix: createFix(range, singleLineText),\n    loc,\n    messageId: \"singleLine\",\n  });\n};\n\nexport { normalizeMaxLineLength, reportIfSingleLine };\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"test-helpers.d.ts","sourceRoot":"","sources":["../../../src/domain/docs/test-helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,qCAAqC;AACrC,UAAU,cAAc;IACtB,wBAAwB;IACxB,GAAG,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;CAC3C;AAED,qCAAqC;AACrC,KAAK,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,CAAC,CAAC;AAE7D;;;;;;;GAOG;AACH,QAAA,MAAM,WAAW,QAAO,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAqBpD,CAAC;AAcH;;;;;;;;GAQG;AACH,QAAA,MAAM,UAAU,GAAI,YAAY,SAAS,KAAG,MAAM,GAAG,SASpD,CAAC;AAEF;;;;;;;;GAQG;AACH,QAAA,MAAM,QAAQ,GAAI,SAAS,cAAc,EAAE,KAAG,IAAI,CAAC,GAAG,EAiBrD,CAAC;AAEF;;;;;;;;;GASG;AACH,QAAA,MAAM,UAAU,GAAI,YAAY,MAAM,EAAE,OAAO,IAAI,CAAC,GAAG,EAAE,KAAG,MAgB3D,CAAC;AAEF,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC"}
|