build: switch from Yarn to Bun

posthtml · Apr 20, 2024 · ba30200 · ba30200
1 parent 98ec0c3
commit ba30200
Show file tree

Hide file tree

Showing 23 changed files with 92 additions and 4,898 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,17 @@
+on:
+  pull_request:
+  push:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v1
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Run unit tests
+        run: bun test
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,4 @@
-/coverage
 /lib
 /node_modules
 .DS_Store
-yarn-debug.log*
-yarn-error.log*
-*.tgz
+*.tgz
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -1,17 +1,14 @@
 # posthtml-inline-favicon <img align="right" width="220" height="200" title="PostHTML logo" src="http://posthtml.github.io/posthtml/logo.svg">
 
 [![NPM][npm]][npm-url]
-[![Deps][deps]][deps-url]
-[![Build][build]][build-badge]
-[![Coverage][codecov-shield]][codecov]
 
 `posthtml-inline-favicon` is a [PostHTML](https://github.com/posthtml/posthtml) plugin to inline favicons.
 
 **Before:**
 
 ```html
 <head>
-  <link rel="shortcut icon" href="favicon.ico" />
+  <link rel="icon" href="favicon.ico" />
 </head>
 ```
 
@@ -26,41 +23,46 @@
 ## Install
 
 ```bash
+# npm
+npm i -D posthtml-inline-favicon
+
+# pnpm
+pnpm add -D posthtml-inline-favicon
+
+# Yarn
 yarn add -D posthtml-inline-favicon
-# OR
-npm i posthtml-inline-favicon
 ```
 
 ## Usage
 
 ```js
-const fs = require('fs');
-const posthtml = require('posthtml');
-const { inlineFavicon } = require('posthtml-inline-favicon');
+const fs = require("fs");
+const posthtml = require("posthtml");
+const { inlineFavicon } = require("posthtml-inline-favicon");
 
-const html = fs.readFileSync('./index.html');
+const html = fs.readFileSync("./index.html");
 
 posthtml()
   .use(inlineFavicon())
   .process(html)
-  .then(result => fs.writeFileSync('./after.html', result.html));
+  .then((result) => fs.writeFileSync("./after.html", result.html));
 ```
 
 ## Options
 
 By default, the plugin assumes that the file to process is in the same directory as the posthtml script. If not, specify the relative path to the html file in the options:
 
 ```js
-const fs = require('fs');
-const posthtml = require('posthtml');
-const { inlineFavicon } = require('posthtml-inline-favicon');
+const fs = require("fs");
+const posthtml = require("posthtml");
+const { inlineFavicon } = require("posthtml-inline-favicon");
 
-const html = fs.readFileSync('./public/index.html');
+const html = fs.readFileSync("./public/index.html");
 
 posthtml()
-  .use(inlineFavicon({ path: 'public' }))
+  .use(inlineFavicon({ path: "public" }))
   .process(html)
-  .then(result => fs.writeFileSync('./after.html', result.html));
+  .then((result) => fs.writeFileSync("./after.html", result.html));
 ```
 
 ## [Example](example)
@@ -77,9 +79,3 @@ See the [PostHTML Guidelines](https://github.com/posthtml/posthtml/tree/master/d
 
 [npm]: https://img.shields.io/npm/v/posthtml-inline-favicon.svg?color=blue
 [npm-url]: https://npmjs.com/package/posthtml-inline-favicon
-[deps]: https://david-dm.org/posthtml/posthtml-inline-favicon.svg
-[deps-url]: https://david-dm.org/posthtml/posthtml-inline-favicon
-[build]: https://travis-ci.com/posthtml/posthtml-inline-favicon.svg?branch=master
-[build-badge]: https://travis-ci.com/posthtml/posthtml-inline-favicon
-[codecov]: https://codecov.io/gh/posthtml/posthtml-inline-favicon
-[codecov-shield]: https://img.shields.io/codecov/c/github/posthtml/posthtml-inline-favicon.svg
diff --git a/bun.lockb b/bun.lockb
diff --git a/example/README.md b/example/README.md
@@ -13,9 +13,9 @@ The default behavior (no plugin options) assumes that `index.html` is located in
 ```js
 // posthtml.config.js
 runPlugin({
-  html: fs.readFileSync('./index.html'),
+  html: fs.readFileSync("./index.html"),
   options: undefined,
-  output: './after.default.html'
+  output: "./after.default.html",
 });
 ```
 
@@ -26,9 +26,9 @@ The custom behavior uses the `index.html` in the `public` folder.
 ```js
 // posthtml.config.js
 runPlugin({
-  html: fs.readFileSync('./public/index.html'),
-  options: { path: 'public' },
-  output: './after.public.html'
+  html: fs.readFileSync("./public/index.html"),
+  options: { path: "public" },
+  output: "./after.public.html",
 });
 ```
 

diff --git a/example/after.default.html b/example/after.default.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html>
   <head>
     <meta charset="utf-8" />

diff --git a/example/after.public.html b/example/after.public.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html>
   <head>
     <meta charset="utf-8" />

diff --git a/example/bun.lockb b/example/bun.lockb
diff --git a/example/index.html b/example/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html>
   <head>
     <meta charset="utf-8" />

diff --git a/example/package.json b/example/package.json
@@ -3,7 +3,7 @@
   "version": "1.0.0",
   "private": true,
   "devDependencies": {
-    "posthtml": "^0.11.4",
-    "posthtml-inline-favicon": "^0.1.0"
+    "posthtml": "^0.16.6",
+    "posthtml-inline-favicon": "^0.1.3"
   }
 }
diff --git a/example/posthtml.config.js b/example/posthtml.config.js
@@ -1,22 +1,22 @@
-const fs = require('fs');
-const posthtml = require('posthtml');
-const { inlineFavicon } = require('posthtml-inline-favicon');
+const fs = require("fs");
+const posthtml = require("posthtml");
+const { inlineFavicon } = require("posthtml-inline-favicon");
 
 function runPlugin({ html, options, output }) {
   posthtml()
     .use(inlineFavicon(options))
     .process(html)
-    .then(result => fs.writeFileSync(output, result.html));
+    .then((result) => fs.writeFileSync(output, result.html));
 }
 
 runPlugin({
-  html: fs.readFileSync('./index.html'),
+  html: fs.readFileSync("./index.html"),
   options: undefined,
-  output: './after.default.html'
+  output: "./after.default.html",
 });
 
 runPlugin({
-  html: fs.readFileSync('./public/index.html'),
-  options: { path: 'public' },
-  output: './after.public.html'
+  html: fs.readFileSync("./public/index.html"),
+  options: { path: "public" },
+  output: "./after.public.html",
 });
diff --git a/example/public/index.html b/example/public/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html>
   <head>
     <meta charset="utf-8" />

diff --git a/example/yarn.lock b/example/yarn.lock