Implementation Review PR

.github/workflows/main.yml

@@ -0,0 +1,26 @@
+name: Build and Deploy
+on: [push]
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: pnpm/[email protected]
+        with:
+          version: 6.32.x
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          cache: 'pnpm'
+      - run: pnpm install
+      - name: Lint 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
+        run: pnpm run lint
+
+      - name: Docs 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
+        run: pnpm run docs
+
+      - name: Deploy 🚀
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages # The branch the action should deploy to.
+          folder: docs # The folder the action should deploy.

.gitignore

@@ -8,6 +8,8 @@ coverage
 
 # misc
 .DS_Store
+dist
+docs
 
 # debug
 npm-debug.log*

package.json

@@ -1,27 +1,84 @@
 {
-  "name": "ucan.storage",
+  "name": "ucan-storage",
   "version": "1.0.0",
   "main": "src/index.js",
+  "types": "dist/src/index.d.ts",
+  "typedocMain": "dist/src/index.js",
   "type": "module",
   "license": "MIT",
-  "devDependencies": {
-    "eslint-config-prettier": "^8.3.0",
-    "typescript": "^4.5.5",
-    "eslint": "^8.7.0",
-    "eslint-config-ipfs": "^2.1.0",
-    "ucans": "^0.9.0-alpha3"
+  "bin": {
+    "ucan-storage": "./src/cli.js"
+  },
+  "exports": {
+    ".": "./src/index.js",
+    "./package.json": "./package.json",
+    "./keypair": "./src/keypair.js",
+    "./types": "./src/types.ts",
+    "./did": "./src/did.js",
+    "./service": "./src/service.js",
+    "./ucan-storage": "./src/ucan-storage.js"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "dist/src/*"
+      ],
+      "types": [
+        "src/types.ts"
+      ]
+    }
+  },
+  "scripts": {
+    "format": "prettier --write '**/*.{js,ts,md,yml,json}' --ignore-path .gitignore",
+    "format:check": "prettier --check '**/*.{js,ts,md,yml,json}' --ignore-path .gitignore",
+    "clean": "rm -rf node_modules yarn.lock dist pnpm-lock.yaml",
+    "docs": "pnpm run lint && typedoc src/ucan-storage.js src/keypair.js --out docs",
+    "lint": "eslint '**/*.{js,ts,.d.ts}' && pnpm run format:check && tsc",
+    "test": "uvu tests",
+    "test:watch": "watchlist src tests -- yarn test"
   },
+  "files": [
+    "src",
+    "dist/src/*.d.ts",
+    "dist/src/*.d.ts.map"
+  ],
   "dependencies": {
     "@noble/ed25519": "^1.5.2",
-    "uint8arrays": "^3.0.0"
+    "base-x": "^4.0.0",
+    "sade": "^1.8.1"
+  },
+  "devDependencies": {
+    "@types/node": "^17.0.21",
+    "hd-scripts": "^1.1.0",
+    "lint-staged": "^12.3.4",
+    "prettier": "2.5.1",
+    "simple-git-hooks": "^2.7.0",
+    "typedoc": "^0.22.11",
+    "typedoc-plugin-missing-exports": "^0.22.6",
+    "typescript": "4.5.5",
+    "uvu": "^0.5.3",
+    "watchlist": "^0.3.1"
+  },
+  "engines": {
+    "node": ">= 16.0.0"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "npx lint-staged"
+  },
+  "lint-staged": {
+    "*.{js,ts,d.ts,md,yml,json}": "prettier --write",
+    "*.js": "eslint --fix"
   },
   "eslintConfig": {
     "extends": [
-      "ipfs",
-      "prettier"
-    ],
-    "parserOptions": {
-      "sourceType": "module"
-    }
-  }
+      "./node_modules/hd-scripts/eslint/index.js"
+    ]
+  },
+  "prettier": "./node_modules/hd-scripts/prettier.config.js",
+  "eslintIgnore": [
+    "node_modules",
+    "coverage",
+    "dist",
+    "docs"
+  ]
 }