Skip to content

Commit

Permalink
Merging v0.5.0 into the main branch (#216)
Browse files Browse the repository at this point in the history
* chore: update readme for new branch changes (#151)

* chore: update all packages within docs (#205)

* chore: update global root workspace packages (#206)

* chore: update prettier sort plugin

* chore: update prettier sort plugin and husky pre-push commit

* Chore/update packages 07 may 24 hooks package (#207)

* feat: bump testing library and typescript to latest

* feat: update typescript eslint parser and plugin to latest

* chore: update linters for react hooks packages

* feat: useStateWithHistory (#208)

* feat: add redo, undo, set for the state with history hook

* feat: addition of the reset action on state with history

* feat: docs and demo example addition for the useStateWithHistory

* feat: Addition of changeset

* feat: useUndoState (#209)

* feat: useUndoState hook added as an re-export of useStateWithHistory

* feat: add docs for the useUndoState hook

* feat: add missing reset action from useUndoState hook

* chore: add changeset logs

* chore: add missing assertion expectation assertion

* feat: useDebounce (#210)

* feat: addition of use debounce hook

* feat: throws error when wait period is negative

* feat: addition of the useDebounce function docs

* chore: addition of the changeset logs

* Feat/useThrottle (#211)

* feat: addition of the useThrottle hook

* feat: addition of docs for the useThrottle hook

* chore: create the changeset chagelog

* Feat/release 0.5.0 (#212)

* feat: update readme for the hook packages with new hooks addition

* feat: version the package for v0.5.0
  • Loading branch information
abhushanaj committed May 11, 2024
1 parent 806a37a commit 75aaf4c
Show file tree
Hide file tree
Showing 34 changed files with 2,640 additions and 1,237 deletions.
2 changes: 1 addition & 1 deletion .husky/pre-push
Original file line number Diff line number Diff line change
@@ -1 +1 @@
pnpm lint:check
pnpm lint:check && pnpm test:check
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,12 @@ Visit [react-hooks.abhushan.dev](https://react-hooks.abhushan.dev/) for more inf

1. [useStack](https://react-hooks.abhushan.dev/hooks/state/usestack/): Manage a stack of items.

1. [useStateWithHistory](https://react-hooks.abhushan.dev/hooks/state/usestack/): Manage a state value with it's entire history of updates.

1. [useToggle](https://react-hooks.abhushan.dev/hooks/state/usetoggle/): Toogle a boolean value.

1. [useUndoState](https://react-hooks.abhushan.dev/hooks/state/usestack/): Manage a state value with ability to undo an update

### User Interface (UI)

1. [useEventListenerOnRef](https://react-hooks.abhushan.dev/hooks/ui/useeventlisteneronref/): Adds an event listener to a element through the ref object.
Expand Down Expand Up @@ -139,6 +143,8 @@ Visit [react-hooks.abhushan.dev](https://react-hooks.abhushan.dev/) for more inf

## Utilities

1. [useDebounce](https://react-hooks.abhushan.dev/hooks/utilities/usewasssr/): Debounce a callback function over a wait (ms) period.

1. [useDebouncedValue](https://react-hooks.abhushan.dev/hooks/utilities/usedebouncedvalue/): Delay execution of a state update until a defined time period.

1. [useFreshCallback](https://react-hooks.abhushan.dev/hooks/utilities/usefreshcallback/): Returns the latest and fresh callback function.
Expand All @@ -153,6 +159,8 @@ Visit [react-hooks.abhushan.dev](https://react-hooks.abhushan.dev/) for more inf

1. [useSampleCallback](https://react-hooks.abhushan.dev/hooks/utilities/usesamplecallback/): Limits the invocation of a callback to every period samples.

1. [useThrottle](https://react-hooks.abhushan.dev/hooks/utilities/usewasssr/): Throttle a callback function over a duration(ms) period.

1. [useWasSSR](https://react-hooks.abhushan.dev/hooks/utilities/usewasssr/): Indicates whether the component was SSR'ed or not.

## Project Structure
Expand All @@ -162,7 +170,7 @@ The project is a monorepo setup created from the `create-turbo` CLI starter cont
1. `www`: the documentation site for the `@abhushanaj/react-hooks`.
2. `react-hooks`: the actual npm package for `@abhushanaj/react-hooks` which is shipped to npm registry.

## Versoning using changeset
## Versioning using changeset

The versioning for the `@abhushanaj/react-hooks` is managed using changeset CLI and adheres to semver at all times.

Expand All @@ -178,6 +186,6 @@ Learn more about changesets from [official repo](https://github.com/changesets/c
## Developing Locally

The active branch for development is `main` until a major version is released. All changes to the project are merged to this branch.
The active branch for development is `develop`. All changes to the project are merged to this branch.

You can follow the respective readme file for both workspaces to learn more about working with each project.
The latest release branch is `main`. All new releases are triggered from this branch and tagged.
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@
},
"devDependencies": {
"@changesets/cli": "^2.27.1",
"@ianvs/prettier-plugin-sort-imports": "^4.1.1",
"@ianvs/prettier-plugin-sort-imports": "^4.2.1",
"husky": "^9.0.11",
"prettier": "^3.2.5",
"prettier-plugin-astro": "^0.13.0",
"prettier-plugin-tailwindcss": "^0.5.11",
"rimraf": "^5.0.5",
"turbo": "latest"
"turbo": "^1.13.3"
},
"packageManager": "[email protected]",
"engines": {
Expand Down
Loading

0 comments on commit 75aaf4c

Please sign in to comment.