@thethracian/oxlint-config 0.5.2 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +54 -0
- package/README.md +119 -271
- package/dist/codemod-fix/index.d.ts.map +1 -1
- package/dist/codemod-fix/index.js +1 -2
- package/dist/codemod-fix/index.js.map +1 -1
- package/dist/index.d.ts +4 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +310 -116
- package/dist/index.js.map +1 -1
- package/dist/rules/diagnostic-guidance.d.ts +0 -76
- package/dist/rules/diagnostic-guidance.d.ts.map +1 -1
- package/dist/rules/diagnostic-guidance.js +1 -154
- package/dist/rules/diagnostic-guidance.js.map +1 -1
- package/dist/rules/effect-default-ast.d.ts +0 -24
- package/dist/rules/effect-default-ast.d.ts.map +1 -1
- package/dist/rules/effect-default-ast.js +1 -38
- package/dist/rules/effect-default-ast.js.map +1 -1
- package/dist/rules/effect-default-compat-rules.d.ts +0 -40
- package/dist/rules/effect-default-compat-rules.d.ts.map +1 -1
- package/dist/rules/effect-default-compat-rules.js +6 -169
- package/dist/rules/effect-default-compat-rules.js.map +1 -1
- package/dist/rules/effect-default-env-rules.d.ts +2 -21
- package/dist/rules/effect-default-env-rules.d.ts.map +1 -1
- package/dist/rules/effect-default-env-rules.js +10 -117
- package/dist/rules/effect-default-env-rules.js.map +1 -1
- package/dist/rules/effect-default-helpers.d.ts +4 -4
- package/dist/rules/effect-default-helpers.d.ts.map +1 -1
- package/dist/rules/effect-default-helpers.js +4 -4
- package/dist/rules/effect-default-helpers.js.map +1 -1
- package/dist/rules/effect-default-safety-helpers.d.ts +0 -24
- package/dist/rules/effect-default-safety-helpers.d.ts.map +1 -1
- package/dist/rules/effect-default-safety-helpers.js +2 -49
- package/dist/rules/effect-default-safety-helpers.js.map +1 -1
- package/dist/rules/effect-default-scan-helpers.d.ts +0 -12
- package/dist/rules/effect-default-scan-helpers.d.ts.map +1 -1
- package/dist/rules/effect-default-scan-helpers.js +0 -43
- package/dist/rules/effect-default-scan-helpers.js.map +1 -1
- package/dist/rules/effect-default-schema-helpers.d.ts +0 -12
- package/dist/rules/effect-default-schema-helpers.d.ts.map +1 -1
- package/dist/rules/effect-default-schema-helpers.js +1 -13
- package/dist/rules/effect-default-schema-helpers.js.map +1 -1
- package/dist/rules/effect-default-workflow-helpers.d.ts +0 -48
- package/dist/rules/effect-default-workflow-helpers.d.ts.map +1 -1
- package/dist/rules/effect-default-workflow-helpers.js +1 -65
- package/dist/rules/effect-default-workflow-helpers.js.map +1 -1
- package/dist/rules/effect-default.d.ts +0 -20
- package/dist/rules/effect-default.d.ts.map +1 -1
- package/dist/rules/effect-default.js +5 -241
- package/dist/rules/effect-default.js.map +1 -1
- package/dist/rules/effect-exported-declarations.d.ts +0 -4
- package/dist/rules/effect-exported-declarations.d.ts.map +1 -1
- package/dist/rules/effect-exported-declarations.js +0 -27
- package/dist/rules/effect-exported-declarations.js.map +1 -1
- package/dist/rules/effect-path-options.d.ts.map +1 -1
- package/dist/rules/effect-path-options.js +2 -7
- package/dist/rules/effect-path-options.js.map +1 -1
- package/dist/rules/effect-rule-names.d.ts +14 -2
- package/dist/rules/effect-rule-names.d.ts.map +1 -1
- package/dist/rules/effect-rule-names.js +130 -3
- package/dist/rules/effect-rule-names.js.map +1 -1
- package/dist/rules/effect-schema-no-redundant-tag-identifier.d.ts +0 -1
- package/dist/rules/effect-schema-no-redundant-tag-identifier.d.ts.map +1 -1
- package/dist/rules/effect-schema-no-redundant-tag-identifier.js +0 -1
- package/dist/rules/effect-schema-no-redundant-tag-identifier.js.map +1 -1
- package/dist/rules/effect-source-cache-weights.d.ts +0 -21
- package/dist/rules/effect-source-cache-weights.d.ts.map +1 -1
- package/dist/rules/effect-source-cache-weights.js +0 -30
- package/dist/rules/effect-source-cache-weights.js.map +1 -1
- package/dist/rules/effect-source-helpers.d.ts +1 -1
- package/dist/rules/effect-source-helpers.d.ts.map +1 -1
- package/dist/rules/effect-source-helpers.js +1 -1
- package/dist/rules/effect-source-helpers.js.map +1 -1
- package/dist/rules/plugin.d.ts +1 -1
- package/dist/rules/plugin.d.ts.map +1 -1
- package/dist/rules/plugin.js +3 -334
- package/dist/rules/plugin.js.map +1 -1
- package/package.json +3 -3
- package/dist/codemods/rename-acronyms.d.ts +0 -8
- package/dist/codemods/rename-acronyms.d.ts.map +0 -1
- package/dist/codemods/rename-acronyms.js +0 -216
- package/dist/codemods/rename-acronyms.js.map +0 -1
- package/dist/rules/acronym-case.d.ts +0 -9
- package/dist/rules/acronym-case.d.ts.map +0 -1
- package/dist/rules/acronym-case.js +0 -226
- package/dist/rules/acronym-case.js.map +0 -1
- package/dist/rules/acronyms-1.d.ts +0 -3
- package/dist/rules/acronyms-1.d.ts.map +0 -1
- package/dist/rules/acronyms-1.js +0 -7
- package/dist/rules/acronyms-1.js.map +0 -1
- package/dist/rules/acronyms-2.d.ts +0 -3
- package/dist/rules/acronyms-2.d.ts.map +0 -1
- package/dist/rules/acronyms-2.js +0 -7
- package/dist/rules/acronyms-2.js.map +0 -1
- package/dist/rules/acronyms-3.d.ts +0 -3
- package/dist/rules/acronyms-3.d.ts.map +0 -1
- package/dist/rules/acronyms-3.js +0 -7
- package/dist/rules/acronyms-3.js.map +0 -1
- package/dist/rules/acronyms-4.d.ts +0 -3
- package/dist/rules/acronyms-4.d.ts.map +0 -1
- package/dist/rules/acronyms-4.js +0 -7
- package/dist/rules/acronyms-4.js.map +0 -1
- package/dist/rules/acronyms.d.ts +0 -3
- package/dist/rules/acronyms.d.ts.map +0 -1
- package/dist/rules/acronyms.js +0 -15
- package/dist/rules/acronyms.js.map +0 -1
- package/dist/rules/boolean-prefix.d.ts +0 -15
- package/dist/rules/boolean-prefix.d.ts.map +0 -1
- package/dist/rules/boolean-prefix.js +0 -86
- package/dist/rules/boolean-prefix.js.map +0 -1
- package/dist/rules/camel-case-identifiers.d.ts +0 -13
- package/dist/rules/camel-case-identifiers.d.ts.map +0 -1
- package/dist/rules/camel-case-identifiers.js +0 -81
- package/dist/rules/camel-case-identifiers.js.map +0 -1
- package/dist/rules/effect-ast-stack-safe-walker.d.ts +0 -24
- package/dist/rules/effect-ast-stack-safe-walker.d.ts.map +0 -1
- package/dist/rules/effect-ast-stack-safe-walker.js +0 -68
- package/dist/rules/effect-ast-stack-safe-walker.js.map +0 -1
- package/dist/rules/effect-default-boundary-ast.d.ts +0 -10
- package/dist/rules/effect-default-boundary-ast.d.ts.map +0 -1
- package/dist/rules/effect-default-boundary-ast.js +0 -312
- package/dist/rules/effect-default-boundary-ast.js.map +0 -1
- package/dist/rules/effect-export-segments.d.ts +0 -9
- package/dist/rules/effect-export-segments.d.ts.map +0 -1
- package/dist/rules/effect-export-segments.js +0 -67
- package/dist/rules/effect-export-segments.js.map +0 -1
- package/dist/rules/effect-object-assign-provenance.d.ts +0 -20
- package/dist/rules/effect-object-assign-provenance.d.ts.map +0 -1
- package/dist/rules/effect-object-assign-provenance.js +0 -37
- package/dist/rules/effect-object-assign-provenance.js.map +0 -1
- package/dist/rules/effect-prefer-all-discard.d.ts +0 -5
- package/dist/rules/effect-prefer-all-discard.d.ts.map +0 -1
- package/dist/rules/effect-prefer-all-discard.js +0 -200
- package/dist/rules/effect-prefer-all-discard.js.map +0 -1
- package/dist/rules/effect-prefer-andthen-over-flatmap-discarded-value.d.ts +0 -4
- package/dist/rules/effect-prefer-andthen-over-flatmap-discarded-value.d.ts.map +0 -1
- package/dist/rules/effect-prefer-andthen-over-flatmap-discarded-value.js +0 -110
- package/dist/rules/effect-prefer-andthen-over-flatmap-discarded-value.js.map +0 -1
- package/dist/rules/effect-prefer-as-over-map-constant.d.ts +0 -4
- package/dist/rules/effect-prefer-as-over-map-constant.d.ts.map +0 -1
- package/dist/rules/effect-prefer-as-over-map-constant.js +0 -183
- package/dist/rules/effect-prefer-as-over-map-constant.js.map +0 -1
- package/dist/rules/effect-prefer-as-some.d.ts +0 -4
- package/dist/rules/effect-prefer-as-some.d.ts.map +0 -1
- package/dist/rules/effect-prefer-as-some.js +0 -248
- package/dist/rules/effect-prefer-as-some.js.map +0 -1
- package/dist/rules/effect-prefer-catchif-over-conditional-catch.d.ts +0 -4
- package/dist/rules/effect-prefer-catchif-over-conditional-catch.d.ts.map +0 -1
- package/dist/rules/effect-prefer-catchif-over-conditional-catch.js +0 -214
- package/dist/rules/effect-prefer-catchif-over-conditional-catch.js.map +0 -1
- package/dist/rules/effect-prefer-collection-discard-over-asvoid.d.ts +0 -5
- package/dist/rules/effect-prefer-collection-discard-over-asvoid.d.ts.map +0 -1
- package/dist/rules/effect-prefer-collection-discard-over-asvoid.js +0 -328
- package/dist/rules/effect-prefer-collection-discard-over-asvoid.js.map +0 -1
- package/dist/rules/effect-prefer-filter-or-fail-over-flatmap-guard.d.ts +0 -4
- package/dist/rules/effect-prefer-filter-or-fail-over-flatmap-guard.d.ts.map +0 -1
- package/dist/rules/effect-prefer-filter-or-fail-over-flatmap-guard.js +0 -321
- package/dist/rules/effect-prefer-filter-or-fail-over-flatmap-guard.js.map +0 -1
- package/dist/rules/effect-prefer-foreach-discard.d.ts +0 -4
- package/dist/rules/effect-prefer-foreach-discard.d.ts.map +0 -1
- package/dist/rules/effect-prefer-foreach-discard.js +0 -225
- package/dist/rules/effect-prefer-foreach-discard.js.map +0 -1
- package/dist/rules/effect-prefer-layer-sync.d.ts +0 -5
- package/dist/rules/effect-prefer-layer-sync.d.ts.map +0 -1
- package/dist/rules/effect-prefer-layer-sync.js +0 -194
- package/dist/rules/effect-prefer-layer-sync.js.map +0 -1
- package/dist/rules/effect-prefer-map-both.d.ts +0 -4
- package/dist/rules/effect-prefer-map-both.d.ts.map +0 -1
- package/dist/rules/effect-prefer-map-both.js +0 -184
- package/dist/rules/effect-prefer-map-both.js.map +0 -1
- package/dist/rules/effect-prefer-map-over-flatmap-succeed.d.ts +0 -4
- package/dist/rules/effect-prefer-map-over-flatmap-succeed.d.ts.map +0 -1
- package/dist/rules/effect-prefer-map-over-flatmap-succeed.js +0 -318
- package/dist/rules/effect-prefer-map-over-flatmap-succeed.js.map +0 -1
- package/dist/rules/effect-prefer-option-get-or-else.d.ts +0 -5
- package/dist/rules/effect-prefer-option-get-or-else.d.ts.map +0 -1
- package/dist/rules/effect-prefer-option-get-or-else.js +0 -197
- package/dist/rules/effect-prefer-option-get-or-else.js.map +0 -1
- package/dist/rules/effect-prefer-option-nullish-getters.d.ts +0 -5
- package/dist/rules/effect-prefer-option-nullish-getters.d.ts.map +0 -1
- package/dist/rules/effect-prefer-option-nullish-getters.js +0 -291
- package/dist/rules/effect-prefer-option-nullish-getters.js.map +0 -1
- package/dist/rules/effect-prefer-option-or-else-some.d.ts +0 -5
- package/dist/rules/effect-prefer-option-or-else-some.d.ts.map +0 -1
- package/dist/rules/effect-prefer-option-or-else-some.js +0 -169
- package/dist/rules/effect-prefer-option-or-else-some.js.map +0 -1
- package/dist/rules/effect-prefer-ref-get-and-update.d.ts +0 -5
- package/dist/rules/effect-prefer-ref-get-and-update.d.ts.map +0 -1
- package/dist/rules/effect-prefer-ref-get-and-update.js +0 -217
- package/dist/rules/effect-prefer-ref-get-and-update.js.map +0 -1
- package/dist/rules/effect-prefer-succeed-for-stable-values.d.ts +0 -4
- package/dist/rules/effect-prefer-succeed-for-stable-values.d.ts.map +0 -1
- package/dist/rules/effect-prefer-succeed-for-stable-values.js +0 -269
- package/dist/rules/effect-prefer-succeed-for-stable-values.js.map +0 -1
- package/dist/rules/effect-prefer-succeed-none.d.ts +0 -4
- package/dist/rules/effect-prefer-succeed-none.d.ts.map +0 -1
- package/dist/rules/effect-prefer-succeed-none.js +0 -113
- package/dist/rules/effect-prefer-succeed-none.js.map +0 -1
- package/dist/rules/effect-prefer-succeed-some.d.ts +0 -4
- package/dist/rules/effect-prefer-succeed-some.d.ts.map +0 -1
- package/dist/rules/effect-prefer-succeed-some.js +0 -129
- package/dist/rules/effect-prefer-succeed-some.js.map +0 -1
- package/dist/rules/effect-prefer-tap-over-flatmap-as.d.ts +0 -4
- package/dist/rules/effect-prefer-tap-over-flatmap-as.d.ts.map +0 -1
- package/dist/rules/effect-prefer-tap-over-flatmap-as.js +0 -200
- package/dist/rules/effect-prefer-tap-over-flatmap-as.js.map +0 -1
- package/dist/rules/effect-prefer-yieldable-error-over-fail-ast.d.ts +0 -39
- package/dist/rules/effect-prefer-yieldable-error-over-fail-ast.d.ts.map +0 -1
- package/dist/rules/effect-prefer-yieldable-error-over-fail-ast.js +0 -135
- package/dist/rules/effect-prefer-yieldable-error-over-fail-ast.js.map +0 -1
- package/dist/rules/effect-prefer-yieldable-error-over-fail.d.ts +0 -5
- package/dist/rules/effect-prefer-yieldable-error-over-fail.d.ts.map +0 -1
- package/dist/rules/effect-prefer-yieldable-error-over-fail.js +0 -310
- package/dist/rules/effect-prefer-yieldable-error-over-fail.js.map +0 -1
- package/dist/rules/effect-promise-ast-values.d.ts +0 -26
- package/dist/rules/effect-promise-ast-values.d.ts.map +0 -1
- package/dist/rules/effect-promise-ast-values.js +0 -66
- package/dist/rules/effect-promise-ast-values.js.map +0 -1
- package/dist/rules/effect-promise-callable-declarations.d.ts +0 -22
- package/dist/rules/effect-promise-callable-declarations.d.ts.map +0 -1
- package/dist/rules/effect-promise-callable-declarations.js +0 -255
- package/dist/rules/effect-promise-callable-declarations.js.map +0 -1
- package/dist/rules/effect-promise-callable-lookup.d.ts +0 -40
- package/dist/rules/effect-promise-callable-lookup.d.ts.map +0 -1
- package/dist/rules/effect-promise-callable-lookup.js +0 -99
- package/dist/rules/effect-promise-callable-lookup.js.map +0 -1
- package/dist/rules/effect-promise-callable-scopes.d.ts +0 -25
- package/dist/rules/effect-promise-callable-scopes.d.ts.map +0 -1
- package/dist/rules/effect-promise-callable-scopes.js +0 -227
- package/dist/rules/effect-promise-callable-scopes.js.map +0 -1
- package/dist/rules/effect-promise-callable-types.d.ts +0 -43
- package/dist/rules/effect-promise-callable-types.d.ts.map +0 -1
- package/dist/rules/effect-promise-callable-types.js +0 -5
- package/dist/rules/effect-promise-callable-types.js.map +0 -1
- package/dist/rules/effect-promise-callables.d.ts +0 -5
- package/dist/rules/effect-promise-callables.d.ts.map +0 -1
- package/dist/rules/effect-promise-callables.js +0 -7
- package/dist/rules/effect-promise-callables.js.map +0 -1
- package/dist/rules/effect-promise-collections.d.ts +0 -20
- package/dist/rules/effect-promise-collections.d.ts.map +0 -1
- package/dist/rules/effect-promise-collections.js +0 -199
- package/dist/rules/effect-promise-collections.js.map +0 -1
- package/dist/rules/effect-promise-completion.d.ts +0 -141
- package/dist/rules/effect-promise-completion.d.ts.map +0 -1
- package/dist/rules/effect-promise-completion.js +0 -200
- package/dist/rules/effect-promise-completion.js.map +0 -1
- package/dist/rules/effect-promise-environment-projections.d.ts +0 -23
- package/dist/rules/effect-promise-environment-projections.d.ts.map +0 -1
- package/dist/rules/effect-promise-environment-projections.js +0 -191
- package/dist/rules/effect-promise-environment-projections.js.map +0 -1
- package/dist/rules/effect-promise-environment-types.d.ts +0 -96
- package/dist/rules/effect-promise-environment-types.d.ts.map +0 -1
- package/dist/rules/effect-promise-environment-types.js +0 -10
- package/dist/rules/effect-promise-environment-types.js.map +0 -1
- package/dist/rules/effect-promise-environment-values.d.ts +0 -41
- package/dist/rules/effect-promise-environment-values.d.ts.map +0 -1
- package/dist/rules/effect-promise-environment-values.js +0 -208
- package/dist/rules/effect-promise-environment-values.js.map +0 -1
- package/dist/rules/effect-promise-environments.d.ts +0 -5
- package/dist/rules/effect-promise-environments.d.ts.map +0 -1
- package/dist/rules/effect-promise-environments.js +0 -7
- package/dist/rules/effect-promise-environments.js.map +0 -1
- package/dist/rules/effect-promise-execution-ast.d.ts +0 -12
- package/dist/rules/effect-promise-execution-ast.d.ts.map +0 -1
- package/dist/rules/effect-promise-execution-ast.js +0 -30
- package/dist/rules/effect-promise-execution-ast.js.map +0 -1
- package/dist/rules/effect-promise-execution-engine.d.ts +0 -9
- package/dist/rules/effect-promise-execution-engine.d.ts.map +0 -1
- package/dist/rules/effect-promise-execution-engine.js +0 -280
- package/dist/rules/effect-promise-execution-engine.js.map +0 -1
- package/dist/rules/effect-promise-execution-flow.d.ts +0 -48
- package/dist/rules/effect-promise-execution-flow.d.ts.map +0 -1
- package/dist/rules/effect-promise-execution-flow.js +0 -197
- package/dist/rules/effect-promise-execution-flow.js.map +0 -1
- package/dist/rules/effect-promise-execution-navigation.d.ts +0 -34
- package/dist/rules/effect-promise-execution-navigation.d.ts.map +0 -1
- package/dist/rules/effect-promise-execution-navigation.js +0 -66
- package/dist/rules/effect-promise-execution-navigation.js.map +0 -1
- package/dist/rules/effect-promise-execution-types.d.ts +0 -36
- package/dist/rules/effect-promise-execution-types.d.ts.map +0 -1
- package/dist/rules/effect-promise-execution-types.js +0 -5
- package/dist/rules/effect-promise-execution-types.js.map +0 -1
- package/dist/rules/effect-promise-execution-values.d.ts +0 -40
- package/dist/rules/effect-promise-execution-values.d.ts.map +0 -1
- package/dist/rules/effect-promise-execution-values.js +0 -262
- package/dist/rules/effect-promise-execution-values.js.map +0 -1
- package/dist/rules/effect-promise-expression-flow.d.ts +0 -27
- package/dist/rules/effect-promise-expression-flow.d.ts.map +0 -1
- package/dist/rules/effect-promise-expression-flow.js +0 -80
- package/dist/rules/effect-promise-expression-flow.js.map +0 -1
- package/dist/rules/effect-promise-invocation-memo.d.ts +0 -16
- package/dist/rules/effect-promise-invocation-memo.d.ts.map +0 -1
- package/dist/rules/effect-promise-invocation-memo.js +0 -44
- package/dist/rules/effect-promise-invocation-memo.js.map +0 -1
- package/dist/rules/effect-promise-invocations.d.ts +0 -16
- package/dist/rules/effect-promise-invocations.d.ts.map +0 -1
- package/dist/rules/effect-promise-invocations.js +0 -126
- package/dist/rules/effect-promise-invocations.js.map +0 -1
- package/dist/rules/effect-promise-node-children.d.ts +0 -22
- package/dist/rules/effect-promise-node-children.d.ts.map +0 -1
- package/dist/rules/effect-promise-node-children.js +0 -49
- package/dist/rules/effect-promise-node-children.js.map +0 -1
- package/dist/rules/effect-promise-node-evaluation.d.ts +0 -43
- package/dist/rules/effect-promise-node-evaluation.d.ts.map +0 -1
- package/dist/rules/effect-promise-node-evaluation.js +0 -150
- package/dist/rules/effect-promise-node-evaluation.js.map +0 -1
- package/dist/rules/effect-promise-parameter-bindings.d.ts +0 -28
- package/dist/rules/effect-promise-parameter-bindings.d.ts.map +0 -1
- package/dist/rules/effect-promise-parameter-bindings.js +0 -187
- package/dist/rules/effect-promise-parameter-bindings.js.map +0 -1
- package/dist/rules/effect-promise-pattern-bindings.d.ts +0 -9
- package/dist/rules/effect-promise-pattern-bindings.d.ts.map +0 -1
- package/dist/rules/effect-promise-pattern-bindings.js +0 -54
- package/dist/rules/effect-promise-pattern-bindings.js.map +0 -1
- package/dist/rules/effect-promise-program-traversal.d.ts +0 -40
- package/dist/rules/effect-promise-program-traversal.d.ts.map +0 -1
- package/dist/rules/effect-promise-program-traversal.js +0 -128
- package/dist/rules/effect-promise-program-traversal.js.map +0 -1
- package/dist/rules/effect-promise-rule-bindings.d.ts +0 -23
- package/dist/rules/effect-promise-rule-bindings.d.ts.map +0 -1
- package/dist/rules/effect-promise-rule-bindings.js +0 -41
- package/dist/rules/effect-promise-rule-bindings.js.map +0 -1
- package/dist/rules/effect-promise-runtime-arguments.d.ts +0 -18
- package/dist/rules/effect-promise-runtime-arguments.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-arguments.js +0 -49
- package/dist/rules/effect-promise-runtime-arguments.js.map +0 -1
- package/dist/rules/effect-promise-runtime-call-targets.d.ts +0 -21
- package/dist/rules/effect-promise-runtime-call-targets.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-call-targets.js +0 -55
- package/dist/rules/effect-promise-runtime-call-targets.js.map +0 -1
- package/dist/rules/effect-promise-runtime-callable-properties.d.ts +0 -20
- package/dist/rules/effect-promise-runtime-callable-properties.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-callable-properties.js +0 -30
- package/dist/rules/effect-promise-runtime-callable-properties.js.map +0 -1
- package/dist/rules/effect-promise-runtime-callables.d.ts +0 -51
- package/dist/rules/effect-promise-runtime-callables.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-callables.js +0 -214
- package/dist/rules/effect-promise-runtime-callables.js.map +0 -1
- package/dist/rules/effect-promise-runtime-choice-operations.d.ts +0 -32
- package/dist/rules/effect-promise-runtime-choice-operations.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-choice-operations.js +0 -145
- package/dist/rules/effect-promise-runtime-choice-operations.js.map +0 -1
- package/dist/rules/effect-promise-runtime-choice.d.ts +0 -26
- package/dist/rules/effect-promise-runtime-choice.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-choice.js +0 -95
- package/dist/rules/effect-promise-runtime-choice.js.map +0 -1
- package/dist/rules/effect-promise-runtime-control-branches.d.ts +0 -14
- package/dist/rules/effect-promise-runtime-control-branches.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-control-branches.js +0 -74
- package/dist/rules/effect-promise-runtime-control-branches.js.map +0 -1
- package/dist/rules/effect-promise-runtime-control-completions.d.ts +0 -26
- package/dist/rules/effect-promise-runtime-control-completions.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-control-completions.js +0 -116
- package/dist/rules/effect-promise-runtime-control-completions.js.map +0 -1
- package/dist/rules/effect-promise-runtime-control-flow.d.ts +0 -9
- package/dist/rules/effect-promise-runtime-control-flow.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-control-flow.js +0 -94
- package/dist/rules/effect-promise-runtime-control-flow.js.map +0 -1
- package/dist/rules/effect-promise-runtime-control-patterns.d.ts +0 -15
- package/dist/rules/effect-promise-runtime-control-patterns.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-control-patterns.js +0 -84
- package/dist/rules/effect-promise-runtime-control-patterns.js.map +0 -1
- package/dist/rules/effect-promise-runtime-control-scalars.d.ts +0 -23
- package/dist/rules/effect-promise-runtime-control-scalars.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-control-scalars.js +0 -178
- package/dist/rules/effect-promise-runtime-control-scalars.js.map +0 -1
- package/dist/rules/effect-promise-runtime-expressions.d.ts +0 -22
- package/dist/rules/effect-promise-runtime-expressions.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-expressions.js +0 -311
- package/dist/rules/effect-promise-runtime-expressions.js.map +0 -1
- package/dist/rules/effect-promise-runtime-heap.d.ts +0 -39
- package/dist/rules/effect-promise-runtime-heap.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-heap.js +0 -73
- package/dist/rules/effect-promise-runtime-heap.js.map +0 -1
- package/dist/rules/effect-promise-runtime-interpreter.d.ts +0 -39
- package/dist/rules/effect-promise-runtime-interpreter.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-interpreter.js +0 -261
- package/dist/rules/effect-promise-runtime-interpreter.js.map +0 -1
- package/dist/rules/effect-promise-runtime-intrinsics.d.ts +0 -15
- package/dist/rules/effect-promise-runtime-intrinsics.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-intrinsics.js +0 -54
- package/dist/rules/effect-promise-runtime-intrinsics.js.map +0 -1
- package/dist/rules/effect-promise-runtime-loops.d.ts +0 -9
- package/dist/rules/effect-promise-runtime-loops.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-loops.js +0 -277
- package/dist/rules/effect-promise-runtime-loops.js.map +0 -1
- package/dist/rules/effect-promise-runtime-members.d.ts +0 -28
- package/dist/rules/effect-promise-runtime-members.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-members.js +0 -88
- package/dist/rules/effect-promise-runtime-members.js.map +0 -1
- package/dist/rules/effect-promise-runtime-memo.d.ts +0 -40
- package/dist/rules/effect-promise-runtime-memo.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-memo.js +0 -124
- package/dist/rules/effect-promise-runtime-memo.js.map +0 -1
- package/dist/rules/effect-promise-runtime-model.d.ts +0 -258
- package/dist/rules/effect-promise-runtime-model.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-model.js +0 -99
- package/dist/rules/effect-promise-runtime-model.js.map +0 -1
- package/dist/rules/effect-promise-runtime-mutations.d.ts +0 -17
- package/dist/rules/effect-promise-runtime-mutations.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-mutations.js +0 -165
- package/dist/rules/effect-promise-runtime-mutations.js.map +0 -1
- package/dist/rules/effect-promise-runtime-patterns.d.ts +0 -21
- package/dist/rules/effect-promise-runtime-patterns.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-patterns.js +0 -179
- package/dist/rules/effect-promise-runtime-patterns.js.map +0 -1
- package/dist/rules/effect-promise-runtime-proof.d.ts +0 -74
- package/dist/rules/effect-promise-runtime-proof.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-proof.js +0 -253
- package/dist/rules/effect-promise-runtime-proof.js.map +0 -1
- package/dist/rules/effect-promise-runtime-reporting.d.ts +0 -16
- package/dist/rules/effect-promise-runtime-reporting.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-reporting.js +0 -11
- package/dist/rules/effect-promise-runtime-reporting.js.map +0 -1
- package/dist/rules/effect-promise-runtime-scalar-operations.d.ts +0 -2
- package/dist/rules/effect-promise-runtime-scalar-operations.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-scalar-operations.js +0 -5
- package/dist/rules/effect-promise-runtime-scalar-operations.js.map +0 -1
- package/dist/rules/effect-promise-runtime-scalars.d.ts +0 -24
- package/dist/rules/effect-promise-runtime-scalars.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-scalars.js +0 -125
- package/dist/rules/effect-promise-runtime-scalars.js.map +0 -1
- package/dist/rules/effect-promise-runtime-statement-sequence.d.ts +0 -11
- package/dist/rules/effect-promise-runtime-statement-sequence.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-statement-sequence.js +0 -155
- package/dist/rules/effect-promise-runtime-statement-sequence.js.map +0 -1
- package/dist/rules/effect-promise-runtime-statements.d.ts +0 -15
- package/dist/rules/effect-promise-runtime-statements.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-statements.js +0 -334
- package/dist/rules/effect-promise-runtime-statements.js.map +0 -1
- package/dist/rules/effect-promise-runtime-store.d.ts +0 -44
- package/dist/rules/effect-promise-runtime-store.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-store.js +0 -186
- package/dist/rules/effect-promise-runtime-store.js.map +0 -1
- package/dist/rules/effect-promise-runtime-structures.d.ts +0 -9
- package/dist/rules/effect-promise-runtime-structures.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-structures.js +0 -266
- package/dist/rules/effect-promise-runtime-structures.js.map +0 -1
- package/dist/rules/effect-promise-runtime-switch.d.ts +0 -9
- package/dist/rules/effect-promise-runtime-switch.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-switch.js +0 -91
- package/dist/rules/effect-promise-runtime-switch.js.map +0 -1
- package/dist/rules/effect-promise-runtime-tasks.d.ts +0 -72
- package/dist/rules/effect-promise-runtime-tasks.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-tasks.js +0 -158
- package/dist/rules/effect-promise-runtime-tasks.js.map +0 -1
- package/dist/rules/effect-promise-runtime-this.d.ts +0 -14
- package/dist/rules/effect-promise-runtime-this.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-this.js +0 -29
- package/dist/rules/effect-promise-runtime-this.js.map +0 -1
- package/dist/rules/effect-promise-runtime-try.d.ts +0 -9
- package/dist/rules/effect-promise-runtime-try.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-try.js +0 -94
- package/dist/rules/effect-promise-runtime-try.js.map +0 -1
- package/dist/rules/effect-promise-runtime-values.d.ts +0 -88
- package/dist/rules/effect-promise-runtime-values.d.ts.map +0 -1
- package/dist/rules/effect-promise-runtime-values.js +0 -398
- package/dist/rules/effect-promise-runtime-values.js.map +0 -1
- package/dist/rules/effect-promise-value-scopes.d.ts +0 -94
- package/dist/rules/effect-promise-value-scopes.d.ts.map +0 -1
- package/dist/rules/effect-promise-value-scopes.js +0 -218
- package/dist/rules/effect-promise-value-scopes.js.map +0 -1
- package/dist/rules/effect-sync-promise-scope-index.d.ts +0 -44
- package/dist/rules/effect-sync-promise-scope-index.d.ts.map +0 -1
- package/dist/rules/effect-sync-promise-scope-index.js +0 -409
- package/dist/rules/effect-sync-promise-scope-index.js.map +0 -1
- package/dist/rules/effect-sync-promise-scopes.d.ts +0 -10
- package/dist/rules/effect-sync-promise-scopes.d.ts.map +0 -1
- package/dist/rules/effect-sync-promise-scopes.js +0 -115
- package/dist/rules/effect-sync-promise-scopes.js.map +0 -1
- package/dist/rules/effect-sync-promise-source.d.ts +0 -2
- package/dist/rules/effect-sync-promise-source.d.ts.map +0 -1
- package/dist/rules/effect-sync-promise-source.js +0 -5
- package/dist/rules/effect-sync-promise-source.js.map +0 -1
- package/dist/rules/effect-yieldable-schema-superclass.d.ts +0 -12
- package/dist/rules/effect-yieldable-schema-superclass.d.ts.map +0 -1
- package/dist/rules/effect-yieldable-schema-superclass.js +0 -84
- package/dist/rules/effect-yieldable-schema-superclass.js.map +0 -1
- package/dist/rules/max-import-depth.d.ts +0 -7
- package/dist/rules/max-import-depth.d.ts.map +0 -1
- package/dist/rules/max-import-depth.js +0 -64
- package/dist/rules/max-import-depth.js.map +0 -1
- package/dist/rules/max-line-length.d.ts +0 -14
- package/dist/rules/max-line-length.d.ts.map +0 -1
- package/dist/rules/max-line-length.js +0 -65
- package/dist/rules/max-line-length.js.map +0 -1
- package/dist/rules/no-commented-out-code.d.ts +0 -8
- package/dist/rules/no-commented-out-code.d.ts.map +0 -1
- package/dist/rules/no-commented-out-code.js +0 -215
- package/dist/rules/no-commented-out-code.js.map +0 -1
- package/dist/rules/pascal-case-types.d.ts +0 -9
- package/dist/rules/pascal-case-types.d.ts.map +0 -1
- package/dist/rules/pascal-case-types.js +0 -81
- package/dist/rules/pascal-case-types.js.map +0 -1
- package/dist/rules/plugin-commented-out-code-jsx-scanner.d.ts +0 -21
- package/dist/rules/plugin-commented-out-code-jsx-scanner.d.ts.map +0 -1
- package/dist/rules/plugin-commented-out-code-jsx-scanner.js +0 -200
- package/dist/rules/plugin-commented-out-code-jsx-scanner.js.map +0 -1
- package/dist/rules/plugin-commented-out-code-lexical-primitives.d.ts +0 -139
- package/dist/rules/plugin-commented-out-code-lexical-primitives.d.ts.map +0 -1
- package/dist/rules/plugin-commented-out-code-lexical-primitives.js +0 -244
- package/dist/rules/plugin-commented-out-code-lexical-primitives.js.map +0 -1
- package/dist/rules/plugin-commented-out-code-rule.d.ts +0 -45
- package/dist/rules/plugin-commented-out-code-rule.d.ts.map +0 -1
- package/dist/rules/plugin-commented-out-code-rule.js +0 -200
- package/dist/rules/plugin-commented-out-code-rule.js.map +0 -1
- package/dist/rules/plugin-commented-out-code-source-scanner.d.ts +0 -8
- package/dist/rules/plugin-commented-out-code-source-scanner.d.ts.map +0 -1
- package/dist/rules/plugin-commented-out-code-source-scanner.js +0 -299
- package/dist/rules/plugin-commented-out-code-source-scanner.js.map +0 -1
- package/dist/rules/private-underscore.d.ts +0 -11
- package/dist/rules/private-underscore.d.ts.map +0 -1
- package/dist/rules/private-underscore.js +0 -18
- package/dist/rules/private-underscore.js.map +0 -1
- package/dist/rules/require-file-doc.d.ts +0 -11
- package/dist/rules/require-file-doc.d.ts.map +0 -1
- package/dist/rules/require-file-doc.js +0 -140
- package/dist/rules/require-file-doc.js.map +0 -1
- package/dist/rules/require-function-doc-ignored-text.d.ts +0 -23
- package/dist/rules/require-function-doc-ignored-text.d.ts.map +0 -1
- package/dist/rules/require-function-doc-ignored-text.js +0 -145
- package/dist/rules/require-function-doc-ignored-text.js.map +0 -1
- package/dist/rules/require-function-doc-local-exports.d.ts +0 -7
- package/dist/rules/require-function-doc-local-exports.d.ts.map +0 -1
- package/dist/rules/require-function-doc-local-exports.js +0 -72
- package/dist/rules/require-function-doc-local-exports.js.map +0 -1
- package/dist/rules/require-function-doc.d.ts +0 -16
- package/dist/rules/require-function-doc.d.ts.map +0 -1
- package/dist/rules/require-function-doc.js +0 -405
- package/dist/rules/require-function-doc.js.map +0 -1
|
@@ -1,140 +0,0 @@
|
|
|
1
|
-
/* -------------------------------------------------------------------------- */
|
|
2
|
-
/* File-level documentation requirement helper for custom Oxlint rules. */
|
|
3
|
-
/* -------------------------------------------------------------------------- */
|
|
4
|
-
import { Match, Option, pipe } from 'effect';
|
|
5
|
-
// Character code constants
|
|
6
|
-
const CH_HASH = 35;
|
|
7
|
-
const CH_SLASH = 47;
|
|
8
|
-
const CH_SPACE = 32;
|
|
9
|
-
const CH_NEWLINE = 10;
|
|
10
|
-
const CH_RETURN = 13;
|
|
11
|
-
const CH_TAB = 9;
|
|
12
|
-
const CH_ASTERISK = 42;
|
|
13
|
-
const JSDOC_PREFIX_LENGTH = 3;
|
|
14
|
-
const LINE_MARKER_LOOKAHEAD = 20;
|
|
15
|
-
const BLOCK_MARKER_LOOKAHEAD = 15;
|
|
16
|
-
// Pre-computed search strings
|
|
17
|
-
const JSDOC_END = '*/';
|
|
18
|
-
const DIVIDER_PREFIX = '/*';
|
|
19
|
-
const DIVIDER_SUFFIX = '*/';
|
|
20
|
-
const MIN_DIVIDER_DASHES = 3;
|
|
21
|
-
const isWhitespace = (code) => code === CH_SPACE || code === CH_NEWLINE || code === CH_RETURN || code === CH_TAB;
|
|
22
|
-
const skipShebangLinesFrom = (source, emptyResult, start) => {
|
|
23
|
-
let pos = start;
|
|
24
|
-
while (pos < source.length && source.charCodeAt(pos) === CH_HASH) {
|
|
25
|
-
const nextLine = source.indexOf('\n', pos);
|
|
26
|
-
if (nextLine === -1) {
|
|
27
|
-
return emptyResult;
|
|
28
|
-
}
|
|
29
|
-
pos = nextLine + 1;
|
|
30
|
-
}
|
|
31
|
-
return pos;
|
|
32
|
-
};
|
|
33
|
-
const skipShebangLines = (source, emptyResult) => skipShebangLinesFrom(source, emptyResult, 0);
|
|
34
|
-
const skipLeadingWhitespace = (source, start) => {
|
|
35
|
-
let pos = start;
|
|
36
|
-
while (pos < source.length && isWhitespace(source.charCodeAt(pos))) {
|
|
37
|
-
pos += 1;
|
|
38
|
-
}
|
|
39
|
-
return pos;
|
|
40
|
-
};
|
|
41
|
-
const trimLineEnd = (line) => line.replace(/\r$/u, '');
|
|
42
|
-
const lineTextAt = (source, start) => trimLineEnd(source.slice(start, lineEndAt(source, start)));
|
|
43
|
-
const isSkippableToolDirectiveLine = (line) => {
|
|
44
|
-
const trimmed = line.trim();
|
|
45
|
-
return (trimmed.startsWith('/* eslint-') ||
|
|
46
|
-
trimmed.startsWith('// eslint-') ||
|
|
47
|
-
trimmed.startsWith('// @ts-') ||
|
|
48
|
-
trimmed.startsWith('/// <reference') ||
|
|
49
|
-
trimmed === "'use strict';" ||
|
|
50
|
-
trimmed === '"use strict";');
|
|
51
|
-
};
|
|
52
|
-
const skipToolDirectiveLines = (source, start) => {
|
|
53
|
-
let pos = start;
|
|
54
|
-
while (true) {
|
|
55
|
-
pos = skipLeadingWhitespace(source, pos);
|
|
56
|
-
if (pos >= source.length) {
|
|
57
|
-
return pos;
|
|
58
|
-
}
|
|
59
|
-
const line = lineTextAt(source, pos);
|
|
60
|
-
if (!isSkippableToolDirectiveLine(line)) {
|
|
61
|
-
return pos;
|
|
62
|
-
}
|
|
63
|
-
pos = nextLineStartAt(source, pos);
|
|
64
|
-
}
|
|
65
|
-
};
|
|
66
|
-
const leadingContentPosition = (source, emptyResult) => skipToolDirectiveLines(source, skipShebangLines(source, emptyResult));
|
|
67
|
-
const hasJSDocStartAt = (source, pos) => pos + 2 < source.length &&
|
|
68
|
-
source.charCodeAt(pos) === CH_SLASH &&
|
|
69
|
-
source.charCodeAt(pos + 1) === CH_ASTERISK &&
|
|
70
|
-
source.charCodeAt(pos + 2) === CH_ASTERISK;
|
|
71
|
-
const lineEndAt = (source, start) => Match.value(source.indexOf('\n', start)).pipe(Match.when(-1, () => source.length), Match.orElse((newline) => newline));
|
|
72
|
-
const nextLineStartAt = (source, start) => Match.value(source.indexOf('\n', start)).pipe(Match.when(-1, () => source.length), Match.orElse((newline) => newline + 1));
|
|
73
|
-
const dividerLineInnerText = (line) => {
|
|
74
|
-
const normalizedLine = trimLineEnd(line);
|
|
75
|
-
if (!normalizedLine.startsWith(DIVIDER_PREFIX) || !normalizedLine.endsWith(DIVIDER_SUFFIX)) {
|
|
76
|
-
return undefined;
|
|
77
|
-
}
|
|
78
|
-
return normalizedLine.slice(DIVIDER_PREFIX.length, -DIVIDER_SUFFIX.length).trim();
|
|
79
|
-
};
|
|
80
|
-
const hasMeaningfulDividerText = (text) => text.length > 0 && !/^-+$/u.test(text);
|
|
81
|
-
const isDividerTextLine = (line) => pipe(Option.fromNullable(dividerLineInnerText(line)), Option.exists(hasMeaningfulDividerText));
|
|
82
|
-
const isDividerRuleLine = (line) => pipe(Option.fromNullable(dividerLineInnerText(line)), Option.exists((text) => /^-+$/u.test(text) && text.length >= MIN_DIVIDER_DASHES));
|
|
83
|
-
const dividerHeaderBodyEndFrom = (source, cursor, hasMeaningfulBody) => {
|
|
84
|
-
let hasBody = hasMeaningfulBody;
|
|
85
|
-
for (let pos = cursor; pos < source.length; pos = nextLineStartAt(source, pos)) {
|
|
86
|
-
const line = lineTextAt(source, pos);
|
|
87
|
-
const end = lineEndAt(source, pos);
|
|
88
|
-
if (isDividerRuleLine(line)) {
|
|
89
|
-
return Match.value(hasBody).pipe(Match.when(true, () => end), Match.orElse(() => undefined));
|
|
90
|
-
}
|
|
91
|
-
if (!isDividerTextLine(line)) {
|
|
92
|
-
return undefined;
|
|
93
|
-
}
|
|
94
|
-
hasBody = true;
|
|
95
|
-
}
|
|
96
|
-
return undefined;
|
|
97
|
-
};
|
|
98
|
-
const dividerHeaderEnd = (source, pos) => {
|
|
99
|
-
if (!isDividerRuleLine(lineTextAt(source, pos))) {
|
|
100
|
-
return undefined;
|
|
101
|
-
}
|
|
102
|
-
return dividerHeaderBodyEndFrom(source, nextLineStartAt(source, pos), false);
|
|
103
|
-
};
|
|
104
|
-
const boundedEnd = (source, pos, lookahead) => Match.value(pos + lookahead).pipe(Match.when((end) => end < source.length, (end) => end), Match.orElse(() => source.length));
|
|
105
|
-
const hasLineOptOutMarker = (source, pos) => {
|
|
106
|
-
const end = boundedEnd(source, pos, LINE_MARKER_LOOKAHEAD);
|
|
107
|
-
const frag = source.slice(pos, end);
|
|
108
|
-
return frag.startsWith('// @internal') || frag.startsWith('// @generated');
|
|
109
|
-
};
|
|
110
|
-
const hasBlockOptOutMarker = (source, pos) => pos + 2 < source.length &&
|
|
111
|
-
source.charCodeAt(pos + 2) !== CH_ASTERISK &&
|
|
112
|
-
source.slice(pos, boundedEnd(source, pos, BLOCK_MARKER_LOOKAHEAD)).startsWith('/* @internal');
|
|
113
|
-
const hasOptOutMarker = (source, pos) => Match.value(source.charCodeAt(pos) === CH_SLASH && pos + 1 < source.length).pipe(Match.when(false, () => false), Match.orElse(() => Match.value(source.charCodeAt(pos + 1)).pipe(Match.when(CH_SLASH, () => hasLineOptOutMarker(source, pos)), Match.when(CH_ASTERISK, () => hasBlockOptOutMarker(source, pos)), Match.orElse(() => false))));
|
|
114
|
-
/**
|
|
115
|
-
* Extract the JSDoc file header comment from source text. Skips leading shebang lines and whitespace.
|
|
116
|
-
* Returns the full JSDoc block or undefined.
|
|
117
|
-
*/
|
|
118
|
-
export const extractDocHeader = (source) => {
|
|
119
|
-
const pos = leadingContentPosition(source, source.length);
|
|
120
|
-
return Match.value(pos).pipe(Match.when((position) => position >= source.length, () => undefined), Match.orElse((position) => extractDocHeaderAt(source, position)));
|
|
121
|
-
};
|
|
122
|
-
const extractDocHeaderAt = (source, pos) => {
|
|
123
|
-
const dividerEnd = dividerHeaderEnd(source, pos);
|
|
124
|
-
return pipe(Option.fromNullable(dividerEnd), Option.match({
|
|
125
|
-
onNone: () => Match.value(hasJSDocStartAt(source, pos)).pipe(Match.when(false, () => undefined), Match.orElse(() => {
|
|
126
|
-
const closePOS = source.indexOf(JSDOC_END, pos + JSDOC_PREFIX_LENGTH);
|
|
127
|
-
return Match.value(closePOS).pipe(Match.when(-1, () => undefined), Match.orElse((closePosition) => source.slice(pos, closePosition + 2)));
|
|
128
|
-
})),
|
|
129
|
-
onSome: (end) => source.slice(pos, end),
|
|
130
|
-
}));
|
|
131
|
-
};
|
|
132
|
-
/**
|
|
133
|
-
* Returns true if the source file satisfies the file doc requirement. Requires: divider header,
|
|
134
|
-
* opt-out marker, or empty/whitespace-only.
|
|
135
|
-
*/
|
|
136
|
-
export default function hasRequiredFileDoc(source) {
|
|
137
|
-
const pos = leadingContentPosition(source, source.length);
|
|
138
|
-
return Match.value(pos).pipe(Match.when((position) => position >= source.length, () => true), Match.when((position) => hasOptOutMarker(source, position), () => true), Match.orElse((position) => dividerHeaderEnd(source, position) !== undefined));
|
|
139
|
-
}
|
|
140
|
-
//# sourceMappingURL=require-file-doc.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"require-file-doc.js","sourceRoot":"","sources":["../../src/rules/require-file-doc.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,gFAAgF;AAChF,gFAAgF;AAChF,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE7C,2BAA2B;AAC3B,MAAM,OAAO,GAAG,EAAE,CAAC;AACnB,MAAM,QAAQ,GAAG,EAAE,CAAC;AACpB,MAAM,QAAQ,GAAG,EAAE,CAAC;AACpB,MAAM,UAAU,GAAG,EAAE,CAAC;AACtB,MAAM,SAAS,GAAG,EAAE,CAAC;AACrB,MAAM,MAAM,GAAG,CAAC,CAAC;AACjB,MAAM,WAAW,GAAG,EAAE,CAAC;AACvB,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAC9B,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAElC,8BAA8B;AAC9B,MAAM,SAAS,GAAG,IAAI,CAAC;AACvB,MAAM,cAAc,GAAG,IAAI,CAAC;AAC5B,MAAM,cAAc,GAAG,IAAI,CAAC;AAC5B,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAE7B,MAAM,YAAY,GAAG,CAAC,IAAY,EAAW,EAAE,CAC7C,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,UAAU,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,MAAM,CAAC;AAEpF,MAAM,oBAAoB,GAAG,CAAC,MAAc,EAAE,WAAmB,EAAE,KAAa,EAAU,EAAE;IAC1F,IAAI,GAAG,GAAG,KAAK,CAAC;IAChB,OAAO,GAAG,GAAG,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,OAAO,EAAE,CAAC;QACjE,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC3C,IAAI,QAAQ,KAAK,CAAC,CAAC,EAAE,CAAC;YACpB,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,GAAG,GAAG,QAAQ,GAAG,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAAE,WAAmB,EAAU,EAAE,CACvE,oBAAoB,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC;AAE/C,MAAM,qBAAqB,GAAG,CAAC,MAAc,EAAE,KAAa,EAAU,EAAE;IACtE,IAAI,GAAG,GAAG,KAAK,CAAC;IAChB,OAAO,GAAG,GAAG,MAAM,CAAC,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QACnE,GAAG,IAAI,CAAC,CAAC;IACX,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AAEvE,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,KAAa,EAAU,EAAE,CAC3D,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AAE7D,MAAM,4BAA4B,GAAG,CAAC,IAAY,EAAW,EAAE;IAC7D,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC5B,OAAO,CACL,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC;QAChC,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC;QAChC,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC;QAC7B,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC;QACpC,OAAO,KAAK,eAAe;QAC3B,OAAO,KAAK,eAAe,CAC5B,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,MAAc,EAAE,KAAa,EAAU,EAAE;IACvE,IAAI,GAAG,GAAG,KAAK,CAAC;IAChB,OAAO,IAAI,EAAE,CAAC;QACZ,GAAG,GAAG,qBAAqB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACzC,IAAI,GAAG,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YACzB,OAAO,GAAG,CAAC;QACb,CAAC;QAED,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACrC,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,EAAE,CAAC;YACxC,OAAO,GAAG,CAAC;QACb,CAAC;QAED,GAAG,GAAG,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACrC,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,MAAc,EAAE,WAAmB,EAAU,EAAE,CAC7E,sBAAsB,CAAC,MAAM,EAAE,gBAAgB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;AAExE,MAAM,eAAe,GAAG,CAAC,MAAc,EAAE,GAAW,EAAW,EAAE,CAC/D,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM;IACvB,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,QAAQ;IACnC,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,WAAW;IAC1C,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,WAAW,CAAC;AAE7C,MAAM,SAAS,GAAG,CAAC,MAAc,EAAE,KAAa,EAAU,EAAE,CAC1D,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,CAC3C,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAW,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,EAC3C,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,EAAU,EAAE,CAAC,OAAO,CAAC,CAC3C,CAAC;AAEJ,MAAM,eAAe,GAAG,CAAC,MAAc,EAAE,KAAa,EAAU,EAAE,CAChE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,CAC3C,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAW,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,EAC3C,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,EAAU,EAAE,CAAC,OAAO,GAAG,CAAC,CAAC,CAC/C,CAAC;AAEJ,MAAM,oBAAoB,GAAG,CAAC,IAAY,EAAsB,EAAE;IAChE,MAAM,cAAc,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IACzC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;QAC3F,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,cAAc,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;AACpF,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,IAAY,EAAW,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEnG,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAW,EAAE,CAClD,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC,CAAC;AAEjG,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAW,EAAE,CAClD,IAAI,CACF,MAAM,CAAC,YAAY,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,EAC/C,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAW,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,IAAI,kBAAkB,CAAC,CAC1F,CAAC;AAEJ,MAAM,wBAAwB,GAAG,CAC/B,MAAc,EACd,MAAc,EACd,iBAA0B,EACN,EAAE;IACtB,IAAI,OAAO,GAAG,iBAAiB,CAAC;IAChC,KAAK,IAAI,GAAG,GAAG,MAAM,EAAE,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,GAAG,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;QAC/E,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACrC,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAEnC,IAAI,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5B,OAAO,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAC9B,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,GAAW,EAAE,CAAC,GAAG,CAAC,EACnC,KAAK,CAAC,MAAM,CAAC,GAAc,EAAE,CAAC,SAAS,CAAC,CACzC,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7B,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,GAAG,IAAI,CAAC;IACjB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAAE,GAAW,EAAsB,EAAE;IAC3E,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;QAChD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,wBAAwB,CAAC,MAAM,EAAE,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;AAC/E,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,GAAW,EAAE,SAAiB,EAAU,EAAE,CAC5E,KAAK,CAAC,KAAK,CAAC,GAAG,GAAG,SAAS,CAAC,CAAC,IAAI,CAC/B,KAAK,CAAC,IAAI,CACR,CAAC,GAAG,EAAW,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC,MAAM,EACrC,CAAC,GAAG,EAAU,EAAE,CAAC,GAAG,CACrB,EACD,KAAK,CAAC,MAAM,CAAC,GAAW,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAC1C,CAAC;AAEJ,MAAM,mBAAmB,GAAG,CAAC,MAAc,EAAE,GAAW,EAAW,EAAE;IACnE,MAAM,GAAG,GAAG,UAAU,CAAC,MAAM,EAAE,GAAG,EAAE,qBAAqB,CAAC,CAAC;IAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACpC,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;AAC7E,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,MAAc,EAAE,GAAW,EAAW,EAAE,CACpE,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM;IACvB,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,WAAW;IAC1C,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,UAAU,CAAC,MAAM,EAAE,GAAG,EAAE,sBAAsB,CAAC,CAAC,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;AAEhG,MAAM,eAAe,GAAG,CAAC,MAAc,EAAE,GAAW,EAAW,EAAE,CAC/D,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,QAAQ,IAAI,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAC9E,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,GAAY,EAAE,CAAC,KAAK,CAAC,EACvC,KAAK,CAAC,MAAM,CAAC,GAAY,EAAE,CACzB,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAC1C,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAY,EAAE,CAAC,mBAAmB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EACrE,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,GAAY,EAAE,CAAC,oBAAoB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EACzE,KAAK,CAAC,MAAM,CAAC,GAAY,EAAE,CAAC,KAAK,CAAC,CACnC,CACF,CACF,CAAC;AAEJ;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAAsB,EAAE;IACrE,MAAM,GAAG,GAAG,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAC1D,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAC1B,KAAK,CAAC,IAAI,CACR,CAAC,QAAQ,EAAW,EAAE,CAAC,QAAQ,IAAI,MAAM,CAAC,MAAM,EAChD,GAAc,EAAE,CAAC,SAAS,CAC3B,EACD,KAAK,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAsB,EAAE,CAAC,kBAAkB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CACrF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,MAAc,EAAE,GAAW,EAAsB,EAAE;IAC7E,MAAM,UAAU,GAAG,gBAAgB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjD,OAAO,IAAI,CACT,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,EAC/B,MAAM,CAAC,KAAK,CAAC;QACX,MAAM,EAAE,GAAuB,EAAE,CAC/B,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAC5C,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,GAAc,EAAE,CAAC,SAAS,CAAC,EAC7C,KAAK,CAAC,MAAM,CAAC,GAAuB,EAAE;YACpC,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,GAAG,mBAAmB,CAAC,CAAC;YACtE,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,CAC/B,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAc,EAAE,CAAC,SAAS,CAAC,EAC1C,KAAK,CAAC,MAAM,CAAC,CAAC,aAAa,EAAU,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,aAAa,GAAG,CAAC,CAAC,CAAC,CAC9E,CAAC;QACJ,CAAC,CAAC,CACH;QACH,MAAM,EAAE,CAAC,GAAG,EAAU,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC;KAChD,CAAC,CACH,CAAC;AACJ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,MAAc;IACvD,MAAM,GAAG,GAAG,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAC1D,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAC1B,KAAK,CAAC,IAAI,CACR,CAAC,QAAQ,EAAW,EAAE,CAAC,QAAQ,IAAI,MAAM,CAAC,MAAM,EAChD,GAAY,EAAE,CAAC,IAAI,CACpB,EACD,KAAK,CAAC,IAAI,CACR,CAAC,QAAQ,EAAW,EAAE,CAAC,eAAe,CAAC,MAAM,EAAE,QAAQ,CAAC,EACxD,GAAY,EAAE,CAAC,IAAI,CACpB,EACD,KAAK,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAW,EAAE,CAAC,gBAAgB,CAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,SAAS,CAAC,CACtF,CAAC;AACJ,CAAC"}
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Index of ignored lexical positions and raw JSDoc starts for one source.
|
|
3
|
-
*/
|
|
4
|
-
export interface IgnoredTextIndex {
|
|
5
|
-
readonly isInside: (pos: number) => boolean;
|
|
6
|
-
readonly jsdocStarts: readonly number[];
|
|
7
|
-
}
|
|
8
|
-
/**
|
|
9
|
-
* Builds lexical state and raw JSDoc indexes for one source invocation.
|
|
10
|
-
*
|
|
11
|
-
* @param source - Source text to index.
|
|
12
|
-
* @returns A reusable ignored-text and JSDoc position index.
|
|
13
|
-
*/
|
|
14
|
-
export declare const createIgnoredTextIndex: (source: string) => IgnoredTextIndex;
|
|
15
|
-
/**
|
|
16
|
-
* Checks whether a source offset is inside a comment or string literal.
|
|
17
|
-
*
|
|
18
|
-
* @param source - Source text to inspect.
|
|
19
|
-
* @param pos - Zero-based source offset to query.
|
|
20
|
-
* @returns Whether the offset is inside ignored lexical text.
|
|
21
|
-
*/
|
|
22
|
-
export declare const isInsideIgnoredText: (source: string, pos: number) => boolean;
|
|
23
|
-
//# sourceMappingURL=require-function-doc-ignored-text.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"require-function-doc-ignored-text.d.ts","sourceRoot":"","sources":["../../src/rules/require-function-doc-ignored-text.ts"],"names":[],"mappings":"AAkBA;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC;IAC5C,QAAQ,CAAC,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC;CACzC;AAsHD;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,GAAI,QAAQ,MAAM,KAAG,gBAWvD,CAAC;AAeF;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,GAAI,QAAQ,MAAM,EAAE,KAAK,MAAM,KAAG,OAClC,CAAC"}
|
|
@@ -1,145 +0,0 @@
|
|
|
1
|
-
/* -------------------------------------------------------------------------- */
|
|
2
|
-
/* Ignored source-region helpers for exported JSDoc checks. */
|
|
3
|
-
/* -------------------------------------------------------------------------- */
|
|
4
|
-
const CHAR_CODE_BACKSLASH = 92;
|
|
5
|
-
const CHAR_CODE_NEWLINE = 10;
|
|
6
|
-
const CHAR_CODE_ASTERISK = 42;
|
|
7
|
-
const CHAR_CODE_SLASH = 47;
|
|
8
|
-
const CHAR_CODE_DOUBLE_QUOTE = 34;
|
|
9
|
-
const CHAR_CODE_SINGLE_QUOTE = 39;
|
|
10
|
-
const CHAR_CODE_BACKTICK = 96;
|
|
11
|
-
const STATE_LINE_COMMENT = 1;
|
|
12
|
-
const STATE_BLOCK_COMMENT = 2;
|
|
13
|
-
const STATE_ESCAPED = 4;
|
|
14
|
-
const STATE_DOUBLE_QUOTE = 8;
|
|
15
|
-
const STATE_SINGLE_QUOTE = 16;
|
|
16
|
-
const STATE_BACKTICK = 32;
|
|
17
|
-
const STATE_QUOTE_MASK = STATE_DOUBLE_QUOTE | STATE_SINGLE_QUOTE | STATE_BACKTICK;
|
|
18
|
-
const isIgnoredState = (state) => (state & (STATE_LINE_COMMENT | STATE_BLOCK_COMMENT | STATE_QUOTE_MASK)) !== 0;
|
|
19
|
-
const boundedPositionFor = (pos, sourceLength) => {
|
|
20
|
-
if (pos < sourceLength) {
|
|
21
|
-
return pos;
|
|
22
|
-
}
|
|
23
|
-
return sourceLength;
|
|
24
|
-
};
|
|
25
|
-
const isJSDocStartAt = (source, idx) => source.charCodeAt(idx) === CHAR_CODE_SLASH &&
|
|
26
|
-
source.charCodeAt(idx + 1) === CHAR_CODE_ASTERISK &&
|
|
27
|
-
source.charCodeAt(idx + 2) === CHAR_CODE_ASTERISK;
|
|
28
|
-
const nextLineCommentState = (state, charCode) => {
|
|
29
|
-
if (charCode === CHAR_CODE_NEWLINE) {
|
|
30
|
-
return state & ~STATE_LINE_COMMENT;
|
|
31
|
-
}
|
|
32
|
-
return state;
|
|
33
|
-
};
|
|
34
|
-
const nextBlockCommentState = (state, charCode, nextCharCode) => {
|
|
35
|
-
if (charCode === CHAR_CODE_ASTERISK && nextCharCode === CHAR_CODE_SLASH) {
|
|
36
|
-
return state & ~STATE_BLOCK_COMMENT;
|
|
37
|
-
}
|
|
38
|
-
return state;
|
|
39
|
-
};
|
|
40
|
-
const isClosingQuote = (state, charCode) => ((state & STATE_DOUBLE_QUOTE) !== 0 && charCode === CHAR_CODE_DOUBLE_QUOTE) ||
|
|
41
|
-
((state & STATE_SINGLE_QUOTE) !== 0 && charCode === CHAR_CODE_SINGLE_QUOTE) ||
|
|
42
|
-
((state & STATE_BACKTICK) !== 0 && charCode === CHAR_CODE_BACKTICK);
|
|
43
|
-
const nextQuotedState = (state, charCode) => {
|
|
44
|
-
if ((state & STATE_ESCAPED) !== 0) {
|
|
45
|
-
return state & ~STATE_ESCAPED;
|
|
46
|
-
}
|
|
47
|
-
if (charCode === CHAR_CODE_BACKSLASH) {
|
|
48
|
-
return state | STATE_ESCAPED;
|
|
49
|
-
}
|
|
50
|
-
if (isClosingQuote(state, charCode)) {
|
|
51
|
-
return state & ~STATE_QUOTE_MASK;
|
|
52
|
-
}
|
|
53
|
-
return state;
|
|
54
|
-
};
|
|
55
|
-
const quoteStateFor = (charCode) => {
|
|
56
|
-
if (charCode === CHAR_CODE_DOUBLE_QUOTE) {
|
|
57
|
-
return STATE_DOUBLE_QUOTE;
|
|
58
|
-
}
|
|
59
|
-
if (charCode === CHAR_CODE_SINGLE_QUOTE) {
|
|
60
|
-
return STATE_SINGLE_QUOTE;
|
|
61
|
-
}
|
|
62
|
-
if (charCode === CHAR_CODE_BACKTICK) {
|
|
63
|
-
return STATE_BACKTICK;
|
|
64
|
-
}
|
|
65
|
-
return 0;
|
|
66
|
-
};
|
|
67
|
-
const nextUnquotedState = (state, charCode, nextCharCode) => {
|
|
68
|
-
if (charCode === CHAR_CODE_SLASH && nextCharCode === CHAR_CODE_SLASH) {
|
|
69
|
-
return state | STATE_LINE_COMMENT;
|
|
70
|
-
}
|
|
71
|
-
if (charCode === CHAR_CODE_SLASH && nextCharCode === CHAR_CODE_ASTERISK) {
|
|
72
|
-
return state | STATE_BLOCK_COMMENT;
|
|
73
|
-
}
|
|
74
|
-
const quoteState = quoteStateFor(charCode);
|
|
75
|
-
if (quoteState !== 0) {
|
|
76
|
-
return state | quoteState;
|
|
77
|
-
}
|
|
78
|
-
return state;
|
|
79
|
-
};
|
|
80
|
-
const nextIgnoredState = (state, charCode, nextCharCode) => {
|
|
81
|
-
if ((state & STATE_LINE_COMMENT) !== 0) {
|
|
82
|
-
return nextLineCommentState(state, charCode);
|
|
83
|
-
}
|
|
84
|
-
if ((state & STATE_BLOCK_COMMENT) !== 0) {
|
|
85
|
-
return nextBlockCommentState(state, charCode, nextCharCode);
|
|
86
|
-
}
|
|
87
|
-
if ((state & STATE_QUOTE_MASK) !== 0) {
|
|
88
|
-
return nextQuotedState(state, charCode);
|
|
89
|
-
}
|
|
90
|
-
return nextUnquotedState(state, charCode, nextCharCode);
|
|
91
|
-
};
|
|
92
|
-
const ignoredPositionQuery = (ignoredPositions, sourceLength, pos) => {
|
|
93
|
-
if (pos <= 0) {
|
|
94
|
-
return false;
|
|
95
|
-
}
|
|
96
|
-
const boundedPosition = boundedPositionFor(pos, sourceLength);
|
|
97
|
-
return ignoredPositions[boundedPosition] === 1;
|
|
98
|
-
};
|
|
99
|
-
const scanIgnoredText = (source, ignoredPositions, jsdocStarts) => {
|
|
100
|
-
const positions = ignoredPositions;
|
|
101
|
-
let state = 0;
|
|
102
|
-
for (let idx = 0; idx < source.length; idx += 1) {
|
|
103
|
-
if (isJSDocStartAt(source, idx)) {
|
|
104
|
-
jsdocStarts.push(idx);
|
|
105
|
-
}
|
|
106
|
-
positions[idx] = Number(isIgnoredState(state));
|
|
107
|
-
state = nextIgnoredState(state, source.charCodeAt(idx), source.charCodeAt(idx + 1));
|
|
108
|
-
}
|
|
109
|
-
return state;
|
|
110
|
-
};
|
|
111
|
-
/**
|
|
112
|
-
* Builds lexical state and raw JSDoc indexes for one source invocation.
|
|
113
|
-
*
|
|
114
|
-
* @param source - Source text to index.
|
|
115
|
-
* @returns A reusable ignored-text and JSDoc position index.
|
|
116
|
-
*/
|
|
117
|
-
export const createIgnoredTextIndex = (source) => {
|
|
118
|
-
const sourceLength = source.length;
|
|
119
|
-
const ignoredPositions = new Uint8Array(sourceLength + 1);
|
|
120
|
-
const jsdocStarts = [];
|
|
121
|
-
const state = scanIgnoredText(source, ignoredPositions, jsdocStarts);
|
|
122
|
-
ignoredPositions[sourceLength] = Number(isIgnoredState(state));
|
|
123
|
-
const isInside = (pos) => ignoredPositionQuery(ignoredPositions, sourceLength, pos);
|
|
124
|
-
return { isInside, jsdocStarts };
|
|
125
|
-
};
|
|
126
|
-
let cachedSource = undefined;
|
|
127
|
-
let cachedIndex = undefined;
|
|
128
|
-
const indexFor = (source) => {
|
|
129
|
-
if (cachedIndex !== undefined && cachedSource === source) {
|
|
130
|
-
return cachedIndex;
|
|
131
|
-
}
|
|
132
|
-
const nextIndex = createIgnoredTextIndex(source);
|
|
133
|
-
cachedSource = source;
|
|
134
|
-
cachedIndex = nextIndex;
|
|
135
|
-
return nextIndex;
|
|
136
|
-
};
|
|
137
|
-
/**
|
|
138
|
-
* Checks whether a source offset is inside a comment or string literal.
|
|
139
|
-
*
|
|
140
|
-
* @param source - Source text to inspect.
|
|
141
|
-
* @param pos - Zero-based source offset to query.
|
|
142
|
-
* @returns Whether the offset is inside ignored lexical text.
|
|
143
|
-
*/
|
|
144
|
-
export const isInsideIgnoredText = (source, pos) => indexFor(source).isInside(pos);
|
|
145
|
-
//# sourceMappingURL=require-function-doc-ignored-text.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"require-function-doc-ignored-text.js","sourceRoot":"","sources":["../../src/rules/require-function-doc-ignored-text.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,gFAAgF;AAChF,gFAAgF;AAChF,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,eAAe,GAAG,EAAE,CAAC;AAC3B,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAC7B,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAC9B,MAAM,aAAa,GAAG,CAAC,CAAC;AACxB,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAC7B,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,cAAc,GAAG,EAAE,CAAC;AAC1B,MAAM,gBAAgB,GAAG,kBAAkB,GAAG,kBAAkB,GAAG,cAAc,CAAC;AAUlF,MAAM,cAAc,GAAG,CAAC,KAAa,EAAW,EAAE,CAChD,CAAC,KAAK,GAAG,CAAC,kBAAkB,GAAG,mBAAmB,GAAG,gBAAgB,CAAC,CAAC,KAAK,CAAC,CAAC;AAEhF,MAAM,kBAAkB,GAAG,CAAC,GAAW,EAAE,YAAoB,EAAU,EAAE;IACvE,IAAI,GAAG,GAAG,YAAY,EAAE,CAAC;QACvB,OAAO,GAAG,CAAC;IACb,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,MAAc,EAAE,GAAW,EAAW,EAAE,CAC9D,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,eAAe;IAC1C,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,kBAAkB;IACjD,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,kBAAkB,CAAC;AAEpD,MAAM,oBAAoB,GAAG,CAAC,KAAa,EAAE,QAAgB,EAAU,EAAE;IACvE,IAAI,QAAQ,KAAK,iBAAiB,EAAE,CAAC;QACnC,OAAO,KAAK,GAAG,CAAC,kBAAkB,CAAC;IACrC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,KAAa,EAAE,QAAgB,EAAE,YAAoB,EAAU,EAAE;IAC9F,IAAI,QAAQ,KAAK,kBAAkB,IAAI,YAAY,KAAK,eAAe,EAAE,CAAC;QACxE,OAAO,KAAK,GAAG,CAAC,mBAAmB,CAAC;IACtC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,KAAa,EAAE,QAAgB,EAAW,EAAE,CAClE,CAAC,CAAC,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC,IAAI,QAAQ,KAAK,sBAAsB,CAAC;IAC3E,CAAC,CAAC,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC,IAAI,QAAQ,KAAK,sBAAsB,CAAC;IAC3E,CAAC,CAAC,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC,IAAI,QAAQ,KAAK,kBAAkB,CAAC,CAAC;AAEtE,MAAM,eAAe,GAAG,CAAC,KAAa,EAAE,QAAgB,EAAU,EAAE;IAClE,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QAClC,OAAO,KAAK,GAAG,CAAC,aAAa,CAAC;IAChC,CAAC;IACD,IAAI,QAAQ,KAAK,mBAAmB,EAAE,CAAC;QACrC,OAAO,KAAK,GAAG,aAAa,CAAC;IAC/B,CAAC;IACD,IAAI,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,CAAC;QACpC,OAAO,KAAK,GAAG,CAAC,gBAAgB,CAAC;IACnC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAU,EAAE;IACjD,IAAI,QAAQ,KAAK,sBAAsB,EAAE,CAAC;QACxC,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IACD,IAAI,QAAQ,KAAK,sBAAsB,EAAE,CAAC;QACxC,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IACD,IAAI,QAAQ,KAAK,kBAAkB,EAAE,CAAC;QACpC,OAAO,cAAc,CAAC;IACxB,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,KAAa,EAAE,QAAgB,EAAE,YAAoB,EAAU,EAAE;IAC1F,IAAI,QAAQ,KAAK,eAAe,IAAI,YAAY,KAAK,eAAe,EAAE,CAAC;QACrE,OAAO,KAAK,GAAG,kBAAkB,CAAC;IACpC,CAAC;IACD,IAAI,QAAQ,KAAK,eAAe,IAAI,YAAY,KAAK,kBAAkB,EAAE,CAAC;QACxE,OAAO,KAAK,GAAG,mBAAmB,CAAC;IACrC,CAAC;IACD,MAAM,UAAU,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC3C,IAAI,UAAU,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,KAAK,GAAG,UAAU,CAAC;IAC5B,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,KAAa,EAAE,QAAgB,EAAE,YAAoB,EAAU,EAAE;IACzF,IAAI,CAAC,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;QACvC,OAAO,oBAAoB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IACD,IAAI,CAAC,KAAK,GAAG,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;QACxC,OAAO,qBAAqB,CAAC,KAAK,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;IAC9D,CAAC;IACD,IAAI,CAAC,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;QACrC,OAAO,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,iBAAiB,CAAC,KAAK,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;AAC1D,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAC3B,gBAA4B,EAC5B,YAAoB,EACpB,GAAW,EACF,EAAE;IACX,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,eAAe,GAAG,kBAAkB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;IAC9D,OAAO,gBAAgB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CACtB,MAAc,EACd,gBAA4B,EAC5B,WAAqB,EACb,EAAE;IACV,MAAM,SAAS,GAAG,gBAAgB,CAAC;IACnC,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;QAChD,IAAI,cAAc,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;YAChC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;QAC/C,KAAK,GAAG,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;IACtF,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,MAAc,EAAoB,EAAE;IACzE,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC;IACnC,MAAM,gBAAgB,GAAG,IAAI,UAAU,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;IAC1D,MAAM,WAAW,GAAa,EAAE,CAAC;IACjC,MAAM,KAAK,GAAG,eAAe,CAAC,MAAM,EAAE,gBAAgB,EAAE,WAAW,CAAC,CAAC;IAErE,gBAAgB,CAAC,YAAY,CAAC,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/D,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAW,EAAE,CACxC,oBAAoB,CAAC,gBAAgB,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC;IAE5D,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AACnC,CAAC,CAAC;AAEF,IAAI,YAAY,GAAuB,SAAS,CAAC;AACjD,IAAI,WAAW,GAAiC,SAAS,CAAC;AAE1D,MAAM,QAAQ,GAAG,CAAC,MAAc,EAAoB,EAAE;IACpD,IAAI,WAAW,KAAK,SAAS,IAAI,YAAY,KAAK,MAAM,EAAE,CAAC;QACzD,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,MAAM,SAAS,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC;IACjD,YAAY,GAAG,MAAM,CAAC;IACtB,WAAW,GAAG,SAAS,CAAC;IACxB,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,MAAc,EAAE,GAAW,EAAW,EAAE,CAC1E,QAAQ,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC"}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Internal helper exported for package-local composition.
|
|
3
|
-
*
|
|
4
|
-
* @internal
|
|
5
|
-
*/
|
|
6
|
-
export declare const isDocumentedLocalExportList: (source: string, afterExport: number, exportPOS: number, hasJSDocBefore: (source: string, declarationPOS: number) => boolean) => boolean | undefined;
|
|
7
|
-
//# sourceMappingURL=require-function-doc-local-exports.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"require-function-doc-local-exports.d.ts","sourceRoot":"","sources":["../../src/rules/require-function-doc-local-exports.ts"],"names":[],"mappings":"AA6JA;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,GACtC,QAAQ,MAAM,EACd,aAAa,MAAM,EACnB,WAAW,MAAM,EACjB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,KAAK,OAAO,KAClE,OAAO,GAAG,SAiBZ,CAAC"}
|
|
@@ -1,72 +0,0 @@
|
|
|
1
|
-
/* -------------------------------------------------------------------------- */
|
|
2
|
-
/* Local export-list documentation helpers for exported JSDoc checks. */
|
|
3
|
-
/* -------------------------------------------------------------------------- */
|
|
4
|
-
import { Array, Match, Option, pipe } from 'effect';
|
|
5
|
-
const CHAR_CODE_OPEN_BRACE = 123;
|
|
6
|
-
const CHAR_CODE_LOWER_A = 97;
|
|
7
|
-
const CHAR_CODE_LOWER_Z = 122;
|
|
8
|
-
const CHAR_CODE_UPPER_A = 65;
|
|
9
|
-
const CHAR_CODE_UPPER_Z = 90;
|
|
10
|
-
const TYPE_KEYWORD_LENGTH = 'type '.length;
|
|
11
|
-
const skipWhitespace = (source, pos) => Match.value(pos).pipe(Match.when((cursor) => cursor < source.length && /\s/u.test(source[cursor] ?? ''), (cursor) => skipWhitespace(source, cursor + 1)), Match.orElse((cursor) => cursor));
|
|
12
|
-
const exportStatementEnd = (source, afterExport) => {
|
|
13
|
-
const semicolon = source.indexOf(';', afterExport);
|
|
14
|
-
return Match.value(semicolon).pipe(Match.when((index) => index === -1, () => source.indexOf('\n', afterExport)), Match.orElse((index) => index));
|
|
15
|
-
};
|
|
16
|
-
const hasFromClauseBefore = (source, openBrace, statementEnd) => {
|
|
17
|
-
const end = Match.value(statementEnd).pipe(Match.when((index) => index === -1, () => source.length), Match.orElse((index) => index));
|
|
18
|
-
return source.slice(openBrace, end).includes(' from ');
|
|
19
|
-
};
|
|
20
|
-
const localExportOpenBrace = (source, afterExport) => Match.value(afterExport).pipe(Match.when((index) => source.slice(index, index + TYPE_KEYWORD_LENGTH) === 'type ' &&
|
|
21
|
-
index + TYPE_KEYWORD_LENGTH < source.length, (index) => skipWhitespace(source, index + TYPE_KEYWORD_LENGTH)), Match.orElse((index) => index));
|
|
22
|
-
const localExportListBounds = (source, afterExport) => {
|
|
23
|
-
const openBrace = localExportOpenBrace(source, afterExport);
|
|
24
|
-
return Match.value(openBrace).pipe(Match.when((index) => source.charCodeAt(index) !== CHAR_CODE_OPEN_BRACE, () => undefined), Match.orElse((index) => pipe(Match.value(source.indexOf('}', index)).pipe(Match.when((closeBrace) => closeBrace === -1, () => Option.none()), Match.orElse((closeBrace) => Option.some(closeBrace))), Option.filter((closeBrace) => !hasFromClauseBefore(source, index, exportStatementEnd(source, closeBrace))), Option.map((closeBrace) => ({
|
|
25
|
-
closeBrace,
|
|
26
|
-
openBrace: index,
|
|
27
|
-
})), Option.getOrUndefined)));
|
|
28
|
-
};
|
|
29
|
-
const localExportName = (part) => part
|
|
30
|
-
.trim()
|
|
31
|
-
.replace(/^type\s+/u, '')
|
|
32
|
-
.split(/\s+as\s+/u)[0]
|
|
33
|
-
?.trim() ?? '';
|
|
34
|
-
const localExportNames = (source, afterExport) => {
|
|
35
|
-
const bounds = localExportListBounds(source, afterExport);
|
|
36
|
-
return pipe(Option.fromNullable(bounds), Option.map((listBounds) => pipe(source.slice(listBounds.openBrace + 1, listBounds.closeBrace).split(','), Array.map(localExportName), Array.filter((name) => Boolean(name)))), Option.getOrUndefined);
|
|
37
|
-
};
|
|
38
|
-
const declarationNeedles = (name) => [
|
|
39
|
-
`const ${name}`,
|
|
40
|
-
`let ${name}`,
|
|
41
|
-
`var ${name}`,
|
|
42
|
-
`function ${name}`,
|
|
43
|
-
`class ${name}`,
|
|
44
|
-
`interface ${name}`,
|
|
45
|
-
`type ${name}`,
|
|
46
|
-
`enum ${name}`,
|
|
47
|
-
];
|
|
48
|
-
const isIdentifierBoundaryAfter = (source, pos) => {
|
|
49
|
-
if (pos >= source.length) {
|
|
50
|
-
return true;
|
|
51
|
-
}
|
|
52
|
-
const code = source.charCodeAt(pos);
|
|
53
|
-
return !((code >= CHAR_CODE_LOWER_A && code <= CHAR_CODE_LOWER_Z) ||
|
|
54
|
-
(code >= CHAR_CODE_UPPER_A && code <= CHAR_CODE_UPPER_Z));
|
|
55
|
-
};
|
|
56
|
-
const localDeclarationPosition = (source, name, exportPOS) => {
|
|
57
|
-
const bestPosition = pipe(declarationNeedles(name), Array.reduce(-1, (currentBest, needle) => {
|
|
58
|
-
const pos = source.lastIndexOf(needle, exportPOS);
|
|
59
|
-
return Match.value(pos).pipe(Match.when((position) => position > currentBest && isIdentifierBoundaryAfter(source, position + needle.length), (position) => position), Match.orElse(() => currentBest));
|
|
60
|
-
}));
|
|
61
|
-
return pipe(Option.some(bestPosition), Option.filter((position) => position !== -1), Option.getOrUndefined);
|
|
62
|
-
};
|
|
63
|
-
/**
|
|
64
|
-
* Internal helper exported for package-local composition.
|
|
65
|
-
*
|
|
66
|
-
* @internal
|
|
67
|
-
*/
|
|
68
|
-
export const isDocumentedLocalExportList = (source, afterExport, exportPOS, hasJSDocBefore) => {
|
|
69
|
-
const names = localExportNames(source, afterExport);
|
|
70
|
-
return pipe(Option.fromNullable(names), Option.map((exportNames) => pipe(exportNames, Array.every((name) => pipe(Option.fromNullable(localDeclarationPosition(source, name, exportPOS)), Option.exists((declarationPOS) => hasJSDocBefore(source, declarationPOS)))))), Option.getOrUndefined);
|
|
71
|
-
};
|
|
72
|
-
//# sourceMappingURL=require-function-doc-local-exports.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"require-function-doc-local-exports.js","sourceRoot":"","sources":["../../src/rules/require-function-doc-local-exports.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,gFAAgF;AAChF,gFAAgF;AAChF,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEpD,MAAM,oBAAoB,GAAG,GAAG,CAAC;AACjC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAC9B,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;AAE3C,MAAM,cAAc,GAAG,CAAC,MAAc,EAAE,GAAW,EAAU,EAAE,CAC7D,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CACnB,KAAK,CAAC,IAAI,CACR,CAAC,MAAM,EAAW,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,EAC/E,CAAC,MAAM,EAAU,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,CACvD,EACD,KAAK,CAAC,MAAM,CAAC,CAAC,MAAM,EAAU,EAAE,CAAC,MAAM,CAAC,CACzC,CAAC;AAEJ,MAAM,kBAAkB,GAAG,CAAC,MAAc,EAAE,WAAmB,EAAU,EAAE;IACzE,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IACnD,OAAO,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAChC,KAAK,CAAC,IAAI,CACR,CAAC,KAAK,EAAW,EAAE,CAAC,KAAK,KAAK,CAAC,CAAC,EAChC,GAAW,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAChD,EACD,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAU,EAAE,CAAC,KAAK,CAAC,CACvC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,MAAc,EAAE,SAAiB,EAAE,YAAoB,EAAW,EAAE;IAC/F,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,IAAI,CACxC,KAAK,CAAC,IAAI,CACR,CAAC,KAAK,EAAW,EAAE,CAAC,KAAK,KAAK,CAAC,CAAC,EAChC,GAAW,EAAE,CAAC,MAAM,CAAC,MAAM,CAC5B,EACD,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAU,EAAE,CAAC,KAAK,CAAC,CACvC,CAAC;IACF,OAAO,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,MAAc,EAAE,WAAmB,EAAU,EAAE,CAC3E,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,CAC3B,KAAK,CAAC,IAAI,CACR,CAAC,KAAK,EAAW,EAAE,CACjB,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,mBAAmB,CAAC,KAAK,OAAO;IAC5D,KAAK,GAAG,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAC7C,CAAC,KAAK,EAAU,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,KAAK,GAAG,mBAAmB,CAAC,CACvE,EACD,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAU,EAAE,CAAC,KAAK,CAAC,CACvC,CAAC;AAEJ,MAAM,qBAAqB,GAAG,CAC5B,MAAc,EACd,WAAmB,EACoC,EAAE;IACzD,MAAM,SAAS,GAAG,oBAAoB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC5D,OAAO,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAChC,KAAK,CAAC,IAAI,CACR,CAAC,KAAK,EAAW,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,oBAAoB,EACrE,GAAc,EAAE,CAAC,SAAS,CAC3B,EACD,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAyD,EAAE,CAC5E,IAAI,CACF,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,CAC1C,KAAK,CAAC,IAAI,CACR,CAAC,UAAU,EAAW,EAAE,CAAC,UAAU,KAAK,CAAC,CAAC,EAC1C,GAA0B,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAC3C,EACD,KAAK,CAAC,MAAM,CAAC,CAAC,UAAU,EAAyB,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAC7E,EACD,MAAM,CAAC,MAAM,CACX,CAAC,UAAU,EAAW,EAAE,CACtB,CAAC,mBAAmB,CAAC,MAAM,EAAE,KAAK,EAAE,kBAAkB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAC9E,EACD,MAAM,CAAC,GAAG,CAAC,CAAC,UAAU,EAA6C,EAAE,CAAC,CAAC;QACrE,UAAU;QACV,SAAS,EAAE,KAAK;KACjB,CAAC,CAAC,EACH,MAAM,CAAC,cAAc,CACtB,CACF,CACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,IAAY,EAAU,EAAE,CAC/C,IAAI;KACD,IAAI,EAAE;KACN,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;KACxB,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IACtB,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;AAEnB,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAAE,WAAmB,EAAiC,EAAE;IAC9F,MAAM,MAAM,GAAG,qBAAqB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC1D,OAAO,IAAI,CACT,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,EAC3B,MAAM,CAAC,GAAG,CAAC,CAAC,UAAU,EAAqB,EAAE,CAC3C,IAAI,CACF,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,GAAG,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EACxE,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,EAC1B,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAW,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAC/C,CACF,EACD,MAAM,CAAC,cAAc,CACtB,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,IAAY,EAAqB,EAAE,CAAC;IAC9D,SAAS,IAAI,EAAE;IACf,OAAO,IAAI,EAAE;IACb,OAAO,IAAI,EAAE;IACb,YAAY,IAAI,EAAE;IAClB,SAAS,IAAI,EAAE;IACf,aAAa,IAAI,EAAE;IACnB,QAAQ,IAAI,EAAE;IACd,QAAQ,IAAI,EAAE;CACf,CAAC;AAEF,MAAM,yBAAyB,GAAG,CAAC,MAAc,EAAE,GAAW,EAAW,EAAE;IACzE,IAAI,GAAG,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACpC,OAAO,CAAC,CACN,CAAC,IAAI,IAAI,iBAAiB,IAAI,IAAI,IAAI,iBAAiB,CAAC;QACxD,CAAC,IAAI,IAAI,iBAAiB,IAAI,IAAI,IAAI,iBAAiB,CAAC,CACzD,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAC/B,MAAc,EACd,IAAY,EACZ,SAAiB,EACG,EAAE;IACtB,MAAM,YAAY,GAAG,IAAI,CACvB,kBAAkB,CAAC,IAAI,CAAC,EACxB,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,EAAU,EAAE;QAC/C,MAAM,GAAG,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAClD,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAC1B,KAAK,CAAC,IAAI,CACR,CAAC,QAAQ,EAAW,EAAE,CACpB,QAAQ,GAAG,WAAW,IAAI,yBAAyB,CAAC,MAAM,EAAE,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,EACvF,CAAC,QAAQ,EAAU,EAAE,CAAC,QAAQ,CAC/B,EACD,KAAK,CAAC,MAAM,CAAC,GAAW,EAAE,CAAC,WAAW,CAAC,CACxC,CAAC;IACJ,CAAC,CAAC,CACH,CAAC;IACF,OAAO,IAAI,CACT,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EACzB,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAW,EAAE,CAAC,QAAQ,KAAK,CAAC,CAAC,CAAC,EACrD,MAAM,CAAC,cAAc,CACtB,CAAC;AACJ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,MAAc,EACd,WAAmB,EACnB,SAAiB,EACjB,cAAmE,EAC9C,EAAE;IACvB,MAAM,KAAK,GAAG,gBAAgB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACpD,OAAO,IAAI,CACT,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,EAC1B,MAAM,CAAC,GAAG,CAAC,CAAC,WAAW,EAAW,EAAE,CAClC,IAAI,CACF,WAAW,EACX,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAW,EAAE,CAC5B,IAAI,CACF,MAAM,CAAC,YAAY,CAAC,wBAAwB,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,EACtE,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,EAAW,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CACnF,CACF,CACF,CACF,EACD,MAAM,CAAC,cAAc,CACtB,CAAC;AACJ,CAAC,CAAC"}
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Location details for the first exported declaration missing JSDoc.
|
|
3
|
-
*/
|
|
4
|
-
export interface RequiredFunctionDocFailure {
|
|
5
|
-
line: number;
|
|
6
|
-
snippet: string;
|
|
7
|
-
}
|
|
8
|
-
/**
|
|
9
|
-
* Finds the first public exported declaration that lacks declaration JSDoc.
|
|
10
|
-
*/
|
|
11
|
-
export declare const findRequiredFunctionDocFailure: (source: string) => RequiredFunctionDocFailure | undefined;
|
|
12
|
-
/**
|
|
13
|
-
* Checks whether exported declarations have meaningful JSDoc comments.
|
|
14
|
-
*/
|
|
15
|
-
export default function hasRequiredFunctionDocs(source: string): boolean;
|
|
16
|
-
//# sourceMappingURL=require-function-doc.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"require-function-doc.d.ts","sourceRoot":"","sources":["../../src/rules/require-function-doc.ts"],"names":[],"mappings":"AAyeA;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAyCD;;GAEG;AACH,eAAO,MAAM,8BAA8B,GACzC,QAAQ,MAAM,KACb,0BAA0B,GAAG,SAe/B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEvE"}
|