Skip to content
main
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Agrippa

npm license

Agrippa is a humble CLI, whose purpose is to assist React developers in creating components without the boilerplate. It can easily generate templates for React components of different compositions (styling solutions, prop validations, etc.) and in different environments.

docs

v1.2.0

Agrippa v1.2.0 is now officially out!! 🎉🎉
It introduces a few new generation options, such as the option to generate a component as a function declaration (function Component(props) ...) and the option to export the component as a default export. v1.2.0 also features a rewriting of the generation logic, in a way that would make generation easier to maintain, scale and test. Some strandardized testing has also already been implemented.

To update to the new version, call npm i -g agrippa. Read more about our release on the release page.

Features

🚀 Extremely easy to pick up and use in both new and existing projects.
🐙 Flexible - agrippa strives to be useful in many different circumstances.
🧠 Smart defaults - agrippa can detect and set defaults based on your environment's configuration, with no extra steps.
⚙️ Configurable - by using a plain old JSON file.

Docs

This page contains useful information to get started with using Agrippa. All other documentation & guides can be found on our wiki.

Installation

npm install -g agrippa
# Or:
yarn global add agrippa

Alterntively, use:

npx agrippa [...]
# e.g.
npx agrippa gen top-bar 

using npx, the latest version is always used.

Usage

Agrippa consists of two commands: generate (or gen) and init:

Generate

agrippa gen <name> [options] is the core of the CLI - this command generates a new React component, based on the name and options passed to it.

agrippa generate is an alias of agrippa gen.

The options that agrippa gen accepts are listed in The Complete List of Generation Options, on our wiki.

Init

agrippa init generates a basic .agripparc.json file, with some default values for options that agrippa accepts.

Using a config

In most projects, some options repeat themselves on most, if not all, components of the app. For example, if the codebase uses CSS modules as a styling solution, then the majority of component would be generated with --styling css.

To avoid this unnecessary boilerplate, an .agripparc.json config file can be used. It's dead simple to set up! simply call agrippa init at the root of your project, or create an empty .agripparc.json file, and edit its contents to match the desired defaults.
The config file's options are the same as the CLI's. The latter's options take precedence over the former's, which is useful for overriding the project's defaults when needed.

Community

My ambition is that Agrippa would become a tool that makes the lives of React developers easier, but perhaps more importantly one that they enjoy using. The tool's ease-of-use at the practical level is one aspect of that, but just as important is the cultivation of an active, positive community around it that developers feel welcome in.

Therefore, your thoughts, suggestions and collaboration are most welcome!
If you like Agrippa and want to see it grow, please spread its word! (and give it a )

License

MIT