Git Product home page Git Product logo

theelegantcoding / eslint-config-elegant-coding Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 1.06 MB

⚙️ Eslint configuration for help you to identify and fix these errors before they cause problems in your code. It can also help you to develop good coding habits that will make your code easier to maintain in the long run.

TypeScript 99.72% JavaScript 0.28%
eslint eslint-config eslint-plugin eslint-rules eslint-shareable-configs clean-code eslintconfig eslintplugin javascript style-guide styleguide typescript code-style linter linter-config linter-eslint

eslint-config-elegant-coding's Introduction

🔧 ESlint aesthetic configuration

eslint

📝 About

You can customize this configuration to fit your specific needs by disabling or enabling rules, or by changing the severity of the rules. You can also add additional rules that are not included in the style guides.

(back to top)


📚 Table of content

(back to top)


⚡️ Requirements

  • node >= 18.16.0
  • git >= 2.38
  • pnpm >= 8.2.0

(back to top)


📦 Installation

Run this command to install eslint and the plugin.

pnpm i -D eslint eslint-config-aesthetic-coder

(back to top)


🚀 Usage

To use this plugin put in your eslint config file this lines of codes.

js - javascript

{
  "root": true,
  "extends": "aesthetic-coder"
}

ts - typescript

{
  "root": true,
  "extends": [
    "aesthetic-coder",
    "aesthetic-coder/typescript",
  ]
}

tsx - jsx

{
  "root": true,
  "extends": [
    "aesthetic-coder",
    "aesthetic-coder/typescript",
    "aesthetic-coder/jsx_a11y",
  ]
}

qwik

{
  "root": true,
  "extends": [
    "aesthetic-coder",
    "aesthetic-coder/typescript",
    "aesthetic-coder/jsx_a11y",
    "aesthetic-coder/qwik",
  ]
}

(back to top)


⚡️ Scripts

The following scripts are available in the package.json:

  • preinstall: This script is for only allow pnpm as package manager
  • postinstall: This script is for setting up the git hooks and validate the error after commit to github
  • type-check: This script is for type checking the typescript files
  • lint-eslint: This script is for format and lint all js ts files
  • lint-markdown: This script is for format and lint all markdown files
  • lint: This script is for format and lint all the files
  • build: This script is for build the package
  • release: This script is for generate a new release in github

(back to top)


📦 Packages

Dependencies

  • typescript - TypeScript is a strongly typed programming language that builds on JavaScript, giving you better tooling at any scale.
  • eslint - ESLint is an open source project that helps you find and fix problems with your JavaScript code.
  • rimraf - A rm -rf util for nodejs

Development dependencies

(back to top)


🗃️ Contact

This package is made by me AesthetiCoder



footer



Thank you for reading ❤️

(back to top)

eslint-config-elegant-coding's People

Watchers

 avatar

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.