@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.
- 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/dist/context-utils.js
CHANGED
|
@@ -1,14 +1,12 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
3
|
+
exports.makeGetDefaultTranslations = exports.makeGetDefaultLocale = exports.makeGetDefaultLocaleFileUri = exports.makeFileSize = exports.makeFileExists = void 0;
|
|
4
4
|
exports.recursiveReadDirectory = recursiveReadDirectory;
|
|
5
5
|
exports.isDirectory = isDirectory;
|
|
6
|
-
const
|
|
6
|
+
const js_yaml_1 = require("js-yaml");
|
|
7
7
|
const platformos_common_1 = require("@platformos/platformos-common");
|
|
8
|
-
const json_1 = require("./json");
|
|
9
8
|
const path_1 = require("./path");
|
|
10
9
|
const types_1 = require("./types");
|
|
11
|
-
const utils_1 = require("./utils");
|
|
12
10
|
const makeFileExists = (fs) => async function fileExists(uri) {
|
|
13
11
|
try {
|
|
14
12
|
await fs.stat(uri);
|
|
@@ -29,55 +27,41 @@ const makeFileSize = (fs) => async function fileSize(uri) {
|
|
|
29
27
|
}
|
|
30
28
|
};
|
|
31
29
|
exports.makeFileSize = makeFileSize;
|
|
32
|
-
|
|
33
|
-
exports.
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
exports.makeGetDefaultSchemaLocale = getDefaultLocaleFactoryFactory('.default.schema.json');
|
|
41
|
-
function getDefaultLocaleFactoryFactory(postfix = '.default.json') {
|
|
42
|
-
return function getDefaultLocaleFactory(fs, rootUri) {
|
|
43
|
-
return cached(() => getDefaultLocale(fs, rootUri, postfix));
|
|
44
|
-
};
|
|
45
|
-
}
|
|
46
|
-
exports.makeGetDefaultTranslations = getDefaultTranslationsFactoryFactory('.default.json');
|
|
47
|
-
exports.makeGetDefaultSchemaTranslations = getDefaultTranslationsFactoryFactory('.default.schema.json');
|
|
48
|
-
// prettier-ignore
|
|
49
|
-
function getDefaultTranslationsFactoryFactory(postfix = '.default.json') {
|
|
50
|
-
return function getDefaultTranslationsFactory(fs, theme, rootUri) {
|
|
51
|
-
return cached(() => getDefaultTranslations(fs, theme, rootUri, postfix));
|
|
52
|
-
};
|
|
53
|
-
}
|
|
54
|
-
async function getDefaultLocaleFile(fs, rootUri, postfix = '.default.json') {
|
|
55
|
-
const files = await fs.readDirectory((0, path_1.join)(rootUri, 'locales'));
|
|
56
|
-
return files.find(([uri]) => uri.endsWith(postfix))?.[0];
|
|
57
|
-
}
|
|
58
|
-
async function getDefaultLocale(fs, rootUri, postfix) {
|
|
30
|
+
const makeGetDefaultLocaleFileUri = (fs) => (rootUri) => getDefaultLocaleFile(fs, rootUri);
|
|
31
|
+
exports.makeGetDefaultLocaleFileUri = makeGetDefaultLocaleFileUri;
|
|
32
|
+
const makeGetDefaultLocale = (fs, rootUri) => cached(() => getDefaultLocale(fs, rootUri));
|
|
33
|
+
exports.makeGetDefaultLocale = makeGetDefaultLocale;
|
|
34
|
+
const makeGetDefaultTranslations = (fs, app, rootUri) => cached(() => getDefaultTranslations(fs, app, rootUri));
|
|
35
|
+
exports.makeGetDefaultTranslations = makeGetDefaultTranslations;
|
|
36
|
+
async function getDefaultLocaleFile(fs, rootUri) {
|
|
37
|
+
const enYmlUri = (0, path_1.join)(rootUri, 'app/translations/en.yml');
|
|
59
38
|
try {
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
return 'en';
|
|
63
|
-
const defaultLocaleFileName = vscode_uri_1.Utils.basename(vscode_uri_1.URI.parse(defaultLocaleFile));
|
|
64
|
-
return defaultLocaleFileName.split('.')[0];
|
|
39
|
+
await fs.stat(enYmlUri);
|
|
40
|
+
return enYmlUri;
|
|
65
41
|
}
|
|
66
|
-
catch
|
|
67
|
-
|
|
68
|
-
return 'en';
|
|
42
|
+
catch {
|
|
43
|
+
return undefined;
|
|
69
44
|
}
|
|
70
45
|
}
|
|
71
|
-
async function
|
|
46
|
+
async function getDefaultLocale(_fs, _rootUri) {
|
|
47
|
+
// In platformOS, en.yml is always the reference translation file
|
|
48
|
+
return 'en';
|
|
49
|
+
}
|
|
50
|
+
async function getDefaultTranslations(fs, app, rootUri) {
|
|
72
51
|
try {
|
|
73
|
-
const bufferTranslations = getDefaultTranslationsFromBuffer(
|
|
52
|
+
const bufferTranslations = getDefaultTranslationsFromBuffer(app);
|
|
74
53
|
if (bufferTranslations)
|
|
75
54
|
return bufferTranslations;
|
|
76
|
-
const defaultLocaleFile = await getDefaultLocaleFile(fs, rootUri
|
|
55
|
+
const defaultLocaleFile = await getDefaultLocaleFile(fs, rootUri);
|
|
77
56
|
if (!defaultLocaleFile)
|
|
78
57
|
return {};
|
|
79
|
-
const
|
|
80
|
-
|
|
58
|
+
const yamlContent = await fs.readFile(defaultLocaleFile);
|
|
59
|
+
const data = (0, js_yaml_1.load)(yamlContent);
|
|
60
|
+
if (!data || typeof data !== 'object')
|
|
61
|
+
return {};
|
|
62
|
+
// YAML translation files wrap content under the locale key: { en: { hello: 'Hello' } }
|
|
63
|
+
const localeKey = Object.keys(data)[0];
|
|
64
|
+
return (localeKey && data[localeKey]) ?? {};
|
|
81
65
|
}
|
|
82
66
|
catch (error) {
|
|
83
67
|
console.error(error);
|
|
@@ -85,16 +69,20 @@ async function getDefaultTranslations(fs, theme, rootUri, postfix) {
|
|
|
85
69
|
}
|
|
86
70
|
}
|
|
87
71
|
/** It might be that you have an open buffer, we prefer translations from there if available */
|
|
88
|
-
function getDefaultTranslationsFromBuffer(
|
|
89
|
-
const defaultTranslationsSourceCode =
|
|
90
|
-
sourceCode.uri.match(/locales/) &&
|
|
91
|
-
sourceCode.uri.endsWith(postfix));
|
|
72
|
+
function getDefaultTranslationsFromBuffer(app) {
|
|
73
|
+
const defaultTranslationsSourceCode = app.find((sourceCode) => sourceCode.type === types_1.SourceCodeType.YAML && sourceCode.uri.endsWith('/en.yml'));
|
|
92
74
|
if (!defaultTranslationsSourceCode)
|
|
93
75
|
return undefined;
|
|
94
|
-
|
|
95
|
-
|
|
76
|
+
try {
|
|
77
|
+
const data = (0, js_yaml_1.load)(defaultTranslationsSourceCode.source);
|
|
78
|
+
if (!data || typeof data !== 'object')
|
|
79
|
+
return undefined;
|
|
80
|
+
const localeKey = Object.keys(data)[0];
|
|
81
|
+
return (localeKey && data[localeKey]) ?? undefined;
|
|
82
|
+
}
|
|
83
|
+
catch {
|
|
96
84
|
return undefined;
|
|
97
|
-
|
|
85
|
+
}
|
|
98
86
|
}
|
|
99
87
|
function cached(fn) {
|
|
100
88
|
let cachedPromise;
|
|
@@ -124,62 +112,4 @@ const ignoredFolders = ['.git', 'node_modules', 'dist', 'build', 'tmp', 'vendor'
|
|
|
124
112
|
function isIgnored([uri, type]) {
|
|
125
113
|
return type === platformos_common_1.FileType.Directory && ignoredFolders.some((folder) => uri.endsWith(folder));
|
|
126
114
|
}
|
|
127
|
-
exports.FETCHED_METAFIELD_CATEGORIES = [
|
|
128
|
-
'article',
|
|
129
|
-
'blog',
|
|
130
|
-
'collection',
|
|
131
|
-
'company',
|
|
132
|
-
'company_location',
|
|
133
|
-
'location',
|
|
134
|
-
'market',
|
|
135
|
-
'order',
|
|
136
|
-
'page',
|
|
137
|
-
'product',
|
|
138
|
-
'variant',
|
|
139
|
-
'shop',
|
|
140
|
-
];
|
|
141
|
-
const makeGetMetafieldDefinitions = (fs) => async function (rootUri) {
|
|
142
|
-
const definitions = {
|
|
143
|
-
article: [],
|
|
144
|
-
blog: [],
|
|
145
|
-
collection: [],
|
|
146
|
-
company: [],
|
|
147
|
-
company_location: [],
|
|
148
|
-
location: [],
|
|
149
|
-
market: [],
|
|
150
|
-
order: [],
|
|
151
|
-
page: [],
|
|
152
|
-
product: [],
|
|
153
|
-
variant: [],
|
|
154
|
-
shop: [],
|
|
155
|
-
};
|
|
156
|
-
try {
|
|
157
|
-
const content = await fs.readFile((0, path_1.join)(rootUri, '.shopify', 'metafields.json'));
|
|
158
|
-
const json = (0, json_1.parseJSON)(content);
|
|
159
|
-
if ((0, utils_1.isError)(json))
|
|
160
|
-
return definitions;
|
|
161
|
-
return exports.FETCHED_METAFIELD_CATEGORIES.reduce((definitions, group) => {
|
|
162
|
-
try {
|
|
163
|
-
definitions[group] = json[group].map((definition) => ({
|
|
164
|
-
key: definition.key,
|
|
165
|
-
name: definition.name,
|
|
166
|
-
namespace: definition.namespace,
|
|
167
|
-
description: definition.description,
|
|
168
|
-
type: {
|
|
169
|
-
category: definition.type.category,
|
|
170
|
-
name: definition.type.name,
|
|
171
|
-
},
|
|
172
|
-
}));
|
|
173
|
-
}
|
|
174
|
-
catch (error) {
|
|
175
|
-
// If there are errors in the file, we ignore it
|
|
176
|
-
}
|
|
177
|
-
return definitions;
|
|
178
|
-
}, definitions);
|
|
179
|
-
}
|
|
180
|
-
catch (err) {
|
|
181
|
-
return definitions;
|
|
182
|
-
}
|
|
183
|
-
};
|
|
184
|
-
exports.makeGetMetafieldDefinitions = makeGetMetafieldDefinitions;
|
|
185
115
|
//# sourceMappingURL=context-utils.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"context-utils.js","sourceRoot":"","sources":["../src/context-utils.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"context-utils.js","sourceRoot":"","sources":["../src/context-utils.ts"],"names":[],"mappings":";;;AAqGA,wDAmBC;AAED,kCAEC;AA5HD,qCAA+B;AAC/B,qEAAmG;AACnG,iCAA8B;AAC9B,mCAA4D;AAIrD,MAAM,cAAc,GAAG,CAAC,EAAsB,EAAc,EAAE,CACnE,KAAK,UAAU,UAAU,CAAC,GAAW;IACnC,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,CAAC;AARS,QAAA,cAAc,kBAQvB;AAEG,MAAM,YAAY,GAAG,CAAC,EAAsB,EAAE,EAAE,CACrD,KAAK,UAAU,QAAQ,CAAC,GAAW;IACjC,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjC,OAAO,KAAK,CAAC,IAAI,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,CAAC;IACX,CAAC;AACH,CAAC,CAAC;AARS,QAAA,YAAY,gBAQrB;AAEG,MAAM,2BAA2B,GAAG,CAAC,EAAsB,EAAE,EAAE,CAAC,CAAC,OAAe,EAAE,EAAE,CACzF,oBAAoB,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;AADvB,QAAA,2BAA2B,+BACJ;AAE7B,MAAM,oBAAoB,GAAG,CAAC,EAAsB,EAAE,OAAe,EAAE,EAAE,CAC9E,MAAM,CAAC,GAAG,EAAE,CAAC,gBAAgB,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC;AADjC,QAAA,oBAAoB,wBACa;AAEvC,MAAM,0BAA0B,GAAG,CAAC,EAAsB,EAAE,GAAQ,EAAE,OAAe,EAAE,EAAE,CAC9F,MAAM,CAAC,GAAG,EAAE,CAAC,sBAAsB,CAAC,EAAE,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;AAD5C,QAAA,0BAA0B,8BACkB;AAEzD,KAAK,UAAU,oBAAoB,CACjC,EAAsB,EACtB,OAAe;IAEf,MAAM,QAAQ,GAAG,IAAA,WAAI,EAAC,OAAO,EAAE,yBAAyB,CAAC,CAAC;IAC1D,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,KAAK,UAAU,gBAAgB,CAAC,GAAuB,EAAE,QAAgB;IACvE,iEAAiE;IACjE,OAAO,IAAI,CAAC;AACd,CAAC;AAED,KAAK,UAAU,sBAAsB,CACnC,EAAsB,EACtB,GAAQ,EACR,OAAe;IAEf,IAAI,CAAC;QACH,MAAM,kBAAkB,GAAG,gCAAgC,CAAC,GAAG,CAAC,CAAC;QACjE,IAAI,kBAAkB;YAAE,OAAO,kBAAkB,CAAC;QAClD,MAAM,iBAAiB,GAAG,MAAM,oBAAoB,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAClE,IAAI,CAAC,iBAAiB;YAAE,OAAO,EAAE,CAAC;QAClC,MAAM,WAAW,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;QACzD,MAAM,IAAI,GAAG,IAAA,cAAI,EAAC,WAAW,CAAwB,CAAC;QACtD,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,OAAO,EAAE,CAAC;QACjD,uFAAuF;QACvF,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACvC,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC;IAC9C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC;AAED,+FAA+F;AAC/F,SAAS,gCAAgC,CAAC,GAAQ;IAChD,MAAM,6BAA6B,GAAG,GAAG,CAAC,IAAI,CAC5C,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,sBAAc,CAAC,IAAI,IAAI,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,CAC9F,CAAC;IACF,IAAI,CAAC,6BAA6B;QAAE,OAAO,SAAS,CAAC;IACrD,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,IAAA,cAAI,EAAC,6BAA6B,CAAC,MAAM,CAAwB,CAAC;QAC/E,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,OAAO,SAAS,CAAC;QACxD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACvC,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,SAAS,CAAC;IACrD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAGD,SAAS,MAAM,CAAI,EAAkC;IACnD,IAAI,aAAyB,CAAC;IAC9B,OAAO,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE;QACvB,IAAI,CAAC,aAAa;YAAE,aAAa,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QAChD,OAAO,aAAa,CAAC;IACvB,CAAC,CAAC;AACJ,CAAC;AAEM,KAAK,UAAU,sBAAsB,CAC1C,EAAsB,EACtB,GAAW,EACX,MAAyC;IAEzC,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAC7C,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEzF,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;QACf,IAAI,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC;YACpB,OAAO,sBAAsB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QACnD,CAAC;aAAM,CAAC;YACN,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClC,CAAC;IACH,CAAC,CAAC,CACH,CAAC;IAEF,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC;AACxB,CAAC;AAED,SAAgB,WAAW,CAAC,CAAC,CAAC,EAAE,IAAI,CAAY;IAC9C,OAAO,IAAI,KAAK,4BAAQ,CAAC,SAAS,CAAC;AACrC,CAAC;AAED,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;AAElF,SAAS,SAAS,CAAC,CAAC,GAAG,EAAE,IAAI,CAAY;IACvC,OAAO,IAAI,KAAK,4BAAQ,CAAC,SAAS,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AAC9F,CAAC"}
|
|
@@ -10,7 +10,9 @@ function createDisabledChecksModule() {
|
|
|
10
10
|
const INLINE_COMMENT_TAG = '#';
|
|
11
11
|
const disabledChecks = new Map();
|
|
12
12
|
function determineRanges(file, value, node) {
|
|
13
|
-
const [_, command, checksJoined] = value
|
|
13
|
+
const [_, command, checksJoined] = value
|
|
14
|
+
.trim()
|
|
15
|
+
.match(/^(?:(?:platformos|theme)\-check\-(disable-next-line|disable|enable)) ?(.*)/) || [];
|
|
14
16
|
const checks = checksJoined ? checksJoined.split(/,[ ]*/) : [SPECIFIC_CHECK_NOT_DEFINED];
|
|
15
17
|
checks.forEach((check) => {
|
|
16
18
|
const disabledRanges = disabledChecks.get(file.uri);
|
|
@@ -99,7 +101,7 @@ function findNextLinePosition(ast, node) {
|
|
|
99
101
|
* E.g. The following disables check for `elsif` tag
|
|
100
102
|
*
|
|
101
103
|
* {% if condition %}
|
|
102
|
-
* {% #
|
|
104
|
+
* {% #platformos-check-disable-next-line %}
|
|
103
105
|
* {% elsif other_condition %}
|
|
104
106
|
* {{ prouduct }}
|
|
105
107
|
* {% endif %}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/disabled-checks/index.ts"],"names":[],"mappings":";;AAeA,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/disabled-checks/index.ts"],"names":[],"mappings":";;AAeA,gEAyGC;AAED,oDA0CC;AAnKD,oCAOkB;AAClB,wCAA6C;AAC7C,oCAAmC;AAKnC,SAAgB,0BAA0B;IACxC,MAAM,0BAA0B,GAAG,MAAM,CAAC;IAC1C,MAAM,kBAAkB,GAAG,GAAG,CAAC;IAC/B,MAAM,cAAc,GAAsB,IAAI,GAAG,EAAE,CAAC;IAEpD,SAAS,eAAe,CACtB,IAA2C,EAC3C,KAAa,EACb,IAA8B;QAE9B,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,YAAY,CAAC,GAC9B,KAAK;aACF,IAAI,EAAE;aACN,KAAK,CAAC,4EAA4E,CAAC,IAAI,EAAE,CAAC;QAE/F,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC;QAEzF,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACvB,MAAM,cAAc,GAAG,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAE,CAAC;YAErD,IAAI,OAAO,KAAK,mBAAmB,IAAI,CAAC,IAAA,eAAO,EAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1D,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;gBAE9D,IAAI,gBAAgB,EAAE,CAAC;oBACrB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;wBAC/B,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;oBAChC,CAAC;oBACD,cAAc,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC,IAAI,CAAC;wBAC9B,IAAI,EAAE,gBAAgB,CAAC,KAAK;wBAC5B,EAAE,EAAE,gBAAgB,CAAC,GAAG;qBACzB,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YAED,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC1B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC/B,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBAChC,CAAC;gBACD,cAAc,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC;YAC/D,CAAC;YAED,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;gBACzB,IAAI,sBAAsB,GAAG,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACvD,IAAI,sBAAsB,EAAE,CAAC;oBAC3B,sBAAsB,CAAC,sBAAsB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;gBACrF,CAAC;qBAAM,CAAC;oBACN,IAAI,KAAK,KAAK,0BAA0B,EAAE,CAAC;wBACzC,KAAK,IAAI,MAAM,IAAI,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC;4BAC3C,KAAK,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC;gCACzB,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;oCACd,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;gCACjC,CAAC;4BACH,CAAC;wBACH,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,qBAAqB,GAA0B;QACnD,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,EAAS;QAC3B,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;YACrB,KAAK,CAAC,eAAe;gBACnB,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;YAC1C,CAAC;YAED,KAAK,CAAC,YAAY,CAAC,IAAI;gBACrB,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC5B,OAAO;gBACT,CAAC;gBAED,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAC/C,CAAC;YAED,KAAK,CAAC,SAAS,CAAC,IAAI;gBAClB,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;oBACxE,OAAO;gBACT,CAAC;gBAED,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC3C,CAAC;SACF,CAAC;KACH,CAAC;IAEF,SAAS,UAAU,CAAC,OAAgB;QAClC,MAAM,MAAM,GAAG,CAAC,0BAA0B,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3E,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBACrC,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAE,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gBACjD,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,OAAO,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAE,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC,IAAI,CAChB,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,KAAK,CAAC,EAAE,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,KAAK,CAAC,EAAE,CAAC,CAC7F,CAAC;IACJ,CAAC;IAED,OAAO;QACL,qBAAqB;QACrB,UAAU;KACX,CAAC;AACJ,CAAC;AAED,SAAgB,oBAAoB,CAClC,GAAmB,EACnB,IAAoB;IAEpB,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG,IAAA,yBAAe,EAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACzE,MAAM,UAAU,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACpC,MAAM,eAAe,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAEzC,IAAI,QAAQ,GAAG,WAAW,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;IACpD;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,IAAI,UAAU,EAAE,CAAC;YACf,QAAQ,GAAG,WAAW,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;QACtD,CAAC;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO;QACT,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,IAAI,oBAAoB,IAAI,QAAQ,EAAE,CAAC;QACrC,OAAO,QAAQ,CAAC,kBAAkB,CAAC;IACrC,CAAC;IAED,OAAO,QAAQ,CAAC,QAAQ,CAAC;AAC3B,CAAC;AAED,SAAS,WAAW,CAClB,UAAsC,EACtC,IAAoB;IAEpB,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO;IACT,CAAC;IAED,IAAI,YAAY,GAAqB,EAAE,CAAC;IAExC,+CAA+C;IAC/C,IAAI,UAAU,CAAC,IAAI,KAAK,2BAAmB,CAAC,SAAS,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1F,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC;IACnC,CAAC;SAAM,IAAI,UAAU,IAAI,UAAU,EAAE,CAAC;QACpC,YAAY,GAAG,UAAU,CAAC,QAAQ,IAAI,EAAE,CAAC;IAC3C,CAAC;IAED,MAAM,cAAc,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;IAEjE,IAAI,cAAc,KAAK,CAAC,CAAC;QAAE,OAAO;IAElC,MAAM,QAAQ,GAAG,YAAY,CAAC,EAAE,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC;IAErD,OAAO,QAAQ,CAAC;AAClB,CAAC"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { LiquidHtmlNode } from '@platformos/liquid-html-parser';
|
|
2
|
+
import { ThemeDocset, UriString } from '../types';
|
|
3
|
+
export interface DetectedParameter {
|
|
4
|
+
name: string;
|
|
5
|
+
type: string | null;
|
|
6
|
+
isOptional: boolean;
|
|
7
|
+
}
|
|
8
|
+
export interface DocBlockResult {
|
|
9
|
+
parameters: DetectedParameter[];
|
|
10
|
+
hasExistingDocBlock: boolean;
|
|
11
|
+
docBlockText: string;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Generate a doc block for a partial/block based on detected parameters and inferred types.
|
|
15
|
+
*/
|
|
16
|
+
export declare function generateDocBlock(ast: LiquidHtmlNode, uri: UriString, themeDocset?: ThemeDocset): Promise<DocBlockResult>;
|