@wix/origami-lint 1.34.11 → 1.34.13

package/dist/page-model/index.js

@@ -1,5 +1,5 @@
 // Part 2 — page model: which pages to lint, and one page's model (its components, each with its CSS).
 export * from "./model.js";
 export { buildPageModel } from "./build-page-model.js";
-export { findPagesToLint, JSX_FILES } from "./pages.js";
+export { findPages, findPagesToLint, JSX_FILES } from "./pages.js";
 export { readPage } from "./read-page.js";

package/dist/rules/project/home-page-folder.js

@@ -0,0 +1,54 @@
+// The home page folder (tracker OUR-035, CONV-unitPath.ts:89): exactly one folder in parentheses, pages/(<slug>), directly
+// under pages/, and no other folder in parentheses in pages/ or popups/. `origami import-site` stops without exactly one
+// home folder and refuses a nested one; the converter refuses a popup folder in parentheses.
+import { findPages } from "../../page-model/index.js";
+import { PAGES_FOLDER, POPUPS_FOLDER } from "../../shared/site-files-tree-mapping.js";
+import { defineProjectRule } from "./define-project-rule.js";
+const EXPECTED_ONE_HOME = `Expected exactly one home page folder "pages/(<slug>)" in ${PAGES_FOLDER}`;
+export const NO_HOME = `${EXPECTED_ONE_HOME}; found 0. Name the home page's folder in parentheses, directly under ${PAGES_FOLDER}, like ${PAGES_FOLDER}/(home) (rule P2-R01; tracker OUR-035). The import stops without it.`;
+export const moreHomes = (count, folder) => `${EXPECTED_ONE_HOME}; found ${count}. Keep the parentheses on the home page's folder only: rename ${folder} to ${withoutParentheses(folder)} (rule P2-R01; tracker OUR-035).`;
+export const onlyHomeInParentheses = (folder) => `Only the home page is written in parentheses, directly under ${PAGES_FOLDER}/. Rename ${folder} to ${withoutParentheses(folder)} (rule P2-R23; tracker CONV-unitPath.ts:89).`;
+/** A home page's folder: its name in parentheses, `(home)`. */
+const HOME_FOLDER = /^\(.+\)$/;
+export default defineProjectRule({
+    name: 'home-page-folder',
+    editors: ['studio2'],
+    check: (project) => [...checkOneHome(project), ...checkNoNestedHome(project), ...checkNoPopupInParentheses(project)],
+});
+// ── the steps ──
+/** Reports no home folder at the top of pages/, or more than one (each after the first). */
+function checkOneHome(project) {
+    const homes = getPages(project).filter((page) => page.folders.length === 1 && HOME_FOLDER.test(page.folders[0]));
+    if (homes.length === 0)
+        return [{ file: PAGES_FOLDER, message: NO_HOME }];
+    return homes.slice(1).map((home) => ({ file: home.jsxFile, message: moreHomes(homes.length, home.folders[0]) }));
+}
+/** Reports every page with a folder in parentheses below the top of pages/ on its path, as import-site refuses them. */
+function checkNoNestedHome(project) {
+    return getPages(project).flatMap((page) => {
+        const nested = page.folders.slice(1).find((folder) => HOME_FOLDER.test(folder));
+        return nested ? [{ file: page.jsxFile, message: onlyHomeInParentheses(nested) }] : [];
+    });
+}
+/** Reports each folder in parentheses under popups/, once, as the converter refuses them. */
+function checkNoPopupInParentheses(project) {
+    const folders = new Set();
+    for (const file of project.files.filter((file) => file.startsWith(`${POPUPS_FOLDER}/`))) {
+        const segments = file.slice(`${POPUPS_FOLDER}/`.length).split('/').slice(0, -1);
+        const index = segments.findIndex((segment) => HOME_FOLDER.test(segment));
+        if (index !== -1)
+            folders.add(`${POPUPS_FOLDER}/${segments.slice(0, index + 1).join('/')}`);
+    }
+    return [...folders].sort().map((folder) => ({ file: folder, message: onlyHomeInParentheses(folder.slice(folder.lastIndexOf('/') + 1)) }));
+}
+/** The site's pages under pages/, sorted by path. */
+function getPages(project) {
+    return findPages([...project.files], [...project.files])
+        .filter((jsxFile) => jsxFile.startsWith(`${PAGES_FOLDER}/`))
+        .sort()
+        .map((jsxFile) => ({ jsxFile, folders: jsxFile.slice(`${PAGES_FOLDER}/`.length).split('/').slice(0, -1) }));
+}
+/** '(team)' → 'team'. */
+function withoutParentheses(folder) {
+    return folder.slice(1, -1);
+}

package/dist/rules/project/index.js

@@ -1,2 +1,3 @@
+import homePageFolder from "./home-page-folder.js";
 export { defineProjectRule } from "./define-project-rule.js";
-export const projectRuleRegistry = [];
+export const projectRuleRegistry = [homePageFolder];

package/dist/rules/site-app/global-styles.js

@@ -1,4 +1,4 @@
-import { BREAKPOINT_AT_RULES, createCssFileReporter, describeAtRule, getCssChildren, getDashedId, getSegmentClass, getSelectorSegments, isCssIdentifier, isSafeCssIdentifier } from "../../rules-api/index.js";
+import { BREAKPOINT_AT_RULES, createCssFileReporter, describeAtRule, getCssChildren, getDashedId, getMixinId, getSegmentClass, getSelectorSegments, isCssIdentifier, isSafeCssIdentifier } from "../../rules-api/index.js";
 import { defineRule } from "./define-rule.js";
 export default defineRule({
     name: 'global-styles',
@@ -150,11 +150,6 @@ function checkLinkOrValues(group, linkedParts, reportInFile) {
     reportInFile(first.node, `\`@mixin --${first.mixin}\` styles \`${part}\` but links no global style there: add \`& ${part} { @apply --<child> }\` and move the values to that child's @mixin (tracker CONV-styleParser.ts:698).`);
 }
 // ── reading a mixin ──
-/** The id a `@mixin` declares (`--btn` → 'btn'), or null when it isn't one dashed identifier. */
-function getMixinId(mixin) {
-    const id = getDashedId(mixin.params);
-    return id !== undefined && isSafeCssIdentifier(id) ? id : null;
-}
 /** The mixin's one `@result` with no params and a block, beside nothing; undefined otherwise. */
 function getResult(mixin) {
     if (mixin.nodes === undefined)

package/dist/rules-api/index.js

@@ -3,4 +3,4 @@ export { createRulesApi, getOrCreateRulesApi } from "./rules-api.js";
 export { createCssFileReporter, describeAtRule, reportCssProblem } from "./report.js";
 export { bare, getAttribute, getExpression, getKey, getName, getObject, getProperties, getCallbackKind, getParamReadKind, getProperty, isBound, isOneEditAway, isReservedAttribute, isStructure, ownerOf, } from "../shared/utils.js";
 export { BUILDERS, CALLBACK_PROP, DATA_KEY, EVENT_ATTRIBUTE, GLOBAL_SECTIONS, INSTANCE_PROPS, LAYER_ATTRIBUTES, RESERVED_ATTRIBUTES, RESERVED_ENTRY_KEYS, RUNTIME_ONLY_BUILDERS, RUNTIME_PACKAGE, SECTIONS, SHARED_COMP_ID, STRUCTURE, SYSTEM_PACKAGE, TRANSFORM_BUILDERS, TYPED_BUILDERS, WRAPPERS, } from "../shared/constants.js";
-export { BREAKPOINT_AT_RULES, CONTENT_TARGET, getCssChildren, getDashedId, getSegmentClass, getSelectorSegments, isCssIdentifier, isPresetProperty, isSafeCssIdentifier, ORIGAMI_TARGETS, OVERFLOW_TARGET, PREAMBLE_LAYER, readSegment } from "../shared/css.js";
+export { BREAKPOINT_AT_RULES, CONTENT_TARGET, getCssChildren, getDashedId, getMixinId, getSegmentClass, getSelectorSegments, isCssIdentifier, isPresetProperty, isSafeCssIdentifier, ORIGAMI_TARGETS, OVERFLOW_TARGET, PREAMBLE_LAYER, readSegment } from "../shared/css.js";

package/dist/shared/css.js

@@ -49,6 +49,11 @@ export const getCssChildren = (node) => (node.nodes ?? []).filter((child) => chi
 export const isPresetProperty = (prop) => prop === '--preset' || prop.startsWith('--preset-');
 /** The id a `@mixin` or `@apply` names: '--btn' → 'btn' (spaces around aside); undefined when its params aren't `--` and one word. */
 export const getDashedId = (params) => DASHED_ID.exec(params.trim())?.[1];
+/** The id a `@mixin` declares (`--btn` → 'btn'), or null when it isn't one dashed identifier. */
+export function getMixinId(mixin) {
+    const id = getDashedId(mixin.params);
+    return id !== undefined && isSafeCssIdentifier(id) ? id : null;
+}
 /** Whether the import reads this as an identifier (cssSelectors.ts `isCssIdentifier`): letters, digits, - and _, not starting with a digit. */
 export const isCssIdentifier = (id) => CSS_IDENT.test(id);
 /** Whether the import takes this as a name (a mixin id, a preset path's part; cssSelectors.ts `isSafeCssIdentifier`): an identifier, not a reserved name. */

package/dist/shared/site-files-tree-mapping.js

@@ -2,6 +2,8 @@
 export const SITE_SRC = 'packages/site-app/src';
 /** One page per folder; routes can be nested (about-us/team). */
 export const PAGES_FOLDER = `${SITE_SRC}/pages`;
+/** One popup per folder, directly under it (popups have no url, so no nesting). */
+export const POPUPS_FOLDER = `${SITE_SRC}/popups`;
 /** What every page shares: the global components, the menus, the theme. */
 export const GLOBAL_FOLDER = `${SITE_SRC}/global`;
 /** Inside src/: one global component per folder (the header, the footer, any other shared section). A page imports one from here. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/origami-lint",
-  "version": "1.34.11",
+  "version": "1.34.13",
   "description": "Offline lint for an exported Origami site: lints the pages that changed since the last passing run",
   "type": "module",
   "bin": {
@@ -52,5 +52,5 @@
       ]
     }
   },
-  "falconPackageHash": "6105be6143086aff6e6d4d5ab523a01350826d77e8c206618d240ec2"
+  "falconPackageHash": "70a9ee3d299565f2869a89a7c2269513b67bdf6101e989b4545ecc19"
 }