@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,184 @@
|
|
|
1
|
+
import { expect, describe, it, afterEach, vi } from 'vitest';
|
|
2
|
+
import { AssetSizeJavaScript } from '.';
|
|
3
|
+
import { check, MockTheme } from '../../test';
|
|
4
|
+
import { SchemaProp } from '../../types';
|
|
5
|
+
import { hasRemoteAssetSizeExceededThreshold } from '../../utils/file-utils';
|
|
6
|
+
|
|
7
|
+
vi.mock('../../utils/file-utils', async (importOriginal) => {
|
|
8
|
+
const actual: any = await importOriginal();
|
|
9
|
+
return {
|
|
10
|
+
...actual,
|
|
11
|
+
hasRemoteAssetSizeExceededThreshold: vi.fn(),
|
|
12
|
+
};
|
|
13
|
+
});
|
|
14
|
+
|
|
15
|
+
describe('Module: AssetSizeJavaScript', () => {
|
|
16
|
+
const theme: MockTheme = {
|
|
17
|
+
'assets/theme.js': "console.log('hello world'); console.log('Oh. Hi Mark!')",
|
|
18
|
+
'templates/index.liquid': `
|
|
19
|
+
<html>
|
|
20
|
+
<head>
|
|
21
|
+
<script src="{{ 'theme.js' | asset_url }}" defer></script>
|
|
22
|
+
</head>
|
|
23
|
+
</html>
|
|
24
|
+
`,
|
|
25
|
+
};
|
|
26
|
+
|
|
27
|
+
const httpTest: MockTheme = {
|
|
28
|
+
'templates/index.liquid': `
|
|
29
|
+
<html>
|
|
30
|
+
<head>
|
|
31
|
+
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/js/bootstrap.min.js" defer></script>
|
|
32
|
+
</head>
|
|
33
|
+
</html>
|
|
34
|
+
`,
|
|
35
|
+
};
|
|
36
|
+
|
|
37
|
+
afterEach(() => {
|
|
38
|
+
vi.clearAllMocks();
|
|
39
|
+
});
|
|
40
|
+
|
|
41
|
+
it('should not find file size for invalid URLs', async () => {
|
|
42
|
+
const invalidUrls = [
|
|
43
|
+
'https://{{ settings.url }}',
|
|
44
|
+
"{{ 'this_file_does_not_exist.js' | asset_url }}",
|
|
45
|
+
'{% if on_product %}https://hello.world{% else %}https://hi.world{% endif %}',
|
|
46
|
+
];
|
|
47
|
+
|
|
48
|
+
for (const url of invalidUrls) {
|
|
49
|
+
const offenses = await check(
|
|
50
|
+
{ 'templates/index.liquid': `<script src="${url}" defer></script>` },
|
|
51
|
+
[AssetSizeJavaScript],
|
|
52
|
+
);
|
|
53
|
+
expect(offenses).toHaveLength(0);
|
|
54
|
+
}
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
it('should report a warning when the JavaScript http request exceeds the threshold', async () => {
|
|
58
|
+
vi.mocked(hasRemoteAssetSizeExceededThreshold).mockReturnValue(Promise.resolve(true));
|
|
59
|
+
const offenses = await check(
|
|
60
|
+
httpTest,
|
|
61
|
+
[AssetSizeJavaScript],
|
|
62
|
+
{},
|
|
63
|
+
{
|
|
64
|
+
AssetSizeJavaScript: {
|
|
65
|
+
enabled: true,
|
|
66
|
+
thresholdInBytes: 1,
|
|
67
|
+
},
|
|
68
|
+
},
|
|
69
|
+
);
|
|
70
|
+
|
|
71
|
+
expect(offenses).toHaveLength(1);
|
|
72
|
+
expect(offenses[0]).toMatchObject({
|
|
73
|
+
message:
|
|
74
|
+
'JavaScript on every page load exceeds compressed size threshold (1 Bytes), consider using the import on interaction pattern.',
|
|
75
|
+
uri: 'file:///templates/index.liquid',
|
|
76
|
+
start: { index: 52 },
|
|
77
|
+
end: { index: 121 },
|
|
78
|
+
});
|
|
79
|
+
});
|
|
80
|
+
|
|
81
|
+
it('should not report any offenses if JavaScript is smaller than threshold', async () => {
|
|
82
|
+
const offenses = await check(theme, [AssetSizeJavaScript]);
|
|
83
|
+
|
|
84
|
+
expect(offenses).toHaveLength(0);
|
|
85
|
+
});
|
|
86
|
+
|
|
87
|
+
it('should report an offense if JavaScript is larger than threshold', async () => {
|
|
88
|
+
const offenses = await check(
|
|
89
|
+
theme,
|
|
90
|
+
[AssetSizeJavaScript],
|
|
91
|
+
{},
|
|
92
|
+
{
|
|
93
|
+
AssetSizeJavaScript: {
|
|
94
|
+
enabled: true,
|
|
95
|
+
thresholdInBytes: 2,
|
|
96
|
+
},
|
|
97
|
+
},
|
|
98
|
+
);
|
|
99
|
+
|
|
100
|
+
expect(offenses).toHaveLength(1);
|
|
101
|
+
expect(offenses[0]).toMatchObject({
|
|
102
|
+
message:
|
|
103
|
+
'JavaScript on every page load exceeds compressed size threshold (2 Bytes), consider using the import on interaction pattern.',
|
|
104
|
+
uri: 'file:///templates/index.liquid',
|
|
105
|
+
start: { index: 52 },
|
|
106
|
+
end: { index: 80 },
|
|
107
|
+
});
|
|
108
|
+
});
|
|
109
|
+
|
|
110
|
+
it('should not report any offenses for inline JavaScript', async () => {
|
|
111
|
+
const inlineTheme: MockTheme = {
|
|
112
|
+
'templates/index.liquid': `
|
|
113
|
+
<html>
|
|
114
|
+
<head>
|
|
115
|
+
<script>
|
|
116
|
+
console.log('hello world');
|
|
117
|
+
</script>
|
|
118
|
+
</head>
|
|
119
|
+
</html>
|
|
120
|
+
`,
|
|
121
|
+
};
|
|
122
|
+
|
|
123
|
+
const offenses = await check(inlineTheme, [AssetSizeJavaScript]);
|
|
124
|
+
|
|
125
|
+
expect(offenses).toHaveLength(0);
|
|
126
|
+
});
|
|
127
|
+
|
|
128
|
+
it('should report an offense if JS is larger than threshold', async () => {
|
|
129
|
+
const extensionFiles: MockTheme = {
|
|
130
|
+
'assets/theme.js': 'console.log("hello world");',
|
|
131
|
+
'templates/index.liquid': `
|
|
132
|
+
<html>
|
|
133
|
+
<head>
|
|
134
|
+
{{ 'theme.js' | asset_url | script_tag }}
|
|
135
|
+
{{ "https://example.com" | script_tag }}
|
|
136
|
+
</head>
|
|
137
|
+
</html>
|
|
138
|
+
`,
|
|
139
|
+
};
|
|
140
|
+
|
|
141
|
+
const offenses = await check(
|
|
142
|
+
extensionFiles,
|
|
143
|
+
[AssetSizeJavaScript],
|
|
144
|
+
{},
|
|
145
|
+
{
|
|
146
|
+
AssetSizeJavaScript: {
|
|
147
|
+
enabled: true,
|
|
148
|
+
thresholdInBytes: 2,
|
|
149
|
+
},
|
|
150
|
+
},
|
|
151
|
+
);
|
|
152
|
+
|
|
153
|
+
expect(offenses).toHaveLength(2);
|
|
154
|
+
expect(offenses[0]).toMatchObject({
|
|
155
|
+
message:
|
|
156
|
+
'JavaScript on every page load exceeds compressed size threshold (2 Bytes), consider using the import on interaction pattern.',
|
|
157
|
+
uri: 'file:///templates/index.liquid',
|
|
158
|
+
start: { index: 48 },
|
|
159
|
+
end: { index: 84 },
|
|
160
|
+
});
|
|
161
|
+
expect(offenses[1]).toMatchObject({
|
|
162
|
+
message:
|
|
163
|
+
'JavaScript on every page load exceeds compressed size threshold (2 Bytes), consider using the import on interaction pattern.',
|
|
164
|
+
uri: 'file:///templates/index.liquid',
|
|
165
|
+
start: { index: 102 },
|
|
166
|
+
end: { index: 123 },
|
|
167
|
+
});
|
|
168
|
+
});
|
|
169
|
+
|
|
170
|
+
it('should not report any offenses if there is no javascript', async () => {
|
|
171
|
+
const extensionFiles: MockTheme = {
|
|
172
|
+
'templates/index.liquid': `
|
|
173
|
+
<html>
|
|
174
|
+
<head>
|
|
175
|
+
</head>
|
|
176
|
+
</html>
|
|
177
|
+
`,
|
|
178
|
+
};
|
|
179
|
+
|
|
180
|
+
const offenses = await check(extensionFiles, [AssetSizeJavaScript]);
|
|
181
|
+
|
|
182
|
+
expect(offenses).toHaveLength(0);
|
|
183
|
+
});
|
|
184
|
+
});
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
import {
|
|
2
|
+
LiquidString,
|
|
3
|
+
LiquidVariable,
|
|
4
|
+
LiquidVariableOutput,
|
|
5
|
+
NodeTypes,
|
|
6
|
+
TextNode,
|
|
7
|
+
} from '@platformos/liquid-html-parser';
|
|
8
|
+
import {
|
|
9
|
+
LiquidCheckDefinition,
|
|
10
|
+
LiquidHtmlNode,
|
|
11
|
+
SchemaProp,
|
|
12
|
+
Severity,
|
|
13
|
+
SourceCodeType,
|
|
14
|
+
} from '../../types';
|
|
15
|
+
import { last } from '../../utils';
|
|
16
|
+
import {
|
|
17
|
+
hasRemoteAssetSizeExceededThreshold,
|
|
18
|
+
hasLocalAssetSizeExceededThreshold,
|
|
19
|
+
} from '../../utils/file-utils';
|
|
20
|
+
import { ValuedHtmlAttribute, isAttr, isNodeOfType, isValuedHtmlAttribute } from '../utils';
|
|
21
|
+
|
|
22
|
+
const schema = {
|
|
23
|
+
thresholdInBytes: SchemaProp.number(10000),
|
|
24
|
+
};
|
|
25
|
+
|
|
26
|
+
function isTextNode(node: LiquidHtmlNode): node is TextNode {
|
|
27
|
+
return node.type === NodeTypes.TextNode;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
function isLiquidVariableOutput(node: LiquidHtmlNode): node is LiquidVariableOutput {
|
|
31
|
+
return node.type === NodeTypes.LiquidVariableOutput;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
function isLiquidVariable(node: LiquidHtmlNode | string): node is LiquidVariable {
|
|
35
|
+
return typeof node !== 'string' && node.type === NodeTypes.LiquidVariable;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
function isString(node: LiquidHtmlNode): node is LiquidString {
|
|
39
|
+
return node.type === NodeTypes.String;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export const AssetSizeJavaScript: LiquidCheckDefinition<typeof schema> = {
|
|
43
|
+
meta: {
|
|
44
|
+
code: 'AssetSizeJavaScript',
|
|
45
|
+
name: 'Prevent Large JavaScript bundles',
|
|
46
|
+
docs: {
|
|
47
|
+
description: 'This check is aimed at preventing large JavaScript bundles for speed.',
|
|
48
|
+
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/asset-size-javascript',
|
|
49
|
+
recommended: false,
|
|
50
|
+
},
|
|
51
|
+
type: SourceCodeType.LiquidHtml,
|
|
52
|
+
severity: Severity.ERROR,
|
|
53
|
+
schema,
|
|
54
|
+
targets: [],
|
|
55
|
+
},
|
|
56
|
+
|
|
57
|
+
create(context) {
|
|
58
|
+
if (!context.fileSize) {
|
|
59
|
+
return {};
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
const thresholdInBytes = context.settings.thresholdInBytes;
|
|
63
|
+
|
|
64
|
+
async function checkRemoteAssetSize(url: string, position: { start: number; end: number }) {
|
|
65
|
+
if (await hasRemoteAssetSizeExceededThreshold(url, thresholdInBytes)) {
|
|
66
|
+
context.report({
|
|
67
|
+
message: `JavaScript on every page load exceeds compressed size threshold (${thresholdInBytes} Bytes), consider using the import on interaction pattern.`,
|
|
68
|
+
startIndex: position.start,
|
|
69
|
+
endIndex: position.end,
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
async function checkThemeAssetSize(srcValue: string, position: { start: number; end: number }) {
|
|
75
|
+
if (
|
|
76
|
+
await hasLocalAssetSizeExceededThreshold(context, `assets/${srcValue}`, thresholdInBytes)
|
|
77
|
+
) {
|
|
78
|
+
context.report({
|
|
79
|
+
message: `JavaScript on every page load exceeds compressed size threshold (${thresholdInBytes} Bytes), consider using the import on interaction pattern.`,
|
|
80
|
+
startIndex: position.start,
|
|
81
|
+
endIndex: position.end,
|
|
82
|
+
});
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
return {
|
|
87
|
+
async HtmlRawNode(node) {
|
|
88
|
+
if (node.name !== 'script') return;
|
|
89
|
+
|
|
90
|
+
const src: ValuedHtmlAttribute | undefined = node.attributes
|
|
91
|
+
.filter(isValuedHtmlAttribute)
|
|
92
|
+
.find((attr) => isAttr(attr, 'src'));
|
|
93
|
+
if (!src) return;
|
|
94
|
+
if (src.value.length !== 1) return;
|
|
95
|
+
|
|
96
|
+
if (isTextNode(src.value[0]) && /(https?:)?\/\//.test(src.value[0].value)) {
|
|
97
|
+
const url = src.value[0].value;
|
|
98
|
+
await checkRemoteAssetSize(url, src.attributePosition);
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
if (
|
|
102
|
+
isLiquidVariableOutput(src.value[0]) &&
|
|
103
|
+
isLiquidVariable(src.value[0].markup) &&
|
|
104
|
+
isString(src.value[0].markup.expression) &&
|
|
105
|
+
src.value[0].markup.filters.length === 1 &&
|
|
106
|
+
src.value[0].markup.filters[0].name === 'asset_url'
|
|
107
|
+
) {
|
|
108
|
+
const assetName = src.value[0].markup.expression.value;
|
|
109
|
+
await checkThemeAssetSize(assetName, src.attributePosition);
|
|
110
|
+
}
|
|
111
|
+
},
|
|
112
|
+
|
|
113
|
+
async LiquidFilter(node, ancestors) {
|
|
114
|
+
if (node.name !== 'script_tag') return;
|
|
115
|
+
|
|
116
|
+
const liquidVariableParent = last(ancestors);
|
|
117
|
+
|
|
118
|
+
if (!liquidVariableParent || !isNodeOfType(NodeTypes.LiquidVariable, liquidVariableParent))
|
|
119
|
+
return;
|
|
120
|
+
|
|
121
|
+
if (liquidVariableParent.expression.type !== NodeTypes.String) return;
|
|
122
|
+
|
|
123
|
+
if (
|
|
124
|
+
liquidVariableParent.expression.value[0].length == 1 &&
|
|
125
|
+
liquidVariableParent.filters.length == 1 &&
|
|
126
|
+
/(https?:)?\/\//.test(liquidVariableParent.expression.value)
|
|
127
|
+
) {
|
|
128
|
+
const url = liquidVariableParent.expression.value;
|
|
129
|
+
await checkRemoteAssetSize(url, liquidVariableParent.expression.position);
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
if (
|
|
133
|
+
liquidVariableParent.expression.value[0].length == 1 &&
|
|
134
|
+
liquidVariableParent.filters.length == 2 &&
|
|
135
|
+
liquidVariableParent.filters[0].name === 'asset_url' &&
|
|
136
|
+
liquidVariableParent.filters[1].name === 'script_tag'
|
|
137
|
+
) {
|
|
138
|
+
const js = liquidVariableParent.expression.value;
|
|
139
|
+
await checkThemeAssetSize(js, liquidVariableParent.position);
|
|
140
|
+
}
|
|
141
|
+
},
|
|
142
|
+
};
|
|
143
|
+
},
|
|
144
|
+
};
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
import { expect, describe, it } from 'vitest';
|
|
2
|
+
import { highlightedOffenses, runLiquidCheck } from '../../test';
|
|
3
|
+
import { BlockIdUsage } from './index';
|
|
4
|
+
|
|
5
|
+
describe('Module: ContentForHeaderModification', () => {
|
|
6
|
+
it('reports offense with the use of block.id in an if liquid tag', async () => {
|
|
7
|
+
const sourceCode = `
|
|
8
|
+
{% if block.id == '123' %}
|
|
9
|
+
No bueno
|
|
10
|
+
{% endif %}
|
|
11
|
+
`;
|
|
12
|
+
|
|
13
|
+
const offenses = await runLiquidCheck(BlockIdUsage, sourceCode);
|
|
14
|
+
expect(offenses).toHaveLength(1);
|
|
15
|
+
expect(offenses[0].message).toEqual(
|
|
16
|
+
'The ID is dynamically generated by Shopify and is subject to change. You should avoid relying on a literal value of this ID.',
|
|
17
|
+
);
|
|
18
|
+
|
|
19
|
+
const highlights = highlightedOffenses({ 'file.liquid': sourceCode }, offenses);
|
|
20
|
+
expect(highlights).toEqual(["block.id == '123'"]);
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
it('reports offense with the use of block.id in an elseif liquid tag', async () => {
|
|
24
|
+
const sourceCode = `
|
|
25
|
+
{% if potato == '123' %}
|
|
26
|
+
No bueno
|
|
27
|
+
{% elsif block.id == '123' %}
|
|
28
|
+
No bueno
|
|
29
|
+
{% endif %}
|
|
30
|
+
`;
|
|
31
|
+
|
|
32
|
+
const offenses = await runLiquidCheck(BlockIdUsage, sourceCode);
|
|
33
|
+
expect(offenses).toHaveLength(1);
|
|
34
|
+
expect(offenses[0].message).toEqual(
|
|
35
|
+
'The ID is dynamically generated by Shopify and is subject to change. You should avoid relying on a literal value of this ID.',
|
|
36
|
+
);
|
|
37
|
+
|
|
38
|
+
const highlights = highlightedOffenses({ 'file.liquid': sourceCode }, offenses);
|
|
39
|
+
expect(highlights).toEqual(["block.id == '123'"]);
|
|
40
|
+
});
|
|
41
|
+
|
|
42
|
+
it('reports offense with the use of block.id in an unless liquid tag', async () => {
|
|
43
|
+
const sourceCode = `
|
|
44
|
+
{% unless block.id == '123' %}
|
|
45
|
+
No bueno
|
|
46
|
+
{% endunless %}
|
|
47
|
+
`;
|
|
48
|
+
|
|
49
|
+
const offenses = await runLiquidCheck(BlockIdUsage, sourceCode);
|
|
50
|
+
expect(offenses).toHaveLength(1);
|
|
51
|
+
expect(offenses[0].message).toEqual(
|
|
52
|
+
'The ID is dynamically generated by Shopify and is subject to change. You should avoid relying on a literal value of this ID.',
|
|
53
|
+
);
|
|
54
|
+
|
|
55
|
+
const highlights = highlightedOffenses({ 'file.liquid': sourceCode }, offenses);
|
|
56
|
+
expect(highlights).toEqual(["block.id == '123'"]);
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
it('reports offense with the use of block.id in a case liquid tag', async () => {
|
|
60
|
+
const sourceCode = `
|
|
61
|
+
{% case block.id %}
|
|
62
|
+
{% when '123' %}
|
|
63
|
+
No bueno
|
|
64
|
+
{% endcase %}
|
|
65
|
+
`;
|
|
66
|
+
|
|
67
|
+
const offenses = await runLiquidCheck(BlockIdUsage, sourceCode);
|
|
68
|
+
expect(offenses).toHaveLength(1);
|
|
69
|
+
expect(offenses[0].message).toEqual(
|
|
70
|
+
'The ID is dynamically generated by Shopify and is subject to change. You should avoid relying on a literal value of this ID.',
|
|
71
|
+
);
|
|
72
|
+
|
|
73
|
+
const highlights = highlightedOffenses({ 'file.liquid': sourceCode }, offenses);
|
|
74
|
+
expect(highlights).toEqual(['block.id']);
|
|
75
|
+
});
|
|
76
|
+
});
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import {
|
|
2
|
+
Position,
|
|
3
|
+
LiquidTagNode,
|
|
4
|
+
NodeTypes,
|
|
5
|
+
LiquidVariableLookup,
|
|
6
|
+
} from '@platformos/liquid-html-parser';
|
|
7
|
+
import { Context, LiquidCheckDefinition, Severity, SourceCodeType } from '../../types';
|
|
8
|
+
|
|
9
|
+
export const BlockIdUsage: LiquidCheckDefinition = {
|
|
10
|
+
meta: {
|
|
11
|
+
code: 'BlockIdUsage',
|
|
12
|
+
name: 'Do not rely on `block.id` in if/else/unless/case',
|
|
13
|
+
docs: {
|
|
14
|
+
description:
|
|
15
|
+
'The ID is dynamically generated by Shopify and is subject to change. You should avoid relying on a literal value of this ID.',
|
|
16
|
+
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/block-id-usage',
|
|
17
|
+
recommended: true,
|
|
18
|
+
},
|
|
19
|
+
type: SourceCodeType.LiquidHtml,
|
|
20
|
+
severity: Severity.WARNING,
|
|
21
|
+
schema: {},
|
|
22
|
+
targets: [],
|
|
23
|
+
},
|
|
24
|
+
|
|
25
|
+
create(context) {
|
|
26
|
+
return {
|
|
27
|
+
// BAD: {% if block.id == "123" %}
|
|
28
|
+
// BAD: {% if block.id == some_variable %}
|
|
29
|
+
// BAD: {% if block[id] == "id" or block.id %}
|
|
30
|
+
// FINE: <div data-block-id="{{ block.id }}">
|
|
31
|
+
// FINE: document.querySelector(`[data-block-id="${block.id}"]`)
|
|
32
|
+
async Comparison(node, ancesors) {
|
|
33
|
+
if (
|
|
34
|
+
node.comparator === '==' &&
|
|
35
|
+
node.left.type === NodeTypes.VariableLookup &&
|
|
36
|
+
isUsingBlockId(node.left)
|
|
37
|
+
) {
|
|
38
|
+
reportWarning(context, node.position);
|
|
39
|
+
}
|
|
40
|
+
},
|
|
41
|
+
|
|
42
|
+
// BAD {% case block.id %}
|
|
43
|
+
async VariableLookup(node, ancestors) {
|
|
44
|
+
const parentNode = ancestors.at(-1);
|
|
45
|
+
if (parentNode?.type === NodeTypes.LiquidTag && parentNode.name === 'case') {
|
|
46
|
+
if (isUsingBlockId(node)) {
|
|
47
|
+
reportWarning(context, node.position);
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
},
|
|
51
|
+
};
|
|
52
|
+
},
|
|
53
|
+
};
|
|
54
|
+
|
|
55
|
+
function isUsingBlockId(node: LiquidVariableLookup) {
|
|
56
|
+
return (
|
|
57
|
+
node.type == NodeTypes.VariableLookup &&
|
|
58
|
+
node.name === 'block' &&
|
|
59
|
+
node.lookups[0] &&
|
|
60
|
+
node.lookups[0].type === NodeTypes.String &&
|
|
61
|
+
node.lookups[0].value === 'id'
|
|
62
|
+
);
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
function reportWarning(context: any, position: Position) {
|
|
66
|
+
context.report({
|
|
67
|
+
message:
|
|
68
|
+
'The ID is dynamically generated by Shopify and is subject to change. You should avoid relying on a literal value of this ID.',
|
|
69
|
+
startIndex: position.start,
|
|
70
|
+
endIndex: position.end,
|
|
71
|
+
});
|
|
72
|
+
}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { expect, describe, it } from 'vitest';
|
|
2
|
+
import { runLiquidCheck } from '../../test';
|
|
3
|
+
import { CdnPreconnect } from './index';
|
|
4
|
+
|
|
5
|
+
describe('Module: CdnPreconnect', () => {
|
|
6
|
+
it('should report preconnect to cdn.shopify.com', async () => {
|
|
7
|
+
const sourceCode = `
|
|
8
|
+
<link rel="preconnect" href="https://cdn.shopify.com/"/>
|
|
9
|
+
`;
|
|
10
|
+
|
|
11
|
+
const offenses = await runLiquidCheck(CdnPreconnect, sourceCode);
|
|
12
|
+
expect(offenses).to.have.length(1);
|
|
13
|
+
expect(offenses[0].message).to.equal(
|
|
14
|
+
'Preconnecting to cdn.shopify.com is unnecessary and can lead to worse performance',
|
|
15
|
+
);
|
|
16
|
+
});
|
|
17
|
+
|
|
18
|
+
it('should report crossorigin preconnect to cdn.shopify.com', async () => {
|
|
19
|
+
const sourceCode = `
|
|
20
|
+
<link rel="preconnect" href="https://cdn.shopify.com/" crossorigin/>
|
|
21
|
+
`;
|
|
22
|
+
|
|
23
|
+
const offenses = await runLiquidCheck(CdnPreconnect, sourceCode);
|
|
24
|
+
expect(offenses).to.have.length(1);
|
|
25
|
+
expect(offenses[0].message).to.equal(
|
|
26
|
+
'Preconnecting to cdn.shopify.com is unnecessary and can lead to worse performance',
|
|
27
|
+
);
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
it('should not report other link types', async () => {
|
|
31
|
+
const sourceCode = `
|
|
32
|
+
<link rel="preload" href="https://example.com/foo.css" as="style"/>
|
|
33
|
+
<link rel="stylesheet" href="https://example.com/bar.css"/>
|
|
34
|
+
<link rel="icon"/>
|
|
35
|
+
`;
|
|
36
|
+
|
|
37
|
+
const offenses = await runLiquidCheck(CdnPreconnect, sourceCode);
|
|
38
|
+
expect(offenses).to.have.length(0);
|
|
39
|
+
});
|
|
40
|
+
});
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { Severity, SourceCodeType, LiquidCheckDefinition } from '../../types';
|
|
2
|
+
import { isAttr, isValuedHtmlAttribute, valueIncludes } from '../utils';
|
|
3
|
+
|
|
4
|
+
export const CdnPreconnect: LiquidCheckDefinition = {
|
|
5
|
+
meta: {
|
|
6
|
+
code: 'CdnPreconnect',
|
|
7
|
+
name: 'CDN Preconnect',
|
|
8
|
+
docs: {
|
|
9
|
+
description: "This check is aimed at signaling the redundant preconnect to Shopify's CDN",
|
|
10
|
+
recommended: true,
|
|
11
|
+
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/cdn-preconnect',
|
|
12
|
+
},
|
|
13
|
+
type: SourceCodeType.LiquidHtml,
|
|
14
|
+
severity: Severity.ERROR,
|
|
15
|
+
schema: {},
|
|
16
|
+
targets: [],
|
|
17
|
+
},
|
|
18
|
+
|
|
19
|
+
create(context) {
|
|
20
|
+
return {
|
|
21
|
+
async HtmlVoidElement(node) {
|
|
22
|
+
if (node.name !== 'link') return;
|
|
23
|
+
|
|
24
|
+
const isPreconnect = node.attributes
|
|
25
|
+
.filter(isValuedHtmlAttribute)
|
|
26
|
+
.some((attr) => isAttr(attr, 'rel') && valueIncludes(attr, 'preconnect'));
|
|
27
|
+
if (!isPreconnect) return;
|
|
28
|
+
|
|
29
|
+
const isShopifyCdn = node.attributes
|
|
30
|
+
.filter(isValuedHtmlAttribute)
|
|
31
|
+
.some((attr) => isAttr(attr, 'href') && valueIncludes(attr, '.+cdn.shopify.com.+'));
|
|
32
|
+
if (!isShopifyCdn) return;
|
|
33
|
+
|
|
34
|
+
context.report({
|
|
35
|
+
message:
|
|
36
|
+
'Preconnecting to cdn.shopify.com is unnecessary and can lead to worse performance',
|
|
37
|
+
startIndex: node.position.start,
|
|
38
|
+
endIndex: node.position.end,
|
|
39
|
+
});
|
|
40
|
+
},
|
|
41
|
+
};
|
|
42
|
+
},
|
|
43
|
+
};
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { expect, describe, it } from 'vitest';
|
|
2
|
+
import { highlightedOffenses, runLiquidCheck } from '../../test';
|
|
3
|
+
import { ContentForHeaderModification } from './index';
|
|
4
|
+
|
|
5
|
+
describe('Module: ContentForHeaderModification', () => {
|
|
6
|
+
it('reports a offense with the use of a filter', async () => {
|
|
7
|
+
const sourceCode = "{{ content_for_header | split: ',' }}";
|
|
8
|
+
|
|
9
|
+
const offenses = await runLiquidCheck(ContentForHeaderModification, sourceCode);
|
|
10
|
+
expect(offenses).toHaveLength(1);
|
|
11
|
+
expect(offenses[0].message).toEqual('Do not rely on the content of `content_for_header`');
|
|
12
|
+
|
|
13
|
+
const highlights = highlightedOffenses({ 'file.liquid': sourceCode }, offenses);
|
|
14
|
+
});
|
|
15
|
+
|
|
16
|
+
it('reports offense with the use of assign', async () => {
|
|
17
|
+
const sourceCode = '{% assign x = content_for_header %}';
|
|
18
|
+
|
|
19
|
+
const offenses = await runLiquidCheck(ContentForHeaderModification, sourceCode);
|
|
20
|
+
expect(offenses).toHaveLength(1);
|
|
21
|
+
expect(offenses[0].message).toEqual('Do not rely on the content of `content_for_header`');
|
|
22
|
+
|
|
23
|
+
const highlights = highlightedOffenses({ 'file.liquid': sourceCode }, offenses);
|
|
24
|
+
expect(highlights).toEqual(['{% assign x = content_for_header %}']);
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
it('reports offense with the use of capture', async () => {
|
|
28
|
+
const sourceCode = `
|
|
29
|
+
{% capture x %}
|
|
30
|
+
{{ content_for_header }}
|
|
31
|
+
{% endcapture %}
|
|
32
|
+
`;
|
|
33
|
+
|
|
34
|
+
const offenses = await runLiquidCheck(ContentForHeaderModification, sourceCode);
|
|
35
|
+
expect(offenses).toHaveLength(1);
|
|
36
|
+
expect(offenses[0].message).toEqual('Do not rely on the content of `content_for_header`');
|
|
37
|
+
|
|
38
|
+
const highlights = highlightedOffenses({ 'file.liquid': sourceCode }, offenses);
|
|
39
|
+
expect(highlights).toEqual(['{{ content_for_header }}']);
|
|
40
|
+
});
|
|
41
|
+
|
|
42
|
+
it('reports offense with the use of echo', async () => {
|
|
43
|
+
const sourceCode = `
|
|
44
|
+
{% liquid
|
|
45
|
+
echo content_for_header | split: ','
|
|
46
|
+
%}
|
|
47
|
+
`;
|
|
48
|
+
|
|
49
|
+
const offenses = await runLiquidCheck(ContentForHeaderModification, sourceCode);
|
|
50
|
+
expect(offenses).toHaveLength(1);
|
|
51
|
+
expect(offenses[0].message).toEqual('Do not rely on the content of `content_for_header`');
|
|
52
|
+
|
|
53
|
+
const highlights = highlightedOffenses({ 'file.liquid': sourceCode }, offenses);
|
|
54
|
+
expect(highlights).toEqual(["echo content_for_header | split: ','"]);
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
it('does not report an offense with normal use', async () => {
|
|
58
|
+
const sourceCode = '{{ content_for_header }}';
|
|
59
|
+
|
|
60
|
+
const offenses = await runLiquidCheck(ContentForHeaderModification, sourceCode);
|
|
61
|
+
expect(offenses).toHaveLength(0);
|
|
62
|
+
const highlights = highlightedOffenses({ 'file.liquid': sourceCode }, offenses);
|
|
63
|
+
expect(highlights).toHaveLength(0);
|
|
64
|
+
});
|
|
65
|
+
});
|