Selfie
-- Precise snapshot testing for the JVM and Javascript (others TBD)
-- Supports text and binary data.
-- Friendly to humans and version control.
-- In-place [literal snapshots](#literal-snapshots).
-- Allows [lenses](#lenses) to verify multiple aspects of an object under test.
- - e.g. pretty-printed JSON, or only the rendered plaintext of an HTML document, etc.
+Snapshot testing is the fastest and most precise mechanism to record and specify the behavior of your system and its components.
-ere is a very simple test which snapshots the HTML served at various URLs.
+Robots are writing their own code. Are you still writing assertions by hand?
-```java
-@Test public void gzipFavicon() {
- expectSelfie(get("/favicon.ico", ContentEncoding.GZIP)).toMatchDisk();
-}
-@Test public void orderFlow() {
- expectSelfie(get("/orders")).toMatchDisk("initial");
- postOrder();
- expectSelfie(get("/orders")).toMatchDisk("ordered");
-}
-```
-
-This will generate a snapshot file like so:
-
-```
-╔═ gzipFavicon ═╗ base64 length 823 bytes
-H4sIAAAAAAAA/8pIzcnJVyjPL8pJUQQAlQYXAAAA
-╔═ orderFlow/initial ═╗
-
-
-
-╔═ orderFlow/ordered ═╗
-
- 
+ );
+}
diff --git a/docs/src/components/Button.tsx b/docs/src/components/Button.tsx
new file mode 100644
index 00000000..ab88290a
--- /dev/null
+++ b/docs/src/components/Button.tsx
@@ -0,0 +1,37 @@
+import clsx from "clsx";
+import { ReactNode } from "react";
+
+type ButtonProps = {
+ children: ReactNode;
+ className?: string;
+ onClick?: () => void;
+};
+
+export function Button({ children, className, onClick }: ButtonProps) {
+ return (
+ 
+ );
+}
diff --git a/docs/src/components/HeadingLanguageSelect.tsx b/docs/src/components/HeadingLanguageSelect.tsx
new file mode 100644
index 00000000..69401df6
--- /dev/null
+++ b/docs/src/components/HeadingLanguageSelect.tsx
@@ -0,0 +1,96 @@
+import {
+ LanguageSlug,
+ PathParts,
+ languageSlugsToLabels,
+} from "@/lib/languageFromPath";
+import { useResizing } from "@/lib/useResizing";
+import clsx from "clsx";
+import { Dispatch, SetStateAction } from "react";
+import { Button } from "./Button";
+import { CaretBottom } from "./Icons/CaretBottom";
+import { Close } from "./Icons/Close";
+
+type HeadingLanguageSelectProps = {
+ pathParts: PathParts;
+ setSelectIsOpen: Dispatch
+
+ 
+
+
+
+
+ );
+}
+
+/**
+ * **DO NOT DELETE** These are all possible outcomes of the math
+ * inside the string interpolation above. Tailwind magic isn't
+ * smart enough to do the math and it needs this list at build
+ * time in order to include these styles in the output.
+ *
+ * translate-y-[40px] translate-y-[50px] translate-y-[60px]
+ * translate-y-[-0px] translate-y-[-30px] translate-y-[-60px]
+ * tablet:translate-y-[45px] tablet:translate-y-[55px] tablet:translate-y-[65px]
+ * tablet:translate-y-[-0px] tablet:translate-y-[-35px] tablet:translate-y-[-70px]
+ * desktop:translate-y-[63px] desktop:translate-y-[73px] desktop:translate-y-[83px]
+ * desktop:translate-y-[-0px] desktop:translate-y-[-53px] desktop:translate-y-[-106px]
+ */
diff --git a/docs/src/components/Hero.tsx b/docs/src/components/Hero.tsx
new file mode 100644
index 00000000..7f6be21e
--- /dev/null
+++ b/docs/src/components/Hero.tsx
@@ -0,0 +1,60 @@
+import clsx from "clsx";
+import { ButtonList } from "./ButtonList";
+import { IntroText } from "./IntroText";
+import { Logo } from "./Logo";
+import { Mascot } from "./Mascot";
+
+export function Hero() {
+ return (
+
+ {Object.keys(languageSlugsToLabels)
+ .filter((slug) => slug !== pathParts.language)
+ .map((slug, idx) => (
+
+ ))}
+
+
+
+ );
+}
diff --git a/docs/src/components/Icons/CaretBottom.tsx b/docs/src/components/Icons/CaretBottom.tsx
new file mode 100644
index 00000000..17413ea7
--- /dev/null
+++ b/docs/src/components/Icons/CaretBottom.tsx
@@ -0,0 +1,14 @@
+import { SVGProps } from "react";
+
+export function CaretBottom(props: SVGProps
+
+
+
+ + snapshot testing for +
+
+
+ );
+}
+
+type SectionLinkProps = {
+ title: string;
+};
+function SectionLink({ title }: SectionLinkProps) {
+ return (
+
+ {title}
+
+ );
+}
diff --git a/docs/src/components/Logo.tsx b/docs/src/components/Logo.tsx
new file mode 100644
index 00000000..22c50126
--- /dev/null
+++ b/docs/src/components/Logo.tsx
@@ -0,0 +1,27 @@
+import clsx from "clsx";
+export function Logo() {
+ return (
+
+ Which is
{" "}
+
and
+
+
+ Snapshot testing is the
{" "}
+ fastest and most precise
+
+ mechanism to{" "}
+
+ record
and specify
+ {" "}
+ the
+
+ behavior of your
+ system and its
+ components
+
+ .
+
+ Robots are
writing their
+ own code. Are
+
you still writing
+
+ assertions by
+ hand?
+
+ selfie +
+ ); +} diff --git a/docs/src/components/Mascot.tsx b/docs/src/components/Mascot.tsx new file mode 100644 index 00000000..9e7d6d92 --- /dev/null +++ b/docs/src/components/Mascot.tsx @@ -0,0 +1,102 @@ +import clsx from "clsx"; +import { useEffect, useRef, useState } from "react"; + +export function Mascot() { + const literalOffsetTop = useRef(0); + const mascotRef = useRef
+
+ 
+
+ );
+}
diff --git a/docs/src/components/NavHeading.tsx b/docs/src/components/NavHeading.tsx
new file mode 100644
index 00000000..f06903a3
--- /dev/null
+++ b/docs/src/components/NavHeading.tsx
@@ -0,0 +1,46 @@
+import { LanguageSlug, getPathParts } from "@/lib/languageFromPath";
+import clsx from "clsx";
+import { useRouter } from "next/router";
+import { useState } from "react";
+import { HeadingLanguageSelect } from "./HeadingLanguageSelect";
+import { Selfie } from "./Selfie";
+
+type NavHeadingProps = {
+ text: string;
+};
+
+export function NavHeading({ text }: NavHeadingProps) {
+ const router = useRouter();
+ const pathParts = getPathParts(router.pathname);
+ if (!pathParts.language) {
+ pathParts.language = "jvm";
+ }
+
+ function handleChange(value: LanguageSlug) {
+ let nextRoute = "/" + value;
+ if (pathParts.subpath) {
+ nextRoute += "/" + pathParts.subpath;
+ }
+ router.push(nextRoute + `#${text}`);
+ setSelectIsOpen(false);
+ }
+
+ const [selectIsOpen, setSelectIsOpen] = useState
+ +
+
+
+
+
+ );
+}
diff --git a/docs/src/components/Navigation/LanguageSelect.tsx b/docs/src/components/Navigation/LanguageSelect.tsx
new file mode 100644
index 00000000..507ace3b
--- /dev/null
+++ b/docs/src/components/Navigation/LanguageSelect.tsx
@@ -0,0 +1,141 @@
+import {
+ LanguageSlug,
+ PathParts,
+ languageSlugsToLabels,
+} from "@/lib/languageFromPath";
+import clsx from "clsx";
+import Link from "next/link";
+import { Dispatch, SetStateAction } from "react";
+import { Button } from "../Button";
+import { CaretBottom } from "../Icons/CaretBottom";
+import { Selfie } from "../Selfie";
+import { Close } from "../Icons/Close";
+
+type LanguageSelectProps = {
+ pathParts: PathParts;
+ setSelectIsOpen: Dispatch
+
+
+
+
+
+
+
+
+ {Object.keys(languageSlugsToLabels)
+ .filter((slug) => slug !== pathParts.language)
+ .map((slug) => (
+
+ ))}
+
+
+ );
+}
+
+function ShadowHider() {
+ return (
+
+ );
+}
diff --git a/docs/src/components/Navigation/Navigation.tsx b/docs/src/components/Navigation/Navigation.tsx
new file mode 100644
index 00000000..7eb566a7
--- /dev/null
+++ b/docs/src/components/Navigation/Navigation.tsx
@@ -0,0 +1,47 @@
+import { LanguageSlug, getPathParts } from "@/lib/languageFromPath";
+import clsx from "clsx";
+import { useRouter } from "next/router";
+import { useState } from "react";
+import { LanguageSelect } from "./LanguageSelect";
+import { SubNavigation } from "./SubNavigation";
+
+export function Navigation() {
+ const router = useRouter();
+ const pathParts = getPathParts(router.pathname);
+
+ function handleChange(value: LanguageSlug) {
+ let nextRoute = "/" + value;
+ if (pathParts.subpath) {
+ nextRoute += "/" + pathParts.subpath;
+ }
+ router.push(nextRoute);
+ setSelectIsOpen(false);
+ }
+
+ const [selectIsOpen, setSelectIsOpen] = useState
+
+ );
+}
diff --git a/docs/src/components/Navigation/SubNavigation.tsx b/docs/src/components/Navigation/SubNavigation.tsx
new file mode 100644
index 00000000..f451542c
--- /dev/null
+++ b/docs/src/components/Navigation/SubNavigation.tsx
@@ -0,0 +1,117 @@
+import { PathParts } from "@/lib/languageFromPath";
+import clsx from "clsx";
+import Link from "next/link";
+import { Button } from "../Button";
+
+type SubNavButton = {
+ text: string;
+ hrefSubpath: string;
+ isPressed(subpathName: PathParts["subpath"]): boolean;
+};
+
+const subNavButtonList: SubNavButton[] = [
+ {
+ text: "why",
+ hrefSubpath: "#literal",
+ isPressed: (subpathName) => subpathName === "",
+ },
+ {
+ text: "get started",
+ hrefSubpath: "/get-started",
+ isPressed: (subpathName) => subpathName === "get-started",
+ },
+ {
+ text: "advanced",
+ hrefSubpath: "/advanced",
+ isPressed: (subpathName) => subpathName === "advanced",
+ },
+];
+
+type SubNavigationProps = {
+ pathParts: PathParts;
+ selectIsOpen: boolean;
+};
+
+export function SubNavigation({ pathParts, selectIsOpen }: SubNavigationProps) {
+ return (
+
+ );
+}
+
+const sharedClasses = clsx([
+ "px-1",
+ "flex",
+ "justify-center",
+ "items-center",
+ "cursor-pointer",
+ "text-[16px]",
+ "border",
+ "h-[23px]",
+ "border-black",
+ "border-2",
+ "rounded-[4px]",
+ "hover:text-white",
+ "hover:bg-blue",
+ "wide-phone:text-base",
+ "wide-phone:h-[30px]",
+ "tablet:h-[35px]",
+ "tablet:border-[3px]",
+ "tablet:rounded-[10px]",
+ "desktop:h-[53px]",
+ "desktop:text-[34px]",
+ "desktop:border-[4px]",
+ "desktop:rounded-[16px]",
+]);
+
+const pressedClasses = clsx([
+ "text-white",
+ "bg-blue",
+ "shadow-none",
+ sharedClasses,
+]);
+
+const unPressedClasses = clsx([
+ "text-black",
+ "bg-white",
+ "shadow-button",
+ "tablet:shadow-button-tablet",
+ sharedClasses,
+]);
diff --git a/docs/src/components/Selfie.tsx b/docs/src/components/Selfie.tsx
new file mode 100644
index 00000000..dbaa2a9a
--- /dev/null
+++ b/docs/src/components/Selfie.tsx
@@ -0,0 +1,28 @@
+import clsx from "clsx";
+
+type SelfieProps = {
+ className?: string;
+};
+
+export function Selfie({ className }: SelfieProps) {
+ return (
+
+ selfie
+
+ );
+}
diff --git a/docs/src/components/mdx.tsx b/docs/src/components/mdx.tsx
new file mode 100644
index 00000000..3ab13d69
--- /dev/null
+++ b/docs/src/components/mdx.tsx
@@ -0,0 +1,97 @@
+import clsx from "clsx";
+import { createContext, useContext } from "react";
+
+type ParentComponentProps = {
+ children?: React.ReactNode;
+};
+
+export function Row({ children }: ParentComponentProps) {
+ return (
+
+ {children}
+
+ );
+}
+
+type ColProps = ParentComponentProps & {
+ sticky?: boolean;
+};
+
+export function Col({ children, sticky = false }: ColProps) {
+ return (
+ :first-child]:mt-0 [&>:last-child]:mb-0",
+ sticky && "xl:sticky xl:top-24"
+ )}
+ >
+ {children}
+
+ );
+}
+
+const CodeBlockContext = createContext(false);
+
+export function code({ children, ...props }: ParentComponentProps) {
+ let isBlock = useContext(CodeBlockContext);
+ const className = isBlock
+ ? ""
+ : clsx([
+ "bg-grey",
+ "px-[14px]",
+ "pt-[6px]",
+ "pb-[2px]",
+ "rounded-xl",
+ "text-sm",
+ "desktop:text-base",
+ "leading-[1.5em]",
+ ]);
+ return children ? (
+
+
+
+ {children}
+
+ + {children} +
+ ); +} + +export function h2({ children, ...props }: ParentComponentProps) { + return ( + <> ++
{children}
+ + ); +} diff --git a/docs/src/lib/languageFromPath.ts b/docs/src/lib/languageFromPath.ts new file mode 100644 index 00000000..33c65df8 --- /dev/null +++ b/docs/src/lib/languageFromPath.ts @@ -0,0 +1,21 @@ +export const languageSlugsToLabels = { + jvm: "jvm", + js: "js", + go: "go", + "other-platforms": "...", +}; + +export type LanguageSlug = keyof typeof languageSlugsToLabels; + +export type PathParts = { + language: LanguageSlug; + subpath: "" | "get-started" | "advanced"; +}; + +export function getPathParts(path: string): PathParts { + const splitPath = path.split("/"); + return { + language: splitPath[1], + subpath: splitPath.length === 3 ? splitPath[2] : "", + } as PathParts; +} diff --git a/docs/src/lib/useResizing.ts b/docs/src/lib/useResizing.ts new file mode 100644 index 00000000..9e13c6d9 --- /dev/null +++ b/docs/src/lib/useResizing.ts @@ -0,0 +1,23 @@ +import { useEffect, useState } from "react"; + +export function useResizing() { + const [resizing, setResizing] = useState(false); + + useEffect(() => { + let timer: NodeJS.Timeout; + function doneResizing() { + setResizing(false); + } + function handleResize() { + setResizing(true); + clearTimeout(timer); + + timer = setTimeout(doneResizing, 100); + } + window.addEventListener("resize", handleResize); + + return () => window.removeEventListener("resize", handleResize); + }, []); + + return resizing; +} diff --git a/docs/src/mdx/recma.mjs b/docs/src/mdx/recma.mjs new file mode 100644 index 00000000..48901160 --- /dev/null +++ b/docs/src/mdx/recma.mjs @@ -0,0 +1,19 @@ +import { mdxAnnotations } from 'mdx-annotations' +import recmaNextjsStaticProps from 'recma-nextjs-static-props' + +function recmaRemoveNamedExports() { + return (tree) => { + tree.body = tree.body.map((node) => { + if (node.type === 'ExportNamedDeclaration') { + return node.declaration + } + return node + }) + } +} + +export const recmaPlugins = [ + mdxAnnotations.recma, + recmaRemoveNamedExports, + recmaNextjsStaticProps, +] diff --git a/docs/src/mdx/rehype.mjs b/docs/src/mdx/rehype.mjs new file mode 100644 index 00000000..6701ca23 --- /dev/null +++ b/docs/src/mdx/rehype.mjs @@ -0,0 +1,129 @@ +import { mdxAnnotations } from "mdx-annotations"; +import { visit } from "unist-util-visit"; +import rehypeMdxTitle from "rehype-mdx-title"; +import shiki from "shiki"; +import { toString } from "mdast-util-to-string"; +import * as acorn from "acorn"; +import { slugifyWithCounter } from "@sindresorhus/slugify"; + +function rehypeParseCodeBlocks() { + return (tree) => { + visit(tree, "element", (node, _nodeIndex, parentNode) => { + if (node.tagName === "code" && node.properties.className) { + parentNode.properties.language = node.properties.className[0]?.replace( + /^language-/, + "" + ); + } + }); + }; +} + +let highlighter; +const theme = await shiki.loadTheme("themes/github-light.json"); +function rehypeShiki() { + return async (tree) => { + highlighter = highlighter ?? (await shiki.getHighlighter({ theme })); + + visit(tree, "element", (node) => { + if (node.tagName === "pre" && node.children[0]?.tagName === "code") { + let codeNode = node.children[0]; + let textNode = codeNode.children[0]; + + node.properties.code = textNode.value; + + if (node.properties.language) { + let tokens = highlighter.codeToThemedTokens( + textNode.value, + node.properties.language + ); + + textNode.value = shiki.renderToHtml(tokens, { + elements: { + pre: ({ children }) => children, + code: ({ children }) => children, + line: ({ children }) => `${children}`, + }, + }); + } + } + }); + }; +} + +function rehypeSlugify() { + return (tree) => { + let slugify = slugifyWithCounter(); + visit(tree, "element", (node) => { + if (["h2", "h3"].includes(node.tagName) && !node.properties.id) { + let id = slugify(toString(node)); + if (id.startsWith("is-")) { + id = id.substring(3); + } + node.properties.id = id; + } + }); + }; +} + +function rehypeAddMDXExports(getExports) { + return (tree) => { + let exports = Object.entries(getExports(tree)); + + for (let [name, value] of exports) { + for (let node of tree.children) { + if ( + node.type === "mdxjsEsm" && + new RegExp(`export\\s+const\\s+${name}\\s*=`).test(node.value) + ) { + return; + } + } + + let exportStr = `export const ${name} = ${value}`; + + tree.children.push({ + type: "mdxjsEsm", + value: exportStr, + data: { + estree: acorn.parse(exportStr, { + sourceType: "module", + ecmaVersion: "latest", + }), + }, + }); + } + }; +} + +function getSections(node) { + let sections = []; + + for (let child of node.children ?? []) { + if (child.type === "element" && child.tagName === "h2") { + sections.push(`{ + title: ${JSON.stringify(toString(child))}, + id: ${JSON.stringify(child.properties.id)}, + ...${child.properties.annotation} + }`); + } else if (child.children) { + sections.push(...getSections(child)); + } + } + + return sections; +} + +export const rehypePlugins = [ + mdxAnnotations.rehype, + rehypeParseCodeBlocks, + rehypeShiki, + rehypeSlugify, + rehypeMdxTitle, + [ + rehypeAddMDXExports, + (tree) => ({ + sections: `[${getSections(tree).join()}]`, + }), + ], +]; diff --git a/docs/src/mdx/remark.mjs b/docs/src/mdx/remark.mjs new file mode 100644 index 00000000..e523464b --- /dev/null +++ b/docs/src/mdx/remark.mjs @@ -0,0 +1,4 @@ +import { mdxAnnotations } from 'mdx-annotations' +import remarkGfm from 'remark-gfm' + +export const remarkPlugins = [mdxAnnotations.remark, remarkGfm] diff --git a/docs/src/mdx/search.mjs b/docs/src/mdx/search.mjs new file mode 100644 index 00000000..06a29fae --- /dev/null +++ b/docs/src/mdx/search.mjs @@ -0,0 +1,136 @@ +import { createLoader } from 'simple-functional-loader' +import glob from 'fast-glob' +import { remark } from 'remark' +import remarkMdx from 'remark-mdx' +import * as url from 'url' +import * as path from 'path' +import * as fs from 'fs' +import { visit, SKIP } from 'unist-util-visit' +import { slugifyWithCounter } from '@sindresorhus/slugify' +import { toString } from 'mdast-util-to-string' +import { filter } from 'unist-util-filter' + +const __filename = url.fileURLToPath(import.meta.url) +const processor = remark().use(remarkMdx).use(extractSections) +const slugify = slugifyWithCounter() + +function isObjectExpression(node) { + return ( + node.type === 'mdxTextExpression' && + node.data?.estree?.body?.[0]?.expression?.type === 'ObjectExpression' + ) +} + +function excludeObjectExpressions(tree) { + return filter(tree, (node) => !isObjectExpression(node)) +} + +function extractSections() { + return (tree, { sections }) => { + slugify.reset() + + visit(tree, (node) => { + if (node.type === 'heading' || node.type === 'paragraph') { + let content = toString(excludeObjectExpressions(node)) + if (node.type === 'heading' && node.depth <= 2) { + let hash = node.depth === 1 ? null : slugify(content) + sections.push([content, hash, []]) + } else { + sections.at(-1)?.[2].push(content) + } + return SKIP + } + }) + } +} + +export default function (nextConfig = {}) { + let cache = new Map() + + return Object.assign({}, nextConfig, { + webpack(config, options) { + config.module.rules.push({ + test: __filename, + use: [ + createLoader(function () { + let pagesDir = path.resolve('./src/pages') + this.addContextDependency(pagesDir) + + let files = glob.sync('**/*.mdx', { cwd: pagesDir }) + let data = files.map((file) => { + let url = + file === 'index.mdx' ? '/' : `/${file.replace(/\.mdx$/, '')}` + let mdx = fs.readFileSync(path.join(pagesDir, file), 'utf8') + + let sections = [] + + if (cache.get(file)?.[0] === mdx) { + sections = cache.get(file)[1] + } else { + let vfile = { value: mdx, sections } + processor.runSync(processor.parse(vfile), vfile) + cache.set(file, [mdx, sections]) + } + + return { url, sections } + }) + + // When this file is imported within the application + // the following module is loaded: + return ` + import FlexSearch from 'flexsearch' + + let sectionIndex = new FlexSearch.Document({ + tokenize: 'full', + document: { + id: 'url', + index: 'content', + store: ['title', 'pageTitle'], + }, + context: { + resolution: 9, + depth: 2, + bidirectional: true + } + }) + + let data = ${JSON.stringify(data)} + + for (let { url, sections } of data) { + for (let [title, hash, content] of sections) { + sectionIndex.add({ + url: url + (hash ? ('#' + hash) : ''), + title, + content: [title, ...content].join('\\n'), + pageTitle: hash ? sections[0][0] : undefined, + }) + } + } + + export function search(query, options = {}) { + let result = sectionIndex.search(query, { + ...options, + enrich: true, + }) + if (result.length === 0) { + return [] + } + return result[0].result.map((item) => ({ + url: item.id, + title: item.doc.title, + pageTitle: item.doc.pageTitle, + })) + } + ` + }), + ], + }) + + if (typeof nextConfig.webpack === 'function') { + return nextConfig.webpack(config, options) + } + + return config + }, + }) +} diff --git a/docs/src/pages/_app.tsx b/docs/src/pages/_app.tsx new file mode 100644 index 00000000..5beebebc --- /dev/null +++ b/docs/src/pages/_app.tsx @@ -0,0 +1,36 @@ +import { Hero } from "@/components/Hero"; +import { Navigation } from "@/components/Navigation/Navigation"; +import * as mdxComponents from "@/components/mdx"; +import "@/styles/tailwind.css"; +import { MDXProvider } from "@mdx-js/react"; +import clsx from "clsx"; +import { AppProps } from "next/app"; +import Head from "next/head"; + +export default function App({ Component, pageProps }: AppProps) { + return ( + <> + +
+ {pageProps.showHero ?
+
+
+
+
+
+
+ );
+}
diff --git a/docs/src/pages/index.mdx b/docs/src/pages/index.mdx
new file mode 100644
index 00000000..5b1eabb1
--- /dev/null
+++ b/docs/src/pages/index.mdx
@@ -0,0 +1,108 @@
+import { Hero } from "@/components/Hero";
+import { Selfie } from "@/components/Selfie";
+import { NavHeading } from "@/components/NavHeading";
+
+{/* show the homepage hero component and hide the navigation used everywhere else in the app */}
+export const showHero = true
+
+
+
+
+ Thanks for your business!
+
+
+
+
+```
+
+TODO.
+
+## Order information
+Tracking #ABC123
+Thanks for your business!
+
+
+
+```
+
+TODO.
+
+## Order information
+Tracking #ABC123
+
+
+
+
+
+
+ <@template_cmd name="pathToRoot">
+
+
+
+
+
+
+ <@source_set_selector.display/>
+
+
\ No newline at end of file
diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
index 033e24c4..7f93135c 100644
Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
index ac72c34e..1af9e093 100644
--- a/gradle/wrapper/gradle-wrapper.properties
+++ b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.3-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
diff --git a/gradlew b/gradlew
index fcb6fca1..0adc8e1a 100755
--- a/gradlew
+++ b/gradlew
@@ -83,7 +83,8 @@ done
# This is normally unused
# shellcheck disable=SC2034
APP_BASE_NAME=${0##*/}
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum
diff --git a/selfie-lib/README.md b/selfie-lib/README.md
new file mode 100644
index 00000000..195f8bfd
--- /dev/null
+++ b/selfie-lib/README.md
@@ -0,0 +1,8 @@
+# Module selfie-lib
+
+
+
+This Kotlin Multiplatform library makes it easy to read and write snapshot files.
+
+It is the guts that make the java and js runners work, but it's also reusable infrastructure if you want to build tooling on top of the snapshot files.
+
\ No newline at end of file
diff --git a/selfie-lib/build.gradle b/selfie-lib/build.gradle
index 69142b8f..623ca8e4 100644
--- a/selfie-lib/build.gradle
+++ b/selfie-lib/build.gradle
@@ -1,10 +1,16 @@
plugins {
id 'org.jetbrains.kotlin.multiplatform'
+ id 'maven-publish'
}
repositories {
mavenCentral()
}
+ext {
+ maven_name = 'selfie-lib'
+ maven_desc = 'Core logic and parsing for Selfie'
+}
+
apply from: rootProject.file('gradle/spotless.gradle')
kotlin {
jvm {
@@ -30,4 +36,8 @@ kotlin {
// the normal `test` task doesn't work for multiplatform projects
tasks.create('test') {
dependsOn('jvmTest')
-}
\ No newline at end of file
+}
+
+// it all needs to get published and formatted
+apply from: 干.file('base/maven.gradle')
+apply from: 干.file('base/sonatype.gradle')
\ No newline at end of file
diff --git a/selfie-runner-junit5/README.md b/selfie-runner-junit5/README.md
new file mode 100644
index 00000000..5d8823e0
--- /dev/null
+++ b/selfie-runner-junit5/README.md
@@ -0,0 +1,10 @@
+# Module selfie-runner-junit5
+
+
+
+
+High level docs for this live at TODO.
+
+Lots of stuff to say.
+
+
\ No newline at end of file
diff --git a/selfie-runner-junit5/build.gradle b/selfie-runner-junit5/build.gradle
index 98877618..83f0bd22 100644
--- a/selfie-runner-junit5/build.gradle
+++ b/selfie-runner-junit5/build.gradle
@@ -4,21 +4,38 @@ plugins {
repositories {
mavenCentral()
}
+ext {
+ maven_name = 'selfie-runner-junit5'
+ maven_desc = 'JUnit 5 test runner for Selfie'
+}
+
apply from: rootProject.file('gradle/spotless.gradle')
apply plugin: 'java-library'
dependencies {
api project(':selfie-lib')
// see if we can drop this down to 1.0.0
- implementation 'org.junit.platform:junit-platform-launcher:1.10.0'
+ implementation 'org.junit.platform:junit-platform-launcher:1.10.1'
compileOnly "org.junit.jupiter:junit-jupiter-api:$ver_JUNIT_API"
+ // jsoup
+ compileOnly 'org.jsoup:jsoup:1.17.1'
+ testImplementation 'org.jsoup:jsoup:1.17.1'
+ // flexmark
+ compileOnly 'com.vladsch.flexmark:flexmark-html2md-converter:0.64.8'
+ testImplementation 'com.vladsch.flexmark:flexmark-html2md-converter:0.64.8'
testImplementation "com.squareup.okio:okio:$ver_OKIO"
testImplementation "org.jetbrains.kotlin:kotlin-test-junit5:$ver_KOTLIN_TEST"
testImplementation "io.kotest:kotest-assertions-core:$ver_KOTEST"
testImplementation "org.junit.jupiter:junit-jupiter:$ver_JUNIT_USE"
testImplementation "org.junit-pioneer:junit-pioneer:$ver_JUNIT_PIONEER"
+
testImplementation gradleTestKit()
}
test {
useJUnitPlatform()
-}
\ No newline at end of file
+ getInputs().dir('../undertest-junit5/src/test/kotlin')
+}
+
+// it all needs to get published and formatted
+apply from: 干.file('base/maven.gradle')
+apply from: 干.file('base/sonatype.gradle')
diff --git a/selfie-runner-junit5/src/test/kotlin/com/diffplug/selfie/junit5/Harness.kt b/selfie-runner-junit5/src/test/kotlin/com/diffplug/selfie/junit5/Harness.kt
index c9f3b3d4..001712e8 100644
--- a/selfie-runner-junit5/src/test/kotlin/com/diffplug/selfie/junit5/Harness.kt
+++ b/selfie-runner-junit5/src/test/kotlin/com/diffplug/selfie/junit5/Harness.kt
@@ -24,9 +24,9 @@ import javax.xml.xpath.XPathFactory
import okio.FileSystem
import okio.Path
import okio.Path.Companion.toPath
-import org.gradle.internal.impldep.junit.framework.AssertionFailedError
import org.gradle.tooling.BuildException
import org.gradle.tooling.GradleConnector
+import org.opentest4j.AssertionFailedError
import org.w3c.dom.NodeList
import org.xml.sax.InputSource
@@ -190,27 +190,29 @@ open class Harness(subproject: String) {
}
}
fun gradlew(task: String, vararg args: String): AssertionFailedError? {
- val runner =
- GradleConnector.newConnector()
- .forProjectDirectory(subprojectFolder.parent!!.toFile())
- .connect()
-
- try {
- val buildLauncher =
- runner
- .newBuild()
- .forTasks(":${subprojectFolder.name}:$task")
- .withArguments(
- buildList