@jphil/bookwhen-client 0.0.4 → 0.0.8

package/README.md

@@ -34,6 +34,8 @@ pnpm add @jphil/bookwhen-client
 
 ## Usage
 
+\[wip\]!
+
 ```typescript
 // ... todo
 ```
@@ -46,13 +48,22 @@ Required configuration options:
 
 API requests to the Bookwhen API are authenticated using Basic Authentication with the API Key as the username and a blank password.
 
-API keys can be generated in the [https://YOUR-ACCOUNT-NAME.bookwhen.com/settings/api_access_permission_sets](API tokens setup area of your Bookwhen account).
+API keys can be generated in the [API tokens setup area of your Bookwhen account](https://YOUR-ACCOUNT-NAME.bookwhen.com/settings/api_access_permission_sets).
 
 ## Contributing
 
-Contributions are welcome! (proper guidelines to be written)
+### How to Contribute
+
+Thank you for your interest in contributing! 
+
+This library follows the standard Github Flow contribution workflow, have a read of the guide to [Github Flow](https://docs.github.com/en/get-started/using-github/github-flow#following-github-flow) from the Github docs, if you're not familiar.
 
-### Setting Up Husky for Contributions
+### Contribution Requirements
+
+- Use the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) style when writing your commit messages.
+- Ensure you create a [changeset](https://github.com/changesets/changesets) as the final commit before creating a new PR (or updating one).
+
+#### Setting Up Husky for Contributions
 
 This project uses Husky for Git hooks and Commitlint to enforce commit message standards.
 
@@ -74,6 +85,33 @@ This command sets up a .husky/ directory in the project, linking the necessary s
 
 Thank you for helping maintain commit quality and consistency!
 
+\[wip\]!
+
+## CI 
+
+>>> consider changesets in the following?
+
+### Contrib flow
+
+- Contrib user clones repo locally
+- Contrib user creates a feature branch
+- Contrib user generates commits to feature branch
+- Contrib user create a PR back to the origin/[default branch]
+- CI pipeline activates and runs at least tests && build
+-> On success PR can be merged to main by Maintainer
+-> On fail PR needs updating until tests and build success 
+
+
+### Maintainer flow
+
+- Maintainer decides that code on main is ready to release
+- Mt pulls main
+- Mt checks out new "release" branch
+- Mt runs: pnpm changeset add
+- Mt commits results when happy with the change set
+- Mt run changeset version 
+[WIP]
+
 ## Roadmap
 
 - Keep up with any future changes or additions to the [Bookwhen API](https://api.bookwhen.com/v2).
@@ -82,6 +120,3 @@ Thank you for helping maintain commit quality and consistency!
 
 ISC License. See [LICENSE](LICENSE) for more information.
 
-## Notice
-
-This software is "unofficial" - its development is not affiliated with or funded by Bookwhen.

package/dist/index.d.ts

@@ -1,3 +1 @@
-declare const test: () => void;
-
-export { test };
+export declare const test: () => void;

package/dist/index.js

@@ -1,7 +1,4 @@
-// src/index.ts
-var test = () => {
-  console.log("hello test");
-};
-export {
-  test
+export const test = () => {
+    console.log('hello test');
 };
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@jphil/bookwhen-client",
-  "version": "0.0.4",
+  "version": "0.0.8",
   "description": "",
   "private": false,
-  "main": "/dist/index.js",
-  "module": "/dist/index.mjs",
-  "types": "/dist/index.d.ts",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
   "keywords": [
     "bookwhen",
     "booking",
@@ -55,16 +55,18 @@
   },
   "scripts": {
     "dev": "vitest",
-    "build": "tsup src/index.ts --format esm --dts",
+    "build": "tsc",
     "lint": "tsc",
     "test": "vitest run",
-    "ci": "pnpm lint && pnpm test && pnpm build",
-    "release": "pnpm lint && pnpm test && pnpm build && changeset publish",
-    "commit": "cz",
     "type-check": "tsc --noEmit",
+    "check-exports": "attw --pack . --ignore-rules=cjs-resolves-to-esm",
+    "prettier-check": "prettier --check 'src/**/*.ts'",
+    "format": "prettier --write 'src/**/*.ts' README.md",
     "pre-commit": "pnpm lint && pnpm build",
+    "commit": "cz",
     "prepush": "pnpm test",
-    "prettier": "prettier --check 'src/**/*.ts'",
-    "format": "prettier --write 'src/**/*.ts' README.md"
+    "local-release": "changeset version && changeset publish",
+    "release": "pnpm lint && pnpm test && pnpm build && changeset publish",
+    "ci": "pnpm test && pnpm check-exports && pnpm build"
   }
 }