ganderzz / gnerate Goto Github PK

Some checks are in place, but going to need to do better. Add error checks for everything!

Everything done in a config file should also be mirrored in command line arguments.

Add --templatePath= (To resolve template path) and --[key]=[value] (For injecting variables to templates).

This will also need to make having the config file optional.

Add more terminal args.

Some ideas:

• Make a third argument that is optional that allows creating file in a defined location
• --typescript adds types to params
• --connect add this only to containers to add react-redux connect()()
• --test add unit tests to component

Need to write docs on how to set up Gnerate.

generate --init will provide a base config file, but still need to describe what templates are, and the templates directory.

Write unit tests for both the CLI and what it outputs

It'd be nice to be able to define aliases for templates through the config.

{
alias: {
"test": ["component", "container"]
}
}

Templates are useless without being able to dynamically inject variables into them!

For example, I would like the have the filename visible to name a JS class the same as the filename.

I imagine this being similar to template strings to make it easy to learn.

class ${rgen.filename} extends React.Component {}

Improve the docs and readme to help explain gnerate better.

• Looking to add a full walkthrough of setting up gnerate and using it (Sort of started on the website)
• Improve readme for contributing to the projects & getting started using gnerate

Would help to add a compilation library instead of rolling our own. Nunjucks seems to be a good solution.

https://mozilla.github.io/nunjucks/

Right now the config file resolves its path to where the terminal command is being ran. For example, in the example directory (here), I have to put "./example/templates".

The templates path should be smart enough to resolve to path to where the config file is. So, the path to the templates should be "./templates" in the config file.

Let's clean up some of this code.

• Move what we can away from index.js
• Move factory into its own file, we can then move all the component files out of index.js
• Handle fileName so we don't have to add it to every class
• Create an interface for 'output' found in classes
• Handle creating file in a better way
  ...

Currently the tools for contributing to the project are slim. It would help to create a better way to test gnerate locally, plus add some nice tooling like linting.

This may be a case to include linting into our CI, or use a pre-commit check (Husky?)