bestax-migrate 2.25.6 → 2.26.0

package/dist/sources/bulma-classes/html.d.ts

@@ -0,0 +1,84 @@
+/**
+ * A Bulma HTML page → a React module, written beside it.
+ *
+ * The page is parsed the way a browser builds it (`_shared/html/`), its body
+ * becomes the JSX a component returns, laid out with Bulma's displays so the
+ * whitespace beside a block, flex or grid box goes, and then the bulma-classes
+ * transform runs on that module unchanged, so the HTML converts exactly as
+ * the same markup written as JSX would. A number attribute on a plain element
+ * is written as a number last, since the planner reads attributes as strings.
+ *
+ * What a component can't carry becomes a `TODO(bestax-migrate)` line and a
+ * report entry under the `html-*` rules (`html-rules.ts`): the head, the
+ * `<html>` and `<body>` attributes, scripts (dropped, since a component runs
+ * none; their code stays in the page), and what the converter couldn't write
+ * as it was. Document-level ones sit above the component, the rest above its
+ * `return`, where the planner's own go. A report entry names the page and
+ * its line, never the module's.
+ *
+ * Nothing is ever overwritten: a module already beside the page stops it
+ * (`html-file:exists`), so a second run changes nothing, and the page itself
+ * stays as it was. A page with no Bulma component class writes nothing (a
+ * Vite `index.html` is a page like any other), and a server template
+ * (`{{`, `{%`, `<?php`, `<%`) is refused rather than read as HTML.
+ */
+import type { HtmlResult, TodoCollector, TodoEntry, TransformOptions } from '../../types.js';
+import { type DisplayOf } from '../_shared/html/whitespace.js';
+/**
+ * One display that keeps every run of whitespace any of `displays` would.
+ * An inline box keeps the runs beside it, `none` (or a box out of the flow)
+ * leaves them to what is past it, and a block drops them, so the result sits
+ * inline if any of them does, and is no box if any is, before it is a block.
+ * Inside, flowing on the line keeps the most and laying children out as boxes
+ * the least.
+ */
+export declare function keepingMost(displays: ReadonlySet<string>): string;
+/**
+ * An element's display on a Bulma page: its inline `style`'s when CSS reads
+ * it, else what Bulma's classes give it at each viewport (its tag's own where
+ * no rule reaches), else its tag's own. Bulma's display helpers are
+ * `!important`, so beside one an inline display is one case among theirs.
+ * A box Bulma takes out of the flow is beside nothing, so `none` counts too.
+ * Where the cases differ, the one display kept is the one that keeps every
+ * run any of them would (`keepingMost`): whitespace beside an element goes
+ * only when every case drops it.
+ *
+ * The page's own stylesheets are out of reach, as they are for the
+ * converter: a class of the page's that changes a display is the limit.
+ */
+export declare const pageDisplayOf: DisplayOf;
+/**
+ * The component a page becomes: its file's name in PascalCase (its folder's
+ * for an `index.html`) and `Page`, so `hero.html` can't shadow bestax's
+ * `Hero`. A name starting with a digit starts with `Page` instead
+ * (`404.html` is `Page404`), and one with nothing to go by is `Page`.
+ */
+export declare function componentName(file: string): string;
+/**
+ * Where a page's module goes: beside it, `.tsx` when the package around it is
+ * TypeScript (a tsconfig, or a dependency on `typescript`), `.jsx` otherwise.
+ */
+export declare function outputPathFor(file: string, options?: TransformOptions): string;
+/**
+ * For a page a folder walk found but left out: whether to say so. `-e`
+ * matches an extension exactly, as it does for every other file, so the
+ * advice names the page's own (`-e html` takes no `.htm` page).
+ */
+export declare function excludedHtml(file: string, source: string): TodoEntry | null;
+/**
+ * The module as written, after the planner: a number attribute on a plain
+ * element as a number (`tabIndex="-1"` as `tabIndex={-1}`), which React's
+ * types want and React renders the same, when it is spelled the way it
+ * renders; a component's are the planner's. And a blank line after the
+ * imports, which the transform puts straight above the component.
+ */
+export declare function finishModule(code: string): string;
+/** A page as a module: the one written, and the one before the planner ran. */
+export interface ConvertedPage extends HtmlResult {
+    /** The page's content as plain JSX, before the bulma-classes transform. */
+    intermediate: string | null;
+}
+export declare function convertPage(file: string, source: string, collector: TodoCollector | undefined, options?: TransformOptions): ConvertedPage;
+/** The `transformHtml` the CLI calls. */
+export declare function transformHtml(file: string, source: string, collector: TodoCollector | undefined, options?: TransformOptions): HtmlResult;
+//# sourceMappingURL=html.d.ts.map

package/dist/sources/bulma-classes/html.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"html.d.ts","sourceRoot":"","sources":["../../../src/sources/bulma-classes/html.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAIH,OAAO,KAAK,EAEV,UAAU,EACV,aAAa,EACb,SAAS,EACT,gBAAgB,EACjB,MAAM,gBAAgB,CAAC;AAexB,OAAO,EAIL,KAAK,SAAS,EAEf,MAAM,+BAA+B,CAAC;AAiDvC;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAYjE;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,aAAa,EAAE,SAoB3B,CAAC;AAIF;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAiBlD;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,gBAAqB,GAC7B,MAAM,CAQR;AAsBD;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAU3E;AAqrBD;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CA4BjD;AAID,+EAA+E;AAC/E,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC/C,2EAA2E;IAC3E,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAWD,wBAAgB,WAAW,CACzB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,aAAa,GAAG,SAAS,EACpC,OAAO,GAAE,gBAAqB,GAC7B,aAAa,CAsGf;AAED,yCAAyC;AACzC,wBAAgB,aAAa,CAC3B,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,aAAa,GAAG,SAAS,EACpC,OAAO,GAAE,gBAAqB,GAC7B,UAAU,CAGZ"}