zumerbox

ZumerBox

ZumerBox is a small set of development tools designed to run common tasks in software development workflows. It offers functionalities for linting, formatting, building, testing, and releasing projects.

Target audience

ZumerBox is intended for small projects with single or small development teams. It was initially created for personal use but can be useful for sharing with other developers who want to quickly test concepts or iterate on small projects.

No configuration needed

The idea behind ZumerBox is that it can be used out-of-the-box without any configuration. Each tool is designed to work with sensible defaults, allowing you to get started quickly without having to spend time configuring settings.

No installation needed

You can use the ZumerBox bundle or any of its tools without installation by running npx. See Usage for details.

Design philosophy

ZumerBox tools are designed as wrappers for popular tools such as Jest, ESLint, StyleLint, ESbuild, Prettier, and update-changelog. They are pre-configured to be immediately usable without the need for extensive setup or configuration.

Installation

You can install ZumerBox as a bundle or each tool individually according to your preference.

Bundle installation

To install the entire ZumerBox bundle, simply run:

npm install zumerbox --save-dev

This will install all tools included in ZumerBox.

Individual tool installation

Alternatively, you can install each tool independently. Here are the available tools:

• @zumerbox/changelog: npm 📦 | GitHub :octocat:
• @zumerbox/release: npm 📦 | GitHub :octocat:
• @zumerbox/build: npm 📦 | GitHub :octocat:
• @zumerbox/code-format: npm 📦 | GitHub :octocat:
• @zumerbox/css-lint: npm 📦 | GitHub :octocat:
• @zumerbox/scss-lint: npm 📦 | GitHub :octocat:
• @zumerbox/js-lint: npm 📦 | GitHub :octocat:
• @zumerbox/tests: npm 📦 | GitHub :octocat:

You can install any of these tools individually using npm:

npm install @zumerbox/tool-name --save-dev

Replace tool-name with the name of the tool you want to install.

Usage

You can use any tool from ZumerBox without the need for installation by running it directly with npx. This allows for a hassle-free setup and usage. For example, to run the tests, you can use in the project root folder:

# using ZumerBox bundle
npx zumerbox tests

or

# using ZumerBox individual tool
npx @zumerbox-tests

Replace tests with the name of the tool you want to use.

Alternatively, you can integrate ZumerBox tools into your npm package scripts. For instance, you can add a script entry in your package.json file:

//package.json
{
    "scripts": {
        "release":"npx zumerbox release"
    }
}

or with an individual tool:

//package.json
{
    "scripts": {
        "release":"npx @zumerbox/release"
    }
}

This way, you can utilize ZumerBox seamlessly within your project's development workflow.

License

ZumerBox is licensed under the MIT License.

Bugs and issues

If you encounter any bugs or have suggestions for improvements, please feel free to open an issue on GitHub.