npm - @platformos/platformos-check-common - Versions diffs - 0.0.7 → 0.0.8 - Mend

@platformos/platformos-check-common 0.0.7 → 0.0.8

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.

Files changed (309) hide show

package/CHANGELOG.md +8 -0
package/dist/AugmentedPlatformOSDocset.d.ts +11 -0
package/dist/AugmentedPlatformOSDocset.js +81 -0
package/dist/AugmentedPlatformOSDocset.js.map +1 -0
package/dist/JSONValidator.js +1 -1
package/dist/JSONValidator.js.map +1 -1
package/dist/checks/deprecated-filter/index.js +4 -41
package/dist/checks/deprecated-filter/index.js.map +1 -1
package/dist/checks/deprecated-tag/index.js +21 -22
package/dist/checks/deprecated-tag/index.js.map +1 -1
package/dist/checks/duplicate-function-arguments/index.js +1 -1
package/dist/checks/duplicate-function-arguments/index.js.map +1 -1
package/dist/checks/duplicate-render-partial-arguments/index.js +1 -1
package/dist/checks/duplicate-render-partial-arguments/index.js.map +1 -1
package/dist/checks/graphql/index.js +1 -1
package/dist/checks/graphql/index.js.map +1 -1
package/dist/checks/img-width-and-height/index.js +1 -1
package/dist/checks/img-width-and-height/index.js.map +1 -1
package/dist/checks/index.d.ts +3 -3
package/dist/checks/index.js +4 -79
package/dist/checks/index.js.map +1 -1
package/dist/checks/json-syntax-error/index.js +1 -1
package/dist/checks/json-syntax-error/index.js.map +1 -1
package/dist/checks/liquid-html-syntax-error/index.js +2 -2
package/dist/checks/liquid-html-syntax-error/index.js.map +1 -1
package/dist/checks/matching-translations/index.d.ts +2 -2
package/dist/checks/matching-translations/index.js +20 -31
package/dist/checks/matching-translations/index.js.map +1 -1
package/dist/checks/metadata-params/index.js +6 -3
package/dist/checks/metadata-params/index.js.map +1 -1
package/dist/checks/missing-asset/index.js +1 -1
package/dist/checks/missing-asset/index.js.map +1 -1
package/dist/checks/missing-partial/index.d.ts +6 -0
package/dist/checks/missing-partial/index.js +70 -0
package/dist/checks/missing-partial/index.js.map +1 -0
package/dist/checks/orphaned-partial/index.js +4 -4
package/dist/checks/orphaned-partial/index.js.map +1 -1
package/dist/checks/parser-blocking-script/index.js +10 -36
package/dist/checks/parser-blocking-script/index.js.map +1 -1
package/dist/checks/parser-blocking-script/suggestions.d.ts +1 -2
package/dist/checks/parser-blocking-script/suggestions.js +1 -11
package/dist/checks/parser-blocking-script/suggestions.js.map +1 -1
package/dist/checks/reserved-doc-param-names/index.js +6 -5
package/dist/checks/reserved-doc-param-names/index.js.map +1 -1
package/dist/checks/translation-key-exists/index.js +1 -1
package/dist/checks/translation-key-exists/index.js.map +1 -1
package/dist/checks/unclosed-html-element/index.js +5 -1
package/dist/checks/unclosed-html-element/index.js.map +1 -1
package/dist/checks/undefined-object/index.js +7 -30
package/dist/checks/undefined-object/index.js.map +1 -1
package/dist/checks/unique-doc-param-names/index.js +1 -1
package/dist/checks/unique-doc-param-names/index.js.map +1 -1
package/dist/checks/unknown-filter/index.js +3 -3
package/dist/checks/unknown-filter/index.js.map +1 -1
package/dist/checks/unknown-property/index.js +1 -1
package/dist/checks/unknown-property/index.js.map +1 -1
package/dist/checks/unrecognized-render-partial-arguments/index.js +2 -2
package/dist/checks/unrecognized-render-partial-arguments/index.js.map +1 -1
package/dist/checks/unused-assign/index.js +1 -1
package/dist/checks/unused-assign/index.js.map +1 -1
package/dist/checks/unused-doc-param/index.js +1 -1
package/dist/checks/unused-doc-param/index.js.map +1 -1
package/dist/checks/utils.js +1 -1
package/dist/checks/utils.js.map +1 -1
package/dist/checks/valid-content-for-arguments/index.js +1 -1
package/dist/checks/valid-content-for-arguments/index.js.map +1 -1
package/dist/checks/valid-doc-param-types/index.js +4 -4
package/dist/checks/valid-doc-param-types/index.js.map +1 -1
package/dist/checks/valid-html-translation/index.d.ts +2 -2
package/dist/checks/valid-html-translation/index.js +4 -4
package/dist/checks/valid-html-translation/index.js.map +1 -1
package/dist/checks/valid-json/index.js +1 -1
package/dist/checks/valid-json/index.js.map +1 -1
package/dist/checks/valid-render-partial-argument-types/index.js +2 -2
package/dist/checks/valid-render-partial-argument-types/index.js.map +1 -1
package/dist/checks/variable-name/index.js +1 -1
package/dist/checks/variable-name/index.js.map +1 -1
package/dist/context-utils.d.ts +2 -7
package/dist/context-utils.js +39 -109
package/dist/context-utils.js.map +1 -1
package/dist/disabled-checks/index.js +4 -2
package/dist/disabled-checks/index.js.map +1 -1
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 +7 -10
package/dist/find-root.js +10 -17
package/dist/find-root.js.map +1 -1
package/dist/fixes/autofix.d.ts +4 -4
package/dist/fixes/autofix.js +2 -2
package/dist/fixes/autofix.js.map +1 -1
package/dist/fixes/correctors/index.js +4 -0
package/dist/fixes/correctors/index.js.map +1 -1
package/dist/index.d.ts +4 -5
package/dist/index.js +34 -17
package/dist/index.js.map +1 -1
package/dist/jsonc/parse.d.ts +1 -1
package/dist/jsonc/parse.js +1 -1
package/dist/liquid-doc/arguments.d.ts +7 -8
package/dist/liquid-doc/arguments.js +20 -28
package/dist/liquid-doc/arguments.js.map +1 -1
package/dist/liquid-doc/liquidDoc.d.ts +1 -1
package/dist/liquid-doc/liquidDoc.js.map +1 -1
package/dist/liquid-doc/utils.d.ts +1 -1
package/dist/liquid-doc/utils.js +4 -3
package/dist/liquid-doc/utils.js.map +1 -1
package/dist/path.d.ts +1 -0
package/dist/path.js +5 -1
package/dist/path.js.map +1 -1
package/dist/test/MockApp.d.ts +16 -0
package/dist/test/MockApp.js +16 -0
package/dist/test/MockApp.js.map +1 -0
package/dist/test/MockFileSystem.d.ts +3 -3
package/dist/test/MockFileSystem.js +6 -6
package/dist/test/MockFileSystem.js.map +1 -1
package/dist/test/index.d.ts +1 -1
package/dist/test/index.js +1 -1
package/dist/test/index.js.map +1 -1
package/dist/test/test-helper.d.ts +10 -9
package/dist/test/test-helper.js +15 -106
package/dist/test/test-helper.js.map +1 -1
package/dist/to-schema.d.ts +1 -1
package/dist/to-source-code.d.ts +3 -2
package/dist/to-source-code.js +20 -0
package/dist/to-source-code.js.map +1 -1
package/dist/tsconfig.tsbuildinfo +1 -1
package/dist/types/platformos-liquid-docs.d.ts +128 -0
package/dist/types/platformos-liquid-docs.js +3 -0
package/dist/types/platformos-liquid-docs.js.map +1 -0
package/dist/types/schemas/index.d.ts +0 -2
package/dist/types/schemas/index.js.map +1 -1
package/dist/types.d.ts +18 -67
package/dist/types.js +3 -5
package/dist/types.js.map +1 -1
package/dist/utils/block.js.map +1 -1
package/dist/utils/index.d.ts +0 -1
package/dist/utils/index.js +0 -1
package/dist/utils/index.js.map +1 -1
package/dist/yaml/parse.d.ts +5 -0
package/dist/yaml/parse.js +94 -0
package/dist/yaml/parse.js.map +1 -0
package/package.json +4 -3
package/src/{AugmentedThemeDocset.spec.ts → AugmentedPlatformOSDocset.spec.ts} +47 -34
package/src/AugmentedPlatformOSDocset.ts +89 -0
package/src/JSONValidator.ts +1 -1
package/src/checks/deprecated-filter/index.spec.ts +76 -248
package/src/checks/deprecated-filter/index.ts +5 -53
package/src/checks/deprecated-tag/index.spec.ts +85 -34
package/src/checks/deprecated-tag/index.ts +27 -22
package/src/checks/duplicate-function-arguments/index.ts +1 -1
package/src/checks/duplicate-render-partial-arguments/index.ts +1 -1
package/src/checks/graphql/index.ts +1 -1
package/src/checks/img-width-and-height/index.ts +1 -1
package/src/checks/index.ts +11 -80
package/src/checks/invalid-hash-assign-target/index.spec.ts +14 -14
package/src/checks/json-syntax-error/index.ts +1 -1
package/src/checks/liquid-html-syntax-error/checks/InvalidBooleanExpression.spec.ts +0 -11
package/src/checks/liquid-html-syntax-error/checks/InvalidLoopArguments.spec.ts +1 -2
package/src/checks/liquid-html-syntax-error/index.spec.ts +1 -6
package/src/checks/liquid-html-syntax-error/index.ts +2 -2
package/src/checks/matching-translations/index.spec.ts +89 -346
package/src/checks/matching-translations/index.ts +24 -35
package/src/checks/metadata-params/index.ts +5 -7
package/src/checks/missing-asset/index.ts +1 -1
package/src/checks/{missing-template → missing-partial}/index.spec.ts +6 -6
package/src/checks/{missing-template → missing-partial}/index.ts +6 -20
package/src/checks/orphaned-partial/index.ts +3 -3
package/src/checks/parser-blocking-script/index.spec.ts +0 -118
package/src/checks/parser-blocking-script/index.ts +3 -33
package/src/checks/parser-blocking-script/suggestions.ts +1 -28
package/src/checks/translation-key-exists/index.ts +1 -1
package/src/checks/unclosed-html-element/index.ts +5 -1
package/src/checks/undefined-object/index.spec.ts +3 -109
package/src/checks/undefined-object/index.ts +8 -33
package/src/checks/unique-doc-param-names/index.ts +1 -1
package/src/checks/unknown-filter/index.spec.ts +2 -2
package/src/checks/unknown-filter/index.ts +3 -3
package/src/checks/unknown-property/index.ts +1 -1
package/src/checks/unrecognized-render-partial-arguments/index.spec.ts +5 -5
package/src/checks/unrecognized-render-partial-arguments/index.ts +2 -5
package/src/checks/unused-assign/index.spec.ts +0 -30
package/src/checks/unused-assign/index.ts +1 -1
package/src/checks/unused-doc-param/index.ts +1 -1
package/src/checks/utils.ts +1 -1
package/src/checks/valid-doc-param-types/index.ts +4 -4
package/src/checks/valid-html-translation/index.spec.ts +42 -32
package/src/checks/valid-html-translation/index.ts +7 -7
package/src/checks/valid-json/index.ts +1 -1
package/src/checks/valid-render-partial-argument-types/index.ts +2 -5
package/src/checks/variable-name/index.ts +1 -1
package/src/context-utils.spec.ts +49 -77
package/src/context-utils.ts +39 -128
package/src/disabled-checks/index.spec.ts +35 -0
package/src/disabled-checks/index.ts +4 -2
package/src/find-root.ts +12 -22
package/src/fixes/autofix.spec.ts +2 -2
package/src/fixes/autofix.ts +4 -4
package/src/fixes/correctors/index.ts +4 -0
package/src/ignore.spec.ts +0 -1
package/src/index.ts +33 -21
package/src/jsonc/parse.ts +1 -1
package/src/liquid-doc/arguments.spec.ts +19 -45
package/src/liquid-doc/arguments.ts +26 -39
package/src/liquid-doc/liquidDoc.ts +1 -2
package/src/liquid-doc/utils.ts +4 -3
package/src/path.ts +1 -0
package/src/test/{MockTheme.ts → MockApp.ts} +1 -1
package/src/test/MockFileSystem.ts +6 -6
package/src/test/index.ts +1 -1
package/src/test/test-helper.ts +29 -127
package/src/to-source-code.ts +20 -1
package/src/types/{theme-liquid-docs.ts → platformos-liquid-docs.ts} +8 -13
package/src/types/schemas/index.ts +0 -2
package/src/types.ts +21 -92
package/src/utils/index.ts +0 -1
package/src/yaml/parse.ts +111 -0
package/src/AugmentedThemeDocset.ts +0 -137
package/src/checks/app-block-missing-schema/index.spec.ts +0 -121
package/src/checks/app-block-missing-schema/index.ts +0 -46
package/src/checks/app-block-valid-tags/index.spec.ts +0 -96
package/src/checks/app-block-valid-tags/index.ts +0 -54
package/src/checks/asset-preload/index.spec.ts +0 -78
package/src/checks/asset-preload/index.ts +0 -65
package/src/checks/asset-size-app-block-css/index.spec.ts +0 -88
package/src/checks/asset-size-app-block-css/index.ts +0 -78
package/src/checks/asset-size-app-block-javascript/index.spec.ts +0 -66
package/src/checks/asset-size-app-block-javascript/index.ts +0 -78
package/src/checks/asset-size-css/index.spec.ts +0 -166
package/src/checks/asset-size-css/index.ts +0 -160
package/src/checks/asset-size-javascript/index.spec.ts +0 -184
package/src/checks/asset-size-javascript/index.ts +0 -144
package/src/checks/block-id-usage/index.spec.ts +0 -76
package/src/checks/block-id-usage/index.ts +0 -72
package/src/checks/cdn-preconnect/index.spec.ts +0 -40
package/src/checks/cdn-preconnect/index.ts +0 -43
package/src/checks/content-for-header-modification/index.spec.ts +0 -65
package/src/checks/content-for-header-modification/index.ts +0 -72
package/src/checks/deprecate-bgsizes/index.spec.ts +0 -41
package/src/checks/deprecate-bgsizes/index.ts +0 -49
package/src/checks/deprecate-lazysizes/index.spec.ts +0 -26
package/src/checks/deprecate-lazysizes/index.ts +0 -58
package/src/checks/deprecated-filter/fixes.ts +0 -264
package/src/checks/deprecated-fonts-on-sections-and-blocks/deprecated-fonts-data.ts +0 -1343
package/src/checks/deprecated-fonts-on-sections-and-blocks/index.spec.ts +0 -613
package/src/checks/deprecated-fonts-on-sections-and-blocks/index.ts +0 -284
package/src/checks/deprecated-fonts-on-settings-schema/index.spec.ts +0 -102
package/src/checks/deprecated-fonts-on-settings-schema/index.ts +0 -66
package/src/checks/duplicate-content-for-arguments/index.spec.ts +0 -98
package/src/checks/duplicate-content-for-arguments/index.ts +0 -43
package/src/checks/empty-block-content/index.spec.ts +0 -117
package/src/checks/empty-block-content/index.ts +0 -60
package/src/checks/hardcoded-routes/index.spec.ts +0 -58
package/src/checks/hardcoded-routes/index.ts +0 -100
package/src/checks/json-missing-block/index.spec.ts +0 -435
package/src/checks/json-missing-block/index.ts +0 -56
package/src/checks/json-missing-block/missing-block-utils.ts +0 -147
package/src/checks/liquid-free-settings/index.spec.ts +0 -180
package/src/checks/liquid-free-settings/index.ts +0 -79
package/src/checks/missing-content-for-arguments/index.spec.ts +0 -144
package/src/checks/missing-content-for-arguments/index.ts +0 -46
package/src/checks/pagination-size/index.spec.ts +0 -158
package/src/checks/pagination-size/index.ts +0 -104
package/src/checks/remote-asset/index.spec.ts +0 -280
package/src/checks/remote-asset/index.ts +0 -238
package/src/checks/reserved-doc-param-names/index.spec.ts +0 -62
package/src/checks/reserved-doc-param-names/index.ts +0 -57
package/src/checks/schema-presets-block-order/index.spec.ts +0 -344
package/src/checks/schema-presets-block-order/index.ts +0 -154
package/src/checks/schema-presets-static-blocks/index.spec.ts +0 -145
package/src/checks/schema-presets-static-blocks/index.ts +0 -126
package/src/checks/static-stylesheet-and-javascript-tags/index.spec.ts +0 -257
package/src/checks/static-stylesheet-and-javascript-tags/index.ts +0 -48
package/src/checks/unique-settings-id/index.spec.ts +0 -24
package/src/checks/unique-settings-id/index.ts +0 -84
package/src/checks/unique-settings-id/test-data.ts +0 -1191
package/src/checks/unique-static-block-id/index.spec.ts +0 -55
package/src/checks/unique-static-block-id/index.ts +0 -60
package/src/checks/unrecognized-content-for-arguments/index.spec.ts +0 -145
package/src/checks/unrecognized-content-for-arguments/index.ts +0 -55
package/src/checks/valid-block-target/index.spec.ts +0 -1396
package/src/checks/valid-block-target/index.ts +0 -142
package/src/checks/valid-content-for-argument-types/index.spec.ts +0 -382
package/src/checks/valid-content-for-argument-types/index.ts +0 -42
package/src/checks/valid-content-for-arguments/index.spec.ts +0 -107
package/src/checks/valid-content-for-arguments/index.ts +0 -98
package/src/checks/valid-local-blocks/index.spec.ts +0 -286
package/src/checks/valid-local-blocks/index.ts +0 -100
package/src/checks/valid-local-blocks/valid-block-utils.ts +0 -97
package/src/checks/valid-schema/index.spec.ts +0 -174
package/src/checks/valid-schema/index.ts +0 -41
package/src/checks/valid-schema-name/index.spec.ts +0 -112
package/src/checks/valid-schema-name/index.ts +0 -75
package/src/checks/valid-settings-key/index.spec.ts +0 -321
package/src/checks/valid-settings-key/index.ts +0 -144
package/src/checks/valid-static-block-type/index.spec.ts +0 -38
package/src/checks/valid-static-block-type/index.ts +0 -58
package/src/checks/valid-visible-if/index.spec.ts +0 -619
package/src/checks/valid-visible-if/index.ts +0 -184
package/src/checks/valid-visible-if/visible-if-utils.ts +0 -158
package/src/tags/content-for.ts +0 -25
package/src/to-schema.ts +0 -231
package/src/types/schemas/section.ts +0 -86
package/src/types/schemas/theme-block.ts +0 -34
package/src/types/theme-schemas.ts +0 -80
package/src/utils/block.ts +0 -300
package/src/utils/markup.ts +0 -10

package/src/checks/asset-size-javascript/index.spec.ts DELETED Viewed

@@ -1,184 +0,0 @@
-import { expect, describe, it, afterEach, vi } from 'vitest';
-import { AssetSizeJavaScript } from '.';
-import { check, MockTheme } from '../../test';
-import { SchemaProp } from '../../types';
-import { hasRemoteAssetSizeExceededThreshold } from '../../utils/file-utils';
-vi.mock('../../utils/file-utils', async (importOriginal) => {
-  const actual: any = await importOriginal();
-  return {
-    ...actual,
-    hasRemoteAssetSizeExceededThreshold: vi.fn(),
-  };
-});
-describe('Module: AssetSizeJavaScript', () => {
-  const theme: MockTheme = {
-    'assets/theme.js': "console.log('hello world'); console.log('Oh. Hi Mark!')",
-    'templates/index.liquid': `
-      <html>
-        <head>
-          <script src="{{ 'theme.js' | asset_url }}" defer></script>
-        </head>
-      </html>
-    `,
-  };
-  const httpTest: MockTheme = {
-    'templates/index.liquid': `
-      <html>
-        <head>
-          <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/js/bootstrap.min.js" defer></script>
-        </head>
-      </html>
-    `,
-  };
-  afterEach(() => {
-    vi.clearAllMocks();
-  });
-  it('should not find file size for invalid URLs', async () => {
-    const invalidUrls = [
-      'https://{{ settings.url }}',
-      "{{ 'this_file_does_not_exist.js' | asset_url }}",
-      '{% if on_product %}https://hello.world{% else %}https://hi.world{% endif %}',
-    ];
-    for (const url of invalidUrls) {
-      const offenses = await check(
-        { 'templates/index.liquid': `<script src="${url}" defer></script>` },
-        [AssetSizeJavaScript],
-      );
-      expect(offenses).toHaveLength(0);
-    }
-  });
-  it('should report a warning when the JavaScript http request exceeds the threshold', async () => {
-    vi.mocked(hasRemoteAssetSizeExceededThreshold).mockReturnValue(Promise.resolve(true));
-    const offenses = await check(
-      httpTest,
-      [AssetSizeJavaScript],
-      {},
-      {
-        AssetSizeJavaScript: {
-          enabled: true,
-          thresholdInBytes: 1,
-        },
-      },
-    );
-    expect(offenses).toHaveLength(1);
-    expect(offenses[0]).toMatchObject({
-      message:
-        'JavaScript on every page load exceeds compressed size threshold (1 Bytes), consider using the import on interaction pattern.',
-      uri: 'file:///templates/index.liquid',
-      start: { index: 52 },
-      end: { index: 121 },
-    });
-  });
-  it('should not report any offenses if JavaScript is smaller than threshold', async () => {
-    const offenses = await check(theme, [AssetSizeJavaScript]);
-    expect(offenses).toHaveLength(0);
-  });
-  it('should report an offense if JavaScript is larger than threshold', async () => {
-    const offenses = await check(
-      theme,
-      [AssetSizeJavaScript],
-      {},
-      {
-        AssetSizeJavaScript: {
-          enabled: true,
-          thresholdInBytes: 2,
-        },
-      },
-    );
-    expect(offenses).toHaveLength(1);
-    expect(offenses[0]).toMatchObject({
-      message:
-        'JavaScript on every page load exceeds compressed size threshold (2 Bytes), consider using the import on interaction pattern.',
-      uri: 'file:///templates/index.liquid',
-      start: { index: 52 },
-      end: { index: 80 },
-    });
-  });
-  it('should not report any offenses for inline JavaScript', async () => {
-    const inlineTheme: MockTheme = {
-      'templates/index.liquid': `
-        <html>
-          <head>
-            <script>
-              console.log('hello world');
-            </script>
-          </head>
-        </html>
-      `,
-    };
-    const offenses = await check(inlineTheme, [AssetSizeJavaScript]);
-    expect(offenses).toHaveLength(0);
-  });
-  it('should report an offense if JS is larger than threshold', async () => {
-    const extensionFiles: MockTheme = {
-      'assets/theme.js': 'console.log("hello world");',
-      'templates/index.liquid': `
-        <html>
-          <head>
-            {{ 'theme.js' | asset_url | script_tag }}
-            {{ "https://example.com" | script_tag }}
-          </head>
-        </html>
-      `,
-    };
-    const offenses = await check(
-      extensionFiles,
-      [AssetSizeJavaScript],
-      {},
-      {
-        AssetSizeJavaScript: {
-          enabled: true,
-          thresholdInBytes: 2,
-        },
-      },
-    );
-    expect(offenses).toHaveLength(2);
-    expect(offenses[0]).toMatchObject({
-      message:
-        'JavaScript on every page load exceeds compressed size threshold (2 Bytes), consider using the import on interaction pattern.',
-      uri: 'file:///templates/index.liquid',
-      start: { index: 48 },
-      end: { index: 84 },
-    });
-    expect(offenses[1]).toMatchObject({
-      message:
-        'JavaScript on every page load exceeds compressed size threshold (2 Bytes), consider using the import on interaction pattern.',
-      uri: 'file:///templates/index.liquid',
-      start: { index: 102 },
-      end: { index: 123 },
-    });
-  });
-  it('should not report any offenses if there is no javascript', async () => {
-    const extensionFiles: MockTheme = {
-      'templates/index.liquid': `
-        <html>
-          <head>
-          </head>
-        </html>
-      `,
-    };
-    const offenses = await check(extensionFiles, [AssetSizeJavaScript]);
-    expect(offenses).toHaveLength(0);
-  });
-});

package/src/checks/asset-size-javascript/index.ts DELETED Viewed

@@ -1,144 +0,0 @@
-import {
-  LiquidString,
-  LiquidVariable,
-  LiquidVariableOutput,
-  NodeTypes,
-  TextNode,
-} from '@platformos/liquid-html-parser';
-import {
-  LiquidCheckDefinition,
-  LiquidHtmlNode,
-  SchemaProp,
-  Severity,
-  SourceCodeType,
-} from '../../types';
-import { last } from '../../utils';
-import {
-  hasRemoteAssetSizeExceededThreshold,
-  hasLocalAssetSizeExceededThreshold,
-} from '../../utils/file-utils';
-import { ValuedHtmlAttribute, isAttr, isNodeOfType, isValuedHtmlAttribute } from '../utils';
-const schema = {
-  thresholdInBytes: SchemaProp.number(10000),
-};
-function isTextNode(node: LiquidHtmlNode): node is TextNode {
-  return node.type === NodeTypes.TextNode;
-}
-function isLiquidVariableOutput(node: LiquidHtmlNode): node is LiquidVariableOutput {
-  return node.type === NodeTypes.LiquidVariableOutput;
-}
-function isLiquidVariable(node: LiquidHtmlNode | string): node is LiquidVariable {
-  return typeof node !== 'string' && node.type === NodeTypes.LiquidVariable;
-}
-function isString(node: LiquidHtmlNode): node is LiquidString {
-  return node.type === NodeTypes.String;
-}
-export const AssetSizeJavaScript: LiquidCheckDefinition<typeof schema> = {
-  meta: {
-    code: 'AssetSizeJavaScript',
-    name: 'Prevent Large JavaScript bundles',
-    docs: {
-      description: 'This check is aimed at preventing large JavaScript bundles for speed.',
-      url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/asset-size-javascript',
-      recommended: false,
-    },
-    type: SourceCodeType.LiquidHtml,
-    severity: Severity.ERROR,
-    schema,
-    targets: [],
-  },
-  create(context) {
-    if (!context.fileSize) {
-      return {};
-    }
-    const thresholdInBytes = context.settings.thresholdInBytes;
-    async function checkRemoteAssetSize(url: string, position: { start: number; end: number }) {
-      if (await hasRemoteAssetSizeExceededThreshold(url, thresholdInBytes)) {
-        context.report({
-          message: `JavaScript on every page load exceeds compressed size threshold (${thresholdInBytes} Bytes), consider using the import on interaction pattern.`,
-          startIndex: position.start,
-          endIndex: position.end,
-        });
-      }
-    }
-    async function checkThemeAssetSize(srcValue: string, position: { start: number; end: number }) {
-      if (
-        await hasLocalAssetSizeExceededThreshold(context, `assets/${srcValue}`, thresholdInBytes)
-      ) {
-        context.report({
-          message: `JavaScript on every page load exceeds compressed size threshold (${thresholdInBytes} Bytes), consider using the import on interaction pattern.`,
-          startIndex: position.start,
-          endIndex: position.end,
-        });
-      }
-    }
-    return {
-      async HtmlRawNode(node) {
-        if (node.name !== 'script') return;
-        const src: ValuedHtmlAttribute | undefined = node.attributes
-          .filter(isValuedHtmlAttribute)
-          .find((attr) => isAttr(attr, 'src'));
-        if (!src) return;
-        if (src.value.length !== 1) return;
-        if (isTextNode(src.value[0]) && /(https?:)?\/\//.test(src.value[0].value)) {
-          const url = src.value[0].value;
-          await checkRemoteAssetSize(url, src.attributePosition);
-        }
-        if (
-          isLiquidVariableOutput(src.value[0]) &&
-          isLiquidVariable(src.value[0].markup) &&
-          isString(src.value[0].markup.expression) &&
-          src.value[0].markup.filters.length === 1 &&
-          src.value[0].markup.filters[0].name === 'asset_url'
-        ) {
-          const assetName = src.value[0].markup.expression.value;
-          await checkThemeAssetSize(assetName, src.attributePosition);
-        }
-      },
-      async LiquidFilter(node, ancestors) {
-        if (node.name !== 'script_tag') return;
-        const liquidVariableParent = last(ancestors);
-        if (!liquidVariableParent || !isNodeOfType(NodeTypes.LiquidVariable, liquidVariableParent))
-          return;
-        if (liquidVariableParent.expression.type !== NodeTypes.String) return;
-        if (
-          liquidVariableParent.expression.value[0].length == 1 &&
-          liquidVariableParent.filters.length == 1 &&
-          /(https?:)?\/\//.test(liquidVariableParent.expression.value)
-        ) {
-          const url = liquidVariableParent.expression.value;
-          await checkRemoteAssetSize(url, liquidVariableParent.expression.position);
-        }
-        if (
-          liquidVariableParent.expression.value[0].length == 1 &&
-          liquidVariableParent.filters.length == 2 &&
-          liquidVariableParent.filters[0].name === 'asset_url' &&
-          liquidVariableParent.filters[1].name === 'script_tag'
-        ) {
-          const js = liquidVariableParent.expression.value;
-          await checkThemeAssetSize(js, liquidVariableParent.position);
-        }
-      },
-    };
-  },
-};

package/src/checks/block-id-usage/index.spec.ts DELETED Viewed

@@ -1,76 +0,0 @@
-import { expect, describe, it } from 'vitest';
-import { highlightedOffenses, runLiquidCheck } from '../../test';
-import { BlockIdUsage } from './index';
-describe('Module: ContentForHeaderModification', () => {
-  it('reports offense with the use of block.id in an if liquid tag', async () => {
-    const sourceCode = `
-      {% if block.id == '123' %}
-        No bueno
-      {% endif %}
-    `;
-    const offenses = await runLiquidCheck(BlockIdUsage, sourceCode);
-    expect(offenses).toHaveLength(1);
-    expect(offenses[0].message).toEqual(
-      'The ID is dynamically generated by Shopify and is subject to change. You should avoid relying on a literal value of this ID.',
-    );
-    const highlights = highlightedOffenses({ 'file.liquid': sourceCode }, offenses);
-    expect(highlights).toEqual(["block.id == '123'"]);
-  });
-  it('reports offense with the use of block.id in an elseif liquid tag', async () => {
-    const sourceCode = `
-      {% if potato == '123' %}
-        No bueno
-      {% elsif block.id == '123' %}
-        No bueno
-      {% endif %}
-    `;
-    const offenses = await runLiquidCheck(BlockIdUsage, sourceCode);
-    expect(offenses).toHaveLength(1);
-    expect(offenses[0].message).toEqual(
-      'The ID is dynamically generated by Shopify and is subject to change. You should avoid relying on a literal value of this ID.',
-    );
-    const highlights = highlightedOffenses({ 'file.liquid': sourceCode }, offenses);
-    expect(highlights).toEqual(["block.id == '123'"]);
-  });
-  it('reports offense with the use of block.id in an unless liquid tag', async () => {
-    const sourceCode = `
-      {% unless block.id == '123' %}
-        No bueno
-      {% endunless %}
-    `;
-    const offenses = await runLiquidCheck(BlockIdUsage, sourceCode);
-    expect(offenses).toHaveLength(1);
-    expect(offenses[0].message).toEqual(
-      'The ID is dynamically generated by Shopify and is subject to change. You should avoid relying on a literal value of this ID.',
-    );
-    const highlights = highlightedOffenses({ 'file.liquid': sourceCode }, offenses);
-    expect(highlights).toEqual(["block.id == '123'"]);
-  });
-  it('reports offense with the use of block.id in a case liquid tag', async () => {
-    const sourceCode = `
-      {% case block.id %}
-        {% when '123' %}
-          No bueno
-      {% endcase %}
-    `;
-    const offenses = await runLiquidCheck(BlockIdUsage, sourceCode);
-    expect(offenses).toHaveLength(1);
-    expect(offenses[0].message).toEqual(
-      'The ID is dynamically generated by Shopify and is subject to change. You should avoid relying on a literal value of this ID.',
-    );
-    const highlights = highlightedOffenses({ 'file.liquid': sourceCode }, offenses);
-    expect(highlights).toEqual(['block.id']);
-  });
-});

package/src/checks/block-id-usage/index.ts DELETED Viewed

@@ -1,72 +0,0 @@
-import {
-  Position,
-  LiquidTagNode,
-  NodeTypes,
-  LiquidVariableLookup,
-} from '@platformos/liquid-html-parser';
-import { Context, LiquidCheckDefinition, Severity, SourceCodeType } from '../../types';
-export const BlockIdUsage: LiquidCheckDefinition = {
-  meta: {
-    code: 'BlockIdUsage',
-    name: 'Do not rely on `block.id` in if/else/unless/case',
-    docs: {
-      description:
-        'The ID is dynamically generated by Shopify and is subject to change. You should avoid relying on a literal value of this ID.',
-      url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/block-id-usage',
-      recommended: true,
-    },
-    type: SourceCodeType.LiquidHtml,
-    severity: Severity.WARNING,
-    schema: {},
-    targets: [],
-  },
-  create(context) {
-    return {
-      // BAD: {% if block.id == "123" %}
-      // BAD: {% if block.id == some_variable %}
-      // BAD: {% if block[id] == "id" or block.id %}
-      // FINE: <div data-block-id="{{ block.id }}">
-      // FINE: document.querySelector(`[data-block-id="${block.id}"]`)
-      async Comparison(node, ancesors) {
-        if (
-          node.comparator === '==' &&
-          node.left.type === NodeTypes.VariableLookup &&
-          isUsingBlockId(node.left)
-        ) {
-          reportWarning(context, node.position);
-        }
-      },
-      // BAD {% case block.id %}
-      async VariableLookup(node, ancestors) {
-        const parentNode = ancestors.at(-1);
-        if (parentNode?.type === NodeTypes.LiquidTag && parentNode.name === 'case') {
-          if (isUsingBlockId(node)) {
-            reportWarning(context, node.position);
-          }
-        }
-      },
-    };
-  },
-};
-function isUsingBlockId(node: LiquidVariableLookup) {
-  return (
-    node.type == NodeTypes.VariableLookup &&
-    node.name === 'block' &&
-    node.lookups[0] &&
-    node.lookups[0].type === NodeTypes.String &&
-    node.lookups[0].value === 'id'
-  );
-}
-function reportWarning(context: any, position: Position) {
-  context.report({
-    message:
-      'The ID is dynamically generated by Shopify and is subject to change. You should avoid relying on a literal value of this ID.',
-    startIndex: position.start,
-    endIndex: position.end,
-  });
-}

package/src/checks/cdn-preconnect/index.spec.ts DELETED Viewed

@@ -1,40 +0,0 @@
-import { expect, describe, it } from 'vitest';
-import { runLiquidCheck } from '../../test';
-import { CdnPreconnect } from './index';
-describe('Module: CdnPreconnect', () => {
-  it('should report preconnect to cdn.shopify.com', async () => {
-    const sourceCode = `
-      <link rel="preconnect" href="https://cdn.shopify.com/"/>
-    `;
-    const offenses = await runLiquidCheck(CdnPreconnect, sourceCode);
-    expect(offenses).to.have.length(1);
-    expect(offenses[0].message).to.equal(
-      'Preconnecting to cdn.shopify.com is unnecessary and can lead to worse performance',
-    );
-  });
-  it('should report crossorigin preconnect to cdn.shopify.com', async () => {
-    const sourceCode = `
-      <link rel="preconnect" href="https://cdn.shopify.com/" crossorigin/>
-    `;
-    const offenses = await runLiquidCheck(CdnPreconnect, sourceCode);
-    expect(offenses).to.have.length(1);
-    expect(offenses[0].message).to.equal(
-      'Preconnecting to cdn.shopify.com is unnecessary and can lead to worse performance',
-    );
-  });
-  it('should not report other link types', async () => {
-    const sourceCode = `
-      <link rel="preload" href="https://example.com/foo.css" as="style"/>
-      <link rel="stylesheet" href="https://example.com/bar.css"/>
-      <link rel="icon"/>
-    `;
-    const offenses = await runLiquidCheck(CdnPreconnect, sourceCode);
-    expect(offenses).to.have.length(0);
-  });
-});

package/src/checks/cdn-preconnect/index.ts DELETED Viewed

@@ -1,43 +0,0 @@
-import { Severity, SourceCodeType, LiquidCheckDefinition } from '../../types';
-import { isAttr, isValuedHtmlAttribute, valueIncludes } from '../utils';
-export const CdnPreconnect: LiquidCheckDefinition = {
-  meta: {
-    code: 'CdnPreconnect',
-    name: 'CDN Preconnect',
-    docs: {
-      description: "This check is aimed at signaling the redundant preconnect to Shopify's CDN",
-      recommended: true,
-      url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/cdn-preconnect',
-    },
-    type: SourceCodeType.LiquidHtml,
-    severity: Severity.ERROR,
-    schema: {},
-    targets: [],
-  },
-  create(context) {
-    return {
-      async HtmlVoidElement(node) {
-        if (node.name !== 'link') return;
-        const isPreconnect = node.attributes
-          .filter(isValuedHtmlAttribute)
-          .some((attr) => isAttr(attr, 'rel') && valueIncludes(attr, 'preconnect'));
-        if (!isPreconnect) return;
-        const isShopifyCdn = node.attributes
-          .filter(isValuedHtmlAttribute)
-          .some((attr) => isAttr(attr, 'href') && valueIncludes(attr, '.+cdn.shopify.com.+'));
-        if (!isShopifyCdn) return;
-        context.report({
-          message:
-            'Preconnecting to cdn.shopify.com is unnecessary and can lead to worse performance',
-          startIndex: node.position.start,
-          endIndex: node.position.end,
-        });
-      },
-    };
-  },
-};

package/src/checks/content-for-header-modification/index.spec.ts DELETED Viewed

@@ -1,65 +0,0 @@
-import { expect, describe, it } from 'vitest';
-import { highlightedOffenses, runLiquidCheck } from '../../test';
-import { ContentForHeaderModification } from './index';
-describe('Module: ContentForHeaderModification', () => {
-  it('reports a offense with the use of a filter', async () => {
-    const sourceCode = "{{ content_for_header | split: ',' }}";
-    const offenses = await runLiquidCheck(ContentForHeaderModification, sourceCode);
-    expect(offenses).toHaveLength(1);
-    expect(offenses[0].message).toEqual('Do not rely on the content of `content_for_header`');
-    const highlights = highlightedOffenses({ 'file.liquid': sourceCode }, offenses);
-  });
-  it('reports offense with the use of assign', async () => {
-    const sourceCode = '{% assign x = content_for_header %}';
-    const offenses = await runLiquidCheck(ContentForHeaderModification, sourceCode);
-    expect(offenses).toHaveLength(1);
-    expect(offenses[0].message).toEqual('Do not rely on the content of `content_for_header`');
-    const highlights = highlightedOffenses({ 'file.liquid': sourceCode }, offenses);
-    expect(highlights).toEqual(['{% assign x = content_for_header %}']);
-  });
-  it('reports offense with the use of capture', async () => {
-    const sourceCode = `
-      {% capture x %}
-        {{ content_for_header }}
-      {% endcapture %}
-    `;
-    const offenses = await runLiquidCheck(ContentForHeaderModification, sourceCode);
-    expect(offenses).toHaveLength(1);
-    expect(offenses[0].message).toEqual('Do not rely on the content of `content_for_header`');
-    const highlights = highlightedOffenses({ 'file.liquid': sourceCode }, offenses);
-    expect(highlights).toEqual(['{{ content_for_header }}']);
-  });
-  it('reports offense with the use of echo', async () => {
-    const sourceCode = `
-      {% liquid
-        echo content_for_header | split: ','
-      %}
-    `;
-    const offenses = await runLiquidCheck(ContentForHeaderModification, sourceCode);
-    expect(offenses).toHaveLength(1);
-    expect(offenses[0].message).toEqual('Do not rely on the content of `content_for_header`');
-    const highlights = highlightedOffenses({ 'file.liquid': sourceCode }, offenses);
-    expect(highlights).toEqual(["echo content_for_header | split: ','"]);
-  });
-  it('does not report an offense with normal use', async () => {
-    const sourceCode = '{{ content_for_header }}';
-    const offenses = await runLiquidCheck(ContentForHeaderModification, sourceCode);
-    expect(offenses).toHaveLength(0);
-    const highlights = highlightedOffenses({ 'file.liquid': sourceCode }, offenses);
-    expect(highlights).toHaveLength(0);
-  });
-});