Coder Social home page Coder Social logo

100terres / eslint-config Goto Github PK

View Code? Open in Web Editor NEW
3.0 2.0 1.0 58 KB

A modern ESlint configuration for JavaScript, TypeScript and React that includes the Airbnb style guide, jsx-a11y to help with accessibility and Pettier to do some code formatting.

License: MIT License

JavaScript 95.14% Shell 4.86%
eslint eslint-config prettier javascript typescript react jsx-a11y

eslint-config's Introduction

eslint-config-100terres

A modern ESlint configuration for JavaScript, TypeScript and React that includes the Airbnb style guide, jsx-a11y to help with accessibility and Pettier to do some code formatting.

eslint-config-100terres is released under the MIT license. PRs welcome!

A bit of context

It's always a bit time consuming to create or maintain different ESlint configurations that works with different languages and libraries such as TypeScript and React. The goal of this package is to have different configurations that just work out-of-the-box and that are constantly kept up-to-date.

Getting Started ๐Ÿš€

Installing this packge is has as easy has any other packages. Simply use your favorite package manager. You'll need to install the required peer dependencies and than this packge.

Install ESlint and Prettier peer dependencies

Install ESlint and Prettier either locally or globally. (Note that locally, per project, is strongly preferred)

npm install eslint@8 --save-dev
npm install prettier@2 --save-dev --save-exact

If you use TypeScript or React you'll also need to install them, but let's assume they're already installed. We'll only support most recent version. Have a look at the peerDependencies field in the package.json to know which one we support.

Install eslint-config-100terres

npm install eslint-config-100terres --save-dev

Setup the configuration file

Using any file formats supported by ESlint, youll need to add "100terres" in the "extends" value of the configuration. Here's an example using a .eslintrc.js file.

Using the full configuration with JavaScript, TypeScript and React

module.exports = {
  "extends": ["100terres"],
};

JavaScript config

module.exports = {
  "extends": ["100terres/js"],
};

JavaScript with React config

module.exports = {
  "extends": ["100terres/js", "100terres/jsx"],
};

TypeScript config

module.exports = {
  "extends": ["100terres/ts"],
};

TypeScript with React config

module.exports = {
  "extends": ["100terres/ts", "100terres/tsx"],
};

Voilร ! Your project now uses a linter.

How to Contribute ๐Ÿค

Pull requests are welcome. If you'd like to contribute to eslint-config-100terres, that's awesome. Simply open an issue explaining what we should change, improve or fix. If we decide that a change is required we can open a pull request and once everything looks good I'll approve and merge the PR.

License

Licensed under the MIT license.

eslint-config's People

Contributors

100terres avatar renovate[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

sdnydev

eslint-config's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions
.github/workflows/commitlint.yml
  • actions/checkout v2
  • wagoid/commitlint-github-action v4
.github/workflows/eslint.yml
  • actions/checkout v3
  • reviewdog/action-eslint v1
npm
package.json
  • @typescript-eslint/eslint-plugin ^5.33.0
  • @typescript-eslint/parser ^5.33.0
  • confusing-browser-globals ^1.0.11
  • eslint-config-airbnb ^19.0.4
  • eslint-config-airbnb-base ^15.0.0
  • eslint-config-prettier ^8.5.0
  • eslint-import-resolver-typescript ^3.4.1
  • eslint-plugin-import ^2.26.0
  • eslint-plugin-jsx-a11y ^6.6.1
  • eslint-plugin-prettier ^4.2.1
  • eslint-plugin-react ^7.30.1
  • eslint-plugin-react-hooks ^4.6.0
  • @commitlint/cli 16.2.1
  • @commitlint/config-conventional 16.2.1
  • @commitlint/cz-commitlint 16.2.1
  • @release-it/conventional-changelog 4.2.0
  • @types/react 17.0.39
  • commitizen 4.2.4
  • eslint 8.10.0
  • husky 7.0.4
  • prettier 2.5.1
  • prop-types 15.8.1
  • react 17.0.2
  • release-it 14.12.5
  • typescript 4.6.2
  • eslint ^8.0.0
  • prettier ^2.0.0
  • react ^16.8.0 || ^17.0.0 || ^18.0.0
  • typescript ^4.0.0

  • Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.