@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
package/CHANGELOG.md
ADDED
package/README.md
ADDED
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
<h1 align="center" style="position: relative;" >
|
|
2
|
+
<br>
|
|
3
|
+
<img src="https://github.com/Platform-OS/platformos-tools/blob/main/packages/vscode-extension/images/platformos_logo.png?raw=true" alt="platformOS logo" width="200">
|
|
4
|
+
<br>
|
|
5
|
+
platformOS Check
|
|
6
|
+
</h1>
|
|
7
|
+
|
|
8
|
+
<h4 align="center">A linter for platformOS</h4>
|
|
9
|
+
|
|
10
|
+
platformOS Check helps you follow best practices by analyzing your platformOS files.
|
|
11
|
+
|
|
12
|
+
Theme Check is available [to code editors that support the Language Server Protocol](https://github.com/Platform-OS/platformos-tools/wiki).
|
|
13
|
+
|
|
14
|
+
You may be interested by the sibling modules:
|
|
15
|
+
|
|
16
|
+
- `@platformos/platformos-check-common`: (you are here) npm module to run checks (runtime agnostic).
|
|
17
|
+
- `@platformos/platformos-check-node`: npm module to run checks from a [Node.js ](https://nodejs.org) runtime.
|
|
18
|
+
- `@platformos/platformos-check-browser`: npm module to run checks in a Browser.
|
|
19
|
+
|
|
20
|
+
## Installation
|
|
21
|
+
|
|
22
|
+
### CLI
|
|
23
|
+
|
|
24
|
+
platformOS Check is integrated in the [platformOS CLI (pos-cli)](https://github.com/Platform-OS/pos-cli).
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
pos-cli check
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### As a library
|
|
31
|
+
|
|
32
|
+
There are three libraries:
|
|
33
|
+
|
|
34
|
+
```
|
|
35
|
+
yarn add @platformos/platformos-check-node
|
|
36
|
+
yarn add @platformos/platformos-check-common
|
|
37
|
+
yarn add @platformos/platformos-check-browser
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Usage
|
|
41
|
+
|
|
42
|
+
### Node
|
|
43
|
+
|
|
44
|
+
The node version comes with batteries included.
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
// simple-cli.ts
|
|
48
|
+
import { check } from '@platformos/platformos-check-node';
|
|
49
|
+
|
|
50
|
+
async function main() {
|
|
51
|
+
const root = process.cwd();
|
|
52
|
+
const offenses = await check(root);
|
|
53
|
+
console.log(offenses);
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
main();
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Browser
|
|
60
|
+
|
|
61
|
+
The browser version is a bit more complex, you need to provide your own implementation of all the dependency injections.
|
|
62
|
+
|
|
63
|
+
```ts
|
|
64
|
+
import { simpleCheck, recommended, ThemeData, Config, Dependencies } from '@platformos/platformos-check-browser';
|
|
65
|
+
|
|
66
|
+
async function main() {
|
|
67
|
+
const themeDesc = {
|
|
68
|
+
'app/views/partials/product-card.liquid': '{{ product | image_url | image_tag }}',
|
|
69
|
+
'app/views/partials/for-loop.liquid': '{% for variant in product.variants %}...{% endfor %}',
|
|
70
|
+
};
|
|
71
|
+
|
|
72
|
+
const config: Config = {
|
|
73
|
+
checks: recommended,
|
|
74
|
+
settings: {},
|
|
75
|
+
root: '/',
|
|
76
|
+
};
|
|
77
|
+
|
|
78
|
+
const dependencies: Dependencies = {
|
|
79
|
+
// ...
|
|
80
|
+
};
|
|
81
|
+
|
|
82
|
+
const offenses = await simpleCheck(themeDesc, config, dependencies);
|
|
83
|
+
|
|
84
|
+
console.log(offenses);
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
main();
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## Contributing
|
|
91
|
+
|
|
92
|
+
See [CONTRIBUTING.md](../../docs/contributing.md).
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { FilterEntry, ObjectEntry, TagEntry, ThemeDocset, Translations } from './types';
|
|
2
|
+
export declare class AugmentedThemeDocset implements ThemeDocset {
|
|
3
|
+
private themeDocset;
|
|
4
|
+
constructor(themeDocset: ThemeDocset);
|
|
5
|
+
graphQL: import("./utils").MemoedFunction<() => Promise<string | null>>;
|
|
6
|
+
isAugmented: boolean;
|
|
7
|
+
filters: import("./utils").MemoedFunction<() => Promise<FilterEntry[]>>;
|
|
8
|
+
objects: import("./utils").MemoedFunction<() => Promise<ObjectEntry[]>>;
|
|
9
|
+
liquidDrops: import("./utils").MemoedFunction<() => Promise<ObjectEntry[]>>;
|
|
10
|
+
tags: import("./utils").MemoedFunction<() => Promise<TagEntry[]>>;
|
|
11
|
+
systemTranslations: import("./utils").MemoedFunction<() => Promise<Translations>>;
|
|
12
|
+
}
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.AugmentedThemeDocset = void 0;
|
|
4
|
+
const utils_1 = require("./utils");
|
|
5
|
+
const toFilterEntry = (name) => ({ name });
|
|
6
|
+
const aliasedFilters = [
|
|
7
|
+
['camelcase', 'camelize'],
|
|
8
|
+
['handle', 'handleize'],
|
|
9
|
+
['t', 'translate'],
|
|
10
|
+
];
|
|
11
|
+
const toAliasedFilterEntry = (entries) => ([alias, baseName]) => {
|
|
12
|
+
const baseEntry = entries.find((entry) => entry.name === baseName);
|
|
13
|
+
if (!baseEntry) {
|
|
14
|
+
return toFilterEntry(alias);
|
|
15
|
+
}
|
|
16
|
+
return {
|
|
17
|
+
...baseEntry,
|
|
18
|
+
name: alias,
|
|
19
|
+
};
|
|
20
|
+
};
|
|
21
|
+
const undocumentedFilters = [
|
|
22
|
+
'_online_store_editor_live_setting',
|
|
23
|
+
'addresses_url',
|
|
24
|
+
'app_block_path?',
|
|
25
|
+
'app_block_path_for',
|
|
26
|
+
'app_extension_path?',
|
|
27
|
+
'app_snippet_path?',
|
|
28
|
+
'cancel_customer_order_link',
|
|
29
|
+
'debug',
|
|
30
|
+
'delete_customer_address_link',
|
|
31
|
+
'dev_shop?',
|
|
32
|
+
'distance_from',
|
|
33
|
+
'edit_customer_address_link',
|
|
34
|
+
'encode_url_component',
|
|
35
|
+
'excerpt',
|
|
36
|
+
'format_code',
|
|
37
|
+
'global_block_type?',
|
|
38
|
+
'h',
|
|
39
|
+
'handle_from',
|
|
40
|
+
'installments_pricing',
|
|
41
|
+
'link_to_theme',
|
|
42
|
+
'login_button',
|
|
43
|
+
'login_url',
|
|
44
|
+
'logout_url',
|
|
45
|
+
'pad_spaces',
|
|
46
|
+
'paragraphize',
|
|
47
|
+
'recover_password_link',
|
|
48
|
+
'recover_url',
|
|
49
|
+
'register_url',
|
|
50
|
+
'registration_uuid_from',
|
|
51
|
+
'root_account_url',
|
|
52
|
+
'sentence',
|
|
53
|
+
'theme_url',
|
|
54
|
+
'unit',
|
|
55
|
+
'weight',
|
|
56
|
+
];
|
|
57
|
+
const undocumentedObjectEntryKeys = [
|
|
58
|
+
'locale',
|
|
59
|
+
'direction',
|
|
60
|
+
'skip_to_content_link',
|
|
61
|
+
'checkout_html_classes',
|
|
62
|
+
'checkout_stylesheets',
|
|
63
|
+
'checkout_scripts',
|
|
64
|
+
'content_for_logo',
|
|
65
|
+
'breadcrumb',
|
|
66
|
+
'order_summary_toggle',
|
|
67
|
+
'content_for_order_summary',
|
|
68
|
+
'alternative_payment_methods',
|
|
69
|
+
'content_for_footer',
|
|
70
|
+
'tracking_code',
|
|
71
|
+
];
|
|
72
|
+
const toObjectEntry = (name, access, returnType) => ({
|
|
73
|
+
name,
|
|
74
|
+
...(access && { access }),
|
|
75
|
+
...(returnType && { return_type: returnType }),
|
|
76
|
+
});
|
|
77
|
+
const undocumentedObjects = ['customer_address', 'product_variant'];
|
|
78
|
+
const legacyCheckoutEntries = undocumentedObjectEntryKeys.map((objectKey) => toObjectEntry(objectKey, { global: false, parents: [], template: [] }, [
|
|
79
|
+
{ type: 'string', name: '' },
|
|
80
|
+
]));
|
|
81
|
+
const toTagEntry = (name) => ({ name });
|
|
82
|
+
const undocumentedTags = ['elsif', 'ifchanged', 'when', 'schema'];
|
|
83
|
+
class AugmentedThemeDocset {
|
|
84
|
+
constructor(themeDocset) {
|
|
85
|
+
this.themeDocset = themeDocset;
|
|
86
|
+
this.graphQL = (0, utils_1.memo)(async () => {
|
|
87
|
+
return await this.themeDocset.graphQL();
|
|
88
|
+
});
|
|
89
|
+
this.isAugmented = true;
|
|
90
|
+
this.filters = (0, utils_1.memo)(async () => {
|
|
91
|
+
const officialFilters = await this.themeDocset.filters();
|
|
92
|
+
return [
|
|
93
|
+
...officialFilters,
|
|
94
|
+
...aliasedFilters.map(toAliasedFilterEntry(officialFilters)),
|
|
95
|
+
...undocumentedFilters.map(toFilterEntry),
|
|
96
|
+
];
|
|
97
|
+
});
|
|
98
|
+
this.objects = (0, utils_1.memo)(async () => {
|
|
99
|
+
return [
|
|
100
|
+
...(await this.themeDocset.objects()),
|
|
101
|
+
...undocumentedObjects.map((obj) => toObjectEntry(obj)),
|
|
102
|
+
...legacyCheckoutEntries,
|
|
103
|
+
];
|
|
104
|
+
});
|
|
105
|
+
this.liquidDrops = (0, utils_1.memo)(async () => {
|
|
106
|
+
return (await this.themeDocset.objects()).filter((obj) => {
|
|
107
|
+
if (!obj.access) {
|
|
108
|
+
return true;
|
|
109
|
+
}
|
|
110
|
+
if (obj.deprecated) {
|
|
111
|
+
return false;
|
|
112
|
+
}
|
|
113
|
+
// objects that are accessible outside Global context
|
|
114
|
+
return !obj.access.global || (obj.access.global && obj.access.parents.length > 0);
|
|
115
|
+
});
|
|
116
|
+
});
|
|
117
|
+
this.tags = (0, utils_1.memo)(async () => {
|
|
118
|
+
return [...(await this.themeDocset.tags()), ...undocumentedTags.map(toTagEntry)];
|
|
119
|
+
});
|
|
120
|
+
this.systemTranslations = (0, utils_1.memo)(async () => {
|
|
121
|
+
return this.themeDocset.systemTranslations();
|
|
122
|
+
});
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
exports.AugmentedThemeDocset = AugmentedThemeDocset;
|
|
126
|
+
//# sourceMappingURL=AugmentedThemeDocset.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"AugmentedThemeDocset.js","sourceRoot":"","sources":["../src/AugmentedThemeDocset.ts"],"names":[],"mappings":";;;AASA,mCAA+B;AAE/B,MAAM,aAAa,GAAG,CAAC,IAAY,EAAe,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;AAChE,MAAM,cAAc,GAAuB;IACzC,CAAC,WAAW,EAAE,UAAU,CAAC;IACzB,CAAC,QAAQ,EAAE,WAAW,CAAC;IACvB,CAAC,GAAG,EAAE,WAAW,CAAC;CACnB,CAAC;AAEF,MAAM,oBAAoB,GACxB,CAAC,OAAsB,EAAE,EAAE,CAC3B,CAAC,CAAC,KAAK,EAAE,QAAQ,CAAmB,EAAe,EAAE;IACnD,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;IACnE,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IACD,OAAO;QACL,GAAG,SAAS;QACZ,IAAI,EAAE,KAAK;KACZ,CAAC;AACJ,CAAC,CAAC;AAEJ,MAAM,mBAAmB,GAAG;IAC1B,mCAAmC;IACnC,eAAe;IACf,iBAAiB;IACjB,oBAAoB;IACpB,qBAAqB;IACrB,mBAAmB;IACnB,4BAA4B;IAC5B,OAAO;IACP,8BAA8B;IAC9B,WAAW;IACX,eAAe;IACf,4BAA4B;IAC5B,sBAAsB;IACtB,SAAS;IACT,aAAa;IACb,oBAAoB;IACpB,GAAG;IACH,aAAa;IACb,sBAAsB;IACtB,eAAe;IACf,cAAc;IACd,WAAW;IACX,YAAY;IACZ,YAAY;IACZ,cAAc;IACd,uBAAuB;IACvB,aAAa;IACb,cAAc;IACd,wBAAwB;IACxB,kBAAkB;IAClB,UAAU;IACV,WAAW;IACX,MAAM;IACN,QAAQ;CACT,CAAC;AAEF,MAAM,2BAA2B,GAAG;IAClC,QAAQ;IACR,WAAW;IACX,sBAAsB;IACtB,uBAAuB;IACvB,sBAAsB;IACtB,kBAAkB;IAClB,kBAAkB;IAClB,YAAY;IACZ,sBAAsB;IACtB,2BAA2B;IAC3B,6BAA6B;IAC7B,oBAAoB;IACpB,eAAe;CAChB,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,IAAY,EAAE,MAAe,EAAE,UAAyB,EAAe,EAAE,CAAC,CAAC;IAChG,IAAI;IACJ,GAAG,CAAC,MAAM,IAAI,EAAE,MAAM,EAAE,CAAC;IACzB,GAAG,CAAC,UAAU,IAAI,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC;CAC/C,CAAC,CAAC;AAEH,MAAM,mBAAmB,GAAG,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,CAAC;AACpE,MAAM,qBAAqB,GAAkB,2BAA2B,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CACzF,aAAa,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE;IACrE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE;CAC7B,CAAC,CACH,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,IAAY,EAAY,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;AAC1D,MAAM,gBAAgB,GAAG,CAAC,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;AAElE,MAAa,oBAAoB;IAC/B,YAAoB,WAAwB;QAAxB,gBAAW,GAAX,WAAW,CAAa;QAC5C,YAAO,GAAG,IAAA,YAAI,EAAC,KAAK,IAA4B,EAAE;YAChD,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEI,gBAAW,GAAG,IAAI,CAAC;QAE1B,YAAO,GAAG,IAAA,YAAI,EAAC,KAAK,IAA4B,EAAE;YAChD,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;YACzD,OAAO;gBACL,GAAG,eAAe;gBAClB,GAAG,cAAc,CAAC,GAAG,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC;gBAC5D,GAAG,mBAAmB,CAAC,GAAG,CAAC,aAAa,CAAC;aAC1C,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,YAAO,GAAG,IAAA,YAAI,EAAC,KAAK,IAA4B,EAAE;YAChD,OAAO;gBACL,GAAG,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;gBACrC,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;gBACvD,GAAG,qBAAqB;aACzB,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,gBAAW,GAAG,IAAA,YAAI,EAAC,KAAK,IAA4B,EAAE;YACpD,OAAO,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;gBACvD,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;oBAChB,OAAO,IAAI,CAAC;gBACd,CAAC;gBAED,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;oBACnB,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,qDAAqD;gBACrD,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACpF,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,SAAI,GAAG,IAAA,YAAI,EAAC,KAAK,IAAyB,EAAE;YAC1C,OAAO,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,gBAAgB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;QACnF,CAAC,CAAC,CAAC;QAEH,uBAAkB,GAAG,IAAA,YAAI,EAAC,KAAK,IAA2B,EAAE;YAC1D,OAAO,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE,CAAC;QAC/C,CAAC,CAAC,CAAC;IA7C4C,CAAC;CA8CjD;AA/CD,oDA+CC"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { LanguageService } from 'vscode-json-languageservice';
|
|
2
|
+
import { Config, Dependencies, IsValidSchema, SchemaDefinition, ValidateJSON } from './types';
|
|
3
|
+
export declare class JSONValidator {
|
|
4
|
+
private service;
|
|
5
|
+
private schemas;
|
|
6
|
+
static create(jsonValidationSet: Dependencies['jsonValidationSet'], config: Config): Promise<JSONValidator | undefined>;
|
|
7
|
+
constructor(schemas: SchemaDefinition[]);
|
|
8
|
+
/**
|
|
9
|
+
* Will return an array of diagnostics for the given source code and JSON string.
|
|
10
|
+
*
|
|
11
|
+
* It's up to the caller to determine where in the file those should be.
|
|
12
|
+
* (presumably by doing some offset logic)
|
|
13
|
+
*/
|
|
14
|
+
validate: ValidateJSON;
|
|
15
|
+
isValid: IsValidSchema;
|
|
16
|
+
private getOffsetDiagnostics;
|
|
17
|
+
private getSchemaForURI;
|
|
18
|
+
}
|
|
19
|
+
/** We'll reuse this in the language server */
|
|
20
|
+
export declare function isValid(service: LanguageService, uri: string, jsonString: string): Promise<boolean>;
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.JSONValidator = void 0;
|
|
4
|
+
exports.isValid = isValid;
|
|
5
|
+
const vscode_json_languageservice_1 = require("vscode-json-languageservice");
|
|
6
|
+
const utils_1 = require("./utils");
|
|
7
|
+
class JSONValidator {
|
|
8
|
+
static async create(jsonValidationSet, config) {
|
|
9
|
+
if (!jsonValidationSet)
|
|
10
|
+
return;
|
|
11
|
+
return new JSONValidator(await jsonValidationSet.schemas(config.context));
|
|
12
|
+
}
|
|
13
|
+
constructor(schemas) {
|
|
14
|
+
/**
|
|
15
|
+
* Will return an array of diagnostics for the given source code and JSON string.
|
|
16
|
+
*
|
|
17
|
+
* It's up to the caller to determine where in the file those should be.
|
|
18
|
+
* (presumably by doing some offset logic)
|
|
19
|
+
*/
|
|
20
|
+
this.validate = async (uri, jsonString) => {
|
|
21
|
+
const jsonTextDocument = vscode_json_languageservice_1.TextDocument.create(uri, 'json', 0, jsonString);
|
|
22
|
+
const diagnostics = await this.getOffsetDiagnostics(jsonTextDocument);
|
|
23
|
+
return diagnostics.map((diagnostic) => ({
|
|
24
|
+
message: diagnostic.message,
|
|
25
|
+
startIndex: jsonTextDocument.offsetAt(diagnostic.range.start),
|
|
26
|
+
endIndex: jsonTextDocument.offsetAt(diagnostic.range.end),
|
|
27
|
+
}));
|
|
28
|
+
};
|
|
29
|
+
this.isValid = async (uri, jsonString) => {
|
|
30
|
+
return isValid(this.service, uri, jsonString);
|
|
31
|
+
};
|
|
32
|
+
this.schemas = (0, utils_1.indexBy)((x) => x.uri, schemas);
|
|
33
|
+
this.service = (0, vscode_json_languageservice_1.getLanguageService)({
|
|
34
|
+
schemaRequestService: this.getSchemaForURI.bind(this),
|
|
35
|
+
workspaceContext: {
|
|
36
|
+
resolveRelativePath: (relativePath, resource) => {
|
|
37
|
+
const url = new URL(relativePath, resource);
|
|
38
|
+
return url.toString();
|
|
39
|
+
},
|
|
40
|
+
},
|
|
41
|
+
});
|
|
42
|
+
this.service.configure({
|
|
43
|
+
schemas: schemas.map((schemaDefinition) => ({
|
|
44
|
+
uri: schemaDefinition.uri,
|
|
45
|
+
fileMatch: schemaDefinition.fileMatch,
|
|
46
|
+
})),
|
|
47
|
+
});
|
|
48
|
+
}
|
|
49
|
+
async getOffsetDiagnostics(jsonTextDocument) {
|
|
50
|
+
const jsonDocument = this.service.parseJSONDocument(jsonTextDocument);
|
|
51
|
+
return this.service.doValidation(jsonTextDocument, jsonDocument, {
|
|
52
|
+
schemaValidation: 'error',
|
|
53
|
+
trailingCommas: 'ignore',
|
|
54
|
+
comments: 'ignore',
|
|
55
|
+
});
|
|
56
|
+
}
|
|
57
|
+
async getSchemaForURI(uri) {
|
|
58
|
+
const schema = this.schemas[uri]?.schema;
|
|
59
|
+
if (!schema)
|
|
60
|
+
return `No schema for '${uri}' found`;
|
|
61
|
+
return schema;
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
exports.JSONValidator = JSONValidator;
|
|
65
|
+
/** We'll reuse this in the language server */
|
|
66
|
+
async function isValid(service, uri, jsonString) {
|
|
67
|
+
const jsonTextDocument = vscode_json_languageservice_1.TextDocument.create(uri, 'json', 0, jsonString);
|
|
68
|
+
const jsonDocument = service.parseJSONDocument(jsonTextDocument);
|
|
69
|
+
const diagnostics = await service.doValidation(jsonTextDocument, jsonDocument, {
|
|
70
|
+
schemaValidation: 'error',
|
|
71
|
+
trailingCommas: 'ignore',
|
|
72
|
+
comments: 'ignore',
|
|
73
|
+
});
|
|
74
|
+
return diagnostics.every((diagnostic) => diagnostic.severity !== 1);
|
|
75
|
+
}
|
|
76
|
+
//# sourceMappingURL=JSONValidator.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"JSONValidator.js","sourceRoot":"","sources":["../src/JSONValidator.ts"],"names":[],"mappings":";;;AAwEA,0BASC;AAjFD,6EAAgG;AAEhG,mCAAkC;AAElC,MAAa,aAAa;IAIxB,MAAM,CAAC,KAAK,CAAC,MAAM,CACjB,iBAAoD,EACpD,MAAc;QAEd,IAAI,CAAC,iBAAiB;YAAE,OAAO;QAC/B,OAAO,IAAI,aAAa,CAAC,MAAM,iBAAiB,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5E,CAAC;IAED,YAAY,OAA2B;QAmBvC;;;;;WAKG;QACI,aAAQ,GAAiB,KAAK,EAAE,GAAW,EAAE,UAAkB,EAAE,EAAE;YACxE,MAAM,gBAAgB,GAAG,0CAAY,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC;YACzE,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;YACtE,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;gBACtC,OAAO,EAAE,UAAU,CAAC,OAAO;gBAC3B,UAAU,EAAE,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC;gBAC7D,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC;aAC1D,CAAC,CAAC,CAAC;QACN,CAAC,CAAC;QAEK,YAAO,GAAkB,KAAK,EAAE,GAAW,EAAE,UAAkB,EAAE,EAAE;YACxE,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;QAChD,CAAC,CAAC;QApCA,IAAI,CAAC,OAAO,GAAG,IAAA,eAAO,EAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,OAAO,GAAG,IAAA,gDAAkB,EAAC;YAChC,oBAAoB,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC;YACrD,gBAAgB,EAAE;gBAChB,mBAAmB,EAAE,CAAC,YAAY,EAAE,QAAQ,EAAE,EAAE;oBAC9C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;oBAC5C,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;gBACxB,CAAC;aACF;SACF,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;YACrB,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;gBAC1C,GAAG,EAAE,gBAAgB,CAAC,GAAG;gBACzB,SAAS,EAAE,gBAAgB,CAAC,SAAS;aACtC,CAAC,CAAC;SACJ,CAAC,CAAC;IACL,CAAC;IAsBO,KAAK,CAAC,oBAAoB,CAAC,gBAA8B;QAC/D,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,gBAAgB,EAAE,YAAY,EAAE;YAC/D,gBAAgB,EAAE,OAAO;YACzB,cAAc,EAAE,QAAQ;YACxB,QAAQ,EAAE,QAAQ;SACnB,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,eAAe,CAAC,GAAW;QACvC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QACzC,IAAI,CAAC,MAAM;YAAE,OAAO,kBAAkB,GAAG,SAAS,CAAC;QACnD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAjED,sCAiEC;AAED,8CAA8C;AACvC,KAAK,UAAU,OAAO,CAAC,OAAwB,EAAE,GAAW,EAAE,UAAkB;IACrF,MAAM,gBAAgB,GAAG,0CAAY,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC;IACzE,MAAM,YAAY,GAAG,OAAO,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;IACjE,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,YAAY,CAAC,gBAAgB,EAAE,YAAY,EAAE;QAC7E,gBAAgB,EAAE,OAAO;QACzB,cAAc,EAAE,QAAQ;QACxB,QAAQ,EAAE,QAAQ;KACnB,CAAC,CAAC;IACH,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,QAAQ,KAAK,CAAC,CAAC,CAAC;AACtE,CAAC"}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.AppBlockMissingSchema = void 0;
|
|
4
|
+
const types_1 = require("../../types");
|
|
5
|
+
exports.AppBlockMissingSchema = {
|
|
6
|
+
meta: {
|
|
7
|
+
code: 'AppBlockMissingSchema',
|
|
8
|
+
name: 'Missing schema definitions in theme app extensions app blocks should be avoided',
|
|
9
|
+
docs: {
|
|
10
|
+
description: 'Report missing schema definitions in theme app extensions app blocks',
|
|
11
|
+
recommended: true,
|
|
12
|
+
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/app-block-missing-schema',
|
|
13
|
+
},
|
|
14
|
+
severity: types_1.Severity.ERROR,
|
|
15
|
+
type: types_1.SourceCodeType.LiquidHtml,
|
|
16
|
+
schema: {},
|
|
17
|
+
targets: [types_1.ConfigTarget.ThemeAppExtension],
|
|
18
|
+
},
|
|
19
|
+
create(context) {
|
|
20
|
+
let foundSchema = false;
|
|
21
|
+
const relativePath = context.toRelativePath(context.file.uri);
|
|
22
|
+
/**
|
|
23
|
+
* Theme app extension blocks are the only types of files that can have a
|
|
24
|
+
* schema defined in them.
|
|
25
|
+
*/
|
|
26
|
+
if (!relativePath.startsWith('blocks/')) {
|
|
27
|
+
return {};
|
|
28
|
+
}
|
|
29
|
+
return {
|
|
30
|
+
async LiquidRawTag(node) {
|
|
31
|
+
if (node.name == 'schema')
|
|
32
|
+
foundSchema = true;
|
|
33
|
+
},
|
|
34
|
+
async onCodePathEnd() {
|
|
35
|
+
if (!foundSchema) {
|
|
36
|
+
context.report({
|
|
37
|
+
message: `The schema does not exist`,
|
|
38
|
+
startIndex: 0,
|
|
39
|
+
endIndex: 0,
|
|
40
|
+
});
|
|
41
|
+
}
|
|
42
|
+
},
|
|
43
|
+
};
|
|
44
|
+
},
|
|
45
|
+
};
|
|
46
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/checks/app-block-missing-schema/index.ts"],"names":[],"mappings":";;;AAAA,uCAA4F;AAE/E,QAAA,qBAAqB,GAA0B;IAC1D,IAAI,EAAE;QACJ,IAAI,EAAE,uBAAuB;QAC7B,IAAI,EAAE,iFAAiF;QACvF,IAAI,EAAE;YACJ,WAAW,EAAE,sEAAsE;YACnF,WAAW,EAAE,IAAI;YACjB,GAAG,EAAE,+FAA+F;SACrG;QACD,QAAQ,EAAE,gBAAQ,CAAC,KAAK;QACxB,IAAI,EAAE,sBAAc,CAAC,UAAU;QAC/B,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,CAAC,oBAAY,CAAC,iBAAiB,CAAC;KAC1C;IAED,MAAM,CAAC,OAAO;QACZ,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,MAAM,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE9D;;;WAGG;QACH,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YACxC,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO;YACL,KAAK,CAAC,YAAY,CAAC,IAAI;gBACrB,IAAI,IAAI,CAAC,IAAI,IAAI,QAAQ;oBAAE,WAAW,GAAG,IAAI,CAAC;YAChD,CAAC;YAED,KAAK,CAAC,aAAa;gBACjB,IAAI,CAAC,WAAW,EAAE,CAAC;oBACjB,OAAO,CAAC,MAAM,CAAC;wBACb,OAAO,EAAE,2BAA2B;wBACpC,UAAU,EAAE,CAAC;wBACb,QAAQ,EAAE,CAAC;qBACZ,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { LiquidCheckDefinition } from '../../types';
|
|
2
|
+
export declare enum ForbiddenTag {
|
|
3
|
+
JavaScript = "javascript",
|
|
4
|
+
StyleSheet = "stylesheet",
|
|
5
|
+
Include = "include",
|
|
6
|
+
Layout = "layout",
|
|
7
|
+
Section = "section",
|
|
8
|
+
Sections = "sections"
|
|
9
|
+
}
|
|
10
|
+
export declare const AppBlockValidTags: LiquidCheckDefinition;
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.AppBlockValidTags = exports.ForbiddenTag = void 0;
|
|
4
|
+
const types_1 = require("../../types");
|
|
5
|
+
var ForbiddenTag;
|
|
6
|
+
(function (ForbiddenTag) {
|
|
7
|
+
ForbiddenTag["JavaScript"] = "javascript";
|
|
8
|
+
ForbiddenTag["StyleSheet"] = "stylesheet";
|
|
9
|
+
ForbiddenTag["Include"] = "include";
|
|
10
|
+
ForbiddenTag["Layout"] = "layout";
|
|
11
|
+
ForbiddenTag["Section"] = "section";
|
|
12
|
+
ForbiddenTag["Sections"] = "sections";
|
|
13
|
+
})(ForbiddenTag || (exports.ForbiddenTag = ForbiddenTag = {}));
|
|
14
|
+
const isForbiddenTag = (value) => {
|
|
15
|
+
return Object.values(ForbiddenTag).includes(value);
|
|
16
|
+
};
|
|
17
|
+
const buildErrorMessage = (tag) => `Theme app extension blocks cannot contain '${tag}' tags`;
|
|
18
|
+
exports.AppBlockValidTags = {
|
|
19
|
+
meta: {
|
|
20
|
+
code: 'AppBlockValidTags',
|
|
21
|
+
name: 'App Block Valid Tags',
|
|
22
|
+
docs: {
|
|
23
|
+
description: 'Identifies forbidden Liquid tags in theme app extension app block and app embed block code.',
|
|
24
|
+
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/app-block-valid-tags',
|
|
25
|
+
recommended: false,
|
|
26
|
+
},
|
|
27
|
+
type: types_1.SourceCodeType.LiquidHtml,
|
|
28
|
+
severity: types_1.Severity.ERROR,
|
|
29
|
+
schema: {},
|
|
30
|
+
targets: [types_1.ConfigTarget.ThemeAppExtension],
|
|
31
|
+
},
|
|
32
|
+
create(context) {
|
|
33
|
+
const handleForbiddenTags = async (node) => {
|
|
34
|
+
if (isForbiddenTag(node.name)) {
|
|
35
|
+
// When a forbidden tag is used to define a block section
|
|
36
|
+
// with an end tag, highlight the whole section
|
|
37
|
+
const endIndex = node.blockEndPosition ? node.blockEndPosition.end : node.position.end;
|
|
38
|
+
const startIndex = node.blockStartPosition.start;
|
|
39
|
+
const message = buildErrorMessage(node.name);
|
|
40
|
+
return context.report({ message, startIndex, endIndex });
|
|
41
|
+
}
|
|
42
|
+
};
|
|
43
|
+
return {
|
|
44
|
+
LiquidRawTag: handleForbiddenTags,
|
|
45
|
+
LiquidTag: handleForbiddenTags,
|
|
46
|
+
};
|
|
47
|
+
},
|
|
48
|
+
};
|
|
49
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/checks/app-block-valid-tags/index.ts"],"names":[],"mappings":";;;AACA,uCAA4F;AAE5F,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,yCAAyB,CAAA;IACzB,yCAAyB,CAAA;IACzB,mCAAmB,CAAA;IACnB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;IACnB,qCAAqB,CAAA;AACvB,CAAC,EAPW,YAAY,4BAAZ,YAAY,QAOvB;AAED,MAAM,cAAc,GAAG,CAAC,KAAa,EAAyB,EAAE;IAC9D,OAAO,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,KAAqB,CAAC,CAAC;AACrE,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,GAAiB,EAAE,EAAE,CAC9C,8CAA8C,GAAG,QAAQ,CAAC;AAE/C,QAAA,iBAAiB,GAA0B;IACtD,IAAI,EAAE;QACJ,IAAI,EAAE,mBAAmB;QACzB,IAAI,EAAE,sBAAsB;QAC5B,IAAI,EAAE;YACJ,WAAW,EACT,6FAA6F;YAC/F,GAAG,EAAE,2FAA2F;YAChG,WAAW,EAAE,KAAK;SACnB;QACD,IAAI,EAAE,sBAAc,CAAC,UAAU;QAC/B,QAAQ,EAAE,gBAAQ,CAAC,KAAK;QACxB,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,CAAC,oBAAY,CAAC,iBAAiB,CAAC;KAC1C;IAED,MAAM,CAAC,OAAO;QACZ,MAAM,mBAAmB,GAAG,KAAK,EAAE,IAA8B,EAAE,EAAE;YACnE,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,yDAAyD;gBACzD,+CAA+C;gBAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;gBACvF,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC;gBACjD,MAAM,OAAO,GAAG,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAE7C,OAAO,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC,CAAC;QAEF,OAAO;YACL,YAAY,EAAE,mBAAmB;YACjC,SAAS,EAAE,mBAAmB;SAC/B,CAAC;IACJ,CAAC;CACF,CAAC"}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.AssetPreload = void 0;
|
|
4
|
+
const liquid_html_parser_1 = require("@platformos/liquid-html-parser");
|
|
5
|
+
const types_1 = require("../../types");
|
|
6
|
+
const utils_1 = require("../utils");
|
|
7
|
+
function isPreload(attr) {
|
|
8
|
+
return ((0, utils_1.isAttr)(attr, 'rel') &&
|
|
9
|
+
attr.value.some((node) => node.type === liquid_html_parser_1.NodeTypes.TextNode && node.value === 'preload'));
|
|
10
|
+
}
|
|
11
|
+
exports.AssetPreload = {
|
|
12
|
+
meta: {
|
|
13
|
+
code: 'AssetPreload',
|
|
14
|
+
name: 'Prevent Manual Preloading of Assets',
|
|
15
|
+
docs: {
|
|
16
|
+
description: 'This check is aimed at discouraging the manual preloading of assets and encourages the use of appropriate Shopify filters.',
|
|
17
|
+
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/asset-preload',
|
|
18
|
+
recommended: true,
|
|
19
|
+
},
|
|
20
|
+
type: types_1.SourceCodeType.LiquidHtml,
|
|
21
|
+
severity: types_1.Severity.WARNING,
|
|
22
|
+
schema: {},
|
|
23
|
+
targets: [],
|
|
24
|
+
},
|
|
25
|
+
create(context) {
|
|
26
|
+
return {
|
|
27
|
+
async HtmlVoidElement(node) {
|
|
28
|
+
const preloadLinkAttr = node.attributes.find((attr) => (0, utils_1.isValuedHtmlAttribute)(attr) && isPreload(attr));
|
|
29
|
+
if (node.name === 'link' && preloadLinkAttr) {
|
|
30
|
+
const asAttr = node.attributes
|
|
31
|
+
.filter(utils_1.isValuedHtmlAttribute)
|
|
32
|
+
.find((attr) => (0, utils_1.isAttr)(attr, 'as'));
|
|
33
|
+
const assetType = asAttr?.value.find((node) => (0, utils_1.isNodeOfType)(liquid_html_parser_1.NodeTypes.TextNode, node))?.value;
|
|
34
|
+
let message = '';
|
|
35
|
+
if (assetType === 'style') {
|
|
36
|
+
message =
|
|
37
|
+
'For better performance, prefer using the preload argument of the stylesheet_tag filter';
|
|
38
|
+
}
|
|
39
|
+
else if (assetType === 'image') {
|
|
40
|
+
message =
|
|
41
|
+
'For better performance, prefer using the preload argument of the image_tag filter';
|
|
42
|
+
}
|
|
43
|
+
else {
|
|
44
|
+
message = 'For better performance, prefer using the preload_tag filter';
|
|
45
|
+
}
|
|
46
|
+
context.report({
|
|
47
|
+
message,
|
|
48
|
+
startIndex: node.position.start,
|
|
49
|
+
endIndex: node.position.end,
|
|
50
|
+
});
|
|
51
|
+
}
|
|
52
|
+
},
|
|
53
|
+
};
|
|
54
|
+
},
|
|
55
|
+
};
|
|
56
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/checks/asset-preload/index.ts"],"names":[],"mappings":";;;AAAA,uEAAqE;AACrE,uCAA8E;AAC9E,oCAA4F;AAE5F,SAAS,SAAS,CAAC,IAAyB;IAC1C,OAAO,CACL,IAAA,cAAM,EAAC,IAAI,EAAE,KAAK,CAAC;QACnB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,8BAAS,CAAC,QAAQ,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,CACxF,CAAC;AACJ,CAAC;AAEY,QAAA,YAAY,GAA0B;IACjD,IAAI,EAAE;QACJ,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,qCAAqC;QAC3C,IAAI,EAAE;YACJ,WAAW,EACT,4HAA4H;YAC9H,GAAG,EAAE,oFAAoF;YACzF,WAAW,EAAE,IAAI;SAClB;QACD,IAAI,EAAE,sBAAc,CAAC,UAAU;QAC/B,QAAQ,EAAE,gBAAQ,CAAC,OAAO;QAC1B,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,EAAE;KACZ;IAED,MAAM,CAAC,OAAO;QACZ,OAAO;YACL,KAAK,CAAC,eAAe,CAAC,IAAI;gBACxB,MAAM,eAAe,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAC1C,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,6BAAqB,EAAC,IAAI,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,CACtB,CAAC;gBAErC,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,eAAe,EAAE,CAAC;oBAC5C,MAAM,MAAM,GAAoC,IAAI,CAAC,UAAU;yBAC5D,MAAM,CAAC,6BAAqB,CAAC;yBAC7B,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,cAAM,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;oBAEtC,MAAM,SAAS,GAAG,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAoB,EAAE,CAC9D,IAAA,oBAAY,EAAC,8BAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CACvC,EAAE,KAAK,CAAC;oBAET,IAAI,OAAO,GAAG,EAAE,CAAC;oBAEjB,IAAI,SAAS,KAAK,OAAO,EAAE,CAAC;wBAC1B,OAAO;4BACL,wFAAwF,CAAC;oBAC7F,CAAC;yBAAM,IAAI,SAAS,KAAK,OAAO,EAAE,CAAC;wBACjC,OAAO;4BACL,mFAAmF,CAAC;oBACxF,CAAC;yBAAM,CAAC;wBACN,OAAO,GAAG,6DAA6D,CAAC;oBAC1E,CAAC;oBAED,OAAO,CAAC,MAAM,CAAC;wBACb,OAAO;wBACP,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK;wBAC/B,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG;qBAC5B,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC"}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.AssetSizeAppBlockCSS = void 0;
|
|
4
|
+
const json_1 = require("../../json");
|
|
5
|
+
const types_1 = require("../../types");
|
|
6
|
+
const utils_1 = require("../../utils");
|
|
7
|
+
const file_utils_1 = require("../../utils/file-utils");
|
|
8
|
+
const schema = {
|
|
9
|
+
thresholdInBytes: types_1.SchemaProp.number(100000),
|
|
10
|
+
};
|
|
11
|
+
exports.AssetSizeAppBlockCSS = {
|
|
12
|
+
meta: {
|
|
13
|
+
code: 'AssetSizeAppBlockCSS',
|
|
14
|
+
name: 'Asset Size App Block CSS',
|
|
15
|
+
docs: {
|
|
16
|
+
description: 'This check is aimed at preventing large CSS bundles from being included via Theme App Extensions.',
|
|
17
|
+
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/asset-size-app-block-css',
|
|
18
|
+
recommended: true,
|
|
19
|
+
},
|
|
20
|
+
type: types_1.SourceCodeType.LiquidHtml,
|
|
21
|
+
severity: types_1.Severity.ERROR,
|
|
22
|
+
schema,
|
|
23
|
+
targets: [types_1.ConfigTarget.ThemeAppExtension],
|
|
24
|
+
},
|
|
25
|
+
create(context) {
|
|
26
|
+
if (!context.fileSize) {
|
|
27
|
+
return {};
|
|
28
|
+
}
|
|
29
|
+
return {
|
|
30
|
+
async LiquidRawTag(node) {
|
|
31
|
+
if (node.name !== 'schema')
|
|
32
|
+
return;
|
|
33
|
+
const schema = (0, json_1.parseJSON)(node.body.value);
|
|
34
|
+
if ((0, utils_1.isError)(schema))
|
|
35
|
+
return;
|
|
36
|
+
const stylesheet = schema.stylesheet;
|
|
37
|
+
if (!stylesheet)
|
|
38
|
+
return;
|
|
39
|
+
const relativePath = `assets/${stylesheet}`;
|
|
40
|
+
const thresholdInBytes = context.settings.thresholdInBytes;
|
|
41
|
+
const startIndex = node.body.position.start + node.body.value.indexOf(stylesheet);
|
|
42
|
+
const endIndex = startIndex + stylesheet.length;
|
|
43
|
+
const fileExists = await (0, file_utils_1.doesFileExist)(context, relativePath);
|
|
44
|
+
if (!fileExists) {
|
|
45
|
+
context.report({
|
|
46
|
+
message: `'${stylesheet}' does not exist.`,
|
|
47
|
+
startIndex: startIndex,
|
|
48
|
+
endIndex: endIndex,
|
|
49
|
+
});
|
|
50
|
+
return;
|
|
51
|
+
}
|
|
52
|
+
const [fileExceedsThreshold, fileSize] = await (0, file_utils_1.doesFileExceedThreshold)(context, relativePath, thresholdInBytes);
|
|
53
|
+
if (fileExceedsThreshold) {
|
|
54
|
+
context.report({
|
|
55
|
+
message: `The file size for '${stylesheet}' (${fileSize} B) exceeds the configured threshold (${thresholdInBytes} B)`,
|
|
56
|
+
startIndex: startIndex,
|
|
57
|
+
endIndex: endIndex,
|
|
58
|
+
});
|
|
59
|
+
}
|
|
60
|
+
},
|
|
61
|
+
};
|
|
62
|
+
},
|
|
63
|
+
};
|
|
64
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/checks/asset-size-app-block-css/index.ts"],"names":[],"mappings":";;;AAAA,qCAAuC;AACvC,uCAMqB;AACrB,uCAAsC;AACtC,uDAAgF;AAEhF,MAAM,MAAM,GAAG;IACb,gBAAgB,EAAE,kBAAU,CAAC,MAAM,CAAC,MAAM,CAAC;CAC5C,CAAC;AAEW,QAAA,oBAAoB,GAAyC;IACxE,IAAI,EAAE;QACJ,IAAI,EAAE,sBAAsB;QAC5B,IAAI,EAAE,0BAA0B;QAChC,IAAI,EAAE;YACJ,WAAW,EACT,mGAAmG;YACrG,GAAG,EAAE,+FAA+F;YACpG,WAAW,EAAE,IAAI;SAClB;QACD,IAAI,EAAE,sBAAc,CAAC,UAAU;QAC/B,QAAQ,EAAE,gBAAQ,CAAC,KAAK;QACxB,MAAM;QACN,OAAO,EAAE,CAAC,oBAAY,CAAC,iBAAiB,CAAC;KAC1C;IAED,MAAM,CAAC,OAAO;QACZ,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YACtB,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO;YACL,KAAK,CAAC,YAAY,CAAC,IAAI;gBACrB,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ;oBAAE,OAAO;gBACnC,MAAM,MAAM,GAAG,IAAA,gBAAS,EAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC1C,IAAI,IAAA,eAAO,EAAC,MAAM,CAAC;oBAAE,OAAO;gBAC5B,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;gBACrC,IAAI,CAAC,UAAU;oBAAE,OAAO;gBAExB,MAAM,YAAY,GAAG,UAAU,UAAU,EAAE,CAAC;gBAC5C,MAAM,gBAAgB,GAAG,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC;gBAE3D,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;gBAClF,MAAM,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC;gBAEhD,MAAM,UAAU,GAAG,MAAM,IAAA,0BAAa,EAAC,OAAO,EAAE,YAAY,CAAC,CAAC;gBAE9D,IAAI,CAAC,UAAU,EAAE,CAAC;oBAChB,OAAO,CAAC,MAAM,CAAC;wBACb,OAAO,EAAE,IAAI,UAAU,mBAAmB;wBAC1C,UAAU,EAAE,UAAU;wBACtB,QAAQ,EAAE,QAAQ;qBACnB,CAAC,CAAC;oBACH,OAAO;gBACT,CAAC;gBAED,MAAM,CAAC,oBAAoB,EAAE,QAAQ,CAAC,GAAG,MAAM,IAAA,oCAAuB,EACpE,OAAO,EACP,YAAY,EACZ,gBAAgB,CACjB,CAAC;gBAEF,IAAI,oBAAoB,EAAE,CAAC;oBACzB,OAAO,CAAC,MAAM,CAAC;wBACb,OAAO,EAAE,sBAAsB,UAAU,MAAM,QAAQ,yCAAyC,gBAAgB,KAAK;wBACrH,UAAU,EAAE,UAAU;wBACtB,QAAQ,EAAE,QAAQ;qBACnB,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC"}
|