Merge pull request #6 from SantaClaas/1-improve-typescript-interop-cr…

…eate-ts-definitions-from-jsdocjavascript-files

Improve typescript support

.github/workflows/publish.yml

@@ -42,6 +42,8 @@ jobs:
         run: pnpm run build:bundle
       - name: Test and ensure dependencies were built as expected
         run: pnpm test
+      - name: Create type definitions
+        run: pnpm create-definitions
       - name: Check if tag is release tag
         id: check-tag
         run: |

.gitignore

@@ -24,4 +24,10 @@ dist-ssr
 *.sw?
 
 # Genrated custom build
-@material/
+@material/
+
+# Generated TypeScript declarations
+*.d.ts
+
+# Generated TypeScript declaration maps
+*.d.ts.map

.npmignore

@@ -1,6 +1,7 @@
 pnpm-lock.yaml
 package-lock.json
 jsconfig.json
+tsconfig.json
 example/
 material-color-utilities/
 # Don't include custom build of material-color-utilities as it will be bundled by "bundledDependencies" in package.json

default.config.js

@@ -2,6 +2,7 @@
 
 /**
  * @type {Partial<CustomThemeConfig & { extend: Partial<CustomThemeConfig> }>}
+ * @private
  */
 const defaultConfiguration = {
   borderRadius: {

package.json

@@ -13,14 +13,15 @@
     "url": "https://github.com/SantaClaas/material-tailwind.git"
   },
   "private": false,
-  "version": "0.1.1",
+  "version": "0.2.0",
   "type": "module",
   "exports": {
     ".": "./index.js"
   },
   "scripts": {
     "build:bundle": "node ./build.js",
-    "test": "vitest"
+    "test": "vitest",
+    "create-definitions": "tsc"
   },
   "dependencies": {
     "@material/material-color-utilities": "./@material/material-color-utilities",
@@ -30,6 +31,8 @@
     "@material/material-color-utilities"
   ],
   "devDependencies": {
+    "typescript": "^5.4.5",
     "vitest": "^1.5.0"
-  }
+  },
+  "types": "./index.d.ts"
 }

tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "exclude": [
+    "@material",
+    "example",
+    "node_modules",
+    "material-color-utilities"
+  ],
+  "include": ["index.js"],
+  "compilerOptions": {
+    "checkJs": true,
+    "allowJs": true,
+    "strict": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "declarationMap": true,
+    "esModuleInterop": true
+  }
+}