open-index/open-npm huggingface dataset:
npm package: @logic-warlock/eslint-config
Description: Base JavaScript elsint rules
Author: Kaemon Lovendahl
Latest version: 1.0.0

# @logic-warlock/eslint-config

This package is all about the basic rules for `.js` and `.jsx` files. The base rules are in place to make it easier to write code with good documentation, and hopefully promote better writing habits in general.

# Installation

With Yarn:

```
yarn add -D @logic-warlock/eslint-config
```

With NPM:

```
npm install --save @logic-warlock/eslint-config
```

All you need to do is add `@logic-warlock` to your `.eslintrc` file within `extends`.

```
{
  extends: ["@logic-warlock"]
}
```

# Rules

## Base

This base style rules mainly adopt those from [airbnb.](https://www.npmjs.com/package/eslint-config-airbnb-base)

## Documentation

Documentation is huge when it comes to code readability and maintenance. Thus jsdoc is strongly enforce, and highly encouraged to be applied whenever possible. However, it's only enforced for arrow functions, class declarations/methods, and function expressions.

Requiring jsdoc also makes generating docs for non frontend code so much easier! Plus some editors, like VS Code, show popup info when using functions that use jsdoc which makes searching params, or return values that much easier!

## Import

There are several rules that make importing modules more consistent. For instance using named exports is enforced in place of default exports. It makes things easier when you know exactly what you're importing.

## Style

Although eslint shouldn't be used to enforce code style, there are several rules stated in order to work with code formatters, like Prettier. This makes writing code so much easier when you don't have to worry about style!
npm package: @logic-warlock/eslint-config-react
Description: Eslint React rules for Logic Warlock applications
Author: Kaemon Lovendahl
Latest version: 1.0.0

# @logic-warlock/eslint-config-react

This package is all about React based rules for `.jsx` files. The base rules are in place to make it easier to write code with good functional components, and hopefully promote better React component habits in general.

# Installation

With Yarn:

```
yarn add -D @logic-warlock/eslint-config-react
```

With NPM:

```
npm install --save @logic-warlock/eslint-config-react
```

All you need to do is add `@logic-warlock/react` to your `.eslintrc` file within `extends`.

```
{
  extends: ["@logic-warlock/react"]
}
```

# Rules

## Base

This base style rules mainly adopt those from [airbnb.](https://www.npmjs.com/package/eslint-config-airbnb-base)

## Style

Although eslint shouldn't be used to enforce code style, there are several rules stated in order to work with code formatters, like Prettier. This makes writing code so much easier when you don't have to worry about style!
npm package: @logic-warlock/eslint-config-typescript
Description: TypeScript ESLint config for logic warlock apps.
Author: Kaemon Lovendahl
Latest version: 1.0.0

# @logic-warlock/eslint-config-typescript

This package is all about TypeScript based rules for `.ts` and `.tsx` files. The base rules are in place to make it easier to write code with good functional components, and hopefully promote better React component habits in general.

# Installation

With Yarn:

```
yarn add -D @logic-warlock/eslint-config-typescript
```

With NPM:

```
npm install --save @logic-warlock/eslint-config-typescript
```

# Setup

All you need to do is extend `@logic-warlock/typescript` within your `.eslintrc` file, set `@typescript-eslint/parser` as the parser, and specify the location of a `.tsconfig` file within `parserOptions`.

Your eslint config should look something like the following:

```
{
  extends: ["@logic-warlock/typescript"],
  parser: "@typescript-eslint/parser",
  parserOptions: {
    project: "./tsconfig.json"
  }
}
```

If you do not have a `tsconfig` file you can create one! Simply add `typescript` to your package.json file if it's not already there and run `tsc --init` in your terminal. This will create a default `tsconfig` file.

[Click Here](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) for more information on the `tsconfig` file.

# Rules

## Base

The default rules come from the recommended [TypeScript eslint](https://github.com/typescript-eslint/typescript-eslint) settings. Along with specifications for [tsdoc](https://github.com/Microsoft/tsdoc).

## Syntax

Currently the only syntax rule declared is so that return types for functions are required.