@thethracian/oxlint-config 0.3.1 → 0.3.2
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 +7 -0
- package/dist/codemods/arrow-body-style.d.ts.map +1 -1
- package/dist/codemods/arrow-body-style.js +29 -68
- package/dist/codemods/arrow-body-style.js.map +1 -1
- package/dist/codemods/comment-format.d.ts.map +1 -1
- package/dist/codemods/comment-format.js +22 -32
- package/dist/codemods/comment-format.js.map +1 -1
- package/dist/codemods/explicit-return-types.d.ts.map +1 -1
- package/dist/codemods/explicit-return-types.js +58 -167
- package/dist/codemods/explicit-return-types.js.map +1 -1
- package/dist/codemods/format-file-header.d.ts.map +1 -1
- package/dist/codemods/format-file-header.js +33 -72
- package/dist/codemods/format-file-header.js.map +1 -1
- package/dist/codemods/format-jsdoc-comments.d.ts.map +1 -1
- package/dist/codemods/format-jsdoc-comments.js +58 -66
- package/dist/codemods/format-jsdoc-comments.js.map +1 -1
- package/dist/codemods/function-declarations.d.ts.map +1 -1
- package/dist/codemods/function-declarations.js +45 -80
- package/dist/codemods/function-declarations.js.map +1 -1
- package/dist/codemods/inline-export-lists.d.ts.map +1 -1
- package/dist/codemods/inline-export-lists.js +60 -108
- package/dist/codemods/inline-export-lists.js.map +1 -1
- package/dist/codemods/internal-export-docs.d.ts.map +1 -1
- package/dist/codemods/internal-export-docs.js +21 -59
- package/dist/codemods/internal-export-docs.js.map +1 -1
- package/dist/codemods/no-ternary-branch-initializers.d.ts.map +1 -1
- package/dist/codemods/no-ternary-branch-initializers.js +72 -144
- package/dist/codemods/no-ternary-branch-initializers.js.map +1 -1
- package/dist/codemods/no-ternary-variable-initializers.d.ts.map +1 -1
- package/dist/codemods/no-ternary-variable-initializers.js +69 -152
- package/dist/codemods/no-ternary-variable-initializers.js.map +1 -1
- package/dist/codemods/no-ternary.d.ts.map +1 -1
- package/dist/codemods/no-ternary.js +44 -108
- package/dist/codemods/no-ternary.js.map +1 -1
- package/dist/codemods/rename-acronyms.d.ts.map +1 -1
- package/dist/codemods/rename-acronyms.js +73 -99
- package/dist/codemods/rename-acronyms.js.map +1 -1
- package/dist/codemods/run.d.ts.map +1 -1
- package/dist/codemods/run.js +15 -7
- package/dist/codemods/run.js.map +1 -1
- package/dist/codemods/sort-imports.d.ts.map +1 -1
- package/dist/codemods/sort-imports.js +52 -94
- package/dist/codemods/sort-imports.js.map +1 -1
- package/dist/rules/acronym-case.d.ts.map +1 -1
- package/dist/rules/acronym-case.js +68 -141
- package/dist/rules/acronym-case.js.map +1 -1
- package/dist/rules/acronyms-1.d.ts +1 -1
- package/dist/rules/acronyms-1.d.ts.map +1 -1
- package/dist/rules/acronyms-1.js +2 -402
- package/dist/rules/acronyms-1.js.map +1 -1
- package/dist/rules/acronyms-2.d.ts +1 -1
- package/dist/rules/acronyms-2.d.ts.map +1 -1
- package/dist/rules/acronyms-2.js +2 -402
- package/dist/rules/acronyms-2.js.map +1 -1
- package/dist/rules/acronyms-3.d.ts +1 -1
- package/dist/rules/acronyms-3.d.ts.map +1 -1
- package/dist/rules/acronyms-3.js +2 -402
- package/dist/rules/acronyms-3.js.map +1 -1
- package/dist/rules/acronyms-4.d.ts +1 -1
- package/dist/rules/acronyms-4.d.ts.map +1 -1
- package/dist/rules/acronyms-4.js +2 -372
- package/dist/rules/acronyms-4.js.map +1 -1
- package/dist/rules/acronyms.d.ts.map +1 -1
- package/dist/rules/acronyms.js +3 -6
- package/dist/rules/acronyms.js.map +1 -1
- package/dist/rules/boolean-prefix.d.ts.map +1 -1
- package/dist/rules/boolean-prefix.js +25 -71
- package/dist/rules/boolean-prefix.js.map +1 -1
- package/dist/rules/camel-case-identifiers.d.ts.map +1 -1
- package/dist/rules/camel-case-identifiers.js +15 -54
- package/dist/rules/camel-case-identifiers.js.map +1 -1
- package/dist/rules/char-class.d.ts +1 -1
- package/dist/rules/char-class.d.ts.map +1 -1
- package/dist/rules/char-class.js +16 -16
- package/dist/rules/char-class.js.map +1 -1
- package/dist/rules/diagnostic-guidance.d.ts.map +1 -1
- package/dist/rules/diagnostic-guidance.js +11 -20
- package/dist/rules/diagnostic-guidance.js.map +1 -1
- package/dist/rules/effect-default-ast.d.ts.map +1 -1
- package/dist/rules/effect-default-ast.js +35 -116
- package/dist/rules/effect-default-ast.js.map +1 -1
- package/dist/rules/effect-default-compat-rules.d.ts.map +1 -1
- package/dist/rules/effect-default-compat-rules.js +41 -79
- package/dist/rules/effect-default-compat-rules.js.map +1 -1
- package/dist/rules/effect-default-env-rules.d.ts.map +1 -1
- package/dist/rules/effect-default-env-rules.js +23 -29
- package/dist/rules/effect-default-env-rules.js.map +1 -1
- package/dist/rules/effect-default-fiber-helpers.d.ts.map +1 -1
- package/dist/rules/effect-default-fiber-helpers.js +12 -26
- package/dist/rules/effect-default-fiber-helpers.js.map +1 -1
- package/dist/rules/effect-default-floating-helpers.d.ts.map +1 -1
- package/dist/rules/effect-default-floating-helpers.js +59 -67
- package/dist/rules/effect-default-floating-helpers.js.map +1 -1
- package/dist/rules/effect-default-resource-helpers.d.ts.map +1 -1
- package/dist/rules/effect-default-resource-helpers.js +36 -44
- package/dist/rules/effect-default-resource-helpers.js.map +1 -1
- package/dist/rules/effect-default-safety-helpers.d.ts.map +1 -1
- package/dist/rules/effect-default-safety-helpers.js +29 -68
- package/dist/rules/effect-default-safety-helpers.js.map +1 -1
- package/dist/rules/effect-default-scan-helpers.d.ts.map +1 -1
- package/dist/rules/effect-default-scan-helpers.js +51 -70
- package/dist/rules/effect-default-scan-helpers.js.map +1 -1
- package/dist/rules/effect-default-schema-helpers.d.ts.map +1 -1
- package/dist/rules/effect-default-schema-helpers.js +32 -43
- package/dist/rules/effect-default-schema-helpers.js.map +1 -1
- package/dist/rules/effect-default-test-helpers.d.ts.map +1 -1
- package/dist/rules/effect-default-test-helpers.js +13 -25
- package/dist/rules/effect-default-test-helpers.js.map +1 -1
- package/dist/rules/effect-default-workflow-helpers.d.ts.map +1 -1
- package/dist/rules/effect-default-workflow-helpers.js +53 -113
- package/dist/rules/effect-default-workflow-helpers.js.map +1 -1
- package/dist/rules/effect-exported-declarations.d.ts.map +1 -1
- package/dist/rules/effect-exported-declarations.js +90 -177
- 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 +48 -58
- package/dist/rules/effect-path-options.js.map +1 -1
- package/dist/rules/effect-rule-aliases.d.ts.map +1 -1
- package/dist/rules/effect-rule-aliases.js +43 -101
- package/dist/rules/effect-rule-aliases.js.map +1 -1
- package/dist/rules/effect-rule-core.d.ts.map +1 -1
- package/dist/rules/effect-rule-core.js +42 -78
- package/dist/rules/effect-rule-core.js.map +1 -1
- package/dist/rules/effect-rule-names.d.ts +2 -2
- package/dist/rules/effect-rule-names.d.ts.map +1 -1
- package/dist/rules/effect-rule-names.js +3 -145
- package/dist/rules/effect-rule-names.js.map +1 -1
- package/dist/rules/effect-source-comments.d.ts.map +1 -1
- package/dist/rules/effect-source-comments.js +112 -167
- package/dist/rules/effect-source-comments.js.map +1 -1
- package/dist/rules/effect-source-navigation.d.ts.map +1 -1
- package/dist/rules/effect-source-navigation.js +103 -185
- package/dist/rules/effect-source-navigation.js.map +1 -1
- package/dist/rules/effect-source-regex-scan.d.ts +13 -0
- package/dist/rules/effect-source-regex-scan.d.ts.map +1 -0
- package/dist/rules/effect-source-regex-scan.js +126 -0
- package/dist/rules/effect-source-regex-scan.js.map +1 -0
- package/dist/rules/effect-source-scan.d.ts +1 -12
- package/dist/rules/effect-source-scan.d.ts.map +1 -1
- package/dist/rules/effect-source-scan.js +93 -239
- package/dist/rules/effect-source-scan.js.map +1 -1
- package/dist/rules/effect-strict-ast-specs.d.ts.map +1 -1
- package/dist/rules/effect-strict-ast-specs.js +11 -8
- package/dist/rules/effect-strict-ast-specs.js.map +1 -1
- package/dist/rules/effect-strict-boundary-helpers.d.ts.map +1 -1
- package/dist/rules/effect-strict-boundary-helpers.js +51 -87
- package/dist/rules/effect-strict-boundary-helpers.js.map +1 -1
- package/dist/rules/effect-strict-core-specs.d.ts.map +1 -1
- package/dist/rules/effect-strict-core-specs.js +8 -6
- package/dist/rules/effect-strict-core-specs.js.map +1 -1
- package/dist/rules/effect-strict-external-helpers.d.ts.map +1 -1
- package/dist/rules/effect-strict-external-helpers.js +20 -40
- package/dist/rules/effect-strict-external-helpers.js.map +1 -1
- package/dist/rules/effect-strict-helpers.d.ts.map +1 -1
- package/dist/rules/effect-strict-helpers.js +47 -72
- package/dist/rules/effect-strict-helpers.js.map +1 -1
- package/dist/rules/effect-strict-internals.d.ts.map +1 -1
- package/dist/rules/effect-strict-internals.js +46 -101
- package/dist/rules/effect-strict-internals.js.map +1 -1
- package/dist/rules/effect-strict-segment-helpers.d.ts.map +1 -1
- package/dist/rules/effect-strict-segment-helpers.js +103 -174
- package/dist/rules/effect-strict-segment-helpers.js.map +1 -1
- package/dist/rules/effect-strict.d.ts.map +1 -1
- package/dist/rules/effect-strict.js +3 -2
- package/dist/rules/effect-strict.js.map +1 -1
- package/dist/rules/max-import-depth.d.ts +2 -1
- package/dist/rules/max-import-depth.d.ts.map +1 -1
- package/dist/rules/max-import-depth.js +13 -15
- package/dist/rules/max-import-depth.js.map +1 -1
- package/dist/rules/max-line-length.d.ts.map +1 -1
- package/dist/rules/max-line-length.js +26 -39
- package/dist/rules/max-line-length.js.map +1 -1
- package/dist/rules/no-commented-out-code.d.ts.map +1 -1
- package/dist/rules/no-commented-out-code.js +53 -156
- package/dist/rules/no-commented-out-code.js.map +1 -1
- package/dist/rules/pascal-case-types.d.ts.map +1 -1
- package/dist/rules/pascal-case-types.js +16 -70
- package/dist/rules/pascal-case-types.js.map +1 -1
- package/dist/rules/plugin-commented-out-code-rule.d.ts.map +1 -1
- package/dist/rules/plugin-commented-out-code-rule.js +50 -77
- package/dist/rules/plugin-commented-out-code-rule.js.map +1 -1
- package/dist/rules/plugin.d.ts.map +1 -1
- package/dist/rules/plugin.js +14 -35
- package/dist/rules/plugin.js.map +1 -1
- package/dist/rules/private-underscore.d.ts +3 -1
- package/dist/rules/private-underscore.d.ts.map +1 -1
- package/dist/rules/private-underscore.js +7 -9
- package/dist/rules/private-underscore.js.map +1 -1
- package/dist/rules/require-file-doc.d.ts.map +1 -1
- package/dist/rules/require-file-doc.js +28 -94
- package/dist/rules/require-file-doc.js.map +1 -1
- package/dist/rules/require-function-doc-ignored-text.d.ts.map +1 -1
- package/dist/rules/require-function-doc-ignored-text.js +6 -9
- package/dist/rules/require-function-doc-ignored-text.js.map +1 -1
- package/dist/rules/require-function-doc-local-exports.d.ts.map +1 -1
- package/dist/rules/require-function-doc-local-exports.js +16 -58
- package/dist/rules/require-function-doc-local-exports.js.map +1 -1
- package/dist/rules/require-function-doc.d.ts.map +1 -1
- package/dist/rules/require-function-doc.js +87 -196
- package/dist/rules/require-function-doc.js.map +1 -1
- package/dist/rules/source-cache.d.ts.map +1 -1
- package/dist/rules/source-cache.js +23 -33
- package/dist/rules/source-cache.js.map +1 -1
- package/package.json +3 -1
|
@@ -1 +1 @@
|
|
|
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,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,KAAK,CAAC;AAC7B,MAAM,cAAc,GAAG,KAAK,CAAC;AAC7B,MAAM,cAAc,GAAG,EAAE,CAAC;AAC1B,MAAM,YAAY,GAChB,kFAAkF,CAAC;AAErF,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,
|
|
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,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEpD,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,KAAK,CAAC;AAC7B,MAAM,cAAc,GAAG,KAAK,CAAC;AAC7B,MAAM,cAAc,GAAG,EAAE,CAAC;AAC1B,MAAM,YAAY,GAChB,kFAAkF,CAAC;AAErF,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,GAAW,EAAU,EAAE,CACxF,KAAK,CAAC,KAAK,CAAC,GAAG,GAAG,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,CAAC,IAAI,CACzE,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,GAAW,EAAE,CAAC,GAAG,CAAC,EACpC,KAAK,CAAC,MAAM,CAAC,GAAW,EAAE;IACxB,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC3C,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,CAC/B,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAW,EAAE,CAAC,WAAW,CAAC,EACzC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,EAAU,EAAE,CAAC,oBAAoB,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC,CAC1F,CAAC;AACJ,CAAC,CAAC,CACH,CAAC;AAEJ,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,CACtE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CACrB,KAAK,CAAC,IAAI,CACR,CAAC,GAAG,EAAW,EAAE,CAAC,GAAG,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAC/E,CAAC,GAAG,EAAU,EAAE,CAAC,GAAG,CACrB,EACD,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,EAAU,EAAE,CAAC,qBAAqB,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,CACtE,CAAC;AAEJ,MAAM,sBAAsB,GAAG,CAAC,MAAc,EAAE,WAAmB,EAAU,EAAE,CAC7E,qBAAqB,CAAC,MAAM,EAAE,gBAAgB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;AAEvE,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,iBAAiB,GAAG,CAAC,IAAY,EAAW,EAAE,CAClD,IAAI,CAAC,MAAM,KAAK,cAAc;IAC9B,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;IAC/B,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;AAEhC,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAW,EAAE,CAAC,IAAI,KAAK,YAAY,CAAC;AAE3E,MAAM,kBAAkB,GAAG,CAAC,MAAc,EAAE,MAAc,EAAsB,EAAE,CAChF,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CACtB,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;IAC5C,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACxC,OAAO,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CACrE,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,GAAW,EAAE,CAAC,GAAG,CAAC,EACnC,KAAK,CAAC,MAAM,CAAC,GAAuB,EAAE,CACpC,kBAAkB,CAAC,MAAM,EAAE,eAAe,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAC9D,CACF,CAAC;AACJ,CAAC,CAAC,CACH,CAAC;AAEJ,MAAM,cAAc,GAAG,CAAC,MAAc,EAAE,KAAa,EAAsB,EAAE,CAC3E,kBAAkB,CAAC,MAAM,EAAE,eAAe,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;AAE7D,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAAE,GAAW,EAAsB,EAAE;IAC3E,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACxC,OAAO,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CACrE,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,GAAc,EAAE,CAAC,SAAS,CAAC,EAC7C,KAAK,CAAC,MAAM,CAAC,GAAuB,EAAE,CACpC,IAAI,CACF,MAAM,CAAC,YAAY,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,EACrD,MAAM,CAAC,MAAM,CAAC,CAAC,iBAAiB,EAAW,EAAE;QAC3C,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,iBAAiB,CAAC,CAAC;QAChF,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAChE,CAAC,CAAC,EACF,MAAM,CAAC,cAAc,CACtB,CACF,CACF,CAAC;AACJ,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 +1 @@
|
|
|
1
|
-
{"version":3,"file":"require-function-doc-ignored-text.d.ts","sourceRoot":"","sources":["../../src/rules/require-function-doc-ignored-text.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"require-function-doc-ignored-text.d.ts","sourceRoot":"","sources":["../../src/rules/require-function-doc-ignored-text.ts"],"names":[],"mappings":"AA+FA;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,QAAQ,MAAM,EAAE,KAAK,MAAM,KAAG,OAI/D,CAAC"}
|
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
/* -------------------------------------------------------------------------- */
|
|
2
2
|
/* Ignored source-region helpers for exported JSDoc checks. */
|
|
3
3
|
/* -------------------------------------------------------------------------- */
|
|
4
|
+
import { Array, HashSet, Match, pipe } from 'effect';
|
|
4
5
|
const initialState = {
|
|
5
6
|
isBlockComment: false,
|
|
6
7
|
isEscaped: false,
|
|
7
8
|
isLineComment: false,
|
|
8
9
|
quote: undefined,
|
|
9
10
|
};
|
|
10
|
-
const quoteCharacters =
|
|
11
|
+
const quoteCharacters = HashSet.make('"', "'", '`');
|
|
11
12
|
const lineCommentState = (state, char) => ({
|
|
12
13
|
...state,
|
|
13
14
|
isLineComment: char !== '\n',
|
|
@@ -35,7 +36,7 @@ const unquotedState = (state, char, nextChar) => {
|
|
|
35
36
|
if (char === '/' && nextChar === '*') {
|
|
36
37
|
return { ...state, isBlockComment: true };
|
|
37
38
|
}
|
|
38
|
-
if (
|
|
39
|
+
if (HashSet.has(quoteCharacters, char)) {
|
|
39
40
|
return { ...state, quote: char };
|
|
40
41
|
}
|
|
41
42
|
return state;
|
|
@@ -52,16 +53,12 @@ const nextIgnoredState = (state, char, nextChar) => {
|
|
|
52
53
|
}
|
|
53
54
|
return unquotedState(state, char, nextChar);
|
|
54
55
|
};
|
|
56
|
+
const scanIndexesBefore = (pos) => Match.value(pos).pipe(Match.when((position) => position <= 0, () => []), Match.orElse((position) => Array.range(0, position - 1)));
|
|
57
|
+
const scanStateBefore = (source, pos) => pipe(scanIndexesBefore(pos), Array.reduce(initialState, (state, index) => nextIgnoredState(state, source[index] ?? '', source[index + 1])));
|
|
55
58
|
/**
|
|
56
59
|
* Checks whether a source offset is inside a comment or string literal.
|
|
57
60
|
*
|
|
58
61
|
* @internal
|
|
59
62
|
*/
|
|
60
|
-
export const isInsideIgnoredText = (source, pos) =>
|
|
61
|
-
let state = initialState;
|
|
62
|
-
for (let index = 0; index < pos; index++) {
|
|
63
|
-
state = nextIgnoredState(state, source[index] ?? '', source[index + 1]);
|
|
64
|
-
}
|
|
65
|
-
return state.isBlockComment || state.isLineComment || state.quote !== undefined;
|
|
66
|
-
};
|
|
63
|
+
export const isInsideIgnoredText = (source, pos) => pipe(scanStateBefore(source, pos), (state) => state.isBlockComment || state.isLineComment || state.quote !== undefined);
|
|
67
64
|
//# sourceMappingURL=require-function-doc-ignored-text.js.map
|
|
@@ -1 +1 @@
|
|
|
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;
|
|
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,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AASrD,MAAM,YAAY,GAAc;IAC9B,cAAc,EAAE,KAAK;IACrB,SAAS,EAAE,KAAK;IAChB,aAAa,EAAE,KAAK;IACpB,KAAK,EAAE,SAAS;CACjB,CAAC;AAEF,MAAM,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAEpD,MAAM,gBAAgB,GAAG,CAAC,KAAgB,EAAE,IAAY,EAAa,EAAE,CAAC,CAAC;IACvE,GAAG,KAAK;IACR,aAAa,EAAE,IAAI,KAAK,IAAI;CAC7B,CAAC,CAAC;AAEH,MAAM,iBAAiB,GAAG,CACxB,KAAgB,EAChB,IAAY,EACZ,QAA4B,EACjB,EAAE,CAAC,CAAC;IACf,GAAG,KAAK;IACR,cAAc,EAAE,CAAC,CAAC,IAAI,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,CAAC;CACpD,CAAC,CAAC;AAEH,MAAM,WAAW,GAAG,CAAC,KAAgB,EAAE,IAAY,EAAa,EAAE;IAChE,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;QACpB,OAAO,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;IACxC,CAAC;IACD,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,OAAO,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;IACvC,CAAC;IACD,IAAI,IAAI,KAAK,KAAK,CAAC,KAAK,EAAE,CAAC;QACzB,OAAO,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;IACxC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,KAAgB,EAAE,IAAY,EAAE,QAA4B,EAAa,EAAE;IAChG,IAAI,IAAI,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,EAAE,CAAC;QACrC,OAAO,EAAE,GAAG,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;IAC3C,CAAC;IACD,IAAI,IAAI,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,EAAE,CAAC;QACrC,OAAO,EAAE,GAAG,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC;IAC5C,CAAC;IACD,IAAI,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,EAAE,CAAC;QACvC,OAAO,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IACnC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CACvB,KAAgB,EAChB,IAAY,EACZ,QAA4B,EACjB,EAAE;IACb,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;QACxB,OAAO,gBAAgB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IACD,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;QACzB,OAAO,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IACD,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAChB,OAAO,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC9C,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,GAAW,EAAqB,EAAE,CAC3D,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CACnB,KAAK,CAAC,IAAI,CACR,CAAC,QAAQ,EAAW,EAAE,CAAC,QAAQ,IAAI,CAAC,EACpC,GAAG,EAAE,CAAC,EAAE,CACT,EACD,KAAK,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,GAAG,CAAC,CAAC,CAAC,CACzD,CAAC;AAEJ,MAAM,eAAe,GAAG,CAAC,MAAc,EAAE,GAAW,EAAa,EAAE,CACjE,IAAI,CACF,iBAAiB,CAAC,GAAG,CAAC,EACtB,KAAK,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAC1C,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAChE,CACF,CAAC;AAEJ;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,MAAc,EAAE,GAAW,EAAW,EAAE,CAC1E,IAAI,CACF,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,EAC5B,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,cAAc,IAAI,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,CACpF,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"require-function-doc-local-exports.d.ts","sourceRoot":"","sources":["../../src/rules/require-function-doc-local-exports.ts"],"names":[],"mappings":"
|
|
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,53 +1,30 @@
|
|
|
1
1
|
/* -------------------------------------------------------------------------- */
|
|
2
2
|
/* Local export-list documentation helpers for exported JSDoc checks. */
|
|
3
3
|
/* -------------------------------------------------------------------------- */
|
|
4
|
+
import { Array, Match, Option, pipe } from 'effect';
|
|
4
5
|
const CHAR_CODE_OPEN_BRACE = 123;
|
|
5
6
|
const CHAR_CODE_LOWER_A = 97;
|
|
6
7
|
const CHAR_CODE_LOWER_Z = 122;
|
|
7
8
|
const CHAR_CODE_UPPER_A = 65;
|
|
8
9
|
const CHAR_CODE_UPPER_Z = 90;
|
|
9
10
|
const TYPE_KEYWORD_LENGTH = 'type '.length;
|
|
10
|
-
const skipWhitespace = (source, pos) =>
|
|
11
|
-
let cursor = pos;
|
|
12
|
-
while (cursor < source.length && /\s/u.test(source[cursor] ?? '')) {
|
|
13
|
-
cursor++;
|
|
14
|
-
}
|
|
15
|
-
return cursor;
|
|
16
|
-
};
|
|
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));
|
|
17
12
|
const exportStatementEnd = (source, afterExport) => {
|
|
18
13
|
const semicolon = source.indexOf(';', afterExport);
|
|
19
|
-
|
|
20
|
-
return source.indexOf('\n', afterExport);
|
|
21
|
-
}
|
|
22
|
-
return semicolon;
|
|
14
|
+
return Match.value(semicolon).pipe(Match.when((index) => index === -1, () => source.indexOf('\n', afterExport)), Match.orElse((index) => index));
|
|
23
15
|
};
|
|
24
16
|
const hasFromClauseBefore = (source, openBrace, statementEnd) => {
|
|
25
|
-
|
|
26
|
-
if (end === -1) {
|
|
27
|
-
end = source.length;
|
|
28
|
-
}
|
|
17
|
+
const end = Match.value(statementEnd).pipe(Match.when((index) => index === -1, () => source.length), Match.orElse((index) => index));
|
|
29
18
|
return source.slice(openBrace, end).includes(' from ');
|
|
30
19
|
};
|
|
31
|
-
const localExportOpenBrace = (source, afterExport) =>
|
|
32
|
-
|
|
33
|
-
afterExport + TYPE_KEYWORD_LENGTH < source.length) {
|
|
34
|
-
return skipWhitespace(source, afterExport + TYPE_KEYWORD_LENGTH);
|
|
35
|
-
}
|
|
36
|
-
return afterExport;
|
|
37
|
-
};
|
|
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));
|
|
38
22
|
const localExportListBounds = (source, afterExport) => {
|
|
39
23
|
const openBrace = localExportOpenBrace(source, afterExport);
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
if (closeBrace === -1) {
|
|
45
|
-
return undefined;
|
|
46
|
-
}
|
|
47
|
-
if (hasFromClauseBefore(source, openBrace, exportStatementEnd(source, closeBrace))) {
|
|
48
|
-
return undefined;
|
|
49
|
-
}
|
|
50
|
-
return { closeBrace, openBrace };
|
|
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)));
|
|
51
28
|
};
|
|
52
29
|
const localExportName = (part) => part
|
|
53
30
|
.trim()
|
|
@@ -56,14 +33,7 @@ const localExportName = (part) => part
|
|
|
56
33
|
?.trim() ?? '';
|
|
57
34
|
const localExportNames = (source, afterExport) => {
|
|
58
35
|
const bounds = localExportListBounds(source, afterExport);
|
|
59
|
-
|
|
60
|
-
return undefined;
|
|
61
|
-
}
|
|
62
|
-
return source
|
|
63
|
-
.slice(bounds.openBrace + 1, bounds.closeBrace)
|
|
64
|
-
.split(',')
|
|
65
|
-
.map(localExportName)
|
|
66
|
-
.filter(Boolean);
|
|
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);
|
|
67
37
|
};
|
|
68
38
|
const declarationNeedles = (name) => [
|
|
69
39
|
`const ${name}`,
|
|
@@ -84,17 +54,11 @@ const isIdentifierBoundaryAfter = (source, pos) => {
|
|
|
84
54
|
(code >= CHAR_CODE_UPPER_A && code <= CHAR_CODE_UPPER_Z));
|
|
85
55
|
};
|
|
86
56
|
const localDeclarationPosition = (source, name, exportPOS) => {
|
|
87
|
-
|
|
88
|
-
for (const needle of declarationNeedles(name)) {
|
|
57
|
+
const bestPosition = pipe(declarationNeedles(name), Array.reduce(-1, (currentBest, needle) => {
|
|
89
58
|
const pos = source.lastIndexOf(needle, exportPOS);
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
}
|
|
94
|
-
if (bestPosition === -1) {
|
|
95
|
-
return undefined;
|
|
96
|
-
}
|
|
97
|
-
return bestPosition;
|
|
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);
|
|
98
62
|
};
|
|
99
63
|
/**
|
|
100
64
|
* Internal helper exported for package-local composition.
|
|
@@ -103,12 +67,6 @@ const localDeclarationPosition = (source, name, exportPOS) => {
|
|
|
103
67
|
*/
|
|
104
68
|
export const isDocumentedLocalExportList = (source, afterExport, exportPOS, hasJSDocBefore) => {
|
|
105
69
|
const names = localExportNames(source, afterExport);
|
|
106
|
-
|
|
107
|
-
return undefined;
|
|
108
|
-
}
|
|
109
|
-
return names.every((name) => {
|
|
110
|
-
const declarationPOS = localDeclarationPosition(source, name, exportPOS);
|
|
111
|
-
return declarationPOS !== undefined && hasJSDocBefore(source, declarationPOS);
|
|
112
|
-
});
|
|
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);
|
|
113
71
|
};
|
|
114
72
|
//# sourceMappingURL=require-function-doc-local-exports.js.map
|
|
@@ -1 +1 @@
|
|
|
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;
|
|
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 +1 @@
|
|
|
1
|
-
{"version":3,"file":"require-function-doc.d.ts","sourceRoot":"","sources":["../../src/rules/require-function-doc.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"require-function-doc.d.ts","sourceRoot":"","sources":["../../src/rules/require-function-doc.ts"],"names":[],"mappings":"AAyhBA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAUvE"}
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
/* Exported-declaration documentation requirement helper for custom Oxlint */
|
|
3
3
|
/* Rules. */
|
|
4
4
|
/* -------------------------------------------------------------------------- */
|
|
5
|
+
import { Array, HashSet, Match, Option, String, pipe } from 'effect';
|
|
5
6
|
import { isDocumentedLocalExportList } from './require-function-doc-local-exports.js';
|
|
6
7
|
import { isInsideIgnoredText } from './require-function-doc-ignored-text.js';
|
|
7
8
|
const CHAR_CODE_SPACE = 32;
|
|
@@ -39,80 +40,39 @@ const EXPORT_KEYWORD_LENGTH = 'export '.length;
|
|
|
39
40
|
const DEFAULT_KEYWORD_LENGTH = 'default '.length;
|
|
40
41
|
const DECLARE_KEYWORD_LENGTH = 'declare '.length;
|
|
41
42
|
const ABSTRACT_KEYWORD_LENGTH = 'abstract '.length;
|
|
43
|
+
const sourceIncludes = (needle) => (source) => pipe(source, String.includes(needle));
|
|
44
|
+
const indexesBetween = (start, endExclusive) => {
|
|
45
|
+
if (start >= endExclusive) {
|
|
46
|
+
return Array.empty();
|
|
47
|
+
}
|
|
48
|
+
return Array.range(start, endExclusive - 1);
|
|
49
|
+
};
|
|
50
|
+
const matchesIn = (source, pattern) => pipe(source.matchAll(pattern), Array.fromIterable);
|
|
42
51
|
const isWhitespace = (code) => code === CHAR_CODE_SPACE ||
|
|
43
52
|
code === CHAR_CODE_TAB ||
|
|
44
53
|
code === CHAR_CODE_NEWLINE ||
|
|
45
54
|
code === CHAR_CODE_CARRIAGE_RETURN;
|
|
46
|
-
const
|
|
47
|
-
const newlineIndex = source.indexOf('\n', lineStart);
|
|
48
|
-
if (newlineIndex === -1) {
|
|
49
|
-
return len;
|
|
50
|
-
}
|
|
51
|
-
return newlineIndex;
|
|
52
|
-
};
|
|
55
|
+
const firstIndexNotMatching = (source, start, endExclusive, predicate) => pipe(indexesBetween(start, endExclusive), Array.findFirst((index) => !predicate(source.charCodeAt(index))), Option.getOrElse(() => endExclusive));
|
|
53
56
|
const skipLinePrefix = (source, pos, lineEnd) => {
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
}
|
|
58
|
-
if (cursor < lineEnd && source.charCodeAt(cursor) === CHAR_CODE_ASTERISK) {
|
|
59
|
-
cursor++;
|
|
60
|
-
}
|
|
61
|
-
while (cursor < lineEnd && isWhitespace(source.charCodeAt(cursor))) {
|
|
62
|
-
cursor++;
|
|
63
|
-
}
|
|
64
|
-
return cursor;
|
|
57
|
+
const contentStart = firstIndexNotMatching(source, pos, lineEnd, isWhitespace);
|
|
58
|
+
const afterAsterisk = Match.value(contentStart).pipe(Match.when((cursor) => cursor < lineEnd && source.charCodeAt(cursor) === CHAR_CODE_ASTERISK, (cursor) => cursor + 1), Match.orElse((cursor) => cursor));
|
|
59
|
+
return firstIndexNotMatching(source, afterAsterisk, lineEnd, isWhitespace);
|
|
65
60
|
};
|
|
66
61
|
const isJSDocTagLine = (source, pos, lineEnd) => pos < lineEnd && source.charCodeAt(pos) === CHAR_CODE_AT_SIGN;
|
|
62
|
+
const lineEndFor = (source, lineStart) => Match.value(source.indexOf('\n', lineStart)).pipe(Match.when((index) => index === -1, () => source.length), Match.orElse((index) => index));
|
|
67
63
|
const lineHasDescriptionContent = (source, lineStart, lineEnd) => {
|
|
68
|
-
|
|
64
|
+
const pos = skipLinePrefix(source, lineStart, lineEnd);
|
|
69
65
|
if (isJSDocTagLine(source, pos, lineEnd)) {
|
|
70
66
|
return false;
|
|
71
67
|
}
|
|
72
|
-
|
|
73
|
-
if (!isWhitespace(source.charCodeAt(pos))) {
|
|
74
|
-
return true;
|
|
75
|
-
}
|
|
76
|
-
pos++;
|
|
77
|
-
}
|
|
78
|
-
return false;
|
|
79
|
-
};
|
|
80
|
-
const nextDescriptionLineStart = (newlineIndex) => {
|
|
81
|
-
if (newlineIndex === -1) {
|
|
82
|
-
return undefined;
|
|
83
|
-
}
|
|
84
|
-
return newlineIndex + 1;
|
|
85
|
-
};
|
|
86
|
-
const hasDescriptionLine = (jsdocBody, lineStart, len) => {
|
|
87
|
-
const newlineIndex = jsdocBody.indexOf('\n', lineStart);
|
|
88
|
-
const lineEnd = lineEndFor(jsdocBody, lineStart, len);
|
|
89
|
-
if (lineHasDescriptionContent(jsdocBody, lineStart, lineEnd)) {
|
|
90
|
-
return { found: true };
|
|
91
|
-
}
|
|
92
|
-
return { found: false, nextLineStart: nextDescriptionLineStart(newlineIndex) };
|
|
93
|
-
};
|
|
94
|
-
const hasDescriptionContent = (jsdocBody) => {
|
|
95
|
-
let lineStart = 0;
|
|
96
|
-
const len = jsdocBody.length;
|
|
97
|
-
while (lineStart <= len) {
|
|
98
|
-
const result = hasDescriptionLine(jsdocBody, lineStart, len);
|
|
99
|
-
if (result.found) {
|
|
100
|
-
return true;
|
|
101
|
-
}
|
|
102
|
-
if (result.nextLineStart === undefined) {
|
|
103
|
-
return false;
|
|
104
|
-
}
|
|
105
|
-
lineStart = result.nextLineStart;
|
|
106
|
-
}
|
|
107
|
-
return false;
|
|
108
|
-
};
|
|
109
|
-
const skipWhitespaceBack = (source, pos) => {
|
|
110
|
-
let cursor = pos;
|
|
111
|
-
while (cursor > 0 && isWhitespace(source.charCodeAt(cursor - 1))) {
|
|
112
|
-
cursor--;
|
|
113
|
-
}
|
|
114
|
-
return cursor;
|
|
68
|
+
return pipe(indexesBetween(pos, lineEnd), Array.some((index) => !isWhitespace(source.charCodeAt(index))));
|
|
115
69
|
};
|
|
70
|
+
const descriptionLineStarts = (jsdocBody) => pipe(matchesIn(jsdocBody, /\n/g), Array.map((match) => match.index + 1), Array.prepend(0));
|
|
71
|
+
const hasDescriptionContent = (jsdocBody) => pipe(descriptionLineStarts(jsdocBody), Array.some((lineStart) => lineHasDescriptionContent(jsdocBody, lineStart, lineEndFor(jsdocBody, lineStart))));
|
|
72
|
+
const skipWhitespaceBack = (source, pos) => pipe(indexesBetween(0, pos), Array.reverse, Array.findFirst((index) => !isWhitespace(source.charCodeAt(index))), Option.match({
|
|
73
|
+
onNone: () => 0,
|
|
74
|
+
onSome: (index) => index + 1,
|
|
75
|
+
}));
|
|
116
76
|
const hasBlockCommentCloseAt = (source, pos) => pos >= '*/'.length &&
|
|
117
77
|
source.charCodeAt(pos - '*/'.length) === CHAR_CODE_ASTERISK &&
|
|
118
78
|
source.charCodeAt(pos - 1) === CHAR_CODE_SLASH;
|
|
@@ -122,23 +82,13 @@ const jsdocContentBeforeClose = (source, open, closeStar) => {
|
|
|
122
82
|
}
|
|
123
83
|
return undefined;
|
|
124
84
|
};
|
|
125
|
-
const previousJSDocContent = (source, closeStar) => {
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
source.charCodeAt(open - 1) === CHAR_CODE_SLASH) {
|
|
130
|
-
const content = jsdocContentBeforeClose(source, open, closeStar);
|
|
131
|
-
if (content !== undefined) {
|
|
132
|
-
return content;
|
|
133
|
-
}
|
|
134
|
-
open -= '/*'.length;
|
|
135
|
-
}
|
|
136
|
-
else {
|
|
137
|
-
open--;
|
|
138
|
-
}
|
|
85
|
+
const previousJSDocContent = (source, closeStar) => pipe(indexesBetween(1, closeStar), Array.reverse, Array.filterMap((open) => {
|
|
86
|
+
if (source.charCodeAt(open) === CHAR_CODE_ASTERISK &&
|
|
87
|
+
source.charCodeAt(open - 1) === CHAR_CODE_SLASH) {
|
|
88
|
+
return Option.fromNullable(jsdocContentBeforeClose(source, open, closeStar));
|
|
139
89
|
}
|
|
140
|
-
return
|
|
141
|
-
};
|
|
90
|
+
return Option.none();
|
|
91
|
+
}), Array.head, Option.getOrUndefined);
|
|
142
92
|
const hasJSDocBefore = (source, exportPOS) => {
|
|
143
93
|
const pos = skipWhitespaceBack(source, exportPOS);
|
|
144
94
|
if (!hasBlockCommentCloseAt(source, pos)) {
|
|
@@ -181,15 +131,8 @@ const isDefaultDeclaration = (source, pos, _len) => {
|
|
|
181
131
|
};
|
|
182
132
|
const AMBIENT_DECLARE_PREFIXES = ['declare module', 'declare namespace', 'declare global'];
|
|
183
133
|
const skipShebangComments = (source, idx) => {
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
cursor = source.indexOf('\n', cursor);
|
|
187
|
-
if (cursor === -1) {
|
|
188
|
-
return undefined;
|
|
189
|
-
}
|
|
190
|
-
cursor++;
|
|
191
|
-
}
|
|
192
|
-
return cursor;
|
|
134
|
+
const scan = (cursor) => Match.value(cursor).pipe(Match.when((position) => position < source.length && source.charCodeAt(position) === CHAR_CODE_HASH, (position) => pipe(Option.some(source.indexOf('\n', position)), Option.filter((newlineIndex) => newlineIndex !== -1), Option.flatMap((newlineIndex) => Option.fromNullable(scan(newlineIndex + 1))), Option.getOrUndefined)), Match.orElse((position) => position));
|
|
135
|
+
return scan(idx);
|
|
193
136
|
};
|
|
194
137
|
const skipBlockComment = (source, idx) => {
|
|
195
138
|
const close = source.indexOf('*/', idx + '/*'.length);
|
|
@@ -223,8 +166,10 @@ const skipTriviaToken = (source, idx) => {
|
|
|
223
166
|
return idx;
|
|
224
167
|
};
|
|
225
168
|
const skipLeadingTrivia = (source, idx) => {
|
|
226
|
-
|
|
227
|
-
|
|
169
|
+
const scan = (cursor) => {
|
|
170
|
+
if (cursor >= source.length) {
|
|
171
|
+
return cursor;
|
|
172
|
+
}
|
|
228
173
|
const next = skipTriviaToken(source, cursor);
|
|
229
174
|
if (next === undefined) {
|
|
230
175
|
return undefined;
|
|
@@ -232,11 +177,11 @@ const skipLeadingTrivia = (source, idx) => {
|
|
|
232
177
|
if (next === cursor) {
|
|
233
178
|
return cursor;
|
|
234
179
|
}
|
|
235
|
-
|
|
236
|
-
}
|
|
237
|
-
return
|
|
180
|
+
return scan(next);
|
|
181
|
+
};
|
|
182
|
+
return scan(idx);
|
|
238
183
|
};
|
|
239
|
-
const hasAmbientPrefixAt = (source, idx) => AMBIENT_DECLARE_PREFIXES.some((prefix) => idx + prefix.length <= source.length && source.slice(idx, idx + prefix.length) === prefix);
|
|
184
|
+
const hasAmbientPrefixAt = (source, idx) => pipe(AMBIENT_DECLARE_PREFIXES, Array.some((prefix) => idx + prefix.length <= source.length && source.slice(idx, idx + prefix.length) === prefix));
|
|
240
185
|
const isAmbientDeclarationFile = (source) => {
|
|
241
186
|
const shebangEnd = skipShebangComments(source, 0);
|
|
242
187
|
if (shebangEnd === undefined) {
|
|
@@ -248,13 +193,6 @@ const isAmbientDeclarationFile = (source) => {
|
|
|
248
193
|
}
|
|
249
194
|
return hasAmbientPrefixAt(source, idx);
|
|
250
195
|
};
|
|
251
|
-
const nextExportPosition = (source, start) => {
|
|
252
|
-
const exp = source.indexOf('export ', start);
|
|
253
|
-
if (exp === -1) {
|
|
254
|
-
return undefined;
|
|
255
|
-
}
|
|
256
|
-
return exp;
|
|
257
|
-
};
|
|
258
196
|
const isStandaloneExportKeyword = (source, exp) => {
|
|
259
197
|
if (exp === 0) {
|
|
260
198
|
return true;
|
|
@@ -285,82 +223,58 @@ const isReExportAt = (source, afterExport) => {
|
|
|
285
223
|
const afterType = afterExport + TYPE_KEYWORD_LENGTH;
|
|
286
224
|
return afterType < source.length && source.charCodeAt(afterType) === CHAR_CODE_OPEN_BRACE;
|
|
287
225
|
};
|
|
288
|
-
const modifierSpecs =
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
isDefault: false,
|
|
320
|
-
length: 0,
|
|
321
|
-
shouldStop: true,
|
|
322
|
-
text: 'namespace ',
|
|
323
|
-
},
|
|
324
|
-
];
|
|
226
|
+
const modifierSpecs = Array.make({
|
|
227
|
+
charCode: CHAR_CODE_LOWER_D,
|
|
228
|
+
isDefault: true,
|
|
229
|
+
length: DEFAULT_KEYWORD_LENGTH,
|
|
230
|
+
shouldStop: false,
|
|
231
|
+
text: 'default ',
|
|
232
|
+
}, {
|
|
233
|
+
charCode: CHAR_CODE_LOWER_A,
|
|
234
|
+
isDefault: false,
|
|
235
|
+
length: ASYNC_KEYWORD_LENGTH,
|
|
236
|
+
shouldStop: false,
|
|
237
|
+
text: 'async ',
|
|
238
|
+
}, {
|
|
239
|
+
charCode: CHAR_CODE_LOWER_A,
|
|
240
|
+
isDefault: false,
|
|
241
|
+
length: ABSTRACT_KEYWORD_LENGTH,
|
|
242
|
+
shouldStop: false,
|
|
243
|
+
text: 'abstract ',
|
|
244
|
+
}, {
|
|
245
|
+
charCode: CHAR_CODE_LOWER_T,
|
|
246
|
+
isDefault: false,
|
|
247
|
+
length: TYPE_KEYWORD_LENGTH,
|
|
248
|
+
shouldStop: false,
|
|
249
|
+
text: 'type ',
|
|
250
|
+
}, {
|
|
251
|
+
charCode: CHAR_CODE_LOWER_N,
|
|
252
|
+
isDefault: false,
|
|
253
|
+
length: 0,
|
|
254
|
+
shouldStop: true,
|
|
255
|
+
text: 'namespace ',
|
|
256
|
+
});
|
|
325
257
|
const modifierSpecMatches = (source, pos, spec) => source.charCodeAt(pos) === spec.charCode &&
|
|
326
258
|
pos + spec.text.length <= source.length &&
|
|
327
259
|
source.slice(pos, pos + spec.text.length) === spec.text;
|
|
328
|
-
const modifierLengthAt = (source, pos) =>
|
|
329
|
-
for (const spec of modifierSpecs) {
|
|
330
|
-
if (modifierSpecMatches(source, pos, spec)) {
|
|
331
|
-
return spec;
|
|
332
|
-
}
|
|
333
|
-
}
|
|
334
|
-
return undefined;
|
|
335
|
-
};
|
|
260
|
+
const modifierLengthAt = (source, pos) => pipe(modifierSpecs, Array.findFirst((spec) => modifierSpecMatches(source, pos, spec)), Option.getOrUndefined);
|
|
336
261
|
const scanExportModifiers = (source, start) => {
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
262
|
+
const scan = (state) => pipe(Option.fromNullable(modifierLengthAt(source, state.pos)), Option.match({
|
|
263
|
+
onNone: () => state,
|
|
264
|
+
onSome: (modifier) => {
|
|
265
|
+
if (modifier.shouldStop) {
|
|
266
|
+
return state;
|
|
267
|
+
}
|
|
268
|
+
return scan({
|
|
269
|
+
hasSawDefault: state.hasSawDefault || modifier.isDefault,
|
|
270
|
+
pos: skipWhitespace(source, state.pos + modifier.length),
|
|
271
|
+
});
|
|
272
|
+
},
|
|
273
|
+
}));
|
|
274
|
+
return scan({ hasSawDefault: false, pos: start });
|
|
346
275
|
};
|
|
347
|
-
const declarationStartCodes =
|
|
348
|
-
|
|
349
|
-
CHAR_CODE_UPPER_F,
|
|
350
|
-
CHAR_CODE_LOWER_C,
|
|
351
|
-
CHAR_CODE_UPPER_C,
|
|
352
|
-
CHAR_CODE_LOWER_I,
|
|
353
|
-
CHAR_CODE_UPPER_I,
|
|
354
|
-
CHAR_CODE_LOWER_E,
|
|
355
|
-
CHAR_CODE_UPPER_E,
|
|
356
|
-
CHAR_CODE_LOWER_L,
|
|
357
|
-
CHAR_CODE_UPPER_L,
|
|
358
|
-
CHAR_CODE_LOWER_V,
|
|
359
|
-
CHAR_CODE_UPPER_V,
|
|
360
|
-
CHAR_CODE_LOWER_N,
|
|
361
|
-
CHAR_CODE_UPPER_N,
|
|
362
|
-
]);
|
|
363
|
-
const isDeclarationStartCode = (code) => declarationStartCodes.has(code);
|
|
276
|
+
const declarationStartCodes = HashSet.make(CHAR_CODE_LOWER_F, CHAR_CODE_UPPER_F, CHAR_CODE_LOWER_C, CHAR_CODE_UPPER_C, CHAR_CODE_LOWER_I, CHAR_CODE_UPPER_I, CHAR_CODE_LOWER_E, CHAR_CODE_UPPER_E, CHAR_CODE_LOWER_L, CHAR_CODE_UPPER_L, CHAR_CODE_LOWER_V, CHAR_CODE_UPPER_V, CHAR_CODE_LOWER_N, CHAR_CODE_UPPER_N);
|
|
277
|
+
const isDeclarationStartCode = (code) => HashSet.has(declarationStartCodes, code);
|
|
364
278
|
const canSkipDocumentedExport = (source, modifiers) => {
|
|
365
279
|
if (modifiers.pos >= source.length) {
|
|
366
280
|
return true;
|
|
@@ -412,30 +326,7 @@ const isUndocumentedExportAt = (source, exp) => {
|
|
|
412
326
|
}
|
|
413
327
|
return isDocumentedExportDeclaration(source, exp) === false;
|
|
414
328
|
};
|
|
415
|
-
const
|
|
416
|
-
const exp = nextExportPosition(source, pos);
|
|
417
|
-
if (exp === undefined) {
|
|
418
|
-
return undefined;
|
|
419
|
-
}
|
|
420
|
-
return {
|
|
421
|
-
nextPOS: exp + EXPORT_KEYWORD_LENGTH,
|
|
422
|
-
undocumented: isUndocumentedExportAt(source, exp),
|
|
423
|
-
};
|
|
424
|
-
};
|
|
425
|
-
const hasUndocumentedExport = (source) => {
|
|
426
|
-
let pos = 0;
|
|
427
|
-
while (pos < source.length) {
|
|
428
|
-
const exportSearch = nextExportSearchPosition(source, pos);
|
|
429
|
-
if (!exportSearch) {
|
|
430
|
-
return false;
|
|
431
|
-
}
|
|
432
|
-
if (exportSearch.undocumented) {
|
|
433
|
-
return true;
|
|
434
|
-
}
|
|
435
|
-
pos = exportSearch.nextPOS;
|
|
436
|
-
}
|
|
437
|
-
return false;
|
|
438
|
-
};
|
|
329
|
+
const hasUndocumentedExport = (source) => pipe(matchesIn(source, /\bexport\s/g), Array.some((match) => isUndocumentedExportAt(source, match.index)));
|
|
439
330
|
/**
|
|
440
331
|
* Checks whether exported declarations have meaningful JSDoc comments.
|
|
441
332
|
*
|
|
@@ -443,7 +334,7 @@ const hasUndocumentedExport = (source) => {
|
|
|
443
334
|
* @returns True when every public declaration is documented or no public declarations exist.
|
|
444
335
|
*/
|
|
445
336
|
export default function hasRequiredFunctionDocs(source) {
|
|
446
|
-
if (!
|
|
337
|
+
if (!sourceIncludes('export ')(source)) {
|
|
447
338
|
return true;
|
|
448
339
|
}
|
|
449
340
|
if (isAmbientDeclarationFile(source)) {
|