https://github.com/immoweltgroup/styleguide-javascript

Styleguide related configuration files (.editorconfig, .prettierrc) for javascript related projects.
https://github.com/immoweltgroup/styleguide-javascript

configuration dotfiles editorconfig prettier

Last synced: 3 months ago
JSON representation

Styleguide related configuration files (.editorconfig, .prettierrc) for javascript related projects.

• Host: GitHub
• URL: https://github.com/immoweltgroup/styleguide-javascript
• Owner: ImmoweltGroup
• License: mit
• Created: 2017-09-06T11:19:48.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-05-03T08:34:32.000Z (almost 3 years ago)
• Last Synced: 2024-11-08T19:53:05.039Z (3 months ago)
• Topics: configuration, dotfiles, editorconfig, prettier
• Language: JavaScript
• Homepage:
• Size: 340 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @immowelt/styleguide-javascript

[![Powered by Immowelt](https://img.shields.io/badge/powered%20by-immowelt-yellow.svg?colorB=ffb200)](https://stackshare.io/immowelt-group/)

[![Build Status](https://travis-ci.org/ImmoweltGroup/styleguide-javascript.svg?branch=master)](https://travis-ci.org/ImmoweltGroup/styleguide-javascript)

[![Dependency Status](https://david-dm.org/ImmoweltGroup/styleguide-javascript.svg)](https://david-dm.org/ImmoweltGroup/styleguide-javascript)

[![devDependency Status](https://david-dm.org/ImmoweltGroup/styleguide-javascript/dev-status.svg)](https://david-dm.org/ImmoweltGroup/styleguide-javascript#info=devDependencies&view=table)

[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovateapp.com/)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

> Styleguide related configuration files(`.editorconfig`, `.prettierrc`) for javascript related projects.

## Usage

If you want to use the `@immowelt/styleguide-javascript`, you can install it by executing:

```bash

npm i -D @immowelt/styleguide-javascript

```

This will automatically setup symlinks to the `.editorconfig` and `.prettierrc` in your project root and add them to your `.gitignore` if possible.

## Styleguide

We use [prettier](https://github.com/prettier/prettier) as a code style since it is easy to automatically keep a consistent style in projects.

You might also be interested in our ESLint config presets:

* [eslint-config-immowelt-react](https://github.com/ImmoweltGroup/eslint-config-immowelt-react)

## IDE configurations

You will find example configuration guides in the [docs](https://github.com/ImmoweltGroup/styleguide-javascript/tree/master/docs) folder.

## Contributing

See the `CONTRIBUTING.md` file at the root of the repository.

## Licensing

See the `LICENSE` file at the root of the repository.