nanosplash 3.0.0 → 3.0.2

package/.github/workflows/ci.yml

@@ -1,48 +1,54 @@
-name: Build and Test
+name: Main Github Actions Workflow
 
 on:
-  push:
-    branches:
-      - production
-  pull_request:
-    branches:
-      - production
+    push:
+        branches:
+            - production
+    pull_request:
+        branches:
+            - production
 
 jobs:
-  build-and-test:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v2
-        with:
-          node-version: '20'
-
-      - name: Set up Git and update production branch
-        run: |
-          git config --global user.name "GitHub Actions"
-          git config --global user.email "actions@github.com"
-          git checkout production
-          git fetch
-          git pull --no-rebase
-
-      - name: Install dependencies
-        run: yarn install --frozen-lockfile
-
-      - name: Build (Vite)
-        run: yarn build
-
-      - name: Test (Vitest)
-        run: yarn test
-
-      - name: Generate Code Coverage (Vitest)
-        run: yarn coverage
-
-      - name: Commit and push changes
-        run: |
-          git add .
-          git commit --allow-empty -m "Build, test, and coverage report"
-          git push
+    build-and-test:
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v3
+
+            - name: Install Bun
+              uses: oven-sh/setup-bun@v1
+
+            - name: Setup Node.js
+              uses: actions/setup-node@v3
+              with:
+                  node-version: 20
+
+            - name: Set up Git and update production branch
+              run: |
+                  git config --global user.name "GitHub Actions"
+                  git config --global user.email "actions@github.com"
+                  git checkout production
+                  git fetch
+                  git pull --no-rebase
+
+            - name: Setup Pages
+              uses: actions/configure-pages@v3
+
+            - name: Install dependencies
+              run: bun install
+
+            - name: Build (Vite)
+              run: bun run build
+
+            - name: Test (Vitest)
+              run: bun run test
+
+            - name: Generate Code Coverage (Vitest)
+              run: bun run coverage
+
+            - name: Commit and push changes
+              run: |
+                  git add .
+                  git commit --allow-empty -m "Build, test, and coverage report"
+                  git push

package/.github/workflows/vitepress.yml

@@ -0,0 +1,69 @@
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy VitePress site to Pages
+
+on:
+    # Runs on pushes targeting the `main` branch. Change this to `master` if you're
+    # using the `master` branch as the default branch.
+    push:
+        branches: [production]
+    pull_request:
+        branches: [production]
+
+    # Allows you to run this workflow manually from the Actions tab
+    workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+    contents: read
+    pages: write
+    id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+    group: pages
+    cancel-in-progress: false
+
+jobs:
+    # Build job
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v3
+              with:
+                  fetch-depth: 0 # Not needed if lastUpdated is not enabled
+            # - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm
+            - name: Install Bun
+              uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
+            - name: Setup Node
+              uses: actions/setup-node@v3
+              with:
+                  node-version: 20
+                  cache: yarn
+            - name: Setup Pages
+              uses: actions/configure-pages@v3
+            - name: Install dependencies
+              run: yarn install
+            - name: Build with VitePress
+              run: |
+                  bun run docs:build
+                  touch docs/.vitepress/dist/.nojekyll
+            - name: Upload artifact
+              uses: actions/upload-pages-artifact@v2
+              with:
+                  path: docs/.vitepress/dist
+
+    # Deployment job
+    deploy:
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        needs: build
+        runs-on: ubuntu-latest
+        name: Deploy
+        steps:
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v2

package/.prettierignore

@@ -0,0 +1 @@
+*.sass

package/.prettierrc

@@ -1,12 +1,12 @@
 {
-  "tabWidth": 2,
-  "useTabs": true,
-  "singleQuote": true,
-  "bracketSpacing": true,
-  "jsxSingleQuote": true,
-  "endOfLine": "lf",
-  "trailingComma": "es5",
-  "arrowParens": "avoid",
-  "semi": false,
-  "printWidth": 80
+	"tabWidth": 4,
+	"useTabs": true,
+	"singleQuote": true,
+	"bracketSpacing": true,
+	"jsxSingleQuote": true,
+	"endOfLine": "lf",
+	"trailingComma": "es5",
+	"arrowParens": "avoid",
+	"semi": false,
+	"printWidth": 80
 }

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Isak Hauge
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,57 +1,30 @@
 # Nanosplash
 
-### Tiny loading screen for web artisans
+### The tiny loading screen for web artisans
 
 <br>
 
-[![Build](https://github.com/isakhauge/nanosplash/actions/workflows/ci.yml/badge.svg?branch=production)](https://github.com/isakhauge/nanosplash/actions/workflows/ci.yml) [![Build Status](https://github.com/isakhauge/nanosplash/workflows/CI/badge.svg?branch=production)](https://github.com/isakhauge/nanosplash/actions?query=workflow%3ACI) [![Coverage](https://img.shields.io/badge/Coverage-98.5%25-brightgreen.svg?style=flat)](https://your-coverage-report-url) [![TypeScript](https://badges.frapsoft.com/typescript/version/typescript-next.svg?v=101)](https://github.com/ellerbrock/typescript-badges/) [![Last Commit](https://img.shields.io/github/last-commit/isakhauge/nanosplash)](https://github.com/isakhauge/nanosplash/commits/production)
+[![Build](https://github.com/isakhauge/nanosplash/actions/workflows/ci.yml/badge.svg?branch=production)](https://github.com/isakhauge/nanosplash/actions/workflows/ci.yml) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/nanosplash) [![Coverage](https://img.shields.io/badge/Coverage-99%25-brightgreen)](./coverage/index.html) [![TypeScript](https://badges.frapsoft.com/typescript/version/typescript-next.svg?v=101)](https://github.com/ellerbrock/typescript-badges/) [![Last Commit](https://img.shields.io/github/last-commit/isakhauge/nanosplash)](https://github.com/isakhauge/nanosplash/commits/production)
 
 <br>
 
-## Get started
+> 📣 **New in 3.0.2**
+>
+> -   CSS is included inside the ES and CJS bundles 🎉
+> -   The `ns.hide` method will now delete splash screens in a FIFO sequence.
 
-Always get the latest version.
-
-```html
-<script src="https://unpkg.com/nanosplash/dist/ns.iife.js">
-```
-
-## Display loading screen
-
-Display spinning wheel only.
-
-```js
-ns.show()
-```
-
-Display with text.
-
-```js
-ns.show('Loading assets')
-```
-
-Display inside another element.
-
-```js
-ns.showInside('Loading table', '#my-table')
-```
-
-## Hide loading screen
-
-Hide the last loading screen (LIFO).
+## Usage
 
 ```js
+// Fullscreen splash screen
+ns.show('Loading')
 ns.hide()
-```
 
-Hide loading screen inside another element.
-
-```js
-ns.hideInside('#my-table')
+// Splash screen inside a DOM element
+ns.showInside('#my-div', 'Loading')
+ns.hide()
 ```
 
-Hide all loading screens.
+## Documentation
 
-```js
-ns.hideAll()
-```
+[isakhauge.github.io/nanosplash/](https://isakhauge.github.io/nanosplash/)