Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 25 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# moon development
# moon development configs

[![Build Status](https://github.com/moonrepo/dev/workflows/Pipeline/badge.svg)](https://github.com/moonrepo/dev/actions?query=branch%3Amaster)
[![npm version](https://badge.fury.io/js/%40moonrepo%dev.svg)](https://www.npmjs.com/package/@moonrepo/dev)
![build status](https://img.shields.io/github/workflow/status/moonrepo/dev/Pipeline)
![npm version](https://img.shields.io/npm/v/@moonrepo/dev)
![npm license](https://img.shields.io/npm/l/@moonrepo/dev)

This repository is a collection of moon owned and maintained configurations and presets for common
developer tools -- primarily tools used by moonrepo and its authors.
Expand Down Expand Up @@ -29,7 +30,9 @@ used stand-alone within their respective tools.
And last but not least, the [@moonrepo/dev](./packages/dev) package that provides helpers, constans,
and more. This should rarely be used directly!

## Contributing
## FAQ

### Can I contribute changes?

All these configs are personal preference and won't change drastically. You're welcome to use them
as-is, but major changes are unlikely to land. Feel free to create an issue otherwise so that we can
Expand All @@ -40,3 +43,21 @@ discuss any intended change.
The JavaScript ecosystem heavily prefers spaces over tabs. However, tabs are more accessible as they
allow developers with vision impairments to control their indentation and improve its readability.
Preferring accessibility compliance over a stylistic choice is always the better option.

### How are packages versioned?

To start, this repo utilizes [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
for versioning and publishing. We achieve this by requiring a
[specific prefix](https://github.com/beemojs/conventional-changelog-beemo#type) in pull request
titles. With that being said, the versioning strategy is as follows:

- Patch
- Dependency upgrades.
- Bug fixes.
- Minor
- Enabling or disabling settings or lint rules.
- Adding new dependencies (like babel plugins).
- Adding new features.
- Major
- Node.js minimum requirements / upgraes.
- Major version upgrades for tools (e.g., eslint 7 -> 8).
7 changes: 4 additions & 3 deletions packages/babel-preset/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# babel-preset-moon

[![Build Status](https://github.com/moonrepo/dev/workflows/Pipeline/badge.svg)](https://github.com/moonrepo/dev/actions?query=branch%3Amaster)
[![npm version](https://badge.fury.io/js/babel-preset-moon.svg)](https://www.npmjs.com/package/babel-preset-moon)
![build status](https://img.shields.io/github/workflow/status/moonrepo/dev/Pipeline)
![npm version](https://img.shields.io/npm/v/babel-preset-moon)
![npm license](https://img.shields.io/npm/l/babel-preset-moon)

A modern Babel preset with built-in TypeScript support. Is designed for unit testing, linting, and
local development only -- it _should not_ be used for web applications or package building (use
[Packemon](https://packemon.dev) instead).

```bash
yarn install --dev babel-preset-moon
yarn add --dev babel-preset-moon
```

## Setup
Expand Down
5 changes: 3 additions & 2 deletions packages/dev/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# @moonrepo/dev

[![Build Status](https://github.com/moonrepo/dev/workflows/Pipeline/badge.svg)](https://github.com/moonrepo/dev/actions?query=branch%3Amaster)
[![npm version](https://badge.fury.io/js/%40moonrepo%dev.svg)](https://www.npmjs.com/package/@moonrepo/dev)
![build status](https://img.shields.io/github/workflow/status/moonrepo/dev/Pipeline)
![npm version](https://img.shields.io/npm/v/@moonrepo/dev)
![npm license](https://img.shields.io/npm/l/@moonrepo/dev)

Reusable constants and helpers for moon configurations. This shouldn't be used directly.
7 changes: 4 additions & 3 deletions packages/eslint-config/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
# eslint-config-moon

[![Build Status](https://github.com/moonrepo/dev/workflows/Pipeline/badge.svg)](https://github.com/moonrepo/dev/actions?query=branch%3Amaster)
[![npm version](https://badge.fury.io/js/eslint-config-moon.svg)](https://www.npmjs.com/package/eslint-config-moon)
![build status](https://img.shields.io/github/workflow/status/moonrepo/dev/Pipeline)
![npm version](https://img.shields.io/npm/v/eslint-config-moon)
![npm license](https://img.shields.io/npm/l/eslint-config-moon)

A modern and strict ESLint configuration with optional presets and first-class TypeScript support.
Expands upon the amazing [Airbnb config](https://www.npmjs.com/package/eslint-config-airbnb-base) to
provide the latest ECMAScript features, enforce popular patterns, and align with the wider
community.

```bash
yarn install --dev eslint eslint-config-moon
yarn add --dev eslint eslint-config-moon
```

## Setup
Expand Down
7 changes: 4 additions & 3 deletions packages/jest-preset/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# jest-preset-moon

[![Build Status](https://github.com/moonrepo/dev/workflows/Pipeline/badge.svg)](https://github.com/moonrepo/dev/actions?query=branch%3Amaster)
[![npm version](https://badge.fury.io/js/jest-preset-moon.svg)](https://www.npmjs.com/package/jest-preset-moon)
![build status](https://img.shields.io/github/workflow/status/moonrepo/dev/Pipeline)
![npm version](https://img.shields.io/npm/v/jest-preset-moon)
![npm license](https://img.shields.io/npm/l/jest-preset-moon)

A modern Jest preset that provides code coverage and performance out of the box.

```bash
yarn install --dev jest-preset-moon
yarn add --dev jest-preset-moon
```

## Setup
Expand Down
7 changes: 4 additions & 3 deletions packages/prettier-config/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# prettier-config-moon

[![Build Status](https://github.com/moonrepo/dev/workflows/Pipeline/badge.svg)](https://github.com/moonrepo/dev/actions?query=branch%3Amaster)
[![npm version](https://badge.fury.io/js/prettier-config-moon.svg)](https://www.npmjs.com/package/prettier-config-moon)
![build status](https://img.shields.io/github/workflow/status/moonrepo/dev/Pipeline)
![npm version](https://img.shields.io/npm/v/prettier-config-moon)
![npm license](https://img.shields.io/npm/l/prettier-config-moon)

A modern and accessibility forward Prettier config that aligns with the community.

```bash
yarn install --dev prettier-config-moon
yarn add --dev prettier-config-moon
```

## Setup
Expand Down
7 changes: 4 additions & 3 deletions packages/tsconfig/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# tsconfig-moon

[![Build Status](https://github.com/moonrepo/dev/workflows/Pipeline/badge.svg)](https://github.com/moonrepo/dev/actions?query=branch%3Amaster)
[![npm version](https://badge.fury.io/js/tsconfig-moon.svg)](https://www.npmjs.com/package/tsconfig-moon)
![build status](https://img.shields.io/github/workflow/status/moonrepo/dev/Pipeline)
![npm version](https://img.shields.io/npm/v/tsconfig-moon)
![npm license](https://img.shields.io/npm/l/tsconfig-moon)

Pre-packaged, strict, and modern TypeScript `tsconfig.json`s. Each config assumes that TypeScript
will _only_ be used as a type checker and _not_ a compiler.

```bash
yarn install --dev tsconfig-moon
yarn add --dev tsconfig-moon
```

## Setup
Expand Down