Skip to content

anolilab/javascript-style-guide

Repository files navigation

Javascript Style Guide

This project is a shareable code style guide of all basic back- and front end project used at Anolilab.


Daniel Bannert's open source work is supported by the community on GitHub Sponsors


This is a mono-repository that contains a collection of separate, shareable npm packages that provide various configuration files for commonly used tools in modern web development.

Usage

Check the README for each configuration within the packages directory for specific usage instructions.

Featured Packages

Tool Package Version Description
babel babel-preset npm Babel is a JavaScript compiler to use next generation JavaScript, today
browserslist browserslist-config npm Share target browsers between different front-end tools, like Autoprefixer, Stylelint and babel-preset-env
commitlint commitlint-config npm Helps your team adhere to a commit convention.
eslint eslint-config npm Statically analyzes your code to quickly find problems.
- package-json-utils npm Shared utilities for parsing information from a package.json file.
lint-staged lint-staged-config npm Run linters on git staged files.
prettier prettier-config npm Prettier is an opinionated code formatter.
semantic-release semantic-release-preset npm semantic-release is a fully automated version management and package publishing library
stylelint stylelint-config npm Linter that helps you avoid errors and enforce conventions in your styles
textlint textlint-config npm The pluggable natural language linter for text and markdown.

Badge

Show the world that you are using Anolilab’s code style in your project by including the badge in your readme.

Anolilab’s Code Style

[![Anolilab’s Code Style](https://img.shields.io/badge/code_style-Anolilab%E2%80%99s-663399.svg?labelColor=292a44&style=flat-square)](https://github.com/anolilab/javascript-style-guide)

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.

Supported Node.js Versions

Libraries in this ecosystem make the best effort to track Node.js’ release schedule. Here’s a post on why we think this is important.

Contributing

If you would like to help take a look at the list of issues and check our Contributing guild.

Note: please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Credits

License

The anolilab javascript-style-guide is open-sourced software licensed under the MIT license