open-index/open-npm huggingface dataset:
npm package: @slhs/eslint-config
Description: SLHS ESLint config
Author: SLHS Web Services
Latest version: 2.6.2

# @slhs/eslint-config

This is the SLHS [ESLint](https://eslint.org/) configuration.

[![npm Version](https://img.shields.io/npm/v/@slhs/eslint-config.svg?style=for-the-badge)](https://www.npmjs.com/package/@slhs/eslint-config)
[![Build Status](https://img.shields.io/badge/CI-GitHub%20Actions-success?logo=github&style=for-the-badge)](https://github.com/slhs/eslint-config/actions?query=workflow%3Aci)

### Requirements

This config uses the new
"[Flat Config](https://eslint.org/docs/latest/use/configure/configuration-files-new)" format and
comes with some requirements:

- Node.js 20.0.0 or newer
- ESLint 8.57.0 or newer
- Your project to be in native ESM (`"type": "module"` in your `package.json`)
- VSCode must be configured to use the Flat Config file (`eslint.config.js`). You'll probably want
  to enable this as a **workspace setting** (not a user setting) and check it in to source control:

![VSCode Settings Screenshot](./other/vscode-flat-config.png)

### Install

```
pnpm add -D @slhs/eslint-config
```

> Be sure to install the appropriately versioned `eslint` peer dependency as well.

### Usage

Follow the ESLint documentation on
[shared configurations](https://eslint.org/docs/latest/use/configure/configuration-files#using-a-shareable-configuration-package).
See the documentation on
[ignoring files](https://eslint.org/docs/latest/use/configure/migration-guide#ignoring-files) if you
need to ignore anything the config doesn't already ignore by default.

### Examples

#### `eslint.config.js`

```js
import { defineConfig } from 'eslint/config';
import slhsConfig from '@slhs/eslint-config';

const config = defineConfig([
  slhsConfig,
  {
    // your optional overrides here
  },
]);

export default config;
```

#### `package.json`

```
{
  "scripts": {
    ...
    "lint": "eslint --cache --cache-location ./node_modules/.cache/eslint .",
    ...
  }
}
```
npm package: @slhs/prettier-config
Description: SLHS Prettier config
Author: SLHS Web Services
Latest version: 4.0.6

# @slhs/prettier-config

This is the SLHS [Prettier](https://prettier.io/) configuration.

[![npm Version](https://img.shields.io/npm/v/@slhs/prettier-config.svg?style=for-the-badge)](https://www.npmjs.com/package/@slhs/prettier-config)
[![Build Status](https://img.shields.io/badge/CI-GitHub%20Actions-success?logo=github&style=for-the-badge)](https://github.com/slhs/prettier-config/actions?query=workflow%3Aci)

### Install

```
pnpm add --save-dev @slhs/prettier-config
```

> Be sure to install the appropriately versioned `prettier` peer dependency as well.

### Usage

Follow the Prettier documentation on
[sharing configurations](https://prettier.io/docs/en/configuration.html#sharing-configurations).

### Examples

#### `package.json`

```
{
  "prettier": "@slhs/prettier-config",
  "scripts": {
    ...
    "format": "prettier --cache --write .",
    "format:check": "prettier --cache --check .",
    ...
  }
}
```

#### `.prettierignore`

```
# .gitignore and...

.changeset
.vscode
package.json
package-lock.json
pnpm-lock.yaml
```

### Customization

If you need to customize the configuration, you can use a dedicated Prettier config file instead of
the one-liner in package.json:

#### `prettier.config.js`

```js
import slhsConfig from '@slhs/prettier-config';

/** @type {import("prettier").Options} */
export const config = {
  ...slhsConfig,
  // overrides here
};

export default config;
```