Fix TS import & document limitations [publish]

Author: ArnaudBarre

README.md

@@ -2,7 +2,20 @@
 
 Validate that your components can safely be updated with fast refresh.
 
-⚠️ To avoid false positive, this plugin is only applied on `tsx` & `jsx` files.
+## Limitations
+
+⚠️ To avoid false positive, this plugin is only applied on `tsx` & `jsx` files ⚠️
+
+Like the implementation for [vite](https://github.com/vitejs/vite/blob/e6495f0a52c9bd2cae166934dc965f8955ce035d/packages/plugin-react/src/fast-refresh.ts#L108), the plugin rely on naming conventions (i.e. use ). This is why there is some limitations:
+
+- `export *` are not supported and will be reported as an error
+- anonymous function are not supported (i.e `export default function() {}`)
+- Full uppercase export would be considered as an error. It can be disabled locally when it's effectively a React component:
+
+```jsx
+// eslint-disable-next-line react-refresh/eslint-plugin-react-refresh
+export const CMS = () => <></>;
+```
 
 ## Installation
 

package.json

@@ -1,10 +1,11 @@
 {
   "name": "eslint-plugin-react-refresh",
   "description": "Validate that your components can safely be updated with fast refresh",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "license": "MIT",
   "author": "Arnaud Barré (https://github.com/ArnaudBarre)",
   "main": "src/index.js",
+  "repository": "github:ArnaudBarre/eslint-plugin-react-refresh",
   "keywords": [
     "eslint",
     "eslint-plugin",

src/index.ts

@@ -1,3 +1,3 @@
 export const rules = {
-  "only-export-components": require("./only-export-components.ts").rule,
+  "only-export-components": require("./only-export-components").rule,
 };