chor: add test and typescript types

Author: claudemyburgh

.github/workflows/test.yaml

@@ -0,0 +1,35 @@
+name: 'Test'
+on:
+  push:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [ 18 ]
+
+    permissions:
+      # Required to check out the code
+      contents: read
+      # Required to put a comment into the pull-request
+      pull-requests: write
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 7
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
+      - name: 'Install Deps'
+        run: pnpm install --frozen-lockfile
+      - name: 'Test'
+        run: npx vitest
+      #      - name: 'Test coverage'
+      #        run: npx vitest --coverage
+      - name: 'Report Coverage'
+        if: always() # Also generate the report if tests are failing
+        uses: davelosert/vitest-coverage-report-action@v2

dist/utils/generateShadows.d.ts dist/generateShadows.d.tsdist/utils/generateShadows.d.ts renamed to dist/generateShadows.d.ts

@@ -23,7 +23,7 @@
     "designbycode"
   ],
   "type": "module",
-  "types": "dist",
+  "types": "dist/",
   "main": "./dist/index.umd.cjs",
   "exports": {
     ".": {
@@ -33,19 +33,18 @@
   },
   "module": "./dist/index.js",
   "files": [
-    "dist",
-    "utils"
+    "dist"
   ],
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "build": "tsc && vite build",
+    "build": "tsc --declaration && vite build",
     "clean": "rd /s /q dist .cache>nul 2>&1|echo.>nul",
     "dev": "pnpm build --watch",
-    "postbuild": "tsc --emitDeclarationOnly",
     "prepublishOnly": "pnpm build",
-    "release": "release-it"
+    "release": "release-it",
+    "test": "vitest --coverage"
   },
   "lint-staged": {
     "src/**/*.ts": [
@@ -79,6 +78,7 @@
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^9.0.4",
     "@types/node": "^20.4.10",
+    "@vitest/coverage-v8": "^0.34.1",
     "autoprefixer": "^10.4.14",
     "husky": "^8.0.3",
     "postcss": "^8.4.27",

dist/index.cjs

@@ -1,7 +1,7 @@
 import { comment } from "postcss"
-import { version as packageVersion } from "../package.json"
-import generateShadows from "../utils/generateShadows.ts"
+import generateShadows from "./generateShadows"
 
+const version = require("../package.json")
 const plugin = require("tailwindcss/plugin")
 const { default: flattenColorPalette } = require("tailwindcss/lib/util/flattenColorPalette")
 
@@ -22,7 +22,7 @@ module.exports = plugin.withOptions(
     return function ({ addBase, addComponents, matchUtilities, matchComponents, theme }: any): void {
       addBase([
         comment({
-          text: `!  tailwindcss-text-shadow v${packageVersion} | MIT License | https://designbycode.co.za`,
+          text: `!  tailwindcss-text-shadow v${version} | MIT License | https://designbycode.co.za`,
         }),
       ])
 

dist/src/index.d.ts dist/index.d.tsdist/src/index.d.ts renamed to dist/index.d.ts

@@ -0,0 +1,25 @@
+import {describe, it, expect} from "vitest";
+import generateShadows from "../src/generateShadows";
+
+
+describe('# Generate shadow', () => {
+
+  const singleLine = `calc(var(--ts-text-shadow-x) * 0) calc(var(--ts-text-shadow-y) * 0) var(--ts-text-shadow-blur) var(--ts-text-shadow-color)`
+
+  const doubleLine = `calc(var(--ts-text-shadow-x) * 0) calc(var(--ts-text-shadow-y) * 0) var(--ts-text-shadow-blur) var(--ts-text-shadow-color),calc(var(--ts-text-shadow-x) * 1) calc(var(--ts-text-shadow-y) * 1) var(--ts-text-shadow-blur) var(--ts-text-shadow-color)`
+
+  const tenSteps = `calc(var(--ts-text-shadow-x) * 0) calc(var(--ts-text-shadow-y) * 0) var(--ts-text-shadow-blur) var(--ts-text-shadow-color),calc(var(--ts-text-shadow-x) * 1) calc(var(--ts-text-shadow-y) * 1) var(--ts-text-shadow-blur) var(--ts-text-shadow-color),calc(var(--ts-text-shadow-x) * 2) calc(var(--ts-text-shadow-y) * 2) var(--ts-text-shadow-blur) var(--ts-text-shadow-color),calc(var(--ts-text-shadow-x) * 3) calc(var(--ts-text-shadow-y) * 3) var(--ts-text-shadow-blur) var(--ts-text-shadow-color),calc(var(--ts-text-shadow-x) * 4) calc(var(--ts-text-shadow-y) * 4) var(--ts-text-shadow-blur) var(--ts-text-shadow-color),calc(var(--ts-text-shadow-x) * 5) calc(var(--ts-text-shadow-y) * 5) var(--ts-text-shadow-blur) var(--ts-text-shadow-color),calc(var(--ts-text-shadow-x) * 6) calc(var(--ts-text-shadow-y) * 6) var(--ts-text-shadow-blur) var(--ts-text-shadow-color),calc(var(--ts-text-shadow-x) * 7) calc(var(--ts-text-shadow-y) * 7) var(--ts-text-shadow-blur) var(--ts-text-shadow-color),calc(var(--ts-text-shadow-x) * 8) calc(var(--ts-text-shadow-y) * 8) var(--ts-text-shadow-blur) var(--ts-text-shadow-color),calc(var(--ts-text-shadow-x) * 9) calc(var(--ts-text-shadow-y) * 9) var(--ts-text-shadow-blur) var(--ts-text-shadow-color)`
+
+  it("should be 1 shadow line", () => {
+    expect(generateShadows(1)).toEqual(singleLine)
+  });
+
+  it("should be 2 shadow line", () => {
+    expect(generateShadows(2)).toEqual(doubleLine)
+  });
+
+  it("should be 10 shadow line", () => {
+    expect(generateShadows(10)).toEqual(tenSteps)
+  });
+
+})