https://github.com/yooga-tecnologia/eslint-config

Style Guide for Yooga projects written in JS
https://github.com/yooga-tecnologia/eslint-config

Last synced: 27 days ago
JSON representation

Style Guide for Yooga projects written in JS

• Host: GitHub
• URL: https://github.com/yooga-tecnologia/eslint-config
• Owner: yooga-tecnologia
• License: unlicense
• Created: 2023-12-21T17:22:24.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2023-12-22T20:38:33.000Z (11 months ago)
• Last Synced: 2024-05-23T10:22:45.234Z (6 months ago)
• Language: JavaScript
• Size: 44.9 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: docs/README.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: docs/CODEOWNERS

Awesome Lists containing this project

README

        
# ESlint Config

A set of rules for JS applications, considering Yooga recommendations.

> Please prefer to give feedbacks or update rules in our monorepo instead of using `eslint-disable`

## Project structure

```shell

.

└── src/

    ├── 📦eslint-config-base

    ├── 📦eslint-config-angular

    └── 📦eslint-config-vue # WIP

```

### Base

Base config for JS files, inspired by Airbnb's eslint plugin.

Recommended for:

- Simple projects, without frameworks (like this one)

### Angular

A plugin recommended for Angular projects, also inspired by Airbnb's eslint plugin, which encapsulates rules from [angular-eslint](https://github.com/angular-eslint/).

✅ Can be used for:

Projects which contain Angular framework

⛔ Should not be used for:

Vue, React, and other front-end frameworks which is not related to Angular.

### Vue

A WIP project. Will be available soon. ;)

## Install

### Github Packages

Using GitHub Packages to manage app packages? Make sure to follow the [official guide](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#installing-a-package).

### NPM

1. Replace `PACKAGE-NAME` by `base` || `angular` || `vue`

2. Add the package to your project

```shell

npm i --save-dev @yooga/eslint-config-PACKAGE-NAME

```

3. Create config file (`.eslintrc.js`) at project root:

```js

module.exports = {

  "ignorePatterns": [

    // Add ignored files and folders here

  ],

  "extends": [

    "@yooga/eslint-config-PACKAGE-NAME/.eslintrc.js"

  ]

}

```

4. Add scripts to your project

```json package.json

{

    "scripts": {

        "lint:js": "npx eslint",

        "lint:cache": "npx eslint --cache-strategy content",

    }

}

```