chore(format): apply prettier's new rules

Author: SMAKSS

CODE_OF_CONDUCT.md

@@ -2,55 +2,85 @@
 
 ## 1. Purpose
 
-A primary goal of @smakss/react-scroll-direction is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe, and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).
+A primary goal of @smakss/react-scroll-direction is to be inclusive to the
+largest number of contributors, with the most varied and diverse backgrounds
+possible. As such, we are committed to providing a friendly, safe, and welcoming
+environment for all, regardless of gender, sexual orientation, ability,
+ethnicity, socioeconomic status, and religion (or lack thereof).
 
-This Code of Conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior.
+This Code of Conduct outlines our expectations for all those who participate in
+our community, as well as the consequences for unacceptable behavior.
 
 ## 2. Open [Source/Culture/Tech] Citizenship
 
-A supplemental goal of this Code of Conduct is to increase open [source/culture/tech] citizenship by encouraging participants to recognize and strengthen the relationships between our actions and their effects on our community.
+A supplemental goal of this Code of Conduct is to increase open
+[source/culture/tech] citizenship by encouraging participants to recognize and
+strengthen the relationships between our actions and their effects on our
+community.
 
 ## 3. Expected Behavior
 
 The following behaviors are expected and requested of all community members:
 
-- Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
+- Participate in an authentic and active way. In doing so, you contribute to the
+  health and longevity of this community.
 - Exercise consideration and respect in your speech and actions.
 - Attempt collaboration before conflict.
 - Refrain from demeaning, discriminatory, or harassing behavior and speech.
 - Be mindful of your surroundings and of your fellow participants.
-- Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
+- Alert community leaders if you notice a dangerous situation, someone in
+  distress, or violations of this Code of Conduct, even if they seem
+  inconsequential.
 
 ## 4. Unacceptable Behavior
 
-The following behaviors are considered harassment and are unacceptable within our community:
+The following behaviors are considered harassment and are unacceptable within
+our community:
 
-- Violence, threats of violence, or violent language directed against another person.
-- Sexist, racist, homophobic, transphobic, ableist, or otherwise discriminatory jokes and language.
+- Violence, threats of violence, or violent language directed against another
+  person.
+- Sexist, racist, homophobic, transphobic, ableist, or otherwise discriminatory
+  jokes and language.
 - Posting or displaying sexually explicit or violent material.
-- Posting or threatening to post other people's personally identifying information ("doxing").
-- Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
+- Posting or threatening to post other people's personally identifying
+  information ("doxing").
+- Personal insults, particularly those related to gender, sexual orientation,
+  race, religion, or disability.
 - Inappropriate photography or recording.
-- Unwelcome sexual attention. This includes, but is not limited to: inappropriate touching, groping, and unwarranted comments.
+- Unwelcome sexual attention. This includes, but is not limited to:
+  inappropriate touching, groping, and unwarranted comments.
 - Advocating for, or encouraging, any of the above behavior.
 - Stalking or following.
 
 ## 5. Consequences of Unacceptable Behavior
 
-Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated. Anyone asked to stop unacceptable behavior is expected to comply immediately.
+Unacceptable behavior from any community member, including sponsors and those
+with decision-making authority, will not be tolerated. Anyone asked to stop
+unacceptable behavior is expected to comply immediately.
 
-If a community member engages in unacceptable behavior, the community organizers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning.
+If a community member engages in unacceptable behavior, the community organizers
+may take any action they deem appropriate, up to and including a temporary ban
+or permanent expulsion from the community without warning.
 
 ## 6. Reporting Guidelines
 
-If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. @SMAKSS.
+If you are subject to or witness unacceptable behavior, or have any other
+concerns, please notify a community organizer as soon as possible. @SMAKSS.
 
-Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe.
+Additionally, community organizers are available to help community members
+engage with local law enforcement or to otherwise help those experiencing
+unacceptable behavior feel safe.
 
 ## 7. Addressing Grievances
 
-If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify the project team with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies.
+If you feel you have been falsely or unfairly accused of violating this Code of
+Conduct, you should notify the project team with a concise description of your
+grievance. Your grievance will be handled in accordance with our existing
+governing policies.
 
 ## 8. Scope
 
-We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues–online and in-person–as well as in all one-on-one communications pertaining to community business.
+We expect all community participants (contributors, paid or otherwise; sponsors;
+and other guests) to abide by this Code of Conduct in all community
+venues–online and in-person–as well as in all one-on-one communications
+pertaining to community business.

CONTRIBUTING.md

@@ -1,41 +1,55 @@
 # Contributing to @smakss/react-scroll-direction
 
-First and foremost, thank you for considering contributing to @smakss/react-scroll-direction! Your efforts help make this project better for everyone.
+First and foremost, thank you for considering contributing to
+@smakss/react-scroll-direction! Your efforts help make this project better for
+everyone.
 
 ## Getting Started
 
-- Please first discuss the change you wish to make via issue, email, or any other method with the maintainers of this repository before making a change.
-- Ensure that your contribution is in line with the project's coding and documentation standards.
+- Please first discuss the change you wish to make via issue, email, or any
+  other method with the maintainers of this repository before making a change.
+- Ensure that your contribution is in line with the project's coding and
+  documentation standards.
 
 ## Development Setup
 
-Before you start working on your contribution, you need to set up your development environment. After cloning the repository, run the following commands:
+Before you start working on your contribution, you need to set up your
+development environment. After cloning the repository, run the following
+commands:
 
 ```bash
 pnpm setup
 ```
 
-This will install all the necessary development dependencies and set up Git hooks using Husky.
+This will install all the necessary development dependencies and set up Git
+hooks using Husky.
 
 ## Pull Request Process
 
-1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
-2. Update the `README.md` or relevant documentation with details of changes, including:
-   - New environment variables
-   - New database migrations
-   - Any other relevant information
-3. Ensure your PR has a single purpose. If it addresses more than one issue or introduces more than one feature, split them into separate PRs.
-4. Describe your PR thoroughly. Explain the purpose of your PR, how you approached the problem, and include any relevant information or screenshots for context.
+1. Ensure any install or build dependencies are removed before the end of the
+   layer when doing a build.
+2. Update the `README.md` or relevant documentation with details of changes,
+   including:
+    - New environment variables
+    - New database migrations
+    - Any other relevant information
+3. Ensure your PR has a single purpose. If it addresses more than one issue or
+   introduces more than one feature, split them into separate PRs.
+4. Describe your PR thoroughly. Explain the purpose of your PR, how you
+   approached the problem, and include any relevant information or screenshots
+   for context.
 
 ## Release Process
 
-Releases are automated with semantic-release on every push to the `master` branch.
+Releases are automated with semantic-release on every push to the `master`
+branch.
 
-- Do not manually bump versions or edit the changelog; semantic-release handles both.
+- Do not manually bump versions or edit the changelog; semantic-release handles
+  both.
 - Follow Conventional Commits so the release type can be inferred.
 - The GitHub Actions workflow requires these secrets:
-  - `NPM_TOKEN` (publish to npm)
-  - `GITHUB_TOKEN` (create GitHub release)
+    - `NPM_TOKEN` (publish to npm)
+    - `GITHUB_TOKEN` (create GitHub release)
 
 To run a local dry run:
 
@@ -45,16 +59,20 @@ pnpm release --dry-run
 
 ## Coding Standards
 
-- Follow [Typescript specific conventions](https://google.github.io/styleguide/tsguide.html) and @smakss/react-scroll-direction's established coding style.
+- Follow
+  [Typescript specific conventions](https://google.github.io/styleguide/tsguide.html)
+  and @smakss/react-scroll-direction's established coding style.
 - Write tests for any new functionality.
 - Comment your code where necessary.
 
 ## Reporting Issues
 
 - Use the provided issue templates if applicable.
-- Be as descriptive as possible. Attach screenshots, logs, or any other relevant information.
+- Be as descriptive as possible. Attach screenshots, logs, or any other relevant
+  information.
 - Check existing issues before submitting a new one to avoid duplicates.
 
 ## Code of Conduct
 
-Please refer to our [Code of Conduct](CODE_OF_CONDUCT.md) to understand what kind of behavior is expected within our community.
+Please refer to our [Code of Conduct](CODE_OF_CONDUCT.md) to understand what
+kind of behavior is expected within our community.

Readme.md

@@ -1,14 +1,25 @@
 # React Scroll Direction Hook
 
-![npm](https://img.shields.io/npm/v/@smakss/react-scroll-direction) ![NPM](https://img.shields.io/npm/l/@smakss/react-scroll-direction) ![npm](https://img.shields.io/npm/dt/@smakss/react-scroll-direction) ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/min/@smakss/react-scroll-direction)
-
-`@smakss/react-scroll-direction` is a versatile, lightweight React hook that not only detects the scroll direction but also provides the scroll position in your application with ease. This enhanced functionality includes detecting distances from the top, bottom, left, and right edges of the viewport, making it an ideal solution for advanced scroll-based interactions in your React applications.
-
-Originally inspired by a [popular StackOverflow response](https://stackoverflow.com/a/62497293/11908502), this package has evolved into a comprehensive tool for managing scroll detection in React applications.
+![npm](https://img.shields.io/npm/v/@smakss/react-scroll-direction)
+![NPM](https://img.shields.io/npm/l/@smakss/react-scroll-direction)
+![npm](https://img.shields.io/npm/dt/@smakss/react-scroll-direction)
+![npm bundle size (scoped)](https://img.shields.io/bundlephobia/min/@smakss/react-scroll-direction)
+
+`@smakss/react-scroll-direction` is a versatile, lightweight React hook that not
+only detects the scroll direction but also provides the scroll position in your
+application with ease. This enhanced functionality includes detecting distances
+from the top, bottom, left, and right edges of the viewport, making it an ideal
+solution for advanced scroll-based interactions in your React applications.
+
+Originally inspired by a
+[popular StackOverflow response](https://stackoverflow.com/a/62497293/11908502),
+this package has evolved into a comprehensive tool for managing scroll detection
+in React applications.
 
 ## Demo
 
-Experience the extended capabilities of `@smakss/react-scroll-direction` on CodeSandbox:
+Experience the extended capabilities of `@smakss/react-scroll-direction` on
+CodeSandbox:
 
 [![View @smakss/search](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/react-scroll-direction-tclwvp?fontsize=14&hidenavigation=1&theme=dark)
 
@@ -29,40 +40,45 @@ Then, import it into your project:
 ES Module:
 
 ```js
-import useDetectScroll from '@smakss/react-scroll-direction';
+import useDetectScroll from '@smakss/react-scroll-direction'
 ```
 
 For TypeScript projects, import the hook and its types:
 
 ```ts
-import useDetectScroll, {
-  Axis,
-  Direction
-} from '@smakss/react-scroll-direction';
+import useDetectScroll, {Axis, Direction} from '@smakss/react-scroll-direction'
 ```
 
 ## Usage
 
-The `useDetectScroll` hook takes an options object with the following properties:
+The `useDetectScroll` hook takes an options object with the following
+properties:
 
-- `target`: The target scrollable element from which to detect scroll direction and position (default: `window`, must be an `HTMLDivElement`).
-- `thr`: Threshold for scroll direction change detection (default: `0`, accepts only positive values).
+- `target`: The target scrollable element from which to detect scroll direction
+  and position (default: `window`, must be an `HTMLDivElement`).
+- `thr`: Threshold for scroll direction change detection (default: `0`, accepts
+  only positive values).
 - `axis`: Defines the scroll axis (`"y"` or `"x"`, default: `"y"`).
-- `scrollUp`: Value returned when scrolling up (y-axis) or left (x-axis) (default: `"up"` for y-axis, `"left"` for x-axis).
-- `scrollDown`: Value returned when scrolling down (y-axis) or right (x-axis) (default: `"down"` for y-axis, `"right"` for x-axis).
-- `still`: Value returned when there's no scrolling activity (default: `"still"`).
+- `scrollUp`: Value returned when scrolling up (y-axis) or left (x-axis)
+  (default: `"up"` for y-axis, `"left"` for x-axis).
+- `scrollDown`: Value returned when scrolling down (y-axis) or right (x-axis)
+  (default: `"down"` for y-axis, `"right"` for x-axis).
+- `still`: Value returned when there's no scrolling activity (default:
+  `"still"`).
 
 The hook returns an object with two properties:
 
-- `scrollDir`: Indicates the scroll direction (`"up"`, `"down"`, `"left"`, `"right"`, or `"still"`).
-- `scrollPosition`: An object containing distances from the top, bottom, left, and right edges of the viewport.
+- `scrollDir`: Indicates the scroll direction (`"up"`, `"down"`, `"left"`,
+  `"right"`, or `"still"`).
+- `scrollPosition`: An object containing distances from the top, bottom, left,
+  and right edges of the viewport.
 
 ## Examples
 
 To detect both scroll direction and position:
 
 ```js
-const { scrollDir, scrollPosition } = useDetectScroll();
+const {scrollDir, scrollPosition} = useDetectScroll()
 
 // scrollDir: "up", "down", "left", "right", or "still"
 // scrollPosition: { top, bottom, left, right }
@@ -71,7 +87,7 @@ const { scrollDir, scrollPosition } = useDetectScroll();
 To customize for horizontal scroll:
 
 ```js
-const { scrollDir, scrollPosition } = useDetectScroll({ axis: Axis.X });
+const {scrollDir, scrollPosition} = useDetectScroll({axis: Axis.X})
 
 // scrollDir: "left", "right", or "still"
 // scrollPosition: { top, bottom, left, right }
@@ -94,8 +110,11 @@ useEffect(() => {
 
 ## Contributing
 
-Interested in making contributions to this project? Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines and details.
+Interested in making contributions to this project? Please see
+[CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines and details.
 
 ## Code of Conduct
 
-We value and prioritize the well-being of all our contributors and users. To ensure that this project remains a welcoming space for everyone, please refer to our [Code of Conduct](./CODE_OF_CONDUCT.md).
+We value and prioritize the well-being of all our contributors and users. To
+ensure that this project remains a welcoming space for everyone, please refer to
+our [Code of Conduct](./CODE_OF_CONDUCT.md).