Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/critocrito/build-chores

Building JS is complicated.
https://github.com/critocrito/build-chores

ava babel babel-preset code-coverage commitlint-config eslint-config flowtype javascript lint-staged linting node-package project-template test-setup testing tooling

Last synced: 10 days ago
JSON representation

Building JS is complicated.

Host: GitHub
URL: https://github.com/critocrito/build-chores
Owner: critocrito
License: gpl-3.0
Created: 2018-10-05T19:20:12.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2019-11-08T21:49:37.000Z (about 5 years ago)
Last Synced: 2024-12-12T03:33:08.319Z (16 days ago)
Topics: ava, babel, babel-preset, code-coverage, commitlint-config, eslint-config, flowtype, javascript, lint-staged, linting, node-package, project-template, test-setup, testing, tooling
Language: JavaScript
Size: 497 KB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 11
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- Contributing: contributing.md
- License: license

Awesome Lists containing this project

README

        # Build Chores

> Building JS projects is complicated.

## Synopsis

[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Build Status](https://travis-ci.org/critocrito/build-chores.svg?branch=master)](https://travis-ci.org/critocrito/build-chores) [![Greenkeeper badge](https://badges.greenkeeper.io/critocrito/build-chores.svg)](https://greenkeeper.io/)

The `@build-chores` packages collect common JavaScript tooling configurations and reduces the friction setting up a new JavaScript project. The tooling contains the following parts:

- Code transpilation using [Babel](https://babeljs.io).

- Code linting using [ESLint](https://eslint.org).

- Type checking with [Flow](https://flow.org/).

- Lint stage files using [lint-staged](https://github.com/okonet/lint-staged).

- Commit messafe linting using [Commitlint](https://marionebl.github.io/commitlint/#/).

- Test code using [AVA](https://github.com/avajs/ava).

- Instrument your code using [IstanbulJS](https://istanbul.js.org/).

## Packages

| Package | Version | Description |

|---------|---------|-------------|

| [`@build-chores/babel-preset`](packages/babel-preset) | [![npm version](https://img.shields.io/npm/v/@build-chores/babel-preset.svg?style=flat)](https://www.npmjs.com/package/@build-chores/babel-preset) | A default [Babel](https://babeljs.io) configuration, targeting Node 8. It provides support for Flow type declarations and class fields and properties. |

| [`@build-chores/eslint-config-lint`](packages/eslint-config-lint) | [![npm version](https://img.shields.io/npm/v/@build-chores/eslint-config-lint.svg?style=flat)](https://www.npmjs.com/package/@build-chores/eslint-config-lint) | A curated configuration for [ESLint](https://eslint.org) with support for Flow, Prettier and promises. |

| [`@build-chores/staged`](packages/staged) | [![npm version](https://img.shields.io/npm/v/@build-chores/staged.svg?style=flat)](https://www.npmjs.com/package/@build-chores/staged) | Lint staged JS, JSON and *.rc files using [lint-staged](https://github.com/okonet/lint-staged). |

| [`@build-chores/commitlint`](packages/commitlint) | [![npm version](https://img.shields.io/npm/v/@build-chores/commitlint.svg?style=flat)](https://www.npmjs.com/package/@build-chores/commitlint) | Enforce rules for your commit messages. |

| [`@build-chores/test`](packages/test) | [![npm version](https://img.shields.io/npm/v/@build-chores/test.svg?style=flat)](https://www.npmjs.com/package/@build-chores/test) | Configure your [AVA](https://github.com/avajs/ava) test runner to play nice with your custom Babel configuration and provide test coverage reports. |

## Installation

Install the `@build-chores` packages as required:

```

yarn add --dev @build-chores/babel-preset \

               @build-chores/eslint-config-lint \

               @build-chores/staged \

               @build-chores/commitlint \

               @build-chores/test

```

See the [respective packages](packages) for details on how to configure them. The [`project-example`](project-example) collects all relevant configuration changes for a quick overview.

## Contribute

See the [contribution guide](contributing.md) and join the [contributors](https://github.com/critocrito/build-chores/graphs/contributors)!

## License

[](license)