Plaiceholder 3.0 (#232)

* chore(example-with-next): move to manual fs usage * chore(example-with-astro): move to manual fs usage * chore(plaiceholder): remove file path type * chore(@plaiceholder/tailwindcss): manual fs * chore(plaiceholder): clean-up unnecessary extraction * chore(plaiceholder): further consolidation * chore: delete 11ty + remix examples due to maintenance overhead * refactor(plaiceholder): remove blurhash support * refactor(plaiceholder): remove img in favour of metadata * feat: color * docs: update * docs: move to nextra * chore(example-with-next): use app directory * chore(example-with-astro): update to [email protected], use assets * chore: update sharp * chore(example-with-astro): use fileURLToPath * chore(example-with-astro): try URL * feat(@plaiceholder/tailwindcss): resolver * chore(example-with-next): remove src dir * refactor(@plaiceholder/tailwindcss): make esm only * refactor(@plaiceholder/next): make esm only * refactor(@plaiceholder/ui): make esm only * chore: pnpm@8, node@18 * chore(example-with-next): remove @plaiceholder/tailwindcss due to lack of esm config support * refactor(plaiceholder): make esm only * feat(plaiceholder): pixels * chore(packages): update deps * feat(plaiceholder): add autoOrient * refactor(plaiceholder): revert removeAlpha by default * docs: update usage * docs: update tailwind plugin documentation * docs: esm disclaimers * docs: migration guide * docs: expand migration guide * docs: sponsors * chore: create FUNDING.yml * chore(@plaiceholder/next): add peerDep * chore(plaiceholder): migrate types * chore(plaiceholder): make modulate nonnullable * chore: update readme
joe-bell · May 24, 2023 · 3dede8b · 3dede8b · vercel · May 24, 2023
1 parent 6534950
commit 3dede8b
Show file tree

Hide file tree

Showing 202 changed files with 6,540 additions and 17,140 deletions.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1 @@
+custom: https://joebell.co.uk/sponsors
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,4 +1,4 @@
-name: CI
+name: ci
 
 on:
   push:
@@ -9,22 +9,22 @@ on:
 jobs:
   pnpm:
     runs-on: ubuntu-latest
-
     strategy:
       fail-fast: false
       matrix:
         script: [lint]
-
     steps:
       - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
       - uses: pnpm/action-setup@v2
         with:
-          version: 7
+          version: 8
+          run_install: false
       - uses: actions/setup-node@v3
         with:
           cache: "pnpm"
           node-version-file: ".nvmrc"
-      - run: pnpm install --frozen-lockfile
-      - run: pnpm build
+      - run: pnpm i
       - name: ${{ matrix.script }}
         run: pnpm ${{ matrix.script }}
diff --git a/.github/workflows/commitlint.yml b/.github/workflows/commitlint.yml
diff --git a/.husky/commit-msg b/.husky/commit-msg
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-pnpm pre-commit
+pnpm precommit
diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-16.15.1
+18.13.0
diff --git a/ACQUISITION.md b/ACQUISITION.md
diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
-<p align="center">
-  <strong>
-    <a href="ACQUISITION.md">
-      Open to Acquisition 🟢
-    </a>
-  </strong>
-</p>
+> **Note**
+>
+> The `plaiceholder` project is feature complete and will now be kept in maintenance mode.
+>
+> [**Read the migration guide**](https://plaiceholder.co/docs/upgrading-to-3) for further information.
+>
+> If this project has been useful to you, please consider [sponsoring my work](https://joebell.co.uk/sponsors).
 
 ---
 
@@ -47,19 +47,7 @@
 
 <br />
 
-## Documentation 📖
-
-Visit **[plaiceholder.co][plaiceholder]** to get started with the open-source free-to-use packages.
-
-### Migrating from `1.0`?
-
-See the [migration guide](https://github.com/joe-bell/plaiceholder/releases/tag/v2.0.0) for further details.
-
-## Sponsors
-
-We're still working on a process for supporting Plaiceholder – check back soon for more details.
-
-### Long-term Supporters
+## Supporters
 
 Thanks go to these wondeful people for their long-standing support.
 
@@ -105,14 +93,3 @@ Copyright © 2013-2022, Lovell Fuller. All Rights Reserved.
 Licensed under the Apache License, Version 2.0 (the "License").
 
 [plaiceholder]: https://plaiceholder.co
-[blurhash]: https://blurha.sh/
-[react-blurhash]: https://github.com/woltapp/react-blurhash
-[next/image]: https://nextjs.org/docs/basic-features/image-optimization
-
----
-
-<p align="center">
-  <a href="https://vercel.com?utm_source=plaiceholder&utm_campaign=oss">
-    <img alt="Powered by Vercel"  src="./.github/assets/powered-by-vercel.svg" />
-  <a>
-</p>
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/babel.config.js b/docs/babel.config.js
diff --git a/docs/components/IntroHeader/index.tsx b/docs/components/IntroHeader/index.tsx
@@ -0,0 +1,26 @@
+import React from "react";
+import { cx } from "class-variance-authority";
+import styles from "./styles.module.css";
+
+interface IntroHeaderProps {
+  headline: string;
+  tagline: string;
+}
+
+function IntroHeader({ headline, tagline }: IntroHeaderProps) {
+  return (
+    <header className={cx("nx-mt-4", styles.container)}>
+      <p
+        className={cx(
+          "nx-text-4xl nx-font-bold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100",
+          styles.headline
+        )}
+      >
+        {headline}
+      </p>
+      <p className={styles.tagline}>{tagline}</p>
+    </header>
+  );
+}
+
+export default IntroHeader;
diff --git a/docs/components/IntroHeader/styles.module.css b/docs/components/IntroHeader/styles.module.css
@@ -0,0 +1,21 @@
+.container {
+  margin-bottom: 2.5rem;
+}
+
+.container > * {
+  display: block;
+  margin: 0;
+}
+
+.container > * + * {
+  margin-top: 1rem;
+}
+
+.headline {
+  line-height: 2.5rem;
+  max-width: 24ch;
+}
+
+.tagline {
+  font-size: 1.2rem;
+}
diff --git a/docs/docs/examples/11ty.md b/docs/docs/examples/11ty.md
diff --git a/docs/docs/examples/remix.md b/docs/docs/examples/remix.md
diff --git a/docs/docs/plugins/next.md b/docs/docs/plugins/next.md