Skip to content
This repository was archived by the owner on Mar 7, 2025. It is now read-only.

Commit b360185

Browse files
authored
Add readme files (#11)
1 parent 8144cb6 commit b360185

File tree

5 files changed

+172
-1
lines changed

5 files changed

+172
-1
lines changed

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,32 @@
1-
_under construction_
1+
<p>
2+
<a href="https://github.com/eslint-types/define-config-plugin-types/actions/workflows/ci.yml">
3+
<img alt="Build Status" src="https://github.com/eslint-types/define-config-plugin-types/actions/workflows/ci.yml/badge.svg?branch=main">
4+
</a>
5+
<a href="https://github.com/eslint-types/define-config-plugin-types/blob/main/LICENSE">
6+
<img alt="License: MIT" src="https://img.shields.io/github/license/eslint-types/define-config-plugin-types.svg">
7+
</a>
8+
<a href="https://prettier.io" target="_blank">
9+
<img alt="Code Style: Prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg">
10+
</a>
11+
<a href="https://www.paypal.com/donate?hosted_button_id=L7GY729FBKTZY" target="_blank">
12+
<img alt="Donate: PayPal" src="https://img.shields.io/badge/Donate-PayPal-blue.svg">
13+
</a>
14+
</p>
15+
16+
# @eslint-types/\*
17+
18+
This repository is a monorepo that contains types for [eslint-define-config](https://github.com/eslint-types/eslint-define-config).
19+
20+
You can install them e.g. via `npm install @eslint-types/import` which will contain types for the `eslint-plugin-import` plugin.
21+
Then you can use them in your `.eslintrc.cjs` config like this:
22+
23+
```js
24+
// @ts-check
25+
const { defineConfig } = require('eslint-define-config');
26+
27+
/// <reference types="@eslint-types/import" />
28+
29+
module.exports = defineConfig({
30+
// ...
31+
});
32+
```

types/deprecation/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<p>
2+
<a href="https://www.npmjs.com/package/@eslint-types/deprecation" target="_blank">
3+
<img alt="NPM package" src="https://img.shields.io/npm/v/@eslint-types/deprecation.svg">
4+
</a>
5+
<a href="https://www.npmjs.com/package/@eslint-types/deprecation" target="_blank">
6+
<img alt="Downloads" src="https://img.shields.io/npm/dt/@eslint-types/deprecation.svg">
7+
</a>
8+
<a href="https://github.com/eslint-types/define-config-plugin-types/blob/main/LICENSE">
9+
<img alt="License: MIT" src="https://img.shields.io/github/license/eslint-types/define-config-plugin-types.svg">
10+
</a>
11+
<a href="https://www.paypal.com/donate?hosted_button_id=L7GY729FBKTZY" target="_blank">
12+
<img alt="Donate: PayPal" src="https://img.shields.io/badge/Donate-PayPal-blue.svg">
13+
</a>
14+
</p>
15+
16+
# @eslint-types/deprecation
17+
18+
## Install
19+
20+
```sh
21+
npm install -D @eslint-types/deprecation
22+
```
23+
24+
## Usage
25+
26+
```js
27+
// @ts-check
28+
const { defineConfig } = require('eslint-define-config');
29+
30+
/// <reference types="@eslint-types/deprecation" />
31+
32+
module.exports = defineConfig({
33+
// ...
34+
});
35+
```

types/import/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<p>
2+
<a href="https://www.npmjs.com/package/@eslint-types/import" target="_blank">
3+
<img alt="NPM package" src="https://img.shields.io/npm/v/@eslint-types/import.svg">
4+
</a>
5+
<a href="https://www.npmjs.com/package/@eslint-types/import" target="_blank">
6+
<img alt="Downloads" src="https://img.shields.io/npm/dt/@eslint-types/import.svg">
7+
</a>
8+
<a href="https://github.com/eslint-types/define-config-plugin-types/blob/main/LICENSE">
9+
<img alt="License: MIT" src="https://img.shields.io/github/license/eslint-types/define-config-plugin-types.svg">
10+
</a>
11+
<a href="https://www.paypal.com/donate?hosted_button_id=L7GY729FBKTZY" target="_blank">
12+
<img alt="Donate: PayPal" src="https://img.shields.io/badge/Donate-PayPal-blue.svg">
13+
</a>
14+
</p>
15+
16+
# @eslint-types/import
17+
18+
## Install
19+
20+
```sh
21+
npm install -D @eslint-types/import
22+
```
23+
24+
## Usage
25+
26+
```js
27+
// @ts-check
28+
const { defineConfig } = require('eslint-define-config');
29+
30+
/// <reference types="@eslint-types/import" />
31+
32+
module.exports = defineConfig({
33+
// ...
34+
});
35+
```

types/jsdoc/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<p>
2+
<a href="https://www.npmjs.com/package/@eslint-types/jsdoc" target="_blank">
3+
<img alt="NPM package" src="https://img.shields.io/npm/v/@eslint-types/jsdoc.svg">
4+
</a>
5+
<a href="https://www.npmjs.com/package/@eslint-types/jsdoc" target="_blank">
6+
<img alt="Downloads" src="https://img.shields.io/npm/dt/@eslint-types/jsdoc.svg">
7+
</a>
8+
<a href="https://github.com/eslint-types/define-config-plugin-types/blob/main/LICENSE">
9+
<img alt="License: MIT" src="https://img.shields.io/github/license/eslint-types/define-config-plugin-types.svg">
10+
</a>
11+
<a href="https://www.paypal.com/donate?hosted_button_id=L7GY729FBKTZY" target="_blank">
12+
<img alt="Donate: PayPal" src="https://img.shields.io/badge/Donate-PayPal-blue.svg">
13+
</a>
14+
</p>
15+
16+
# @eslint-types/jsdoc
17+
18+
## Install
19+
20+
```sh
21+
npm install -D @eslint-types/jsdoc
22+
```
23+
24+
## Usage
25+
26+
```js
27+
// @ts-check
28+
const { defineConfig } = require('eslint-define-config');
29+
30+
/// <reference types="@eslint-types/jsdoc" />
31+
32+
module.exports = defineConfig({
33+
// ...
34+
});
35+
```

types/typescript-eslint/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<p>
2+
<a href="https://www.npmjs.com/package/@eslint-types/typescript-eslint" target="_blank">
3+
<img alt="NPM package" src="https://img.shields.io/npm/v/@eslint-types/typescript-eslint.svg">
4+
</a>
5+
<a href="https://www.npmjs.com/package/@eslint-types/typescript-eslint" target="_blank">
6+
<img alt="Downloads" src="https://img.shields.io/npm/dt/@eslint-types/typescript-eslint.svg">
7+
</a>
8+
<a href="https://github.com/eslint-types/define-config-plugin-types/blob/main/LICENSE">
9+
<img alt="License: MIT" src="https://img.shields.io/github/license/eslint-types/define-config-plugin-types.svg">
10+
</a>
11+
<a href="https://www.paypal.com/donate?hosted_button_id=L7GY729FBKTZY" target="_blank">
12+
<img alt="Donate: PayPal" src="https://img.shields.io/badge/Donate-PayPal-blue.svg">
13+
</a>
14+
</p>
15+
16+
# @eslint-types/typescript-eslint
17+
18+
## Install
19+
20+
```sh
21+
npm install -D @eslint-types/typescript-eslint
22+
```
23+
24+
## Usage
25+
26+
```js
27+
// @ts-check
28+
const { defineConfig } = require('eslint-define-config');
29+
30+
/// <reference types="@eslint-types/typescript-eslint" />
31+
32+
module.exports = defineConfig({
33+
// ...
34+
});
35+
```

0 commit comments

Comments
 (0)