Intro to box.json

Nathaniel Francis February 26, 2015

Spread the word

Nathaniel Francis

February 26, 2015

Spread the word

Share your thoughts

Package management = development++

Package management is one of the key aspects to CommandBox development. Going out to ForgeBox and uploading a package in seconds is a major boost to CFML development efficiency and extensibility.

All about that box.json

To make package management work in the CFML community, we need standards: a way to categorize packages, log dependencies, and register packages with ForgeBox. The file that handles these aspects is box.json. Every package uploaded to ForgeBox requires one. They communicate the basic information from name, slug, and author - to really detailed information like dependencies, CFML engine compatibility, licensing, CFC type and much, much more!!!

K.I.S.S. (Keep It Simple, Silly)

Please don't lose it on the "much, much more!!!". Just because you can do amazing things with the box.json doesn't mean you have to.

When in doubt, keep it simple.

It is a good idea to add (at a minimum), these attributes to your box.json.

    "name" : "Ortus Awesome",
    "slug" : "ort-awe",
    "version" : "1.0",

I made a fictitious "Ortus Awesome" package, gave it the unique ForgeBox slug "ort-awe" (something ForgeBox checks when you register the package), and made it version 1.0 - a very basic alpha version.

These three attributes are a good minimum requirement because:

  • name is what you'd call your package
  • slug allows developers to find/upload if via ForgeBox
  • version is helpful for you both: allows you to make updates clearly (by increasing the version number) and for developers to see that out on ForgeBox.

Future Proof

By populating your package's box.json file with these attributes, be assured that you have the necessary items to keep your package relevant both now and going forward. Future versions of ForgeBox and CommandBox will leverage these attributes, and the box.json as a whole more and more.

Add Your Comment

Recent Entries

CBWIRE 2.2 Released

CBWIRE 2.2 Released

We're excited to announce the release of CBWIRE 2.2. This release includes several added enhancements, such as new lifecycle hooks and simplified Turbo Drive integration. We changed the previous lifecycle hook of mount() to onMount() to be consistent, and several bugs were squashed.

Maria Jose Herrera
Maria Jose Herrera
January 09, 2023
FORGEBOX v7.1.0 Released

FORGEBOX v7.1.0 Released

We are so happy to announce a minor release for our package management system. In this release, we take care of some bug fixes reported and a lot of work for our elastic search engine. Now better search results with an improved response time. We have updated our core modules to the latest versions for better security and performance.

Javier Quintero
Javier Quintero
December 30, 2022
Favorite 2022 Ortus Content

Favorite 2022 Ortus Content

2022 was quite the year. For us, it was all about delivering exceptional content and service to our amazing community of developers. That's why we updated our tools, released new products, and announce upcoming projects and initiatives we are working on for 2023.

We know 2023 will be awesome but 2022 was amazing too. Read on and don't miss anything, review the top content we released in 2022 and improve your projects in 2023. Happy New Year!

Maria Jose Herrera
Maria Jose Herrera
December 29, 2022