zaach / jsxgettext

Extract gettext calls from JavaScript, EJS, and other template formats.
Mozilla Public License 2.0
105 stars 56 forks source link

Document .parse() and .generate() #103

Open andrewcharnley opened 8 years ago

andrewcharnley commented 8 years ago

On the readme, since these are going to be used by anyone not running the node script directly.

BYK commented 8 years ago

I wouldn't rely on the API too much since this project is still not 1.0

andrewcharnley commented 8 years ago

Not want I want to hear, it's going to be integrated into the Igaro App project and I've found it to work reliable so far.

I'll clean & document if you don't have the time, but let me know before hand else I'll fork.

Cheers, A.

BYK commented 8 years ago

The project is currently trying to convert different file formats into JS and then parses that which is not really ideal. The plan was to use dedicated parsers for each file type (and may be even plugins) and encapsulate the extraction part to those specific things instead of trying to cast everything into JS (sometimes fake JS).

I think you can rely on these versions but with the change I mentioned above, the programmatic API may change in an incompatible way.

If you have the time I'd appreciate a PR.