Skip to content

Latest commit

 

History

History
140 lines (95 loc) · 5.68 KB

README.md

File metadata and controls

140 lines (95 loc) · 5.68 KB
Raw

Poetic

Automatic code styling for JavaScript, TypeScript and React.

NPM Status Code Size

Poetic installs and maintains ESLint, Prettier, EditorConfig and Airbnb rules for JavaScript, TypeScript and React.

Poetic installation example

Install

On the root of your project run:

npx poetic

CLI flags:

--keeprules
Keeps your current rule configuration files as is.
--local
Installs poetic from the local parent directory (for contributing to Poetic)
--skipinstall
Skips installing Poetic as a dev dependency (useful for bundling Poetic as part of another package).

Trying out Poetic is safe! You can review all the changes in Git before committing. If you don't like it, just discard it.

Features

  • Installs and configures ESLint, Prettier and EditorConfig
  • Provides a curated set of rules based on Airbnb and ESLint Recommended
  • Customizable project configurations that are shareable
  • Easy to maintain with a single dependency
  • Configures Visual Studio Code

Requirements

  • Yarn (There are some limitations with NPM that make it incompatible with ESLint as a subdependency)

Motivation

Keeping the code clean and organized is important to prevent bugs and to collaborate with others. Linters help identify possible errors and bad practices and formatters allow us to concentrate on the features without having to worry about the code format. Unfortunately, configuring and maintaining these tools is cumbersome and more often than not, the project ends up with incorrect configurations (if any at all).

The goal of Poetic is to simplify the setup and maintenance of code styling tools and rules while allowing full customization.

To learn more read the Configuring Eslint, Prettier, and Airbnb in 1 Line.

Supported File Types

  • Javascript (.js)
  • TypeScript (.ts)
  • React (.jsx,.tsx)
your-app/
├── package.json
└── src/
    └── [your source files]

Poetic checks the code inside the src/ directory by default. This can be changed in the package.json

Recommended Visual Studio Code Extensions

Poetic comes preconfigured to work with VSC, so that you can see the error indicators in real-time as well as automatic formatting on save. In order for these features to work, you need to install the following extensions:

Running on the CLI

Poetic provides a few handy NPM scripts that are useful for applying the code style from the command line:

  • yarn code:check - Checks linting and formatting (Useful for CI)
  • yarn code:clean - Applies linting and formatting (Useful for automatic fixes)
  • yarn code:lint - Applies linting only
  • yarn code:format - Applies formatting only

You may use these in conjunction with Husky to clean the code automatically before committing or pushing.

Customizing for your project

Poetic provides a base configuration that can be easily extended or overridden. It uses the native configurations you are familiar with, so that you can build your own rules on top of it. Feel free to edit the following files as you see fit:

  • ESLint:
    • .eslintrc.js (Linting rules)
    • .eslintignore (Ignored files)
  • Prettier:
    • .prettierrc (Formatting rules)
  • TypeScript:
    • tsconfig.json (TS compilation)
  • EditorConfig:
    • .editorconfig (Basic editor config)
  • Visual Studio Code:
    • .vscode/settings.json (IDE behavior)

Installing on a preconfigured project

It is strongly recommended to remove other versions of ESLint and Prettier prior to installing Poetic.

If your project has custom rules or configurations, those can be easily copied over to the files added by Poetic. The filename convention is the same, so it should be straight forward.

Plese note that existing configuration files might be modified. Make sure to review all changes before committing.

Contributing

We are looking for contributors that are passionate about code style and making it accessible to teams around the world.

To make Poetic useful for everyone, we need to understand your needs, so please let us know about things that could help you improve your workflow.

If you would like to submit a PR, these are some of the short-term goals, but feel free to improve other areas as well:

  • Improve rules
  • Test on different types of projects
  • Add configs for Webstorm
  • Improve the documentation

Visit the CONTRIBUTING section for instructions on how to develop, test and release Poetic.

Contacting Collaborators

Spread the ❤️ about Poetic