@platformos/platformos-check-common 0.0.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 +9 -0
- package/README.md +92 -0
- package/dist/AugmentedThemeDocset.d.ts +12 -0
- package/dist/AugmentedThemeDocset.js +126 -0
- package/dist/AugmentedThemeDocset.js.map +1 -0
- package/dist/JSONValidator.d.ts +20 -0
- package/dist/JSONValidator.js +76 -0
- package/dist/JSONValidator.js.map +1 -0
- package/dist/checks/app-block-missing-schema/index.d.ts +2 -0
- package/dist/checks/app-block-missing-schema/index.js +46 -0
- package/dist/checks/app-block-missing-schema/index.js.map +1 -0
- package/dist/checks/app-block-valid-tags/index.d.ts +10 -0
- package/dist/checks/app-block-valid-tags/index.js +49 -0
- package/dist/checks/app-block-valid-tags/index.js.map +1 -0
- package/dist/checks/asset-preload/index.d.ts +2 -0
- package/dist/checks/asset-preload/index.js +56 -0
- package/dist/checks/asset-preload/index.js.map +1 -0
- package/dist/checks/asset-size-app-block-css/index.d.ts +6 -0
- package/dist/checks/asset-size-app-block-css/index.js +64 -0
- package/dist/checks/asset-size-app-block-css/index.js.map +1 -0
- package/dist/checks/asset-size-app-block-javascript/index.d.ts +6 -0
- package/dist/checks/asset-size-app-block-javascript/index.js +64 -0
- package/dist/checks/asset-size-app-block-javascript/index.js.map +1 -0
- package/dist/checks/asset-size-css/index.d.ts +6 -0
- package/dist/checks/asset-size-css/index.js +125 -0
- package/dist/checks/asset-size-css/index.js.map +1 -0
- package/dist/checks/asset-size-javascript/index.d.ts +6 -0
- package/dist/checks/asset-size-javascript/index.js +110 -0
- package/dist/checks/asset-size-javascript/index.js.map +1 -0
- package/dist/checks/block-id-usage/index.d.ts +2 -0
- package/dist/checks/block-id-usage/index.js +60 -0
- package/dist/checks/block-id-usage/index.js.map +1 -0
- package/dist/checks/cdn-preconnect/index.d.ts +2 -0
- package/dist/checks/cdn-preconnect/index.js +44 -0
- package/dist/checks/cdn-preconnect/index.js.map +1 -0
- package/dist/checks/content-for-header-modification/index.d.ts +2 -0
- package/dist/checks/content-for-header-modification/index.js +66 -0
- package/dist/checks/content-for-header-modification/index.js.map +1 -0
- package/dist/checks/deprecate-bgsizes/index.d.ts +2 -0
- package/dist/checks/deprecate-bgsizes/index.js +46 -0
- package/dist/checks/deprecate-bgsizes/index.js.map +1 -0
- package/dist/checks/deprecate-lazysizes/index.d.ts +2 -0
- package/dist/checks/deprecate-lazysizes/index.js +52 -0
- package/dist/checks/deprecate-lazysizes/index.js.map +1 -0
- package/dist/checks/deprecated-filter/fixes.d.ts +8 -0
- package/dist/checks/deprecated-filter/fixes.js +205 -0
- package/dist/checks/deprecated-filter/fixes.js.map +1 -0
- package/dist/checks/deprecated-filter/index.d.ts +2 -0
- package/dist/checks/deprecated-filter/index.js +93 -0
- package/dist/checks/deprecated-filter/index.js.map +1 -0
- package/dist/checks/deprecated-fonts-on-sections-and-blocks/deprecated-fonts-data.d.ts +1 -0
- package/dist/checks/deprecated-fonts-on-sections-and-blocks/deprecated-fonts-data.js +1347 -0
- package/dist/checks/deprecated-fonts-on-sections-and-blocks/deprecated-fonts-data.js.map +1 -0
- package/dist/checks/deprecated-fonts-on-sections-and-blocks/index.d.ts +2 -0
- package/dist/checks/deprecated-fonts-on-sections-and-blocks/index.js +156 -0
- package/dist/checks/deprecated-fonts-on-sections-and-blocks/index.js.map +1 -0
- package/dist/checks/deprecated-fonts-on-settings-schema/index.d.ts +2 -0
- package/dist/checks/deprecated-fonts-on-settings-schema/index.js +56 -0
- package/dist/checks/deprecated-fonts-on-settings-schema/index.js.map +1 -0
- package/dist/checks/deprecated-tag/index.d.ts +2 -0
- package/dist/checks/deprecated-tag/index.js +48 -0
- package/dist/checks/deprecated-tag/index.js.map +1 -0
- package/dist/checks/duplicate-content-for-arguments/index.d.ts +2 -0
- package/dist/checks/duplicate-content-for-arguments/index.js +39 -0
- package/dist/checks/duplicate-content-for-arguments/index.js.map +1 -0
- package/dist/checks/duplicate-function-arguments/index.d.ts +2 -0
- package/dist/checks/duplicate-function-arguments/index.js +40 -0
- package/dist/checks/duplicate-function-arguments/index.js.map +1 -0
- package/dist/checks/duplicate-render-partial-arguments/index.d.ts +2 -0
- package/dist/checks/duplicate-render-partial-arguments/index.js +43 -0
- package/dist/checks/duplicate-render-partial-arguments/index.js.map +1 -0
- package/dist/checks/empty-block-content/index.d.ts +2 -0
- package/dist/checks/empty-block-content/index.js +60 -0
- package/dist/checks/empty-block-content/index.js.map +1 -0
- package/dist/checks/graphql/index.d.ts +2 -0
- package/dist/checks/graphql/index.js +58 -0
- package/dist/checks/graphql/index.js.map +1 -0
- package/dist/checks/graphql-variables/index.d.ts +8 -0
- package/dist/checks/graphql-variables/index.js +91 -0
- package/dist/checks/graphql-variables/index.js.map +1 -0
- package/dist/checks/hardcoded-routes/index.d.ts +2 -0
- package/dist/checks/hardcoded-routes/index.js +89 -0
- package/dist/checks/hardcoded-routes/index.js.map +1 -0
- package/dist/checks/img-width-and-height/index.d.ts +2 -0
- package/dist/checks/img-width-and-height/index.js +46 -0
- package/dist/checks/img-width-and-height/index.js.map +1 -0
- package/dist/checks/index.d.ts +8 -0
- package/dist/checks/index.js +154 -0
- package/dist/checks/index.js.map +1 -0
- package/dist/checks/invalid-hash-assign-target/index.d.ts +2 -0
- package/dist/checks/invalid-hash-assign-target/index.js +252 -0
- package/dist/checks/invalid-hash-assign-target/index.js.map +1 -0
- package/dist/checks/json-missing-block/index.d.ts +2 -0
- package/dist/checks/json-missing-block/index.js +48 -0
- package/dist/checks/json-missing-block/index.js.map +1 -0
- package/dist/checks/json-missing-block/missing-block-utils.d.ts +4 -0
- package/dist/checks/json-missing-block/missing-block-utils.js +87 -0
- package/dist/checks/json-missing-block/missing-block-utils.js.map +1 -0
- package/dist/checks/json-syntax-error/index.d.ts +2 -0
- package/dist/checks/json-syntax-error/index.js +92 -0
- package/dist/checks/json-syntax-error/index.js.map +1 -0
- package/dist/checks/liquid-free-settings/index.d.ts +2 -0
- package/dist/checks/liquid-free-settings/index.js +64 -0
- package/dist/checks/liquid-free-settings/index.js.map +1 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidBooleanExpressions.d.ts +3 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidBooleanExpressions.js +23 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidBooleanExpressions.js.map +1 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidConditionalNode.d.ts +3 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidConditionalNode.js +136 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidConditionalNode.js.map +1 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidConditionalNodeParenthesis.d.ts +3 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidConditionalNodeParenthesis.js +26 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidConditionalNodeParenthesis.js.map +1 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidEchoValue.d.ts +3 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidEchoValue.js +59 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidEchoValue.js.map +1 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidFilterName.d.ts +3 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidFilterName.js +66 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidFilterName.js.map +1 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidLoopArguments.d.ts +3 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidLoopArguments.js +73 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidLoopArguments.js.map +1 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidLoopRange.d.ts +4 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidLoopRange.js +54 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidLoopRange.js.map +1 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidPipeSyntax.d.ts +3 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidPipeSyntax.js +71 -0
- package/dist/checks/liquid-html-syntax-error/checks/InvalidPipeSyntax.js.map +1 -0
- package/dist/checks/liquid-html-syntax-error/checks/MultipleAssignValues.d.ts +3 -0
- package/dist/checks/liquid-html-syntax-error/checks/MultipleAssignValues.js +69 -0
- package/dist/checks/liquid-html-syntax-error/checks/MultipleAssignValues.js.map +1 -0
- package/dist/checks/liquid-html-syntax-error/checks/utils.d.ts +15 -0
- package/dist/checks/liquid-html-syntax-error/checks/utils.js +58 -0
- package/dist/checks/liquid-html-syntax-error/checks/utils.js.map +1 -0
- package/dist/checks/liquid-html-syntax-error/index.d.ts +2 -0
- package/dist/checks/liquid-html-syntax-error/index.js +131 -0
- package/dist/checks/liquid-html-syntax-error/index.js.map +1 -0
- package/dist/checks/matching-translations/index.d.ts +2 -0
- package/dist/checks/matching-translations/index.js +146 -0
- package/dist/checks/matching-translations/index.js.map +1 -0
- package/dist/checks/metadata-params/index.d.ts +2 -0
- package/dist/checks/metadata-params/index.js +96 -0
- package/dist/checks/metadata-params/index.js.map +1 -0
- package/dist/checks/missing-asset/index.d.ts +2 -0
- package/dist/checks/missing-asset/index.js +44 -0
- package/dist/checks/missing-asset/index.js.map +1 -0
- package/dist/checks/missing-content-for-arguments/index.d.ts +2 -0
- package/dist/checks/missing-content-for-arguments/index.js +36 -0
- package/dist/checks/missing-content-for-arguments/index.js.map +1 -0
- package/dist/checks/missing-template/index.d.ts +6 -0
- package/dist/checks/missing-template/index.js +70 -0
- package/dist/checks/missing-template/index.js.map +1 -0
- package/dist/checks/orphaned-partial/index.d.ts +2 -0
- package/dist/checks/orphaned-partial/index.js +42 -0
- package/dist/checks/orphaned-partial/index.js.map +1 -0
- package/dist/checks/pagination-size/index.d.ts +7 -0
- package/dist/checks/pagination-size/index.js +89 -0
- package/dist/checks/pagination-size/index.js.map +1 -0
- package/dist/checks/parser-blocking-script/index.d.ts +2 -0
- package/dist/checks/parser-blocking-script/index.js +81 -0
- package/dist/checks/parser-blocking-script/index.js.map +1 -0
- package/dist/checks/parser-blocking-script/suggestions.d.ts +4 -0
- package/dist/checks/parser-blocking-script/suggestions.js +22 -0
- package/dist/checks/parser-blocking-script/suggestions.js.map +1 -0
- package/dist/checks/remote-asset/index.d.ts +6 -0
- package/dist/checks/remote-asset/index.js +189 -0
- package/dist/checks/remote-asset/index.js.map +1 -0
- package/dist/checks/reserved-doc-param-names/index.d.ts +2 -0
- package/dist/checks/reserved-doc-param-names/index.js +46 -0
- package/dist/checks/reserved-doc-param-names/index.js.map +1 -0
- package/dist/checks/schema-presets-block-order/index.d.ts +2 -0
- package/dist/checks/schema-presets-block-order/index.js +108 -0
- package/dist/checks/schema-presets-block-order/index.js.map +1 -0
- package/dist/checks/schema-presets-static-blocks/index.d.ts +2 -0
- package/dist/checks/schema-presets-static-blocks/index.js +109 -0
- package/dist/checks/schema-presets-static-blocks/index.js.map +1 -0
- package/dist/checks/static-stylesheet-and-javascript-tags/index.d.ts +2 -0
- package/dist/checks/static-stylesheet-and-javascript-tags/index.js +42 -0
- package/dist/checks/static-stylesheet-and-javascript-tags/index.js.map +1 -0
- package/dist/checks/translation-key-exists/index.d.ts +2 -0
- package/dist/checks/translation-key-exists/index.js +67 -0
- package/dist/checks/translation-key-exists/index.js.map +1 -0
- package/dist/checks/unclosed-html-element/index.d.ts +2 -0
- package/dist/checks/unclosed-html-element/index.js +252 -0
- package/dist/checks/unclosed-html-element/index.js.map +1 -0
- package/dist/checks/undefined-object/index.d.ts +2 -0
- package/dist/checks/undefined-object/index.js +255 -0
- package/dist/checks/undefined-object/index.js.map +1 -0
- package/dist/checks/unique-doc-param-names/index.d.ts +2 -0
- package/dist/checks/unique-doc-param-names/index.js +37 -0
- package/dist/checks/unique-doc-param-names/index.js.map +1 -0
- package/dist/checks/unique-settings-id/index.d.ts +2 -0
- package/dist/checks/unique-settings-id/index.js +69 -0
- package/dist/checks/unique-settings-id/index.js.map +1 -0
- package/dist/checks/unique-settings-id/test-data.d.ts +2 -0
- package/dist/checks/unique-settings-id/test-data.js +1194 -0
- package/dist/checks/unique-settings-id/test-data.js.map +1 -0
- package/dist/checks/unique-static-block-id/index.d.ts +2 -0
- package/dist/checks/unique-static-block-id/index.js +56 -0
- package/dist/checks/unique-static-block-id/index.js.map +1 -0
- package/dist/checks/unknown-filter/index.d.ts +2 -0
- package/dist/checks/unknown-filter/index.js +38 -0
- package/dist/checks/unknown-filter/index.js.map +1 -0
- package/dist/checks/unknown-property/index.d.ts +2 -0
- package/dist/checks/unknown-property/index.js +361 -0
- package/dist/checks/unknown-property/index.js.map +1 -0
- package/dist/checks/unknown-property/property-shape.d.ts +41 -0
- package/dist/checks/unknown-property/property-shape.js +267 -0
- package/dist/checks/unknown-property/property-shape.js.map +1 -0
- package/dist/checks/unrecognized-content-for-arguments/index.d.ts +2 -0
- package/dist/checks/unrecognized-content-for-arguments/index.js +43 -0
- package/dist/checks/unrecognized-content-for-arguments/index.js.map +1 -0
- package/dist/checks/unrecognized-render-partial-arguments/index.d.ts +2 -0
- package/dist/checks/unrecognized-render-partial-arguments/index.js +59 -0
- package/dist/checks/unrecognized-render-partial-arguments/index.js.map +1 -0
- package/dist/checks/unused-assign/index.d.ts +2 -0
- package/dist/checks/unused-assign/index.js +77 -0
- package/dist/checks/unused-assign/index.js.map +1 -0
- package/dist/checks/unused-doc-param/index.d.ts +2 -0
- package/dist/checks/unused-doc-param/index.js +55 -0
- package/dist/checks/unused-doc-param/index.js.map +1 -0
- package/dist/checks/utils.d.ts +22 -0
- package/dist/checks/utils.js +74 -0
- package/dist/checks/utils.js.map +1 -0
- package/dist/checks/valid-block-target/index.d.ts +2 -0
- package/dist/checks/valid-block-target/index.js +99 -0
- package/dist/checks/valid-block-target/index.js.map +1 -0
- package/dist/checks/valid-content-for-argument-types/index.d.ts +2 -0
- package/dist/checks/valid-content-for-argument-types/index.js +35 -0
- package/dist/checks/valid-content-for-argument-types/index.js.map +1 -0
- package/dist/checks/valid-content-for-arguments/index.d.ts +2 -0
- package/dist/checks/valid-content-for-arguments/index.js +82 -0
- package/dist/checks/valid-content-for-arguments/index.js.map +1 -0
- package/dist/checks/valid-doc-param-types/index.d.ts +2 -0
- package/dist/checks/valid-doc-param-types/index.js +61 -0
- package/dist/checks/valid-doc-param-types/index.js.map +1 -0
- package/dist/checks/valid-html-translation/index.d.ts +2 -0
- package/dist/checks/valid-html-translation/index.js +46 -0
- package/dist/checks/valid-html-translation/index.js.map +1 -0
- package/dist/checks/valid-json/index.d.ts +2 -0
- package/dist/checks/valid-json/index.js +36 -0
- package/dist/checks/valid-json/index.js.map +1 -0
- package/dist/checks/valid-local-blocks/index.d.ts +2 -0
- package/dist/checks/valid-local-blocks/index.js +66 -0
- package/dist/checks/valid-local-blocks/index.js.map +1 -0
- package/dist/checks/valid-local-blocks/valid-block-utils.d.ts +13 -0
- package/dist/checks/valid-local-blocks/valid-block-utils.js +74 -0
- package/dist/checks/valid-local-blocks/valid-block-utils.js.map +1 -0
- package/dist/checks/valid-render-partial-argument-types/index.d.ts +2 -0
- package/dist/checks/valid-render-partial-argument-types/index.js +66 -0
- package/dist/checks/valid-render-partial-argument-types/index.js.map +1 -0
- package/dist/checks/valid-schema/index.d.ts +2 -0
- package/dist/checks/valid-schema/index.js +40 -0
- package/dist/checks/valid-schema/index.js.map +1 -0
- package/dist/checks/valid-schema-name/index.d.ts +2 -0
- package/dist/checks/valid-schema-name/index.js +74 -0
- package/dist/checks/valid-schema-name/index.js.map +1 -0
- package/dist/checks/valid-settings-key/index.d.ts +2 -0
- package/dist/checks/valid-settings-key/index.js +90 -0
- package/dist/checks/valid-settings-key/index.js.map +1 -0
- package/dist/checks/valid-static-block-type/index.d.ts +2 -0
- package/dist/checks/valid-static-block-type/index.js +54 -0
- package/dist/checks/valid-static-block-type/index.js.map +1 -0
- package/dist/checks/valid-visible-if/index.d.ts +3 -0
- package/dist/checks/valid-visible-if/index.js +146 -0
- package/dist/checks/valid-visible-if/index.js.map +1 -0
- package/dist/checks/valid-visible-if/visible-if-utils.d.ts +14 -0
- package/dist/checks/valid-visible-if/visible-if-utils.js +125 -0
- package/dist/checks/valid-visible-if/visible-if-utils.js.map +1 -0
- package/dist/checks/variable-name/index.d.ts +6 -0
- package/dist/checks/variable-name/index.js +93 -0
- package/dist/checks/variable-name/index.js.map +1 -0
- package/dist/context-utils.d.ts +15 -0
- package/dist/context-utils.js +185 -0
- package/dist/context-utils.js.map +1 -0
- package/dist/create-safe-check.d.ts +2 -0
- package/dist/create-safe-check.js +15 -0
- package/dist/create-safe-check.js.map +1 -0
- package/dist/disabled-checks/index.d.ts +7 -0
- package/dist/disabled-checks/index.js +145 -0
- package/dist/disabled-checks/index.js.map +1 -0
- package/dist/disabled-checks/test-checks.d.ts +3 -0
- package/dist/disabled-checks/test-checks.js +59 -0
- package/dist/disabled-checks/test-checks.js.map +1 -0
- package/dist/doc-generator/DocBlockGenerator.d.ts +16 -0
- package/dist/doc-generator/DocBlockGenerator.js +464 -0
- package/dist/doc-generator/DocBlockGenerator.js.map +1 -0
- package/dist/doc-generator/index.d.ts +1 -0
- package/dist/doc-generator/index.js +6 -0
- package/dist/doc-generator/index.js.map +1 -0
- package/dist/find-root.d.ts +18 -0
- package/dist/find-root.js +81 -0
- package/dist/find-root.js.map +1 -0
- package/dist/fixes/apply-fix-to-string.d.ts +2 -0
- package/dist/fixes/apply-fix-to-string.js +50 -0
- package/dist/fixes/apply-fix-to-string.js.map +1 -0
- package/dist/fixes/autofix.d.ts +9 -0
- package/dist/fixes/autofix.js +30 -0
- package/dist/fixes/autofix.js.map +1 -0
- package/dist/fixes/corrector.d.ts +0 -0
- package/dist/fixes/corrector.js +2 -0
- package/dist/fixes/corrector.js.map +1 -0
- package/dist/fixes/correctors/base-corrector.d.ts +4 -0
- package/dist/fixes/correctors/base-corrector.js +3 -0
- package/dist/fixes/correctors/base-corrector.js.map +1 -0
- package/dist/fixes/correctors/graphql-corrector.d.ts +56 -0
- package/dist/fixes/correctors/graphql-corrector.js +78 -0
- package/dist/fixes/correctors/graphql-corrector.js.map +1 -0
- package/dist/fixes/correctors/index.d.ts +6 -0
- package/dist/fixes/correctors/index.js +30 -0
- package/dist/fixes/correctors/index.js.map +1 -0
- package/dist/fixes/correctors/json-corrector.d.ts +39 -0
- package/dist/fixes/correctors/json-corrector.js +86 -0
- package/dist/fixes/correctors/json-corrector.js.map +1 -0
- package/dist/fixes/correctors/string-corrector.d.ts +56 -0
- package/dist/fixes/correctors/string-corrector.js +78 -0
- package/dist/fixes/correctors/string-corrector.js.map +1 -0
- package/dist/fixes/index.d.ts +4 -0
- package/dist/fixes/index.js +14 -0
- package/dist/fixes/index.js.map +1 -0
- package/dist/fixes/utils.d.ts +2 -0
- package/dist/fixes/utils.js +9 -0
- package/dist/fixes/utils.js.map +1 -0
- package/dist/ignore.d.ts +2 -0
- package/dist/ignore.js +20 -0
- package/dist/ignore.js.map +1 -0
- package/dist/index.d.ts +23 -0
- package/dist/index.js +211 -0
- package/dist/index.js.map +1 -0
- package/dist/json.d.ts +17 -0
- package/dist/json.js +79 -0
- package/dist/json.js.map +1 -0
- package/dist/jsonc/parse.d.ts +25 -0
- package/dist/jsonc/parse.js +101 -0
- package/dist/jsonc/parse.js.map +1 -0
- package/dist/jsonc/types.d.ts +37 -0
- package/dist/jsonc/types.js +3 -0
- package/dist/jsonc/types.js.map +1 -0
- package/dist/liquid-doc/arguments.d.ts +36 -0
- package/dist/liquid-doc/arguments.js +239 -0
- package/dist/liquid-doc/arguments.js.map +1 -0
- package/dist/liquid-doc/liquidDoc.d.ts +33 -0
- package/dist/liquid-doc/liquidDoc.js +94 -0
- package/dist/liquid-doc/liquidDoc.js.map +1 -0
- package/dist/liquid-doc/utils.d.ts +49 -0
- package/dist/liquid-doc/utils.js +119 -0
- package/dist/liquid-doc/utils.js.map +1 -0
- package/dist/path.d.ts +10 -0
- package/dist/path.js +47 -0
- package/dist/path.js.map +1 -0
- package/dist/tags/content-for.d.ts +3 -0
- package/dist/tags/content-for.js +27 -0
- package/dist/tags/content-for.js.map +1 -0
- package/dist/test/MockFileSystem.d.ts +12 -0
- package/dist/test/MockFileSystem.js +109 -0
- package/dist/test/MockFileSystem.js.map +1 -0
- package/dist/test/MockTheme.d.ts +16 -0
- package/dist/test/MockTheme.js +16 -0
- package/dist/test/MockTheme.js.map +1 -0
- package/dist/test/chai-offer-fix-assertion.d.ts +22 -0
- package/dist/test/chai-offer-fix-assertion.js +20 -0
- package/dist/test/chai-offer-fix-assertion.js.map +1 -0
- package/dist/test/chai-suggest-assertion.d.ts +22 -0
- package/dist/test/chai-suggest-assertion.js +29 -0
- package/dist/test/chai-suggest-assertion.js.map +1 -0
- package/dist/test/contain-offense.d.ts +12 -0
- package/dist/test/contain-offense.js +36 -0
- package/dist/test/contain-offense.js.map +1 -0
- package/dist/test/index.d.ts +3 -0
- package/dist/test/index.js +20 -0
- package/dist/test/index.js.map +1 -0
- package/dist/test/test-helper.d.ts +14 -0
- package/dist/test/test-helper.js +289 -0
- package/dist/test/test-helper.js.map +1 -0
- package/dist/test/test-setup.d.ts +9 -0
- package/dist/test/test-setup.js +26 -0
- package/dist/test/test-setup.js.map +1 -0
- package/dist/to-schema.d.ts +16 -0
- package/dist/to-schema.js +218 -0
- package/dist/to-schema.js.map +1 -0
- package/dist/to-source-code.d.ts +5 -0
- package/dist/to-source-code.js +103 -0
- package/dist/to-source-code.js.map +1 -0
- package/dist/tsconfig.tsbuildinfo +1 -0
- package/dist/types/schema-prop-factory.d.ts +76 -0
- package/dist/types/schema-prop-factory.js +84 -0
- package/dist/types/schema-prop-factory.js.map +1 -0
- package/dist/types/schemas/index.d.ts +5 -0
- package/dist/types/schemas/index.js +6 -0
- package/dist/types/schemas/index.js.map +1 -0
- package/dist/types/schemas/preset.d.ts +38 -0
- package/dist/types/schemas/preset.js +3 -0
- package/dist/types/schemas/preset.js.map +1 -0
- package/dist/types/schemas/section.d.ts +49 -0
- package/dist/types/schemas/section.js +3 -0
- package/dist/types/schemas/section.js.map +1 -0
- package/dist/types/schemas/setting.d.ts +216 -0
- package/dist/types/schemas/setting.js +3 -0
- package/dist/types/schemas/setting.js.map +1 -0
- package/dist/types/schemas/template.d.ts +30 -0
- package/dist/types/schemas/template.js +3 -0
- package/dist/types/schemas/template.js.map +1 -0
- package/dist/types/schemas/theme-block.d.ts +24 -0
- package/dist/types/schemas/theme-block.js +3 -0
- package/dist/types/schemas/theme-block.js.map +1 -0
- package/dist/types/theme-liquid-docs.d.ts +131 -0
- package/dist/types/theme-liquid-docs.js +3 -0
- package/dist/types/theme-liquid-docs.js.map +1 -0
- package/dist/types/theme-schemas.d.ts +70 -0
- package/dist/types/theme-schemas.js +25 -0
- package/dist/types/theme-schemas.js.map +1 -0
- package/dist/types.d.ts +469 -0
- package/dist/types.js +55 -0
- package/dist/types.js.map +1 -0
- package/dist/utils/array.d.ts +5 -0
- package/dist/utils/array.js +28 -0
- package/dist/utils/array.js.map +1 -0
- package/dist/utils/block.d.ts +22 -0
- package/dist/utils/block.js +179 -0
- package/dist/utils/block.js.map +1 -0
- package/dist/utils/error.d.ts +2 -0
- package/dist/utils/error.js +44 -0
- package/dist/utils/error.js.map +1 -0
- package/dist/utils/file-utils.d.ts +6 -0
- package/dist/utils/file-utils.js +46 -0
- package/dist/utils/file-utils.js.map +1 -0
- package/dist/utils/index.d.ts +8 -0
- package/dist/utils/index.js +25 -0
- package/dist/utils/index.js.map +1 -0
- package/dist/utils/indexBy.d.ts +5 -0
- package/dist/utils/indexBy.js +15 -0
- package/dist/utils/indexBy.js.map +1 -0
- package/dist/utils/markup.d.ts +2 -0
- package/dist/utils/markup.js +10 -0
- package/dist/utils/markup.js.map +1 -0
- package/dist/utils/memo.d.ts +34 -0
- package/dist/utils/memo.js +61 -0
- package/dist/utils/memo.js.map +1 -0
- package/dist/utils/object.d.ts +1 -0
- package/dist/utils/object.js +7 -0
- package/dist/utils/object.js.map +1 -0
- package/dist/utils/position.d.ts +3 -0
- package/dist/utils/position.js +20 -0
- package/dist/utils/position.js.map +1 -0
- package/dist/utils/types.d.ts +52 -0
- package/dist/utils/types.js +23 -0
- package/dist/utils/types.js.map +1 -0
- package/dist/visitor.d.ts +24 -0
- package/dist/visitor.js +119 -0
- package/dist/visitor.js.map +1 -0
- package/dist/visitors/index.d.ts +2 -0
- package/dist/visitors/index.js +8 -0
- package/dist/visitors/index.js.map +1 -0
- package/dist/visitors/json.d.ts +2 -0
- package/dist/visitors/json.js +39 -0
- package/dist/visitors/json.js.map +1 -0
- package/dist/visitors/liquid.d.ts +2 -0
- package/dist/visitors/liquid.js +39 -0
- package/dist/visitors/liquid.js.map +1 -0
- package/package.json +45 -0
- package/src/AugmentedThemeDocset.spec.ts +148 -0
- package/src/AugmentedThemeDocset.ts +148 -0
- package/src/JSONValidator.ts +82 -0
- package/src/checks/app-block-missing-schema/index.spec.ts +121 -0
- package/src/checks/app-block-missing-schema/index.ts +46 -0
- package/src/checks/app-block-valid-tags/index.spec.ts +96 -0
- package/src/checks/app-block-valid-tags/index.ts +54 -0
- package/src/checks/asset-preload/index.spec.ts +78 -0
- package/src/checks/asset-preload/index.ts +65 -0
- package/src/checks/asset-size-app-block-css/index.spec.ts +88 -0
- package/src/checks/asset-size-app-block-css/index.ts +78 -0
- package/src/checks/asset-size-app-block-javascript/index.spec.ts +66 -0
- package/src/checks/asset-size-app-block-javascript/index.ts +78 -0
- package/src/checks/asset-size-css/index.spec.ts +166 -0
- package/src/checks/asset-size-css/index.ts +160 -0
- package/src/checks/asset-size-javascript/index.spec.ts +184 -0
- package/src/checks/asset-size-javascript/index.ts +144 -0
- package/src/checks/block-id-usage/index.spec.ts +76 -0
- package/src/checks/block-id-usage/index.ts +72 -0
- package/src/checks/cdn-preconnect/index.spec.ts +40 -0
- package/src/checks/cdn-preconnect/index.ts +43 -0
- package/src/checks/content-for-header-modification/index.spec.ts +65 -0
- package/src/checks/content-for-header-modification/index.ts +72 -0
- package/src/checks/deprecate-bgsizes/index.spec.ts +41 -0
- package/src/checks/deprecate-bgsizes/index.ts +49 -0
- package/src/checks/deprecate-lazysizes/index.spec.ts +26 -0
- package/src/checks/deprecate-lazysizes/index.ts +58 -0
- package/src/checks/deprecated-filter/fixes.ts +264 -0
- package/src/checks/deprecated-filter/index.spec.ts +274 -0
- package/src/checks/deprecated-filter/index.ts +113 -0
- package/src/checks/deprecated-fonts-on-sections-and-blocks/deprecated-fonts-data.ts +1343 -0
- package/src/checks/deprecated-fonts-on-sections-and-blocks/index.spec.ts +613 -0
- package/src/checks/deprecated-fonts-on-sections-and-blocks/index.ts +284 -0
- package/src/checks/deprecated-fonts-on-settings-schema/index.spec.ts +102 -0
- package/src/checks/deprecated-fonts-on-settings-schema/index.ts +66 -0
- package/src/checks/deprecated-tag/index.spec.ts +68 -0
- package/src/checks/deprecated-tag/index.ts +46 -0
- package/src/checks/duplicate-content-for-arguments/index.spec.ts +98 -0
- package/src/checks/duplicate-content-for-arguments/index.ts +43 -0
- package/src/checks/duplicate-function-arguments/index.spec.ts +98 -0
- package/src/checks/duplicate-function-arguments/index.ts +44 -0
- package/src/checks/duplicate-render-partial-arguments/index.spec.ts +120 -0
- package/src/checks/duplicate-render-partial-arguments/index.ts +48 -0
- package/src/checks/empty-block-content/index.spec.ts +117 -0
- package/src/checks/empty-block-content/index.ts +60 -0
- package/src/checks/graphql/index.ts +64 -0
- package/src/checks/graphql-variables/index.ts +113 -0
- package/src/checks/hardcoded-routes/index.spec.ts +58 -0
- package/src/checks/hardcoded-routes/index.ts +100 -0
- package/src/checks/img-width-and-height/index.spec.ts +79 -0
- package/src/checks/img-width-and-height/index.ts +52 -0
- package/src/checks/index.ts +160 -0
- package/src/checks/invalid-hash-assign-target/index.spec.ts +176 -0
- package/src/checks/invalid-hash-assign-target/index.ts +306 -0
- package/src/checks/json-missing-block/index.spec.ts +435 -0
- package/src/checks/json-missing-block/index.ts +56 -0
- package/src/checks/json-missing-block/missing-block-utils.ts +147 -0
- package/src/checks/json-syntax-error/index.spec.ts +64 -0
- package/src/checks/json-syntax-error/index.ts +92 -0
- package/src/checks/liquid-free-settings/index.spec.ts +180 -0
- package/src/checks/liquid-free-settings/index.ts +79 -0
- package/src/checks/liquid-html-syntax-error/checks/InvalidBooleanExpression.spec.ts +43 -0
- package/src/checks/liquid-html-syntax-error/checks/InvalidBooleanExpressions.ts +29 -0
- package/src/checks/liquid-html-syntax-error/checks/InvalidConditionalNode.spec.ts +385 -0
- package/src/checks/liquid-html-syntax-error/checks/InvalidConditionalNode.ts +165 -0
- package/src/checks/liquid-html-syntax-error/checks/InvalidConditionalNodeParenthesis.spec.ts +52 -0
- package/src/checks/liquid-html-syntax-error/checks/InvalidConditionalNodeParenthesis.ts +39 -0
- package/src/checks/liquid-html-syntax-error/checks/InvalidEchoValue.spec.ts +108 -0
- package/src/checks/liquid-html-syntax-error/checks/InvalidEchoValue.ts +74 -0
- package/src/checks/liquid-html-syntax-error/checks/InvalidFilterName.spec.ts +223 -0
- package/src/checks/liquid-html-syntax-error/checks/InvalidFilterName.ts +92 -0
- package/src/checks/liquid-html-syntax-error/checks/InvalidLoopArguments.spec.ts +145 -0
- package/src/checks/liquid-html-syntax-error/checks/InvalidLoopArguments.ts +116 -0
- package/src/checks/liquid-html-syntax-error/checks/InvalidLoopRange.spec.ts +84 -0
- package/src/checks/liquid-html-syntax-error/checks/InvalidLoopRange.ts +79 -0
- package/src/checks/liquid-html-syntax-error/checks/InvalidPipeSyntax.spec.ts +184 -0
- package/src/checks/liquid-html-syntax-error/checks/InvalidPipeSyntax.ts +91 -0
- package/src/checks/liquid-html-syntax-error/checks/MultipleAssignValues.spec.ts +82 -0
- package/src/checks/liquid-html-syntax-error/checks/MultipleAssignValues.ts +86 -0
- package/src/checks/liquid-html-syntax-error/checks/utils.spec.ts +82 -0
- package/src/checks/liquid-html-syntax-error/checks/utils.ts +66 -0
- package/src/checks/liquid-html-syntax-error/index.spec.ts +129 -0
- package/src/checks/liquid-html-syntax-error/index.ts +152 -0
- package/src/checks/matching-translations/index.spec.ts +400 -0
- package/src/checks/matching-translations/index.ts +175 -0
- package/src/checks/metadata-params/index.spec.ts +103 -0
- package/src/checks/metadata-params/index.ts +119 -0
- package/src/checks/missing-asset/index.spec.ts +59 -0
- package/src/checks/missing-asset/index.ts +48 -0
- package/src/checks/missing-content-for-arguments/index.spec.ts +144 -0
- package/src/checks/missing-content-for-arguments/index.ts +46 -0
- package/src/checks/missing-template/index.spec.ts +61 -0
- package/src/checks/missing-template/index.ts +101 -0
- package/src/checks/orphaned-partial/index.spec.ts +58 -0
- package/src/checks/orphaned-partial/index.ts +43 -0
- package/src/checks/pagination-size/index.spec.ts +158 -0
- package/src/checks/pagination-size/index.ts +104 -0
- package/src/checks/parser-blocking-script/index.spec.ts +225 -0
- package/src/checks/parser-blocking-script/index.ts +91 -0
- package/src/checks/parser-blocking-script/suggestions.ts +42 -0
- package/src/checks/remote-asset/index.spec.ts +280 -0
- package/src/checks/remote-asset/index.ts +238 -0
- package/src/checks/reserved-doc-param-names/index.spec.ts +62 -0
- package/src/checks/reserved-doc-param-names/index.ts +57 -0
- package/src/checks/schema-presets-block-order/index.spec.ts +344 -0
- package/src/checks/schema-presets-block-order/index.ts +154 -0
- package/src/checks/schema-presets-static-blocks/index.spec.ts +145 -0
- package/src/checks/schema-presets-static-blocks/index.ts +126 -0
- package/src/checks/static-stylesheet-and-javascript-tags/index.spec.ts +257 -0
- package/src/checks/static-stylesheet-and-javascript-tags/index.ts +48 -0
- package/src/checks/translation-key-exists/index.spec.ts +44 -0
- package/src/checks/translation-key-exists/index.ts +78 -0
- package/src/checks/unclosed-html-element/index.spec.ts +260 -0
- package/src/checks/unclosed-html-element/index.ts +296 -0
- package/src/checks/undefined-object/index.spec.ts +519 -0
- package/src/checks/undefined-object/index.ts +336 -0
- package/src/checks/unique-doc-param-names/index.spec.ts +35 -0
- package/src/checks/unique-doc-param-names/index.ts +39 -0
- package/src/checks/unique-settings-id/index.spec.ts +24 -0
- package/src/checks/unique-settings-id/index.ts +84 -0
- package/src/checks/unique-settings-id/test-data.ts +1191 -0
- package/src/checks/unique-static-block-id/index.spec.ts +55 -0
- package/src/checks/unique-static-block-id/index.ts +60 -0
- package/src/checks/unknown-filter/index.spec.ts +59 -0
- package/src/checks/unknown-filter/index.ts +38 -0
- package/src/checks/unknown-property/index.spec.ts +234 -0
- package/src/checks/unknown-property/index.ts +468 -0
- package/src/checks/unknown-property/property-shape.ts +315 -0
- package/src/checks/unrecognized-content-for-arguments/index.spec.ts +145 -0
- package/src/checks/unrecognized-content-for-arguments/index.ts +55 -0
- package/src/checks/unrecognized-render-partial-arguments/index.spec.ts +184 -0
- package/src/checks/unrecognized-render-partial-arguments/index.ts +76 -0
- package/src/checks/unused-assign/index.spec.ts +160 -0
- package/src/checks/unused-assign/index.ts +87 -0
- package/src/checks/unused-doc-param/index.spec.ts +89 -0
- package/src/checks/unused-doc-param/index.ts +59 -0
- package/src/checks/utils.ts +117 -0
- package/src/checks/valid-block-target/index.spec.ts +1396 -0
- package/src/checks/valid-block-target/index.ts +142 -0
- package/src/checks/valid-content-for-argument-types/index.spec.ts +382 -0
- package/src/checks/valid-content-for-argument-types/index.ts +42 -0
- package/src/checks/valid-content-for-arguments/index.spec.ts +107 -0
- package/src/checks/valid-content-for-arguments/index.ts +98 -0
- package/src/checks/valid-doc-param-types/index.spec.ts +75 -0
- package/src/checks/valid-doc-param-types/index.ts +71 -0
- package/src/checks/valid-html-translation/index.spec.ts +74 -0
- package/src/checks/valid-html-translation/index.ts +45 -0
- package/src/checks/valid-json/index.spec.ts +102 -0
- package/src/checks/valid-json/index.ts +34 -0
- package/src/checks/valid-local-blocks/index.spec.ts +286 -0
- package/src/checks/valid-local-blocks/index.ts +100 -0
- package/src/checks/valid-local-blocks/valid-block-utils.ts +97 -0
- package/src/checks/valid-render-partial-argument-types/index.spec.ts +468 -0
- package/src/checks/valid-render-partial-argument-types/index.ts +89 -0
- package/src/checks/valid-schema/index.spec.ts +174 -0
- package/src/checks/valid-schema/index.ts +41 -0
- package/src/checks/valid-schema-name/index.spec.ts +112 -0
- package/src/checks/valid-schema-name/index.ts +75 -0
- package/src/checks/valid-settings-key/index.spec.ts +321 -0
- package/src/checks/valid-settings-key/index.ts +144 -0
- package/src/checks/valid-static-block-type/index.spec.ts +38 -0
- package/src/checks/valid-static-block-type/index.ts +58 -0
- package/src/checks/valid-visible-if/index.spec.ts +619 -0
- package/src/checks/valid-visible-if/index.ts +184 -0
- package/src/checks/valid-visible-if/visible-if-utils.ts +158 -0
- package/src/checks/variable-name/index.spec.ts +62 -0
- package/src/checks/variable-name/index.ts +115 -0
- package/src/context-utils.spec.ts +103 -0
- package/src/context-utils.ts +220 -0
- package/src/create-safe-check.ts +13 -0
- package/src/disabled-checks/index.spec.ts +262 -0
- package/src/disabled-checks/index.ts +189 -0
- package/src/disabled-checks/test-checks.ts +60 -0
- package/src/find-root.ts +60 -0
- package/src/fixes/apply-fix-to-string.spec.ts +52 -0
- package/src/fixes/apply-fix-to-string.ts +59 -0
- package/src/fixes/autofix.spec.ts +85 -0
- package/src/fixes/autofix.ts +41 -0
- package/src/fixes/corrector.ts +0 -0
- package/src/fixes/correctors/base-corrector.ts +5 -0
- package/src/fixes/correctors/graphql-corrector.ts +78 -0
- package/src/fixes/correctors/index.ts +29 -0
- package/src/fixes/correctors/json-corrector.spec.ts +111 -0
- package/src/fixes/correctors/json-corrector.ts +106 -0
- package/src/fixes/correctors/string-corrector.ts +78 -0
- package/src/fixes/index.ts +4 -0
- package/src/fixes/utils.ts +6 -0
- package/src/ignore.spec.ts +202 -0
- package/src/ignore.ts +23 -0
- package/src/index.spec.ts +8 -0
- package/src/index.ts +234 -0
- package/src/json.spec.ts +140 -0
- package/src/json.ts +81 -0
- package/src/jsonc/parse.spec.ts +118 -0
- package/src/jsonc/parse.ts +121 -0
- package/src/jsonc/types.ts +47 -0
- package/src/liquid-doc/arguments.spec.ts +146 -0
- package/src/liquid-doc/arguments.ts +315 -0
- package/src/liquid-doc/liquidDoc.spec.ts +296 -0
- package/src/liquid-doc/liquidDoc.ts +147 -0
- package/src/liquid-doc/utils.spec.ts +23 -0
- package/src/liquid-doc/utils.ts +125 -0
- package/src/path.ts +45 -0
- package/src/tags/content-for.ts +25 -0
- package/src/test/MockFileSystem.spec.ts +71 -0
- package/src/test/MockFileSystem.ts +87 -0
- package/src/test/MockTheme.ts +17 -0
- package/src/test/chai-offer-fix-assertion.spec.ts +53 -0
- package/src/test/chai-offer-fix-assertion.ts +45 -0
- package/src/test/chai-suggest-assertion.spec.ts +53 -0
- package/src/test/chai-suggest-assertion.ts +62 -0
- package/src/test/contain-offense.spec.ts +74 -0
- package/src/test/contain-offense.ts +54 -0
- package/src/test/index.ts +3 -0
- package/src/test/test-helper.ts +327 -0
- package/src/test/test-setup.ts +36 -0
- package/src/to-schema.ts +231 -0
- package/src/to-source-code.ts +75 -0
- package/src/types/schema-prop-factory.ts +112 -0
- package/src/types/schemas/index.ts +5 -0
- package/src/types/schemas/preset.ts +52 -0
- package/src/types/schemas/section.ts +86 -0
- package/src/types/schemas/setting.ts +320 -0
- package/src/types/schemas/template.ts +34 -0
- package/src/types/schemas/theme-block.ts +34 -0
- package/src/types/theme-liquid-docs.ts +184 -0
- package/src/types/theme-schemas.ts +80 -0
- package/src/types.ts +617 -0
- package/src/utils/array.ts +31 -0
- package/src/utils/block.ts +300 -0
- package/src/utils/error.spec.ts +71 -0
- package/src/utils/error.ts +48 -0
- package/src/utils/file-utils.ts +58 -0
- package/src/utils/index.ts +8 -0
- package/src/utils/indexBy.ts +14 -0
- package/src/utils/markup.ts +10 -0
- package/src/utils/memo.spec.ts +83 -0
- package/src/utils/memo.ts +80 -0
- package/src/utils/object.ts +3 -0
- package/src/utils/position.ts +16 -0
- package/src/utils/types.ts +57 -0
- package/src/visitor.spec.ts +163 -0
- package/src/visitor.ts +161 -0
- package/src/visitors/index.ts +2 -0
- package/src/visitors/json.ts +41 -0
- package/src/visitors/liquid.ts +40 -0
- package/tsconfig.build.json +8 -0
- package/tsconfig.json +31 -0
|
@@ -0,0 +1,239 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.reportUnknownArguments = reportUnknownArguments;
|
|
4
|
+
exports.reportMissingArguments = reportMissingArguments;
|
|
5
|
+
exports.reportDuplicateArguments = reportDuplicateArguments;
|
|
6
|
+
exports.findTypeMismatchParams = findTypeMismatchParams;
|
|
7
|
+
exports.reportTypeMismatches = reportTypeMismatches;
|
|
8
|
+
exports.generateTypeMismatchSuggestions = generateTypeMismatchSuggestions;
|
|
9
|
+
exports.getBlockName = getBlockName;
|
|
10
|
+
exports.getPartialName = getPartialName;
|
|
11
|
+
exports.getLiquidDocParams = getLiquidDocParams;
|
|
12
|
+
exports.makeRemoveArgumentCorrector = makeRemoveArgumentCorrector;
|
|
13
|
+
exports.makeAddArgumentCorrector = makeAddArgumentCorrector;
|
|
14
|
+
/**
|
|
15
|
+
* Helper methods shared between `render` tag and `content_for` tag to report
|
|
16
|
+
* errors when LiquidDoc exists
|
|
17
|
+
*/
|
|
18
|
+
const liquid_html_parser_1 = require("@platformos/liquid-html-parser");
|
|
19
|
+
const utils_1 = require("./utils");
|
|
20
|
+
const utils_2 = require("../checks/utils");
|
|
21
|
+
/**
|
|
22
|
+
* Report error when unknown arguments are provided for `content_for` tag or `render` tag
|
|
23
|
+
*/
|
|
24
|
+
function reportUnknownArguments(context, node, unknownProvidedArgs, name) {
|
|
25
|
+
let errorOwnerMessage = '';
|
|
26
|
+
if (node.type === liquid_html_parser_1.NodeTypes.ContentForMarkup) {
|
|
27
|
+
errorOwnerMessage = ` in content_for tag for static block '${name}'`;
|
|
28
|
+
}
|
|
29
|
+
else if (node.type === liquid_html_parser_1.NodeTypes.RenderMarkup) {
|
|
30
|
+
errorOwnerMessage = ` in render tag for partial '${name}'`;
|
|
31
|
+
}
|
|
32
|
+
else if (node.type === liquid_html_parser_1.NodeTypes.FunctionMarkup) {
|
|
33
|
+
errorOwnerMessage = ` in function tag for partial '${name}'`;
|
|
34
|
+
}
|
|
35
|
+
for (const arg of unknownProvidedArgs) {
|
|
36
|
+
context.report({
|
|
37
|
+
message: `Unknown argument '${arg.name}'${errorOwnerMessage}.`,
|
|
38
|
+
startIndex: arg.position.start,
|
|
39
|
+
endIndex: arg.position.end,
|
|
40
|
+
suggest: [
|
|
41
|
+
{
|
|
42
|
+
message: `Remove '${arg.name}'`,
|
|
43
|
+
fix: makeRemoveArgumentCorrector(node, arg),
|
|
44
|
+
},
|
|
45
|
+
],
|
|
46
|
+
});
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Report error when missing arguments are provided for `content_for` tag or `render` tag
|
|
51
|
+
*/
|
|
52
|
+
function reportMissingArguments(context, node, missingRequiredArgs, name) {
|
|
53
|
+
let errorOwnerMessage = '';
|
|
54
|
+
if (node.type === liquid_html_parser_1.NodeTypes.ContentForMarkup) {
|
|
55
|
+
errorOwnerMessage = ` in content_for tag for static block '${name}'`;
|
|
56
|
+
}
|
|
57
|
+
else if (node.type === liquid_html_parser_1.NodeTypes.RenderMarkup) {
|
|
58
|
+
errorOwnerMessage = ` in render tag for partial '${name}'`;
|
|
59
|
+
}
|
|
60
|
+
else if (node.type === liquid_html_parser_1.NodeTypes.FunctionMarkup) {
|
|
61
|
+
errorOwnerMessage = ` in function tag for partial '${name}'`;
|
|
62
|
+
}
|
|
63
|
+
for (const arg of missingRequiredArgs) {
|
|
64
|
+
context.report({
|
|
65
|
+
message: `Missing required argument '${arg.name}'${errorOwnerMessage}.`,
|
|
66
|
+
startIndex: node.position.start,
|
|
67
|
+
endIndex: node.position.end,
|
|
68
|
+
suggest: [
|
|
69
|
+
{
|
|
70
|
+
message: `Add required argument '${arg.name}'`,
|
|
71
|
+
fix: makeAddArgumentCorrector(node, arg),
|
|
72
|
+
},
|
|
73
|
+
],
|
|
74
|
+
});
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
function reportDuplicateArguments(context, node, duplicateArgs, name) {
|
|
78
|
+
let errorOwnerMessage = '';
|
|
79
|
+
if (node.type === liquid_html_parser_1.NodeTypes.ContentForMarkup) {
|
|
80
|
+
errorOwnerMessage = ` in content_for tag for static block '${name}'`;
|
|
81
|
+
}
|
|
82
|
+
else if (node.type === liquid_html_parser_1.NodeTypes.RenderMarkup) {
|
|
83
|
+
errorOwnerMessage = ` in render tag for partial '${name}'`;
|
|
84
|
+
}
|
|
85
|
+
else if (node.type === liquid_html_parser_1.NodeTypes.FunctionMarkup) {
|
|
86
|
+
errorOwnerMessage = ` in function tag for partial '${name}'`;
|
|
87
|
+
}
|
|
88
|
+
for (const arg of duplicateArgs) {
|
|
89
|
+
context.report({
|
|
90
|
+
message: `Duplicate argument '${arg.name}'${errorOwnerMessage}.`,
|
|
91
|
+
startIndex: arg.position.start,
|
|
92
|
+
endIndex: arg.position.end,
|
|
93
|
+
suggest: [
|
|
94
|
+
{
|
|
95
|
+
message: `Remove duplicate argument '${arg.name}'`,
|
|
96
|
+
fix: makeRemoveArgumentCorrector(node, arg),
|
|
97
|
+
},
|
|
98
|
+
],
|
|
99
|
+
});
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* Find type mismatch between the arguments provided for `content_for` tag and `render` tag
|
|
104
|
+
* and their associated file's LiquidDoc
|
|
105
|
+
*/
|
|
106
|
+
function findTypeMismatchParams(liquidDocParameters, providedParams) {
|
|
107
|
+
const typeMismatchParams = [];
|
|
108
|
+
for (const arg of providedParams) {
|
|
109
|
+
if (arg.value.type === liquid_html_parser_1.NodeTypes.VariableLookup) {
|
|
110
|
+
continue;
|
|
111
|
+
}
|
|
112
|
+
const liquidDocParamDef = liquidDocParameters.get(arg.name);
|
|
113
|
+
if (liquidDocParamDef && liquidDocParamDef.type) {
|
|
114
|
+
const paramType = liquidDocParamDef.type.toLowerCase();
|
|
115
|
+
const supportedTypes = Object.keys(utils_1.BasicParamTypes).map((type) => type.toLowerCase());
|
|
116
|
+
if (!supportedTypes.includes(paramType)) {
|
|
117
|
+
continue;
|
|
118
|
+
}
|
|
119
|
+
if (!(0, utils_1.isTypeCompatible)(paramType, (0, utils_1.inferArgumentType)(arg.value))) {
|
|
120
|
+
typeMismatchParams.push(arg);
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
return typeMismatchParams;
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* Report error if the type mismatches between LiquidDoc and provided arguments
|
|
128
|
+
*/
|
|
129
|
+
function reportTypeMismatches(context, typeMismatchArgs, liquidDocParameters) {
|
|
130
|
+
for (const arg of typeMismatchArgs) {
|
|
131
|
+
const paramDef = liquidDocParameters.get(arg.name);
|
|
132
|
+
if (!paramDef || !paramDef.type)
|
|
133
|
+
continue;
|
|
134
|
+
const expectedType = paramDef.type.toLowerCase();
|
|
135
|
+
const actualType = (0, utils_1.inferArgumentType)(arg.value);
|
|
136
|
+
const suggestions = generateTypeMismatchSuggestions(expectedType, arg.value.position.start, arg.value.position.end);
|
|
137
|
+
context.report({
|
|
138
|
+
message: `Type mismatch for argument '${arg.name}': expected ${expectedType}, got ${actualType}`,
|
|
139
|
+
startIndex: arg.value.position.start,
|
|
140
|
+
endIndex: arg.value.position.end,
|
|
141
|
+
suggest: suggestions,
|
|
142
|
+
});
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
/**
|
|
146
|
+
* Generates suggestions for type mismatches based on the expected type and node positions
|
|
147
|
+
*/
|
|
148
|
+
function generateTypeMismatchSuggestions(expectedType, startPosition, endPosition) {
|
|
149
|
+
const defaultValue = (0, utils_1.getDefaultValueForType)(expectedType);
|
|
150
|
+
const suggestions = [];
|
|
151
|
+
// Only add the "replace with default" suggestion if the default is not an empty string
|
|
152
|
+
if (defaultValue !== '') {
|
|
153
|
+
suggestions.push({
|
|
154
|
+
message: `Replace with default value '${defaultValue}' for ${expectedType}`,
|
|
155
|
+
fix: (fixer) => {
|
|
156
|
+
return fixer.replace(startPosition, endPosition, defaultValue);
|
|
157
|
+
},
|
|
158
|
+
});
|
|
159
|
+
}
|
|
160
|
+
// Always include the "remove value" suggestion
|
|
161
|
+
suggestions.push({
|
|
162
|
+
message: `Remove value`,
|
|
163
|
+
fix: (fixer) => {
|
|
164
|
+
return fixer.remove(startPosition, endPosition);
|
|
165
|
+
},
|
|
166
|
+
});
|
|
167
|
+
return suggestions;
|
|
168
|
+
}
|
|
169
|
+
function isLastArg(node, arg) {
|
|
170
|
+
return (node.args.length == 1 || arg.position.start == node.args[node.args.length - 1].position.start);
|
|
171
|
+
}
|
|
172
|
+
function getBlockName(node) {
|
|
173
|
+
if (node.contentForType.value !== 'block') {
|
|
174
|
+
return;
|
|
175
|
+
}
|
|
176
|
+
const contentForTypeArg = node.args.find((arg) => arg.name == 'type')?.value;
|
|
177
|
+
if (!contentForTypeArg || !(0, utils_2.isLiquidString)(contentForTypeArg)) {
|
|
178
|
+
return;
|
|
179
|
+
}
|
|
180
|
+
return contentForTypeArg.value;
|
|
181
|
+
}
|
|
182
|
+
function getPartialName(node) {
|
|
183
|
+
if (node.type === liquid_html_parser_1.NodeTypes.RenderMarkup) {
|
|
184
|
+
if (!(0, utils_2.isLiquidString)(node.snippet)) {
|
|
185
|
+
return;
|
|
186
|
+
}
|
|
187
|
+
return node.snippet.value;
|
|
188
|
+
}
|
|
189
|
+
if (node.type === liquid_html_parser_1.NodeTypes.FunctionMarkup) {
|
|
190
|
+
if (!(0, utils_2.isLiquidString)(node.partial)) {
|
|
191
|
+
return;
|
|
192
|
+
}
|
|
193
|
+
return node.partial.value;
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
async function getLiquidDocParams(context, relativePath) {
|
|
197
|
+
const docDefinition = context.getDocDefinition && (await context.getDocDefinition(relativePath));
|
|
198
|
+
if (!docDefinition?.liquidDoc?.parameters) {
|
|
199
|
+
return;
|
|
200
|
+
}
|
|
201
|
+
return new Map(docDefinition.liquidDoc.parameters.map((p) => [p.name, p]));
|
|
202
|
+
}
|
|
203
|
+
function makeRemoveArgumentCorrector(node, arg) {
|
|
204
|
+
return (fixer) => {
|
|
205
|
+
const sourceBeforeArg = node.source.slice(node.position.start, arg.position.start);
|
|
206
|
+
const matches = sourceBeforeArg.match(/,\s*/g);
|
|
207
|
+
const lastCommaMatch = matches?.[matches.length - 1];
|
|
208
|
+
let startPos = lastCommaMatch
|
|
209
|
+
? arg.position.start - (lastCommaMatch.length - 1)
|
|
210
|
+
: arg.position.start;
|
|
211
|
+
if (isLastArg(node, arg)) {
|
|
212
|
+
// Remove the leading comma if it's the last parameter
|
|
213
|
+
startPos -= 1;
|
|
214
|
+
}
|
|
215
|
+
const sourceAfterArg = node.source.substring(arg.position.end, node.position.end);
|
|
216
|
+
const trailingCommaMatch = sourceAfterArg.match(/\s*,/);
|
|
217
|
+
if (trailingCommaMatch) {
|
|
218
|
+
return fixer.remove(startPos, arg.position.end + trailingCommaMatch[0].length);
|
|
219
|
+
}
|
|
220
|
+
return fixer.remove(startPos, arg.position.end);
|
|
221
|
+
};
|
|
222
|
+
}
|
|
223
|
+
function makeAddArgumentCorrector(node, arg) {
|
|
224
|
+
return (fixer) => {
|
|
225
|
+
const paramToAdd = `, ${arg.name}: ${(0, utils_1.getDefaultValueForType)(arg.type)}`;
|
|
226
|
+
if (node.args.length == 0) {
|
|
227
|
+
return fixer.insert(node.position.end - 1, paramToAdd);
|
|
228
|
+
}
|
|
229
|
+
const lastArg = node.args[node.args.length - 1];
|
|
230
|
+
const sourceAfterLastArg = node.source.substring(lastArg.position.end, node.position.end);
|
|
231
|
+
const trailingCommaAndWhitespaceMatch = sourceAfterLastArg.match(/\s*,\s*/);
|
|
232
|
+
if (trailingCommaAndWhitespaceMatch) {
|
|
233
|
+
// IF there is already a trailing comma after the last arg, we want to find it and replace it with our own while stripping whitespace
|
|
234
|
+
return fixer.replace(lastArg.position.end, lastArg.position.end + trailingCommaAndWhitespaceMatch[0].length, `${paramToAdd} `);
|
|
235
|
+
}
|
|
236
|
+
return fixer.insert(lastArg.position.end, paramToAdd);
|
|
237
|
+
};
|
|
238
|
+
}
|
|
239
|
+
//# sourceMappingURL=arguments.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"arguments.js","sourceRoot":"","sources":["../../src/liquid-doc/arguments.ts"],"names":[],"mappings":";;AAuBA,wDA4BC;AAKD,wDA4BC;AAED,4DA4BC;AAMD,wDA0BC;AAKD,oDAyBC;AAKD,0EA2BC;AAWD,oCAYC;AAED,wCAcC;AAED,gDAWC;AAED,kEAwBC;AAED,4DA0BC;AA1TD;;;GAGG;AACH,uEAMwC;AAExC,mCAKiB;AACjB,2CAAiD;AAEjD;;GAEG;AACH,SAAgB,sBAAsB,CACpC,OAA2C,EAC3C,IAAsD,EACtD,mBAA0C,EAC1C,IAAY;IAEZ,IAAI,iBAAiB,GAAG,EAAE,CAAC;IAC3B,IAAI,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,gBAAgB,EAAE,CAAC;QAC7C,iBAAiB,GAAG,yCAAyC,IAAI,GAAG,CAAC;IACvE,CAAC;SAAM,IAAI,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,YAAY,EAAE,CAAC;QAChD,iBAAiB,GAAG,+BAA+B,IAAI,GAAG,CAAC;IAC7D,CAAC;SAAM,IAAI,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,cAAc,EAAE,CAAC;QAClD,iBAAiB,GAAG,iCAAiC,IAAI,GAAG,CAAC;IAC/D,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,mBAAmB,EAAE,CAAC;QACtC,OAAO,CAAC,MAAM,CAAC;YACb,OAAO,EAAE,qBAAqB,GAAG,CAAC,IAAI,IAAI,iBAAiB,GAAG;YAC9D,UAAU,EAAE,GAAG,CAAC,QAAQ,CAAC,KAAK;YAC9B,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG;YAC1B,OAAO,EAAE;gBACP;oBACE,OAAO,EAAE,WAAW,GAAG,CAAC,IAAI,GAAG;oBAC/B,GAAG,EAAE,2BAA2B,CAAC,IAAI,EAAE,GAAG,CAAC;iBAC5C;aACF;SACF,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,sBAAsB,CACpC,OAA2C,EAC3C,IAAsD,EACtD,mBAAyC,EACzC,IAAY;IAEZ,IAAI,iBAAiB,GAAG,EAAE,CAAC;IAC3B,IAAI,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,gBAAgB,EAAE,CAAC;QAC7C,iBAAiB,GAAG,yCAAyC,IAAI,GAAG,CAAC;IACvE,CAAC;SAAM,IAAI,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,YAAY,EAAE,CAAC;QAChD,iBAAiB,GAAG,+BAA+B,IAAI,GAAG,CAAC;IAC7D,CAAC;SAAM,IAAI,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,cAAc,EAAE,CAAC;QAClD,iBAAiB,GAAG,iCAAiC,IAAI,GAAG,CAAC;IAC/D,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,mBAAmB,EAAE,CAAC;QACtC,OAAO,CAAC,MAAM,CAAC;YACb,OAAO,EAAE,8BAA8B,GAAG,CAAC,IAAI,IAAI,iBAAiB,GAAG;YACvE,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK;YAC/B,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG;YAC3B,OAAO,EAAE;gBACP;oBACE,OAAO,EAAE,0BAA0B,GAAG,CAAC,IAAI,GAAG;oBAC9C,GAAG,EAAE,wBAAwB,CAAC,IAAI,EAAE,GAAG,CAAC;iBACzC;aACF;SACF,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,SAAgB,wBAAwB,CACtC,OAA2C,EAC3C,IAAsD,EACtD,aAAoC,EACpC,IAAY;IAEZ,IAAI,iBAAiB,GAAG,EAAE,CAAC;IAC3B,IAAI,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,gBAAgB,EAAE,CAAC;QAC7C,iBAAiB,GAAG,yCAAyC,IAAI,GAAG,CAAC;IACvE,CAAC;SAAM,IAAI,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,YAAY,EAAE,CAAC;QAChD,iBAAiB,GAAG,+BAA+B,IAAI,GAAG,CAAC;IAC7D,CAAC;SAAM,IAAI,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,cAAc,EAAE,CAAC;QAClD,iBAAiB,GAAG,iCAAiC,IAAI,GAAG,CAAC;IAC/D,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC;QAChC,OAAO,CAAC,MAAM,CAAC;YACb,OAAO,EAAE,uBAAuB,GAAG,CAAC,IAAI,IAAI,iBAAiB,GAAG;YAChE,UAAU,EAAE,GAAG,CAAC,QAAQ,CAAC,KAAK;YAC9B,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG;YAC1B,OAAO,EAAE;gBACP;oBACE,OAAO,EAAE,8BAA8B,GAAG,CAAC,IAAI,GAAG;oBAClD,GAAG,EAAE,2BAA2B,CAAC,IAAI,EAAE,GAAG,CAAC;iBAC5C;aACF;SACF,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAgB,sBAAsB,CACpC,mBAAoD,EACpD,cAAqC;IAErC,MAAM,kBAAkB,GAA0B,EAAE,CAAC;IAErD,KAAK,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;QACjC,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,8BAAS,CAAC,cAAc,EAAE,CAAC;YAChD,SAAS;QACX,CAAC;QAED,MAAM,iBAAiB,GAAG,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5D,IAAI,iBAAiB,IAAI,iBAAiB,CAAC,IAAI,EAAE,CAAC;YAChD,MAAM,SAAS,GAAG,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACvD,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,uBAAe,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;YACtF,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;gBACxC,SAAS;YACX,CAAC;YAED,IAAI,CAAC,IAAA,wBAAgB,EAAC,SAAS,EAAE,IAAA,yBAAiB,EAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBAC/D,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAED;;GAEG;AACH,SAAgB,oBAAoB,CAClC,OAA2C,EAC3C,gBAAuC,EACvC,mBAAoD;IAEpD,KAAK,MAAM,GAAG,IAAI,gBAAgB,EAAE,CAAC;QACnC,MAAM,QAAQ,GAAG,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,IAAI;YAAE,SAAS;QAE1C,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjD,MAAM,UAAU,GAAG,IAAA,yBAAiB,EAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAEhD,MAAM,WAAW,GAAG,+BAA+B,CACjD,YAAY,EACZ,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,EACxB,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CACvB,CAAC;QAEF,OAAO,CAAC,MAAM,CAAC;YACb,OAAO,EAAE,+BAA+B,GAAG,CAAC,IAAI,eAAe,YAAY,SAAS,UAAU,EAAE;YAChG,UAAU,EAAE,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK;YACpC,QAAQ,EAAE,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG;YAChC,OAAO,EAAE,WAAW;SACrB,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,+BAA+B,CAC7C,YAAoB,EACpB,aAAqB,EACrB,WAAmB;IAEnB,MAAM,YAAY,GAAG,IAAA,8BAAsB,EAAC,YAAY,CAAC,CAAC;IAC1D,MAAM,WAAW,GAAG,EAAE,CAAC;IAEvB,uFAAuF;IACvF,IAAI,YAAY,KAAK,EAAE,EAAE,CAAC;QACxB,WAAW,CAAC,IAAI,CAAC;YACf,OAAO,EAAE,+BAA+B,YAAY,SAAS,YAAY,EAAE;YAC3E,GAAG,EAAE,CAAC,KAAsB,EAAE,EAAE;gBAC9B,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;YACjE,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED,+CAA+C;IAC/C,WAAW,CAAC,IAAI,CAAC;QACf,OAAO,EAAE,cAAc;QACvB,GAAG,EAAE,CAAC,KAAsB,EAAE,EAAE;YAC9B,OAAO,KAAK,CAAC,MAAM,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;QAClD,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAS,SAAS,CAChB,IAAsD,EACtD,GAAwB;IAExB,OAAO,CACL,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAC9F,CAAC;AACJ,CAAC;AAED,SAAgB,YAAY,CAAC,IAAsB;IACjD,IAAI,IAAI,CAAC,cAAc,CAAC,KAAK,KAAK,OAAO,EAAE,CAAC;QAC1C,OAAO;IACT,CAAC;IAED,MAAM,iBAAiB,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,IAAI,MAAM,CAAC,EAAE,KAAK,CAAC;IAE7E,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAA,sBAAc,EAAC,iBAAiB,CAAC,EAAE,CAAC;QAC7D,OAAO;IACT,CAAC;IAED,OAAO,iBAAiB,CAAC,KAAK,CAAC;AACjC,CAAC;AAED,SAAgB,cAAc,CAAC,IAAmC;IAChE,IAAI,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,YAAY,EAAE,CAAC;QACzC,IAAI,CAAC,IAAA,sBAAc,EAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAClC,OAAO;QACT,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;IAC5B,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,cAAc,EAAE,CAAC;QAC3C,IAAI,CAAC,IAAA,sBAAc,EAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAClC,OAAO;QACT,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;IAC5B,CAAC;AACH,CAAC;AAEM,KAAK,UAAU,kBAAkB,CACtC,OAA2C,EAC3C,YAAoB;IAEpB,MAAM,aAAa,GAAG,OAAO,CAAC,gBAAgB,IAAI,CAAC,MAAM,OAAO,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;IAEjG,IAAI,CAAC,aAAa,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC;QAC1C,OAAO;IACT,CAAC;IAED,OAAO,IAAI,GAAG,CAAC,aAAa,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7E,CAAC;AAED,SAAgB,2BAA2B,CACzC,IAAsD,EACtD,GAAwB;IAExB,OAAO,CAAC,KAAsB,EAAE,EAAE;QAChC,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACnF,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/C,MAAM,cAAc,GAAG,OAAO,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACrD,IAAI,QAAQ,GAAG,cAAc;YAC3B,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,GAAG,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC;YAClD,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC;QAEvB,IAAI,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;YACzB,sDAAsD;YACtD,QAAQ,IAAI,CAAC,CAAC;QAChB,CAAC;QAED,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAClF,MAAM,kBAAkB,GAAG,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACxD,IAAI,kBAAkB,EAAE,CAAC;YACvB,OAAO,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACjF,CAAC;QACD,OAAO,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAClD,CAAC,CAAC;AACJ,CAAC;AAED,SAAgB,wBAAwB,CACtC,IAAsD,EACtD,GAAuB;IAEvB,OAAO,CAAC,KAAsB,EAAE,EAAE;QAChC,MAAM,UAAU,GAAG,KAAK,GAAG,CAAC,IAAI,KAAK,IAAA,8BAAsB,EAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QAExE,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,EAAE,UAAU,CAAC,CAAC;QACzD,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAChD,MAAM,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAE1F,MAAM,+BAA+B,GAAG,kBAAkB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC5E,IAAI,+BAA+B,EAAE,CAAC;YACpC,qIAAqI;YACrI,OAAO,KAAK,CAAC,OAAO,CAClB,OAAO,CAAC,QAAQ,CAAC,GAAG,EACpB,OAAO,CAAC,QAAQ,CAAC,GAAG,GAAG,+BAA+B,CAAC,CAAC,CAAC,CAAC,MAAM,EAChE,GAAG,UAAU,GAAG,CACjB,CAAC;QACJ,CAAC;QAED,OAAO,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IACxD,CAAC,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { UriString } from '../types';
|
|
2
|
+
import { LiquidHtmlNode } from '../types';
|
|
3
|
+
export type GetDocDefinitionForURI = (uri: UriString, category: 'blocks' | 'app/views/partials', name: string) => Promise<DocDefinition | undefined>;
|
|
4
|
+
export type DocDefinition = {
|
|
5
|
+
uri: UriString;
|
|
6
|
+
liquidDoc?: DocContent;
|
|
7
|
+
};
|
|
8
|
+
type DocContent = {
|
|
9
|
+
parameters?: LiquidDocParameter[];
|
|
10
|
+
examples?: LiquidDocExample[];
|
|
11
|
+
description?: LiquidDocDescription;
|
|
12
|
+
};
|
|
13
|
+
interface LiquidDocNode {
|
|
14
|
+
nodeType: 'param' | 'example' | 'description';
|
|
15
|
+
}
|
|
16
|
+
export interface LiquidDocParameter extends LiquidDocNode {
|
|
17
|
+
nodeType: 'param';
|
|
18
|
+
name: string;
|
|
19
|
+
description: string | null;
|
|
20
|
+
type: string | null;
|
|
21
|
+
required: boolean;
|
|
22
|
+
}
|
|
23
|
+
export interface LiquidDocExample extends LiquidDocNode {
|
|
24
|
+
content: string;
|
|
25
|
+
nodeType: 'example';
|
|
26
|
+
}
|
|
27
|
+
export interface LiquidDocDescription extends LiquidDocNode {
|
|
28
|
+
content: string;
|
|
29
|
+
nodeType: 'description';
|
|
30
|
+
}
|
|
31
|
+
export declare function hasLiquidDoc(partial: LiquidHtmlNode): Promise<boolean>;
|
|
32
|
+
export declare function extractDocDefinition(uri: UriString, ast: LiquidHtmlNode): Promise<DocDefinition>;
|
|
33
|
+
export {};
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.hasLiquidDoc = hasLiquidDoc;
|
|
4
|
+
exports.extractDocDefinition = extractDocDefinition;
|
|
5
|
+
const visitor_1 = require("../visitor");
|
|
6
|
+
async function hasLiquidDoc(partial) {
|
|
7
|
+
let foundDocTag = false;
|
|
8
|
+
await (0, visitor_1.visit)(partial, {
|
|
9
|
+
async LiquidRawTag(node) {
|
|
10
|
+
if (node.name === 'doc')
|
|
11
|
+
foundDocTag = true;
|
|
12
|
+
},
|
|
13
|
+
});
|
|
14
|
+
return foundDocTag;
|
|
15
|
+
}
|
|
16
|
+
async function extractDocDefinition(uri, ast) {
|
|
17
|
+
let hasDocTag = false;
|
|
18
|
+
const nodes = await (0, visitor_1.visit)(ast, {
|
|
19
|
+
async LiquidRawTag(node) {
|
|
20
|
+
if (node.name === 'doc')
|
|
21
|
+
hasDocTag = true;
|
|
22
|
+
return undefined;
|
|
23
|
+
},
|
|
24
|
+
async LiquidDocParamNode(node) {
|
|
25
|
+
return {
|
|
26
|
+
name: node.paramName.value,
|
|
27
|
+
description: node.paramDescription?.value ?? null,
|
|
28
|
+
type: node.paramType?.value ?? null,
|
|
29
|
+
required: node.required,
|
|
30
|
+
nodeType: 'param',
|
|
31
|
+
};
|
|
32
|
+
},
|
|
33
|
+
async LiquidDocExampleNode(node) {
|
|
34
|
+
return {
|
|
35
|
+
content: handleMultilineIndentation(node.content.value.trim()),
|
|
36
|
+
nodeType: 'example',
|
|
37
|
+
};
|
|
38
|
+
},
|
|
39
|
+
async LiquidDocDescriptionNode(node) {
|
|
40
|
+
return {
|
|
41
|
+
content: handleMultilineIndentation(node.content.value.trim()),
|
|
42
|
+
nodeType: 'description',
|
|
43
|
+
};
|
|
44
|
+
},
|
|
45
|
+
});
|
|
46
|
+
if (!hasDocTag)
|
|
47
|
+
return { uri };
|
|
48
|
+
const { parameters, examples, description } = nodes.reduce((acc, node) => {
|
|
49
|
+
if (node.nodeType === 'param') {
|
|
50
|
+
acc.parameters.push(node);
|
|
51
|
+
}
|
|
52
|
+
else if (node.nodeType === 'example') {
|
|
53
|
+
acc.examples.push(node);
|
|
54
|
+
}
|
|
55
|
+
else if (node.nodeType === 'description' && !acc.description) {
|
|
56
|
+
acc.description = node;
|
|
57
|
+
}
|
|
58
|
+
return acc;
|
|
59
|
+
}, {
|
|
60
|
+
parameters: [],
|
|
61
|
+
examples: [],
|
|
62
|
+
description: undefined,
|
|
63
|
+
});
|
|
64
|
+
return {
|
|
65
|
+
uri,
|
|
66
|
+
liquidDoc: {
|
|
67
|
+
...(parameters.length && { parameters }),
|
|
68
|
+
...(examples.length && { examples }),
|
|
69
|
+
...(description && { description }),
|
|
70
|
+
},
|
|
71
|
+
};
|
|
72
|
+
}
|
|
73
|
+
function handleMultilineIndentation(text) {
|
|
74
|
+
const lines = text.split('\n');
|
|
75
|
+
if (lines.length <= 1)
|
|
76
|
+
return text;
|
|
77
|
+
const nonEmptyLines = lines.slice(1).filter((line) => line.trim().length > 0);
|
|
78
|
+
const indentLengths = nonEmptyLines.map((line) => {
|
|
79
|
+
const match = line.match(/^\s*/);
|
|
80
|
+
return match ? match[0].length : 0;
|
|
81
|
+
});
|
|
82
|
+
if (indentLengths.length === 0)
|
|
83
|
+
return text;
|
|
84
|
+
const minIndent = Math.min(...indentLengths);
|
|
85
|
+
return [
|
|
86
|
+
lines[0],
|
|
87
|
+
...lines.slice(1).map((line) => {
|
|
88
|
+
if (line.trim().length === 0)
|
|
89
|
+
return line; // Skip empty lines
|
|
90
|
+
return line.slice(minIndent);
|
|
91
|
+
}),
|
|
92
|
+
].join('\n');
|
|
93
|
+
}
|
|
94
|
+
//# sourceMappingURL=liquidDoc.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"liquidDoc.js","sourceRoot":"","sources":["../../src/liquid-doc/liquidDoc.ts"],"names":[],"mappings":";;AAgDA,oCAQC;AAED,oDAgEC;AAzHD,wCAAmC;AA+C5B,KAAK,UAAU,YAAY,CAAC,OAAuB;IACxD,IAAI,WAAW,GAAG,KAAK,CAAC;IACxB,MAAM,IAAA,eAAK,EAAkC,OAAO,EAAE;QACpD,KAAK,CAAC,YAAY,CAAC,IAAI;YACrB,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK;gBAAE,WAAW,GAAG,IAAI,CAAC;QAC9C,CAAC;KACF,CAAC,CAAC;IACH,OAAO,WAAW,CAAC;AACrB,CAAC;AAEM,KAAK,UAAU,oBAAoB,CACxC,GAAc,EACd,GAAmB;IAEnB,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,MAAM,KAAK,GAAqE,MAAM,IAAA,eAAK,EAGzF,GAAG,EAAE;QACL,KAAK,CAAC,YAAY,CAAC,IAAI;YACrB,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK;gBAAE,SAAS,GAAG,IAAI,CAAC;YAC1C,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,CAAC,kBAAkB,CAAC,IAAwB;YAC/C,OAAO;gBACL,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK;gBAC1B,WAAW,EAAE,IAAI,CAAC,gBAAgB,EAAE,KAAK,IAAI,IAAI;gBACjD,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,IAAI,IAAI;gBACnC,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,QAAQ,EAAE,OAAO;aAClB,CAAC;QACJ,CAAC;QACD,KAAK,CAAC,oBAAoB,CAAC,IAA0B;YACnD,OAAO;gBACL,OAAO,EAAE,0BAA0B,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;gBAC9D,QAAQ,EAAE,SAAS;aACpB,CAAC;QACJ,CAAC;QACD,KAAK,CAAC,wBAAwB,CAAC,IAA8B;YAC3D,OAAO;gBACL,OAAO,EAAE,0BAA0B,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;gBAC9D,QAAQ,EAAE,aAAa;aACxB,CAAC;QACJ,CAAC;KACF,CAAC,CAAC;IAEH,IAAI,CAAC,SAAS;QAAE,OAAO,EAAE,GAAG,EAAE,CAAC;IAE/B,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC,MAAM,CACxD,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;QACZ,IAAI,IAAI,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;YAC9B,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAA0B,CAAC,CAAC;QAClD,CAAC;aAAM,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACvC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAwB,CAAC,CAAC;QAC9C,CAAC;aAAM,IAAI,IAAI,CAAC,QAAQ,KAAK,aAAa,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;YAC/D,GAAG,CAAC,WAAW,GAAG,IAA4B,CAAC;QACjD,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC,EACD;QACE,UAAU,EAAE,EAA0B;QACtC,QAAQ,EAAE,EAAwB;QAClC,WAAW,EAAE,SAA6C;KAC3D,CACF,CAAC;IAEF,OAAO;QACL,GAAG;QACH,SAAS,EAAE;YACT,GAAG,CAAC,UAAU,CAAC,MAAM,IAAI,EAAE,UAAU,EAAE,CAAC;YACxC,GAAG,CAAC,QAAQ,CAAC,MAAM,IAAI,EAAE,QAAQ,EAAE,CAAC;YACpC,GAAG,CAAC,WAAW,IAAI,EAAE,WAAW,EAAE,CAAC;SACpC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,0BAA0B,CAAC,IAAY;IAC9C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAE/B,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAEnC,MAAM,aAAa,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC9E,MAAM,aAAa,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACjC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAE5C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,CAAC;IAE7C,OAAO;QACL,KAAK,CAAC,CAAC,CAAC;QACR,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YAC7B,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC,CAAC,mBAAmB;YAC9D,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC/B,CAAC,CAAC;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC"}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { LiquidExpression } from '@platformos/liquid-html-parser';
|
|
2
|
+
import { ObjectEntry, UriString } from '../types';
|
|
3
|
+
/**
|
|
4
|
+
* The base set of supported param types for LiquidDoc.
|
|
5
|
+
*
|
|
6
|
+
* This is used in conjunction with objects defined in [liquid docs](https://shopify.dev/docs/api/liquid/objects)
|
|
7
|
+
* to determine ALL supported param types for LiquidDoc.
|
|
8
|
+
*
|
|
9
|
+
* References `getValidParamTypes`
|
|
10
|
+
*/
|
|
11
|
+
export declare enum BasicParamTypes {
|
|
12
|
+
String = "string",
|
|
13
|
+
Number = "number",
|
|
14
|
+
Boolean = "boolean",
|
|
15
|
+
Object = "object"
|
|
16
|
+
}
|
|
17
|
+
export declare enum SupportedDocTagTypes {
|
|
18
|
+
Param = "param",
|
|
19
|
+
Example = "example",
|
|
20
|
+
Description = "description"
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Provides a default completion value for an argument / parameter of a given type.
|
|
24
|
+
*/
|
|
25
|
+
export declare function getDefaultValueForType(type: string | null): "''" | "0" | "false" | "";
|
|
26
|
+
/**
|
|
27
|
+
* Casts the value of a LiquidNamedArgument to a string representing the type of the value.
|
|
28
|
+
*/
|
|
29
|
+
export declare function inferArgumentType(arg: LiquidExpression): BasicParamTypes;
|
|
30
|
+
/**
|
|
31
|
+
* Checks if the provided argument type is compatible with the expected type.
|
|
32
|
+
* Makes certain types more permissive:
|
|
33
|
+
* - Boolean accepts any value, since everything is truthy / falsy in Liquid
|
|
34
|
+
*/
|
|
35
|
+
export declare function isTypeCompatible(expectedType: string, actualType: BasicParamTypes): boolean;
|
|
36
|
+
/**
|
|
37
|
+
* Checks if the provided file path supports the LiquidDoc tag.
|
|
38
|
+
*/
|
|
39
|
+
export declare function filePathSupportsLiquidDoc(uri: UriString): boolean;
|
|
40
|
+
/**
|
|
41
|
+
* Dynamically generates a map of LiquidDoc param types using object entries from
|
|
42
|
+
* [liquid docs](https://shopify.dev/docs/api/liquid/objects).
|
|
43
|
+
*
|
|
44
|
+
* This is used in conjunction with the base set of supported param.
|
|
45
|
+
*
|
|
46
|
+
* References `BasicParamTypes`
|
|
47
|
+
*/
|
|
48
|
+
export declare function getValidParamTypes(objectEntries: ObjectEntry[]): Map<string, string | undefined>;
|
|
49
|
+
export declare function parseParamType(validParamTypes: Set<string>, value: string): [pseudoType: string, isArray: boolean] | undefined;
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.SupportedDocTagTypes = exports.BasicParamTypes = void 0;
|
|
4
|
+
exports.getDefaultValueForType = getDefaultValueForType;
|
|
5
|
+
exports.inferArgumentType = inferArgumentType;
|
|
6
|
+
exports.isTypeCompatible = isTypeCompatible;
|
|
7
|
+
exports.filePathSupportsLiquidDoc = filePathSupportsLiquidDoc;
|
|
8
|
+
exports.getValidParamTypes = getValidParamTypes;
|
|
9
|
+
exports.parseParamType = parseParamType;
|
|
10
|
+
const liquid_html_parser_1 = require("@platformos/liquid-html-parser");
|
|
11
|
+
const utils_1 = require("../utils");
|
|
12
|
+
const to_schema_1 = require("../to-schema");
|
|
13
|
+
const to_schema_2 = require("../to-schema");
|
|
14
|
+
/**
|
|
15
|
+
* The base set of supported param types for LiquidDoc.
|
|
16
|
+
*
|
|
17
|
+
* This is used in conjunction with objects defined in [liquid docs](https://shopify.dev/docs/api/liquid/objects)
|
|
18
|
+
* to determine ALL supported param types for LiquidDoc.
|
|
19
|
+
*
|
|
20
|
+
* References `getValidParamTypes`
|
|
21
|
+
*/
|
|
22
|
+
var BasicParamTypes;
|
|
23
|
+
(function (BasicParamTypes) {
|
|
24
|
+
BasicParamTypes["String"] = "string";
|
|
25
|
+
BasicParamTypes["Number"] = "number";
|
|
26
|
+
BasicParamTypes["Boolean"] = "boolean";
|
|
27
|
+
BasicParamTypes["Object"] = "object";
|
|
28
|
+
})(BasicParamTypes || (exports.BasicParamTypes = BasicParamTypes = {}));
|
|
29
|
+
var SupportedDocTagTypes;
|
|
30
|
+
(function (SupportedDocTagTypes) {
|
|
31
|
+
SupportedDocTagTypes["Param"] = "param";
|
|
32
|
+
SupportedDocTagTypes["Example"] = "example";
|
|
33
|
+
SupportedDocTagTypes["Description"] = "description";
|
|
34
|
+
})(SupportedDocTagTypes || (exports.SupportedDocTagTypes = SupportedDocTagTypes = {}));
|
|
35
|
+
/**
|
|
36
|
+
* Provides a default completion value for an argument / parameter of a given type.
|
|
37
|
+
*/
|
|
38
|
+
function getDefaultValueForType(type) {
|
|
39
|
+
switch (type?.toLowerCase()) {
|
|
40
|
+
case BasicParamTypes.String:
|
|
41
|
+
return "''";
|
|
42
|
+
case BasicParamTypes.Number:
|
|
43
|
+
return '0';
|
|
44
|
+
case BasicParamTypes.Boolean:
|
|
45
|
+
return 'false';
|
|
46
|
+
case BasicParamTypes.Object: // Objects don't have a sensible default value (maybe `theme`?)
|
|
47
|
+
default:
|
|
48
|
+
return '';
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Casts the value of a LiquidNamedArgument to a string representing the type of the value.
|
|
53
|
+
*/
|
|
54
|
+
function inferArgumentType(arg) {
|
|
55
|
+
switch (arg.type) {
|
|
56
|
+
case liquid_html_parser_1.NodeTypes.String:
|
|
57
|
+
return BasicParamTypes.String;
|
|
58
|
+
case liquid_html_parser_1.NodeTypes.Number:
|
|
59
|
+
return BasicParamTypes.Number;
|
|
60
|
+
case liquid_html_parser_1.NodeTypes.LiquidLiteral:
|
|
61
|
+
return BasicParamTypes.Boolean;
|
|
62
|
+
case liquid_html_parser_1.NodeTypes.Range:
|
|
63
|
+
case liquid_html_parser_1.NodeTypes.VariableLookup:
|
|
64
|
+
return BasicParamTypes.Object;
|
|
65
|
+
default:
|
|
66
|
+
// This ensures that we have a case for every possible type for arg.value
|
|
67
|
+
return (0, utils_1.assertNever)(arg);
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Checks if the provided argument type is compatible with the expected type.
|
|
72
|
+
* Makes certain types more permissive:
|
|
73
|
+
* - Boolean accepts any value, since everything is truthy / falsy in Liquid
|
|
74
|
+
*/
|
|
75
|
+
function isTypeCompatible(expectedType, actualType) {
|
|
76
|
+
const normalizedExpectedType = expectedType.toLowerCase();
|
|
77
|
+
if (normalizedExpectedType === BasicParamTypes.Boolean) {
|
|
78
|
+
return true;
|
|
79
|
+
}
|
|
80
|
+
return normalizedExpectedType === actualType;
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Checks if the provided file path supports the LiquidDoc tag.
|
|
84
|
+
*/
|
|
85
|
+
function filePathSupportsLiquidDoc(uri) {
|
|
86
|
+
return (0, to_schema_1.isSnippet)(uri) || (0, to_schema_2.isBlock)(uri);
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* Dynamically generates a map of LiquidDoc param types using object entries from
|
|
90
|
+
* [liquid docs](https://shopify.dev/docs/api/liquid/objects).
|
|
91
|
+
*
|
|
92
|
+
* This is used in conjunction with the base set of supported param.
|
|
93
|
+
*
|
|
94
|
+
* References `BasicParamTypes`
|
|
95
|
+
*/
|
|
96
|
+
function getValidParamTypes(objectEntries) {
|
|
97
|
+
const paramTypes = new Map([
|
|
98
|
+
[BasicParamTypes.String, undefined],
|
|
99
|
+
[BasicParamTypes.Number, undefined],
|
|
100
|
+
[BasicParamTypes.Boolean, undefined],
|
|
101
|
+
[
|
|
102
|
+
BasicParamTypes.Object,
|
|
103
|
+
'A generic type used to represent any liquid object or primitive value.',
|
|
104
|
+
],
|
|
105
|
+
]);
|
|
106
|
+
objectEntries.forEach((obj) => paramTypes.set(obj.name, obj.summary || obj.description));
|
|
107
|
+
return paramTypes;
|
|
108
|
+
}
|
|
109
|
+
function parseParamType(validParamTypes, value) {
|
|
110
|
+
const paramTypeMatch = value.match(/^([a-z_]+)(\[\])?$/);
|
|
111
|
+
if (!paramTypeMatch)
|
|
112
|
+
return undefined;
|
|
113
|
+
const extractedParamType = paramTypeMatch[1];
|
|
114
|
+
const isArrayType = !!paramTypeMatch[2];
|
|
115
|
+
if (!validParamTypes.has(extractedParamType))
|
|
116
|
+
return undefined;
|
|
117
|
+
return [extractedParamType, isArrayType];
|
|
118
|
+
}
|
|
119
|
+
//# sourceMappingURL=utils.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/liquid-doc/utils.ts"],"names":[],"mappings":";;;AA8BA,wDAYC;AAKD,8CAeC;AAOD,4CAQC;AAKD,8DAEC;AAUD,gDAcC;AAED,wCAcC;AA5HD,uEAA6E;AAC7E,oCAAuC;AACvC,4CAAyC;AACzC,4CAAuC;AAGvC;;;;;;;GAOG;AACH,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,oCAAiB,CAAA;IACjB,oCAAiB,CAAA;IACjB,sCAAmB,CAAA;IACnB,oCAAiB,CAAA;AACnB,CAAC,EALW,eAAe,+BAAf,eAAe,QAK1B;AAED,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC9B,uCAAe,CAAA;IACf,2CAAmB,CAAA;IACnB,mDAA2B,CAAA;AAC7B,CAAC,EAJW,oBAAoB,oCAApB,oBAAoB,QAI/B;AAED;;GAEG;AACH,SAAgB,sBAAsB,CAAC,IAAmB;IACxD,QAAQ,IAAI,EAAE,WAAW,EAAE,EAAE,CAAC;QAC5B,KAAK,eAAe,CAAC,MAAM;YACzB,OAAO,IAAI,CAAC;QACd,KAAK,eAAe,CAAC,MAAM;YACzB,OAAO,GAAG,CAAC;QACb,KAAK,eAAe,CAAC,OAAO;YAC1B,OAAO,OAAO,CAAC;QACjB,KAAK,eAAe,CAAC,MAAM,CAAC,CAAC,+DAA+D;QAC5F;YACE,OAAO,EAAE,CAAC;IACd,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,iBAAiB,CAAC,GAAqB;IACrD,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;QACjB,KAAK,8BAAS,CAAC,MAAM;YACnB,OAAO,eAAe,CAAC,MAAM,CAAC;QAChC,KAAK,8BAAS,CAAC,MAAM;YACnB,OAAO,eAAe,CAAC,MAAM,CAAC;QAChC,KAAK,8BAAS,CAAC,aAAa;YAC1B,OAAO,eAAe,CAAC,OAAO,CAAC;QACjC,KAAK,8BAAS,CAAC,KAAK,CAAC;QACrB,KAAK,8BAAS,CAAC,cAAc;YAC3B,OAAO,eAAe,CAAC,MAAM,CAAC;QAChC;YACE,yEAAyE;YACzE,OAAO,IAAA,mBAAW,EAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,YAAoB,EAAE,UAA2B;IAChF,MAAM,sBAAsB,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC;IAE1D,IAAI,sBAAsB,KAAK,eAAe,CAAC,OAAO,EAAE,CAAC;QACvD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,sBAAsB,KAAK,UAAU,CAAC;AAC/C,CAAC;AAED;;GAEG;AACH,SAAgB,yBAAyB,CAAC,GAAc;IACtD,OAAO,IAAA,qBAAS,EAAC,GAAG,CAAC,IAAI,IAAA,mBAAO,EAAC,GAAG,CAAC,CAAC;AACxC,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAAC,aAA4B;IAC7D,MAAM,UAAU,GAAoC,IAAI,GAAG,CAAC;QAC1D,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC;QACnC,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC;QACnC,CAAC,eAAe,CAAC,OAAO,EAAE,SAAS,CAAC;QACpC;YACE,eAAe,CAAC,MAAM;YACtB,wEAAwE;SACzE;KACF,CAAC,CAAC;IAEH,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;IAEzF,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAgB,cAAc,CAC5B,eAA4B,EAC5B,KAAa;IAEb,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAEzD,IAAI,CAAC,cAAc;QAAE,OAAO,SAAS,CAAC;IAEtC,MAAM,kBAAkB,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;IAC7C,MAAM,WAAW,GAAG,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAExC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,kBAAkB,CAAC;QAAE,OAAO,SAAS,CAAC;IAE/D,OAAO,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAC;AAC3C,CAAC"}
|
package/dist/path.d.ts
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { RelativePath, UriString } from './types';
|
|
2
|
+
import { URI, Utils } from 'vscode-uri';
|
|
3
|
+
export { URI, Utils };
|
|
4
|
+
export declare function relative(uri: UriString | URI, rootUri: UriString): RelativePath;
|
|
5
|
+
export declare function join(rootUri: UriString | URI, ...paths: string[]): string;
|
|
6
|
+
export declare function resolve(uri: UriString | URI, path: string): string;
|
|
7
|
+
export declare function normalize(uri: UriString | URI): UriString;
|
|
8
|
+
export declare function dirname(uri: UriString | URI): UriString;
|
|
9
|
+
export declare function basename(uri: UriString | URI, ext?: string): string;
|
|
10
|
+
export declare function fsPath(uri: UriString | URI): string;
|
package/dist/path.js
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Utils = exports.URI = void 0;
|
|
4
|
+
exports.relative = relative;
|
|
5
|
+
exports.join = join;
|
|
6
|
+
exports.resolve = resolve;
|
|
7
|
+
exports.normalize = normalize;
|
|
8
|
+
exports.dirname = dirname;
|
|
9
|
+
exports.basename = basename;
|
|
10
|
+
exports.fsPath = fsPath;
|
|
11
|
+
const vscode_uri_1 = require("vscode-uri");
|
|
12
|
+
Object.defineProperty(exports, "URI", { enumerable: true, get: function () { return vscode_uri_1.URI; } });
|
|
13
|
+
Object.defineProperty(exports, "Utils", { enumerable: true, get: function () { return vscode_uri_1.Utils; } });
|
|
14
|
+
function relative(uri, rootUri) {
|
|
15
|
+
return normalize(uri)
|
|
16
|
+
.replace(rootUri, '')
|
|
17
|
+
.replace(/\\\\/g, '/') // We expect forward slash paths (windows path get normalized)
|
|
18
|
+
.replace(/^\/+/, '');
|
|
19
|
+
}
|
|
20
|
+
function join(rootUri, ...paths) {
|
|
21
|
+
return normalize(vscode_uri_1.Utils.joinPath(asUri(rootUri), ...paths));
|
|
22
|
+
}
|
|
23
|
+
function resolve(uri, path) {
|
|
24
|
+
return normalize(vscode_uri_1.Utils.resolvePath(asUri(uri), path));
|
|
25
|
+
}
|
|
26
|
+
function normalize(uri) {
|
|
27
|
+
const normalized = asUri(uri).toString(true);
|
|
28
|
+
// On Windows machines, paths use backslash ('\') as separator
|
|
29
|
+
// This causes issues since backslashes in glob patterns are treated as escape characters
|
|
30
|
+
// and in various URI contexts, forward slashes are expected
|
|
31
|
+
// We replace all backslashes with forward slashes for cross-platform consistency
|
|
32
|
+
return normalized.replace(/\\/g, '/');
|
|
33
|
+
}
|
|
34
|
+
function dirname(uri) {
|
|
35
|
+
return normalize(vscode_uri_1.Utils.dirname(asUri(uri)));
|
|
36
|
+
}
|
|
37
|
+
function basename(uri, ext) {
|
|
38
|
+
const base = vscode_uri_1.Utils.basename(asUri(uri));
|
|
39
|
+
return ext ? base.replace(new RegExp(`${ext.replace(/\./g, '\\.')}$`), '') : base;
|
|
40
|
+
}
|
|
41
|
+
function fsPath(uri) {
|
|
42
|
+
return asUri(uri).fsPath;
|
|
43
|
+
}
|
|
44
|
+
function asUri(uri) {
|
|
45
|
+
return vscode_uri_1.URI.isUri(uri) ? uri : vscode_uri_1.URI.parse(uri);
|
|
46
|
+
}
|
|
47
|
+
//# sourceMappingURL=path.js.map
|
package/dist/path.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"path.js","sourceRoot":"","sources":["../src/path.ts"],"names":[],"mappings":";;;AAKA,4BAKC;AAED,oBAEC;AAED,0BAEC;AAED,8BAOC;AAED,0BAEC;AAED,4BAGC;AAED,wBAEC;AAvCD,2CAAwC;AAE/B,oFAFA,gBAAG,OAEA;AAAE,sFAFA,kBAAK,OAEA;AAEnB,SAAgB,QAAQ,CAAC,GAAoB,EAAE,OAAkB;IAC/D,OAAO,SAAS,CAAC,GAAG,CAAC;SAClB,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;SACpB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,8DAA8D;SACpF,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACzB,CAAC;AAED,SAAgB,IAAI,CAAC,OAAwB,EAAE,GAAG,KAAe;IAC/D,OAAO,SAAS,CAAC,kBAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;AAC7D,CAAC;AAED,SAAgB,OAAO,CAAC,GAAoB,EAAE,IAAY;IACxD,OAAO,SAAS,CAAC,kBAAK,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;AACxD,CAAC;AAED,SAAgB,SAAS,CAAC,GAAoB;IAC5C,MAAM,UAAU,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC7C,8DAA8D;IAC9D,yFAAyF;IACzF,4DAA4D;IAC5D,iFAAiF;IACjF,OAAO,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACxC,CAAC;AAED,SAAgB,OAAO,CAAC,GAAoB;IAC1C,OAAO,SAAS,CAAC,kBAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAC9C,CAAC;AAED,SAAgB,QAAQ,CAAC,GAAoB,EAAE,GAAY;IACzD,MAAM,IAAI,GAAG,kBAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IACxC,OAAO,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACpF,CAAC;AAED,SAAgB,MAAM,CAAC,GAAoB;IACzC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;AAC3B,CAAC;AAED,SAAS,KAAK,CAAC,GAAoB;IACjC,OAAO,gBAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,gBAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC/C,CAAC"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.CLOSEST_ARGUMENT = exports.REQUIRED_CONTENT_FOR_ARGUMENTS = exports.RESERVED_CONTENT_FOR_ARGUMENTS = void 0;
|
|
4
|
+
exports.RESERVED_CONTENT_FOR_ARGUMENTS = [
|
|
5
|
+
'attributes',
|
|
6
|
+
'block',
|
|
7
|
+
'blocks',
|
|
8
|
+
'class',
|
|
9
|
+
'context',
|
|
10
|
+
'inherit',
|
|
11
|
+
'resource',
|
|
12
|
+
'resources',
|
|
13
|
+
'schema',
|
|
14
|
+
'section',
|
|
15
|
+
'sections',
|
|
16
|
+
'settings',
|
|
17
|
+
'snippet',
|
|
18
|
+
'snippets',
|
|
19
|
+
'src',
|
|
20
|
+
'style',
|
|
21
|
+
'styles',
|
|
22
|
+
'template',
|
|
23
|
+
'templates',
|
|
24
|
+
];
|
|
25
|
+
exports.REQUIRED_CONTENT_FOR_ARGUMENTS = ['id', 'type'];
|
|
26
|
+
exports.CLOSEST_ARGUMENT = 'closest.';
|
|
27
|
+
//# sourceMappingURL=content-for.js.map
|