@joshdb/ts-config 1.1.0-next.4e4fa02.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +3 -0
- package/README.md +53 -0
- package/package.json +49 -0
- package/tsconfig.json +10 -0
package/CHANGELOG.md
ADDED
package/README.md
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
# @joshdb/ts-config
|
|
6
|
+
|
|
7
|
+
**TypeScript configuration for all Josh Project repositories.**
|
|
8
|
+
|
|
9
|
+
[](https://github.com/josh-development/utilities/blob/main/LICENSE.md)
|
|
10
|
+
[](https://codecov.io/gh/josh-development/utilities)
|
|
11
|
+
[](https://www.npmjs.com/package/@joshdb/ts-config)
|
|
12
|
+
|
|
13
|
+
[](https://discord.gg/N7ZKH3P)
|
|
14
|
+
|
|
15
|
+
</div>
|
|
16
|
+
|
|
17
|
+
## Installation
|
|
18
|
+
|
|
19
|
+
You can use the following command to install this package, or replace `npm install` with your package manager of choice.
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
npm install @joshdb/ts-config
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Usage
|
|
26
|
+
|
|
27
|
+
Add the ESLint config to your `package.json`:
|
|
28
|
+
|
|
29
|
+
```json
|
|
30
|
+
{
|
|
31
|
+
"name": "my-project",
|
|
32
|
+
"eslintConfig": {
|
|
33
|
+
"extends": "@joshdb/ts-config"
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Or to your `.eslintrc.js` / `.eslintrc.json`:
|
|
39
|
+
|
|
40
|
+
```json
|
|
41
|
+
{
|
|
42
|
+
"extends": "@joshdb/ts-config"
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Create `tsconfig.eslint.json` next to the eslint config file, for example with content:
|
|
47
|
+
|
|
48
|
+
```json
|
|
49
|
+
{
|
|
50
|
+
"extends": "./tsconfig.base.json",
|
|
51
|
+
"include": ["src", "tests"]
|
|
52
|
+
}
|
|
53
|
+
```
|
package/package.json
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@joshdb/ts-config",
|
|
3
|
+
"version": "1.1.0-next.4e4fa02.0",
|
|
4
|
+
"description": "Standard TypeScript config for the Josh Project",
|
|
5
|
+
"author": "Évelyne Lachance <eslachance@gmail.com> (https://evie.codes/)",
|
|
6
|
+
"contributors": [
|
|
7
|
+
"Hezekiah Hendry <hezekiah.hendry@gmail.com>"
|
|
8
|
+
],
|
|
9
|
+
"main": "tsconfig.json",
|
|
10
|
+
"exports": {
|
|
11
|
+
"import": "./tsconfig.json",
|
|
12
|
+
"require": "./tsconfig.json"
|
|
13
|
+
},
|
|
14
|
+
"sideEffects": false,
|
|
15
|
+
"scripts": {
|
|
16
|
+
"bump": "cliff-jumper",
|
|
17
|
+
"check-update": "cliff-jumper --dry-run"
|
|
18
|
+
},
|
|
19
|
+
"dependencies": {
|
|
20
|
+
"@sapphire/ts-config": "^3.3.4"
|
|
21
|
+
},
|
|
22
|
+
"devDependencies": {
|
|
23
|
+
"@favware/cliff-jumper": "^1.8.8",
|
|
24
|
+
"gen-esm-wrapper": "^1.1.3",
|
|
25
|
+
"typedoc": "^0.23.19",
|
|
26
|
+
"typedoc-json-parser": "^7.0.1"
|
|
27
|
+
},
|
|
28
|
+
"repository": {
|
|
29
|
+
"type": "git",
|
|
30
|
+
"url": "git+https://github.com/josh-development/utilities.git"
|
|
31
|
+
},
|
|
32
|
+
"files": [
|
|
33
|
+
"tsconfig.json"
|
|
34
|
+
],
|
|
35
|
+
"engines": {
|
|
36
|
+
"node": ">=16.6.0",
|
|
37
|
+
"npm": ">=7"
|
|
38
|
+
},
|
|
39
|
+
"keywords": [
|
|
40
|
+
"eslint"
|
|
41
|
+
],
|
|
42
|
+
"bugs": {
|
|
43
|
+
"url": "https://github.com/josh-development/utilities/issues"
|
|
44
|
+
},
|
|
45
|
+
"homepage": "https://josh.evie.dev",
|
|
46
|
+
"publishConfig": {
|
|
47
|
+
"access": "public"
|
|
48
|
+
}
|
|
49
|
+
}
|