robins-tsconfig 1.0.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 ADDED
@@ -0,0 +1,5 @@
1
+ # changelog
2
+
3
+ ## 1.0.0 (2024-05-03)
4
+
5
+ * initial release
package/license.txt ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Robin Löffel
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/package.json ADDED
@@ -0,0 +1,24 @@
1
+ {
2
+ "name": "robins-tsconfig",
3
+ "version": "1.0.0",
4
+ "description": "this is how i like my typescript projects. you might like it too. 🫱🏼‍🫲🏽",
5
+ "keywords": [
6
+ "tsconfig"
7
+ ],
8
+ "homepage": "https://github.com/robinloeffel/robins-tsconfig",
9
+ "repository": "https://github.com/robinloeffel/robins-tsconfig",
10
+ "license": "MIT",
11
+ "author": "Robin Löffel",
12
+ "main": "tsconfig.json",
13
+ "files": [
14
+ "tsconfig.json"
15
+ ],
16
+ "dependencies": {
17
+ "@tsconfig/strictest": "^2.0.5"
18
+ },
19
+ "devDependencies": {
20
+ "eslint": "^8.57.0",
21
+ "eslint-config-sweet": "^20.0.0",
22
+ "eslint-define-config": "^2.1.0"
23
+ }
24
+ }
package/readme.md ADDED
@@ -0,0 +1,37 @@
1
+ # `robins-tsconfig`
2
+
3
+ [![latest version](https://img.shields.io/npm/v/robins-tsconfig)](https://www.npmjs.com/package/robins-tsconfig)
4
+ [![npm downloads a week](https://img.shields.io/npm/dw/robins-tsconfig)](https://www.npmjs.com/package/robins-tsconfig)
5
+ [![license](https://img.shields.io/npm/l/robins-tsconfig)](https://www.npmjs.com/package/robins-tsconfig)
6
+
7
+ > this is how i like my typescript projects. you might like it too. 🫱🏼‍🫲🏽
8
+
9
+ a quite strict [`tsconfig.json`](https://www.typescriptlang.org/tsconfig) to [extend](https://www.typescriptlang.org/tsconfig/#extends) from.
10
+
11
+ ## usage
12
+
13
+ ```sh
14
+ npm i -D robins-tsconfig
15
+ ```
16
+
17
+ ```json
18
+ {
19
+ "extends": "robins-tsconfig",
20
+ "include": ["your", "includes", "here"],
21
+ "exclude": ["your", "excludes", "here"]
22
+ }
23
+ ```
24
+
25
+ ## good to know
26
+
27
+ - the config extends from [`@tsconfig/strictest`](https://www.npmjs.com/package/@tsconfig/strictest)
28
+ - i borrowed heavily from the [tsconfig cheat sheet](https://www.totaltypescript.com/tsconfig-cheat-sheet) by [matt pocock](https://github.com/mattpocock)
29
+ - you'll have to set [`include`](https://www.typescriptlang.org/tsconfig/#include) and [`exclude`](https://www.typescriptlang.org/tsconfig/#exclude) yourself
30
+ - it assumes you're building for the browser; change [`lib`](https://www.typescriptlang.org/tsconfig/#lib) if you're not
31
+ - if you want to compile via [`tsc`](https://www.typescriptlang.org/docs/handbook/compiler-options.html), override [`noEmit`](https://www.typescriptlang.org/tsconfig/#noEmit) and [`outDir`](https://www.typescriptlang.org/tsconfig/#outDir)
32
+
33
+ you can check out the full config [here](./tsconfig.json).
34
+
35
+ ## license
36
+
37
+ [mit](./license.txt)
package/tsconfig.json ADDED
@@ -0,0 +1,16 @@
1
+ {
2
+ "extends": "@tsconfig/strictest",
3
+ "compilerOptions": {
4
+ "allowJs": true,
5
+ "esModuleInterop": true,
6
+ "forceConsistentCasingInFileNames": true,
7
+ "lib": ["esnext", "dom", "dom.iterable"],
8
+ "module": "preserve",
9
+ "moduleDetection": "force",
10
+ "noEmit": true,
11
+ "noPropertyAccessFromIndexSignature": false,
12
+ "resolveJsonModule": true,
13
+ "target": "esnext",
14
+ "verbatimModuleSyntax": true
15
+ }
16
+ }