This utility droid provides a set of single-purpose, functional JavaScript, Node, and/or (S)CSS utilities for writing code within the Galaxy.
Please check the README for each configuration within the packages directory for specific installation instructions, however the general process is:
npm install --save-dev @theholocron/<package>- Usage
- Packages
- Browsers & Devices
- Documentation
- Changelog
- Versioning
- Contribution
- Support
- Tools
- Support
- License
Check the README for each utility within the packages directory for specific usage instructions.
- Configuration - A set of variables for writing (S)CSS.
- CSS Syntaxes - A set of CSS syntaxes for writing (S)CSS functional helpers or mixins.
- (S)CSS Functions - A set of single-purpose, functions for writing (S)CSS.
- (S)CSS Mixins - A set of single-purpose, functional mixins for writing (S)CSS.
- NodeJS Utils - A set of single-purpose, functional utilities for writing NodeJS.
- Utils - A set of single-purpose, functional utilities for writing JavaScript.
The best way to find out what's available is to check out the source code or tests within each package. You can also take a look at docs site the-holocron.github.io/astromech/<package> or the README in each package which have been generated by SassDoc and sassdoc-to-markdown.
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.
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.
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)
Looking to talk to someone or need some help? Please read our support guidelines.
- Babel - Used to compile ES Next
- Browserslist - Used to share to our code which browsers we support
- CommitLint - Used to ensure our commits follow our standards
- Dart Sass - Used to compile (S)CSS
- Conventional Changelog - Used to generate our CHANGELOG
- ESLint - Used to lint our JavaScript
- Husky - Used for auto-fixing linting errors on each commit
- Jest - Used for testing our JavaScript and (S)CSS
- MarkdownLint - Used to lint our Markdown docs
- PostCSS - Used to compile (S)CSS
- Semantic Release - Used for automating and releasing our library
- StyleLint - Used to lint our (S)CSS
- True - Used to test our (S)CSS mixins and functions
- @godban's Browser Support Badges - The tool used to generate the "Which Browsers [sic] We Support" section
- Conventional Commits - For how we format commit messages
- Contributor Convenant
- Keep a Changelog - For building out a quality CHANGELOG
- Make a README - For building out this README
- SemVer - For versioning this library
©2020 GNU General Public License v3. See LICENSE for specifics.
