refactor(svelte-ast-print): Polish codebase, improve tests syntax & docs (#118)

Author: xeho91

.github/workflows/ci_lint.yml

@@ -61,12 +61,8 @@ jobs:
           pnpm install
           --frozen-lockfile
 
-      # https://github.com/Codex-/knip-reporter
-      - name: Create Knip report
-        uses: codex-/knip-reporter@v2
-        with:
-          command_script_name: pnpm run "lint:knip" --reporter=json
-          verbose: true
+      - name: Check the project with Knip
+        run: pnpm run "lint:knip"
 
   lint_tsc:
     name: TSC

.github/workflows/cr_pr-preview.yml

@@ -41,5 +41,4 @@ jobs:
           --frozen-lockfile
 
       - name: Publish packages preview with pkg-pr-new CLI
-        run: pnpx pkg-pr-new publish --pnpm './pkgs/*' --packageManager=pnpm
-        if: ${{ steps.changed-files.outputs.all_changed_files_count > 0 }}
+        run: pnpx pkg-pr-new publish --pnpm './packages/*' --packageManager=pnpm

package.json

@@ -24,7 +24,7 @@
     "lint:biome": "biome check . --verbose",
     "lint:biome:format": "biome format . --verbose",
     "lint:biome:js": "biome lint . --verbose --unsafe",
-    "lint:knip": "knip --tags=-lintignore ",
+    "lint:knip": "knip --tags=-lintignore",
     "lint:tsc": "tsc --noEmit",
     "lint:typos": "typos --verbose",
     "serve:doc": "serve \"./docs\" ",

packages/svelte-ast-print/src/_internal/template/fragment.ts renamed to packages/svelte-ast-print/src/_internal/fragment.ts

@@ -301,6 +301,3 @@ export abstract class Wrapper<T extends WrapperType = WrapperType> {
 		}
 	}
 }
-
-// @ts-expect-error NOTE: This to solve cyclic dependency issue
-export const hub: typeof import("../lib.ts") = {};

packages/svelte-ast-print/src/_internal/shared.ts

@@ -1,12 +1,11 @@
 import type { AST as SV } from "svelte/compiler";
-
-import { printAttributeLike } from "../../attribute.ts";
 import { printFragment } from "../../fragment.ts";
+import { printAttributeLike } from "../../template/attribute-like.ts";
 import * as char from "../char.js";
+import { has_frag_text_or_exp_tag_only } from "../fragment.js";
 import { HTMLClosingTag, HTMLOpeningTag, HTMLSelfClosingTag } from "../html.js";
 import type { PrintOptions } from "../option.js";
 import { type Result, State } from "../shared.js";
-import { has_frag_text_or_exp_tag_only } from "./fragment.js";
 
 /**
  * @internal

packages/svelte-ast-print/src/_internal/template/attribute.ts renamed to packages/svelte-ast-print/src/_internal/template/attribute-like.ts

@@ -23,10 +23,7 @@ import {
 	printCSSSelectorList,
 	printCSSTypeSelector,
 } from "./css/selector.ts";
-import { printCSSStyleSheet } from "./root.ts";
-
-export * from "./css/rule.ts";
-export * from "./css/selector.ts";
+import { printCSSStyleSheet } from "./template/root.ts";
 
 /**
  * @see {@link https://developer.mozilla.org/en-US/docs/Web/CSS/Attribute_selectors}

packages/svelte-ast-print/src/_internal/template/element.ts renamed to packages/svelte-ast-print/src/_internal/template/element-like.ts

@@ -4,7 +4,7 @@ import { describe, it } from "vitest";
 
 import { printCSSAtrule, printCSSBlock, printCSSDeclaration, printCSSRule } from "./rule.ts";
 
-describe(printCSSBlock.name, () => {
+describe(printCSSBlock, () => {
 	it("prints correctly", ({ expect }) => {
 		const code = `
 			<style>
@@ -24,7 +24,7 @@ describe(printCSSBlock.name, () => {
 	});
 });
 
-describe(printCSSDeclaration.name, () => {
+describe(printCSSDeclaration, () => {
 	it("prints correctly", ({ expect }) => {
 		const code = `
 			<style>
@@ -38,7 +38,7 @@ describe(printCSSDeclaration.name, () => {
 	});
 });
 
-describe(printCSSAtrule.name, () => {
+describe(printCSSAtrule, () => {
 	it("prints correctly", ({ expect }) => {
 		const code = `
 			<style>
@@ -60,7 +60,7 @@ describe(printCSSAtrule.name, () => {
 	});
 });
 
-describe(printCSSRule.name, () => {
+describe(printCSSRule, () => {
 	it("prints correctly", ({ expect }) => {
 		const code = `
 			<style>

packages/svelte-ast-print/src/css.ts

@@ -18,8 +18,8 @@ import {
 	printCSSTypeSelector,
 } from "./selector.ts";
 
-describe(printCSSSimpleSelector.name, () => {
-	describe(printCSSAttributeSelector.name, () => {
+describe(printCSSSimpleSelector, () => {
+	describe(printCSSAttributeSelector, () => {
 		it("prints correctly without value", ({ expect }) => {
 			const code = `
 			<style>
@@ -57,7 +57,7 @@ describe(printCSSSimpleSelector.name, () => {
 		});
 	});
 
-	describe(printCSSClassSelector.name, () => {
+	describe(printCSSClassSelector, () => {
 		it("prints correctly", ({ expect }) => {
 			const code = `
 			<style>
@@ -71,7 +71,7 @@ describe(printCSSSimpleSelector.name, () => {
 		});
 	});
 
-	describe(printCSSIdSelector.name, () => {
+	describe(printCSSIdSelector, () => {
 		it("prints correctly", ({ expect }) => {
 			const code = `
 			<style>
@@ -85,7 +85,7 @@ describe(printCSSSimpleSelector.name, () => {
 		});
 	});
 
-	describe(printCSSNestingSelector.name, () => {
+	describe(printCSSNestingSelector, () => {
 		it("prints correctly", ({ expect }) => {
 			const code = `
 			<style>
@@ -101,7 +101,7 @@ describe(printCSSSimpleSelector.name, () => {
 		});
 	});
 
-	describe(printCSSPseudoClassSelector.name, () => {
+	describe(printCSSPseudoClassSelector, () => {
 		it("prints correctly without args", ({ expect }) => {
 			const code = `
 			<style>
@@ -127,7 +127,7 @@ describe(printCSSSimpleSelector.name, () => {
 		});
 	});
 
-	describe(printCSSPseudoElementSelector.name, () => {
+	describe(printCSSPseudoElementSelector, () => {
 		it("prints correctly", ({ expect }) => {
 			const code = `
 			<style>
@@ -141,7 +141,7 @@ describe(printCSSSimpleSelector.name, () => {
 		});
 	});
 
-	describe(printCSSTypeSelector.name, () => {
+	describe(printCSSTypeSelector, () => {
 		it("prints correctly", ({ expect }) => {
 			const code = `
 			<style>
@@ -155,7 +155,7 @@ describe(printCSSSimpleSelector.name, () => {
 		});
 	});
 
-	describe(printCSSNth.name, () => {
+	describe(printCSSNth, () => {
 		it("prints correctly simple number", ({ expect }) => {
 			const code = `
 			<style>
@@ -206,7 +206,7 @@ describe(printCSSSimpleSelector.name, () => {
 		});
 	});
 
-	describe(printCSSPercentage.name, () => {
+	describe(printCSSPercentage, () => {
 		it("prints correctly", ({ expect }) => {
 			const code = `
 			<style>
@@ -223,7 +223,7 @@ describe(printCSSSimpleSelector.name, () => {
 	});
 });
 
-describe(printCSSRelativeSelector.name, () => {
+describe(printCSSRelativeSelector, () => {
 	it("prints correctly without combinator", ({ expect }) => {
 		const code = `
 			<style>
@@ -249,7 +249,7 @@ describe(printCSSRelativeSelector.name, () => {
 	});
 });
 
-describe(printCSSComplexSelector.name, () => {
+describe(printCSSComplexSelector, () => {
 	it("prints correctly", ({ expect }) => {
 		const code = `
 			<style>
@@ -263,7 +263,7 @@ describe(printCSSComplexSelector.name, () => {
 	});
 });
 
-describe(printCSSSelectorList.name, () => {
+describe(printCSSSelectorList, () => {
 	it("prints correctly", ({ expect }) => {
 		const code = `
 			<style>

packages/svelte-ast-print/src/css/rule.test.ts

@@ -1,6 +1,6 @@
 /**
  * Printers related to CSS **selector** related AST nodes only.
- * @module svelte-ast-print/css/seletor
+ * @module svelte-ast-print/css/selector
  */
 
 import type { AST as SV } from "svelte/compiler";

packages/svelte-ast-print/src/css/selector.test.ts

@@ -4,7 +4,7 @@ import { describe, it } from "vitest";
 
 import { printFragment } from "./fragment.ts";
 
-describe(printFragment.name, () => {
+describe(printFragment, () => {
 	it("it prints correctly fragment code", ({ expect }) => {
 		const code = `
 			<h1>Shopping list</h1>

packages/svelte-ast-print/src/css/selector.ts

@@ -4,15 +4,14 @@
  */
 
 import type { AST as SV } from "svelte/compiler";
-
-import { isBlock } from "./_internal/template/block.ts";
-import { isElementLike } from "./_internal/template/element.ts";
 import type { PrintOptions } from "./_internal/option.ts";
-import { hub, type Result, State } from "./_internal/shared.ts";
-import { printBlock } from "./block.ts";
-import { printElementLike } from "./element.ts";
-import { printHTMLNode } from "./html.ts";
-import { printTag } from "./tag.ts";
+import { type Result, State } from "./_internal/shared.ts";
+import { isBlock } from "./_internal/template/block.ts";
+import { isElementLike } from "./_internal/template/element-like.ts";
+import { printBlock } from "./template/block.ts";
+import { printElementLike } from "./template/element-like.ts";
+import { printHTMLNode } from "./template/html.ts";
+import { printTag } from "./template/tag.ts";
 
 /**
  * @since 1.0.0
@@ -78,7 +77,3 @@ export function printFragment(n: SV.Fragment, opts: Partial<PrintOptions> = {}):
 	}
 	return st.result;
 }
-
-Object.assign(hub, {
-	printFragment,
-});

packages/svelte-ast-print/src/fragment.test.ts

@@ -17,13 +17,13 @@
  *
  * ```ts
  * import type { AST } from "svelte/compiler";
- * import { printSvelteSnippet } from "svelte-ast-print/template";
+ * import { printSnippetBlock } from "svelte-ast-print/template/block";
  *
  * // How you obtain the node is up to you.
  * // Either by building programmatically or from parsing
  * let node: AST.SnippetBlock;
  *
- * const stringified = printSvelteSnippet(node);
+ * const stringified = printSnippetBlock(node);
  * ```
  *
  * @example General usage
@@ -70,12 +70,17 @@
  * @module svelte-ast-print
  */
 
+import type esrap from "esrap";
 import type * as JS from "estree";
 import type { AST as SV } from "svelte/compiler";
 
 import { print_js } from "./_internal/js.ts";
 import type { PrintOptions } from "./_internal/option.js";
-import { hub, isSvelteOnlyNode, type Result, State, type SvelteOnlyNode } from "./_internal/shared.ts";
+import { isSvelteOnlyNode, type Result, State, type SvelteOnlyNode } from "./_internal/shared.ts";
+import { printCSSNode } from "./css.ts";
+import { printFragment } from "./fragment.ts";
+import { printRoot, printScript } from "./template/root.ts";
+import { printTemplateNode } from "./template.ts";
 
 /**
  * @param n Svelte or JavaScript/TypeScript ESTree specification complaint AST node
@@ -104,7 +109,7 @@ export function printSvelte<N extends SvelteOnlyNode>(n: N, opts: Partial<PrintO
 	const st = State.get(n, opts);
 	switch (n.type) {
 		case "Root": {
-			st.add(hub.printRoot(n, opts));
+			st.add(printRoot(n, opts));
 			break;
 		}
 		// CSS
@@ -126,15 +131,15 @@ export function printSvelte<N extends SvelteOnlyNode>(n: N, opts: Partial<PrintO
 		case "Atrule":
 		case "Rule":
 		case "StyleSheet": {
-			st.add(hub.printCSSNode(n, opts));
+			st.add(printCSSNode(n, opts));
 			break;
 		}
 		case "Fragment": {
-			st.add(hub.printFragment(n, opts));
+			st.add(printFragment(n, opts));
 			break;
 		}
 		case "Script": {
-			st.add(hub.printScript(n, opts));
+			st.add(printScript(n, opts));
 			break;
 		}
 		// attribute-like
@@ -178,14 +183,9 @@ export function printSvelte<N extends SvelteOnlyNode>(n: N, opts: Partial<PrintO
 		// HTML
 		case "Comment":
 		case "Text": {
-			st.add(hub.printTemplateNode(n, opts));
+			st.add(printTemplateNode(n, opts));
 			break;
 		}
 	}
 	return st.result;
 }
-
-export * from "./css.ts";
-export * from "./fragment.ts";
-export * from "./root.ts";
-export * from "./template.ts";

packages/svelte-ast-print/src/fragment.ts

@@ -7,12 +7,12 @@ import type { AST as SV } from "svelte/compiler";
 
 import type { PrintOptions } from "./_internal/option.ts";
 import type { Result } from "./_internal/shared.ts";
-import { printAttributeLike } from "./attribute.ts";
-import { printBlock } from "./block.ts";
-import { printElementLike } from "./element.ts";
-import { printHTMLNode } from "./html.ts";
-import { printRoot } from "./root.ts";
-import { printTag } from "./tag.ts";
+import { printAttributeLike } from "./template/attribute-like.ts";
+import { printBlock } from "./template/block.ts";
+import { printElementLike } from "./template/element-like.ts";
+import { printHTMLNode } from "./template/html.ts";
+import { printRoot } from "./template/root.ts";
+import { printTag } from "./template/tag.ts";
 
 /**
  * @since 1.0.0
@@ -61,9 +61,3 @@ export function printTemplateNode(n: SV.TemplateNode, opts: Partial<PrintOptions
 		case "Root": return printRoot(n, opts);
 	}
 }
-
-export * from "./attribute.ts";
-export * from "./block.ts";
-export * from "./element.ts";
-export * from "./html.ts";
-export * from "./tag.ts";