Skip to content

thundermiracle/web-configs

Repository files navigation

Web Configs

License: MIT lerna

This repository contains common configurations for building web apps. The original version is here.

Usage

This repo is managed as a monorepo that is composed of many npm packages, where each package has its own README and documentation describing usage.

Package Index

Name NPM Size
@web-configs/babel-preset npm version npm bundle size (minified + gzip)
@web-configs/browserslist-config npm version npm bundle size (minified + gzip)
@web-configs/eslint-plugin npm version npm bundle size (minified + gzip)
@web-configs/prettier npm version npm bundle size (minified + gzip)
@web-configs/stylelint-plugin npm version npm bundle size (minified + gzip)
@web-configs/typescript npm version npm bundle size (minified + gzip)

Contribution

ThunderMiracle has also adopted a Code of Conduct that we expect contributors to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Ways to contribute

There are many ways to contribute, some of which are:

  • Filing bug reports
  • Requesting new features or packages via an issue
  • Improving the existing codebase by picking up an issue, improving tests, or furthering documentation

Development

Getting Started

pnpm # install project dependencies
pnpm lerna bootstrap

Documentation

If your change affects the public API of any packages within this repository (i.e. adding or changing arguments to a function, adding a new function, changing the return value, etc), please ensure the documentation is updated, and a changelog is added to reflect this. Documentation is in the README.md files of each package. If further documentation is needed please communicate via a GitHub issue.

Testing

The packages in this repository are used in mission-critical production scenarios. As such, we do not merge any untested code.

To run the full test suite, simply run dev test or pnpm test.

Releasing

The release process currently involves some manual steps to complete. Once your PR has been merged, our team will orchestrate when to cut a new release.

Note Version numbers in package.json files should never be altered manually. This will be done via scripts as part of the release process.

License

MIT © thundermiracle, see LICENSE.md for details.