@theholocron/node-utils

Node Utils

This utility droid provides a set of single-purpose, functional utilities for writing NodeJS within the Galaxy.

Installation

$ npm install --save-dev @theholocron/node-utils

Table of Contents

• Usage
• Documentation
• Change Log
• Versioning
• Contribution
• Support
• License

Usage

import utils from '@theholocron/node-utils';

utils.curl.getHTTPStatus('http://example.com'); // 200
utils.file.isFileOfType('/foo/bar/baz.json', 'json') // true
utils.git.remote() // 'https://github.com/the-holocron/astromech.git'
utils.log.error('foo') // [ERROR] foo
utils.semver.increment('1.0.0', 'major') // 2.0.0
utils.str.encode('foo') // Zm9v

The previous examples are only a sample of what utilities are available.

Documentation

The best way to find out what's available is to check out the source code. More documentation and a possible site to explore are set to come.

• Curl - use NodeJS to curl and grab data from sites and/or APIs.
• Files - a set of functions that work with the Filesystem.
• Git - a translation of Git operations in NodeJS.
• Logs - various functions that log different types and levels of output to the console
• SemVer - functions to work with Semantic Versioning and verifying numbers and keywords are valid.
• Strings - any function that manipulates strings; input a direction and output the opposite, strip the unit suffix, replace parts of a string, and so on.

How We Track Changes

This project uses a CHANGELOG and GitHub releases which contains a curated, chronologically ordered list of notable changes for each version of a project. Read more about changelogs.

How We Version

We use SemVer for its versioning providing us an opt-in approach to releases. This means we add a version number according to the spec, as you see below. So rather than force developers to consume the latest and greatest, they can choose which version to consume and test any newer ones before upgrading. Please the read the spec as it goes into further detail.

Given a version number MAJOR.MINOR.PATCH, increment the:

• MAJOR version when you make incompatible API changes.
• MINOR version when you add functionality in a backward-compatible manner.
• PATCH version when you make backward-compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

How to Contribute

Have a bug or a feature request? Looking to contribute to advance the project? Read our contribution guide or maintenance guide first in order to understand how we do things around here. Or you could look at some of our other guides below:

How do I… (click to expand)

• Ask or Say Something?
  • Request Support
  • Report an Error or Bug
  • Request a Feature
• Make Something?
  • Setup the Project
  • Create an Issue
  • Create a Feature Request
  • Contribute Documentation
  • Contribute Code
  • Join the Team
• Manage Something
  • Provide Support on Issues
  • Label Issues
  • Clean Up Issues and PRs
  • Create a Pull Request
  • Review Pull Requests
  • Merge Pull Requests
  • Tag a Release
  • Release a Version

Where to Find Support

Looking to talk to someone or need some help? Please read our support guidelines.

License

©2020 GNU General Public License v3. See LICENSE for specifics.