feat!: upgrade to @rbxts/react (#9)

* refactor: migrate to react-ts

* build: set up for publish

* fix: support new react binding impl

* fix: add default project file

* fix: change path to out

* fix: rename to pretty-react-hooks

* v0.1.2

* build: accept any `react-ts` version

* v0.1.3

* ci: use yarn

* build: accept any roact version

* v0.1.4

* refactor: use ReactRoblox & StrictMode in hoarcekat

* v0.2.0

* chore: bump version number

* 0.3.0

* fix: add react-roblox to peer deps

* v0.3.1

* fix: silence react dev warning

* v0.3.2

* chore: merge v3.2.1 from upstream to react (#7)

* 3.2.0

* fix: `as const` not required in `joinAnyBindings`

* 3.2.1

* v0.3.3

* feat!: upgrade to @rbxts/react

* fix(ci): install dependencies

* v0.4.0-alpha.0

* v0.4.0

* build: migrate to pnpm

* 0.4.1

Author: littensy

.eslintrc

@@ -7,21 +7,17 @@
 		"sourceType": "module",
 		"project": "./tsconfig.json"
 	},
-	"ignorePatterns": [
-		"/out"
-	],
-	"plugins": [
-		"@typescript-eslint",
-		"roblox-ts",
-		"prettier"
-	],
+	"ignorePatterns": ["/out"],
+	"plugins": ["@typescript-eslint", "roblox-ts", "prettier"],
 	"extends": [
 		"eslint:recommended",
 		"plugin:@typescript-eslint/recommended",
 		"plugin:roblox-ts/recommended",
 		"plugin:prettier/recommended"
 	],
 	"rules": {
-		"prettier/prettier": "warn"
+		"prettier/prettier": "warn",
+		"@typescript-eslint/no-explicit-any": "off",
+		"@typescript-eslint/no-unused-vars": "warn"
 	}
-}
+}

.github/workflows/ci.yml

@@ -14,14 +14,13 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - name: GitHub Checkout
-        uses: actions/checkout@v3
-
-      - name: Setup PNPM
-        uses: pnpm/action-setup@v2.2.4
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v3
         with:
-          version: 8.6.1
-          run_install: true
+          version: 8.15.3
+
+      - name: Install Dependencies
+        run: pnpm install
 
       - name: Run ESLint
         run: pnpm eslint src

.gitignore

@@ -3,3 +3,4 @@
 /include
 *.tsbuildinfo
 .DS_Store
+yarn-error.log

.npmignore

@@ -0,0 +1 @@
+node-linker=hoisted

.npmrc

@@ -3,4 +3,4 @@
 	"tabWidth": 4,
 	"trailingComma": "all",
 	"useTabs": true
-}
+}

.prettierrc

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023-present Richard
+Copyright (c) 2024 Littensy
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

LICENSE.md

@@ -1,13 +1,13 @@
-## 🌺 [pretty-roact-hooks](https://npmjs.com/package/@rbxts/pretty-roact-hooks)
+## 🌺 [pretty-react-hooks](https://npmjs.com/package/@rbxts/pretty-react-hooks)
 
-![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/littensy/pretty-roact-hooks/ci.yml?branch=master&style=for-the-badge&logo=github)
-[![npm version](https://img.shields.io/npm/v/@rbxts/pretty-roact-hooks.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@rbxts/pretty-roact-hooks)
-[![npm downloads](https://img.shields.io/npm/dt/@rbxts/pretty-roact-hooks.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@rbxts/pretty-roact-hooks)
-[![GitHub license](https://img.shields.io/github/license/littensy/pretty-roact-hooks?style=for-the-badge)](LICENSE.md)
+![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/littensy/pretty-react-hooks/ci.yml?branch=master&style=for-the-badge&logo=github)
+[![npm version](https://img.shields.io/npm/v/@rbxts/pretty-react-hooks.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@rbxts/pretty-react-hooks)
+[![npm downloads](https://img.shields.io/npm/dt/@rbxts/pretty-react-hooks.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@rbxts/pretty-react-hooks)
+[![GitHub license](https://img.shields.io/github/license/littensy/pretty-react-hooks?style=for-the-badge)](LICENSE.md)
 
-An opinionated collection of useful hooks and utilites for Roblox-TS and [Roact Hooked](https://github.com/littensy/rbxts-roact-hooked/).
+An opinionated collection of useful hooks and utilites for Roblox-TS and [React TS](https://github.com/littensy/rbxts-react).
 
-Every hook has documentation and tests. If you find a bug or have a feature request, please [open an issue](https://github.com/littensy/pretty-roact-hooks/issues/new/).
+If you find a bug or have a feature request, please [open an issue](https://github.com/littensy/pretty-react-hooks/issues/new/).
 
  
 
@@ -21,8 +21,7 @@ Check out some featured hooks:
 
 This package also exports some useful utilities:
 
--   [🧪 `renderHook`](src/utils/testez.tsx) - Render a hook in a test environment
--   [📕 `hoarcekat`](src/utils/hoarcekat.tsx) - Create a Hoarcekat story with hook detection
+-   [📕 `hoarcekat`](src/utils/hoarcekat.tsx) - Create a Hoarcekat story
 -   [📦 `binding utils`](src/utils/binding.ts) - Work with values that may or may not be bindings
 
 Or, see the [full list of hooks](src/).
@@ -31,16 +30,12 @@ Or, see the [full list of hooks](src/).
 
 ## 📦 Installation
 
-This package is available for Roblox TypeScript projects on [NPM](https://www.npmjs.com/package/@rbxts/pretty-roact-hooks).
+This package is available for Roblox TypeScript projects on [NPM](https://www.npmjs.com/package/@rbxts/pretty-react-hooks).
 
 ```sh
-npm install @rbxts/pretty-roact-hooks @rbxts/flipper @rbxts/roact-hooked
-```
-
-or
-
-```sh
-pnpm add @rbxts/pretty-roact-hooks @rbxts/flipper @rbxts/roact-hooked
+npm install @rbxts/pretty-react-hooks
+yarn add @rbxts/pretty-react-hooks
+pnpm add @rbxts/pretty-react-hooks
 ```
 
  
@@ -49,10 +44,10 @@ pnpm add @rbxts/pretty-roact-hooks @rbxts/flipper @rbxts/roact-hooked
 
 Contributions are welcome! Note that if you make a change to a hook, you should also check the tests and documentation.
 
-To get started, clone the repository and run `npm install` or `pnpm install`. Then, you can run the following commands:
+To get started, clone the repository and run `pnpm install`. Then, you can run the following commands:
 
--   `pnpm dev` - Enable watch mode with the `game` project type
--   `pnpm build` - Build the package
+-   `pnpm dev` - Enable watch mode with support for TestEZ Companion
+-   `pnpm build` - Compile the package's `out` directory
 
 You will likely need the following extensions:
 
@@ -63,4 +58,4 @@ You will likely need the following extensions:
 
 ## 📝 License
 
-pretty-roact-hooks is licensed under the [MIT License](LICENSE.md).
+pretty-react-hooks is licensed under the [MIT License](LICENSE.md).

README.md

@@ -3,5 +3,5 @@
 
 # To add a new tool, add an entry to this table.
 [tools]
-rojo = "rojo-rbx/rojo@7.3.0"
+rojo = "rojo-rbx/rojo@7.4.0"
 # rojo = "rojo-rbx/rojo@6.2.0"

aftman.toml

@@ -0,0 +1,6 @@
+{
+	"name": "pretty-react-hooks",
+	"tree": {
+		"$path": "out/"
+	}
+}