🔧 ESlint aesthetic configuration

---

📝 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

• 📝 About
• ⚡️ Requirements
• 📦 Installation
• 🚀 Usage
• ⚡️ Scripts
• 📦 Packages
  • Dependencies
  • Development Dependencies
• 🗃️ Contact

(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

• eslint-plugin-import - ESLint plugin with rules that help validate proper imports.
• @typescript-eslint/eslint-plugin - An ESLint plugin which provides lint rules for TypeScript codebase.
• @typescript-eslint/parser - An ESLint parser which leverages TypeScript ESTree to allow for ESLint to lint TypeScript source code.
• eslint-plugin-etc - More general-purpose (TypeScript-related) ESLint rules
• eslint-plugin-perfectionist - 🦄 ESLint plugin for sorting various data such as objects, imports, types, enums, JSX props, etc.
• eslint-plugin-promise - Enforce best practices for JavaScript promises
• eslint-plugin-security - ESLint rules for Node Security
• eslint-plugin-sonarjs - SonarJS rules for ESLint to detect bugs and suspicious patterns in your code.
• eslint-plugin-sonarjs - More than 100 powerful ESLint rules

(back to top)

---

🗃️ Contact

This package is made by me AesthetiCoder

Thank you for reading ❤️

(back to top)