Merge pull request #10 from rossipedia/feat/repo-improvements

chore: repository improvements

.eslintrc.cjs

@@ -1,16 +1,23 @@
 module.exports = {
   env: { browser: true, es2020: true },
+  ignorePatterns: [
+    "node_modules",
+    "dist",
+    "src/remix-app-for-testing",
+    ".eslintrc.cjs",
+    "tailwind.config.js",
+  ],
   extends: [
     "eslint:recommended",
     "plugin:@typescript-eslint/recommended",
     "plugin:react-hooks/recommended",
   ],
   parser: "@typescript-eslint/parser",
   parserOptions: { ecmaVersion: "latest", sourceType: "module" },
-  plugins: ["react-refresh"],
+  plugins: ["@typescript-eslint"],
   rules: {
-    "react-refresh/only-export-components": "warn",
     "@typescript-eslint/no-non-null-assertion": "off",
     "@typescript-eslint/ban-ts-comment": "off",
+    "@typescript-eslint/no-explicit-any": "off",
   },
 };

.prettierignore

@@ -0,0 +1 @@
+src/remix-app-for-testing

.prettierrc

@@ -0,0 +1,8 @@
+{
+  "plugins": ["prettier-plugin-tailwindcss"],
+  "tabWidth": 2,
+  "useTabs": false,
+  "singleQuote": false,
+  "trailingComma": "es5",
+  "semi": true
+}

CODE_OF_CONDUCT.md

@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
+- Focusing on what is best not just for us as individuals, but for the
   overall community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
+- The use of sexualized language or imagery, and sexual attention or
   advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
   address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within
@@ -125,4 +125,4 @@ enforcement ladder](https://github.com/mozilla/diversity).
 
 For answers to common questions about this code of conduct, see the FAQ at
 https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
+https://www.contributor-covenant.org/translations.

README.md

@@ -33,8 +33,8 @@ To install and utilize Remix Development Tools, follow these steps:
 
 ```bash
 npm install remix-development-tools
-``` 
- 
+```
+
 2. Add the following to your application `root.tsx` file:
 
 ```diff
@@ -72,6 +72,7 @@ export default function App() {
 ## RemixDevTools props
 
 The `RemixDevTools` component accepts the following props:
+
 - `port`: The port number to use for the Remix Development Tools connection to Remix Forge. If you want to change the port and connect to your Remix Forge VS code extension you need to change the port in VS Code too. Defaults to `3003`.
 - `defaultOpen`: Whether to open the Remix Development Tools by default. Defaults to `false`.
 
@@ -81,11 +82,11 @@ Contributions to Remix Development Tools are welcome! To contribute, please foll
 
 1. Fork the repository and clone it locally.
 2. Create a new branch for your feature or bug fix.
-3. Run `npm run setup` to get your development environment set up.
+3. Run `npm install` to get your development environment set up.
 4. Run `npm run dev` to start the development server.
-3. Implement your changes, adhering to the existing code style and best practices. 
-5. Commit and push your changes to your forked repository.
-6. Open a pull request, providing a clear description of your changes and their purpose.
+5. Implement your changes, adhering to the existing code style and best practices.
+6. Commit and push your changes to your forked repository.
+7. Open a pull request, providing a clear description of your changes and their purpose.
 
 ## Support
 
@@ -101,4 +102,4 @@ Remix Development Tools was inspired by the Remix framework and aims to enhance
 
 ---
 
-Feel free to explore Remix Development Tools, and we hope it significantly improves your Remix development process. If you encounter any issues or have suggestions for enhancements, please don't hesitate to open an issue on our GitHub repository. Happy Remixing!
+Feel free to explore Remix Development Tools, and we hope it significantly improves your Remix development process. If you encounter any issues or have suggestions for enhancements, please don't hesitate to open an issue on our GitHub repository. Happy Remixing!