0.1.0 • Published 3 years ago

@etfdev/prettier-config v0.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

About the Project

An opinionated collection of Prettier rules. To be imported into other projects or used as a boilerplate for further Prettier configurations.

Built With

The following tools and packages were used to build this project:

  • Prettier A static code analysis tool for identifying problematic patterns found in JavaScript code
  • Node.js A JavaScript runtime built on Chrome's V8 JavaScript engine

Getting Started

Prerequisites

  • NPM
    npm install npm@latest --global
  • Prettier
    npm install prettier@latest --global

Installation

  1. Install the package dependencies into the project
    npm install prettier --save-dev
  2. Install the package into the project
    npm install @etfdev/prettier-config --save-dev

Usage

  1. Create an Prettier configuration file (if one does not already exist)
    touch .prettierrc.js
  2. Edit / Update the Prettier configuration file to include the following

    module.exports = {
    
      ...
    
      extends : [
        ...
    
       '@etfdev'
      ]
    
      ...
    }

Roadmap

See the open issues for a list of proposed features (and known issues)

Contributing

Contributions are what make the open source community such an amazing place to learn, create and be inspired.

Any contributions you make are grearly appreciated.

Contribution Policies

Before contributing, be sure to review the contributing policies

Contribution Guide

  1. Fork the Project
  2. Create your Feature Branch
    git checkout -b feature/AmazingFeature
  3. Commit your changes
    git commit -m 'Add some AmazingFeature'
  4. Push to the Branch
  5. Open a Pull Request

Versioning

We use Semantic Versioning for versioning.

For the versions available, see the tags on this repository.

License

Distributed under the MIT License. See LICENSE file for more details.

Contact

Eric Fledderman - @ericfledderman - ericfledderman@me.com

Project Link: https://github.com/ericfledderman/prettier-config

Acknowledgements

  • Choose a License Non-judgmental guidance on choosing a license for your open source project
  • Img Shields Legible & concise status badges for third-party codebase services