simonrelet / react-pure-html-component-loader Goto Github PK

First of all, thanks for the amazing plugin.

Issue:
When I first started using this I came across the npm page first: https://www.npmjs.com/package/html-to-react-loader
It is super great that you updated the package after afterwards and that it redirects to this package, but I still wasted some time basing my code of the npm documentation which set me back a hour or two. I almost gave up before I decided to checkout the github link.

I think it would be a good idea to mitigate the issue for easier adoption.

Regards,
Fanus

Theses are the rules that need to be added before the release of v1.0.0:

Imports

• Imports cannot be nested in components
• Component imports nesting is allowed for named component imports
• Imports have valid relation types
• Component imports have valid attributes
• Style imports have valid attributes
• Style imports cannot be nested

Components

• Cannot have multiple default components
• Components cannot be nested
• Components have valid attributes
• Components cannot have multiple children

Controls

• Loops and conditionals cannot be merged on the same element
• Loops cannot have multiple children
• Loops have valid attributes
• Conditionals cannot have multiple children

Globals

• Root element types are limited
• Ids must be unique

Is this inspired from vue templates syntax?
If yes, maybe you can put in your README file. So it's more describable.