open-index/open-npm huggingface dataset:
npm package: @smart-gate/eslint-config-smartgate
Description: ESLint shareable config for the Smart Gate CO. projects style guide.
Author: Ahmed Jasim
Latest version: 1.0.8

# eslint-config-smartgate

ESLint shareable config for the Smart Gate Co. projects.

## Installation

```bash
npm install --save-dev @smart-gate/eslint-config-smartgate
```

## Usage

add `.eslint.cjs` then extend our configs (ESLint v8):

```cjs
modules.exports = {
  extends: ['@smart-gate/eslint-config-smartgate'],
};
```

1. next add the following script in your package json scripts:

```json
{
  "scripts": {
    "lint": "eslint . --fix --ignore-path .gitignore"
  }
}
```

1. By now, you should be able to run this script in your terminal:

```bash
npm run lint
```

> [!WARNING] Note
>
> 1. While creating a brand new project with this command `npm create vue@latest` make sure to say no for code quality option.
> 2. This package does not support latest eslint version (flat config object). we are still using `cjs` until vue eslint packages will be updated as well.
> 3. In order to avoid installation conflicts just uninstall the following packages in your `package.json`.
>    `eslint`, `@vue/eslint-config-typescript`, `eslint-config-google`, `eslint-plugin-import`, `eslint-plugin-vue`.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
npm package: @smart-gate/prettier-config
Description: Configure Prettier for Smart-Gate Co. projects to ensure consistent formatting across all styles.
Author: Ahmed Jasim
Latest version: 1.0.4

# prettier-config

`prettier-config` is some Prettier rules designed to enforce consistent formatting across all Smart-Gate Co. projects. It provides a standard set of formatting rules to ensure uniform code style and improve code readability.

> [!WARNING]
> In order to avoid installation conflicts just make sure you've deleted/ don't have the following packages in your `package.json`.
>
> 1. prettier
> 2. @vue/eslint-config-prettier

## Installation

To use `prettier-config` in your project, follow these steps:

1. **Install Prettier and the Config Package:**

   You can install Prettier along with `prettier-config` using npm:

   ```bash
   npm install --save-dev prettier @smart-gate/prettier-config
   ```

2. **Add Prettier Configuration File:**

   Add This line in your `package.json` file.

   ```json
   {
     "prettier": "@smart-gate/prettier-config"
   }
   ```

3. **(Optional) Prettier With Eslint:**

   Prettier rules conlficts with eslints, to keep your mental health well you may want update your `.eslintrc.cjs` file: (I assume you've just chosen our smartgate eslint configs)

   ```cjs
   extends: ["@smart-gate/eslint-config-smartgate", '@vue/eslint-config-prettier/skip-formatting']
   ```

4. **Add Prettier Script to `package.json`:**

   To make it easy to format your code, you can add a script to your `package.json`:

   ```json
   {
     "scripts": {
       "format": "prettier --write ."
     }
   }
   ```

   You can then run `npm run format` to format your codebase.

## Usage

Once you have followed those steps, you can start formating your code using our prettier rules by running

```bash
npm run format
```

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.