Merge pull request #9 from joeyfigaro/typescript-support

#8 – initial TS support + release workflow

.github/workflows/release.yml

@@ -0,0 +1,45 @@
+name: 'Create Release'
+
+on:
+  push: 
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:       
+  build_typings:
+    name: generate declarations
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@main
+
+      - uses: actions/setup-node@v4
+        name: setup node
+        id: cache
+
+      - name: install dependencies
+        run: npm install
+
+      - name: create declarations
+        continue-on-error: false
+        run: npm run build:types
+
+  # publish: 
+  #   name: publish new release
+  #   runs-on: ubuntu-latest
+  #   needs: typecheck
+  #   steps:
+  #     - uses: actions/checkout@main
+
+  #     - uses: actions/setup-node@v4
+  #       name: setup node
+  #       id: cache
+
+  #     - name: install dependencies
+  #       run: npm install
+
+  #     - name: publish to npm
+  #       run: npm publish

.gitignore

@@ -0,0 +1 @@
+dist/

package.json

@@ -4,12 +4,22 @@
   "description": "Unlock custom brushes, natural fill effects and intuitive hatching in p5.js",
   "main": "p5.brush.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build:types": "tsc --project tsconfig.build.json"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/acamposuribe/p5.brush.git"
   },
+  "typings": "dist/p5.brush.d.ts",
+  "exports": {
+    ".": {
+      "import": "./p5.brush.js",
+      "require": "./p5.brush.js",
+      "types": "./dist/p5.brush.d.ts"
+    },
+    "./minified": "./p5.brush.min.js"
+  },
   "keywords": [
     "brush",
     "children",
@@ -26,5 +36,9 @@
   "bugs": {
     "url": "https://github.com/acamposuribe/p5.brush/issues"
   },
-  "homepage": "https://p5-brush.cargo.site/"
+  "homepage": "https://p5-brush.cargo.site/",
+  "devDependencies": {
+    "@types/p5": "^1.7.3",
+    "typescript": "^5.3.2"
+  }
 }

tsconfig.build.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": true,
+    "outDir": "dist",
+    "types": ["p5"]
+  },
+  "files": ["p5.brush.js"],
+}