Roc is a tool that assists in creating and managing JavaScript projects built on libraries from npm. It has the ambitious goal of making it easier to work with modern JavaScript development, which at times can be quite complex and require a lot of tooling and configuration.
The core of Roc (this project) aims to be as agnostic as possible and uses opinionated extensions to provide different frameworks and libraries along with templates for easy and predictable initial setup. When putting all of this together you get an ecosystem that enables developers to focus on writing great software and away from tooling and juggling boilerplates that degrade over time. All the software (including Roc itself) is still on npm.
By design it will in most cases be trivial to migrate away from or to Roc (based on individual extensions) because the code you write is the same code you would write without it; just with less boilerplate, setup and dependency management directly coupled with your project space.
Why Roc?
- Get started quickly and easily
- Possible to update projects after initial setup
- Unopinionated, allowing for a wide range of different types of projects
- Composable, easy to add and remove functionality
- Modular, easy to create custom packages & plugins for specific needs
Roc removes fragmented configurations, boilerplate and toolchain complexity from your project space without limiting you.
You can see Roc as mainly four separate things that work together.
You do not need to understand how everything is connected if you only want to create a project using existing templates and extensions, something that will be the case in most situations. However a short overview of what the different parts do is great for an understanding of how Roc functions and where to look if a problem occurs.
The core of Roc, often referred to as roc from the command line interface, serves multiple purposes in the ecosystem and will mainly manage the following things.
Roc features a powerful and dynamic command line interface that will feature different commands depending on the context from which it is invoked.
Read more here for the CLI in general and here for how commands work.
Roc features a configuration system that makes it possible for extensions and projects to configure things to a high degree.
See here for information about the general configuration and here for information about the settings system.
An important part of Roc is documentation generation and is used both by extensions and user projects.
Roc uses a hook system to extend and modify functionality in extensions.
Manages a runtime that drives extensions allowing them to do powerful things like providing configuration and dependency management.
Extensions are typically opinionated modules that add code and configuration needed to build a project as well as boilerplate code in some instances. Extensions come in two forms, packages and plugins. They are always npm packages unless declared as standalone.
A user project can use multiple extensions that together compose everything needed for the project. That is build management, testing, project code, cli commands and much more.
By design most extensions will try to stay out of the developers way as much as possible and should in most cases not introduce anything specific to Roc that needs to be considered when writing your code. This makes it easier to learn and also migrate away from or to Roc.
Projects are the consumers of extensions and will typically be applications, components and modules. They will often be instantiated from templates that will use a specific set of extensions for some predefined purpose.
When working with projects one does not need to know how everything in Roc is connected and the introduction here serves as a good basis.
All code needed to create projects can't be managed by extensions alone and that is where templates come into the picture. Templates can be used to quickly bootstrap new projects with a skeleton tuned to work with a specific set of extensions.
It's easy to create new templates and use them instead of the existing ones. Templates are typically very small compared to other forms of boilerplates/starter kits.