@monkvision/typescript-config 4.0.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Samy Ouyahia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,43 @@
+# @monkvision/typescript-config
+This package provides the TSConfigs used in MonkJs Typescript projects. It also exports useful type declarations for
+compiling.
+
+# Install
+To install the project simply run the following command :
+
+```shell
+yarn add -D typescript @monkvision/typescript-config
+```
+
+# How to use
+To use one of the Typescript config exported by this package, place the following code in your `tsconfig.json` :
+
+```json
+{
+  "extends": "@monkvision/typescript-config/tsconfig.json",
+  "include": ["src", "test"]
+}
+```
+
+You can replace `tsconfig.json` by the name of the config file you want to use.
+
+We also recommend using a second tsconfig file used for building your sources using the command
+`tsc -p tsconfig.build.json`. The build file will specify the outDir and exclude the test files like this :
+
+```json
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "dist"
+  },
+  "exclude": ["test"]
+}
+```
+
+# Available configs
+Here is a list of available Typescript config files exported by this project :
+
+| Name                         | Usage                                        |
+|------------------------------|----------------------------------------------|
+| `tsconfig.json`              | Base configuration for TypeScript projects   |
+| `tsconfig.react.json`        | Base configuration for React projects        |

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@monkvision/typescript-config",
+  "packageManager": "yarn@3.2.4",
+  "version": "4.0.7",
+  "description": "The TSConfigs used in MonkJs TypeScript projects",
+  "author": "monkvision",
+  "license": "BSD-3-Clause-Clear",
+  "files": [
+    "tsconfig.json",
+    "tsconfig.react.json",
+    "tsconfig.react-native.json",
+    "types.d.ts",
+    "LICENSE",
+    "README.md"
+  ],
+  "types": "./types.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/monkvision/monkjs.git"
+  },
+  "keywords": [
+    "monkvision",
+    "config",
+    "typescript",
+    "tsconfig"
+  ],
+  "bugs": {
+    "url": "https://github.com/monkvision/monkjs/issues"
+  },
+  "homepage": "https://github.com/monkvision/monkjs",
+  "gitHead": "f132e4e5bc390aa304e25a05f3f72f5e1dca6b13"
+}

package/tsconfig.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Base",
+  "compileOnSave": false,
+  "compilerOptions": {
+    "allowJs": true,
+    "allowUnreachableCode": false,
+    "allowUnusedLabels": false,
+    "allowSyntheticDefaultImports": true,
+    "alwaysStrict": true,
+    "declaration": true,
+    "esModuleInterop": true,
+    "exactOptionalPropertyTypes": false,
+    "forceConsistentCasingInFileNames": false,
+    "lib": ["esnext"],
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitAny": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noImplicitThis": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": false,
+    "resolveJsonModule": true,
+    "sourceMap": true,
+    "skipLibCheck": false,
+    "strict": true,
+    "strictBindCallApply": true,
+    "strictFunctionTypes": true,
+    "strictNullChecks": true,
+    "strictPropertyInitialization": true,
+    "target": "esnext",
+    "types": ["jest", "node", "@monkvision/typescript-config"],
+    "useUnknownInCatchVariables": true
+  }
+}

package/tsconfig.react.json

@@ -0,0 +1,17 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "target": "es5",
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ],
+    "isolatedModules": true,
+    "jsx": "react-jsx",
+    "module": "commonjs",
+    "skipLibCheck": true
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "**/*.spec.ts"]
+}

package/types.d.ts

@@ -0,0 +1,34 @@
+declare module '*.svg' {
+  import React = require('react');
+  export const ReactComponent: React.FunctionComponent<React.SVGProps<SVGSVGElement>>;
+  const src: string;
+  export default src;
+}
+
+// Network Information API
+declare interface Navigator extends NavigatorNetworkInformation {}
+declare interface WorkerNavigator extends NavigatorNetworkInformation {}
+declare interface NavigatorNetworkInformation {
+  readonly connection?: NetworkInformation;
+}
+type Megabit = number;
+type Millisecond = number;
+type EffectiveConnectionType = '2g' | '3g' | '4g' | 'slow-2g';
+type ConnectionType =
+  | 'bluetooth'
+  | 'cellular'
+  | 'ethernet'
+  | 'mixed'
+  | 'none'
+  | 'other'
+  | 'unknown'
+  | 'wifi'
+  | 'wimax';
+interface NetworkInformation extends EventTarget {
+  readonly type?: ConnectionType;
+  readonly effectiveType?: EffectiveConnectionType;
+  readonly downlinkMax?: Megabit;
+  readonly downlink?: Megabit;
+  readonly rtt?: Millisecond;
+  readonly saveData?: boolean;
+}