@w0s/tsconfig 1.0.1 → 1.1.0

package/README.md

@@ -1,7 +1,7 @@
 # tsconfig
 
-[![npm version](https://badge.fury.io/js/%40w0s%2Ftsconfig.svg)](https://badge.fury.io/js/%40w0s%2Ftsconfig)
-[![Build Status](https://github.com/SaekiTominaga/tsconfig/actions/workflows/test.yml/badge.svg)](https://github.com/SaekiTominaga/tsconfig/actions/workflows/test.yml)
+[![npm version](https://badge.fury.io/js/%40w0s%2Ftsconfig.svg)](https://www.npmjs.com/package/@w0s/tsconfig)
+[![test status](https://github.com/SaekiTominaga/w0s/actions/workflows/ts-test.yml/badge.svg)](https://github.com/SaekiTominaga/w0s/actions/workflows/ts-test.yml)
 
 [TSConfig](https://www.typescriptlang.org/tsconfig) file used on [w0s.jp](https://w0s.jp/)
 

package/__tests__/@types/types.d.ts

@@ -0,0 +1,22 @@
+interface UserDefaults {
+	// The absence of a value represents 'system'
+	colorThemeOverride?: 'dark' | 'light';
+}
+
+interface GameSettings {
+	// Known up-front properties
+	speed: 'fast' | 'medium' | 'slow';
+	quality: 'high' | 'low';
+	// Assume anything unknown to the interface
+	// is a string.
+	[key: string]: string;
+}
+
+interface EnvironmentVars {
+	NAME: string;
+	OS: string;
+	// Unknown properties are covered by this index signature.
+	[propName: string]: string;
+}
+
+declare const env: EnvironmentVars;

package/__tests__/invalid/compilerOptions/typeChecking/01 allowUnreachableCode.ts

@@ -0,0 +1,8 @@
+export const fn = function (n: number) {
+	if (n > 5) {
+		return true;
+	} else {
+		return false;
+	}
+	return true;
+};

package/__tests__/invalid/compilerOptions/typeChecking/02 allowUnusedLabels.ts

@@ -0,0 +1,6 @@
+export const verifyAge = function (age: number) {
+	// Forgot 'return' statement
+	if (age > 18) {
+		verified: true;
+	}
+};

package/__tests__/invalid/compilerOptions/typeChecking/04 exactOptionalPropertyTypes.ts

@@ -0,0 +1,4 @@
+{
+	const settings: UserDefaults = {};
+	settings.colorThemeOverride = undefined;
+}

package/__tests__/invalid/compilerOptions/typeChecking/05 noFallthroughCasesInSwitch.ts

@@ -0,0 +1,10 @@
+{
+	const a: number = 6;
+	switch (a) {
+		case 0:
+			console.log('even');
+		case 1:
+			console.log('odd');
+			break;
+	}
+}

package/__tests__/invalid/compilerOptions/typeChecking/06 noImplicitAny.ts

@@ -0,0 +1,7 @@
+{
+	const fn = function (s) {
+		// No error?
+		console.log(s.substr(3));
+	};
+	fn(42);
+}

package/__tests__/invalid/compilerOptions/typeChecking/07 noImplicitOverride.ts

@@ -0,0 +1,11 @@
+class Album {
+	setup() {}
+}
+
+class MLAlbum extends Album {
+	override setup() {}
+}
+
+class SharedAlbum extends Album {
+	setup() {}
+}

package/__tests__/invalid/compilerOptions/typeChecking/08 noImplicitReturns.ts

@@ -0,0 +1,7 @@
+export const lookupHeadphonesManufacturer = function (color: 'blue' | 'black'): string {
+	if (color === 'blue') {
+		return 'beats';
+	} else {
+		('bose');
+	}
+};

package/__tests__/invalid/compilerOptions/typeChecking/09 noImplicitThis.ts

@@ -0,0 +1,15 @@
+class Rectangle {
+	width: number;
+	height: number;
+
+	constructor(width: number, height: number) {
+		this.width = width;
+		this.height = height;
+	}
+
+	getAreaFunction() {
+		return function () {
+			return this.width * this.height;
+		};
+	}
+}

package/__tests__/invalid/compilerOptions/typeChecking/10 noPropertyAccessFromIndexSignature.ts

@@ -0,0 +1,9 @@
+{
+	const settings: GameSettings = { speed: 'fast', quality: 'high' };
+	settings.speed;
+	settings.quality;
+
+	// Unknown key accessors are allowed on
+	// this object, and are `string`
+	settings.username;
+}

package/__tests__/invalid/compilerOptions/typeChecking/11 noUncheckedIndexedAccess.ts

@@ -0,0 +1,11 @@
+{
+	// Declared as existing
+	const sysName = env.NAME;
+	const os = env.OS;
+
+	// Not declared, but because of the index
+	// signature, then it is considered a string
+	const nodeEnv = env['NODE_ENV'];
+
+	console.debug(sysName.trim(), os.trim(), nodeEnv.trim());
+}

package/__tests__/invalid/compilerOptions/typeChecking/12 noUnusedLocals.ts

@@ -0,0 +1,5 @@
+(modelID: number) => {
+	const defaultModelID = 23;
+
+	return { type: 'keyboard', modelID };
+};

package/__tests__/invalid/compilerOptions/typeChecking/13 noUnusedParameters.ts

@@ -0,0 +1,5 @@
+(modelID: number) => {
+	const defaultModelID = 23;
+
+	return { type: 'keyboard', modelID: defaultModelID };
+};

package/__tests__/tsconfig-invalid.json

@@ -0,0 +1,11 @@
+{
+	"extends": "../tsconfig.json",
+	"include": ["@types/*.d.ts", "invalid/**/*.ts"],
+	"compilerOptions": {
+		/* Emit */
+		"noEmit": true,
+
+		/* Projects */
+		"incremental": false
+	}
+}

package/__tests__/tsconfig-valid.json

@@ -0,0 +1,11 @@
+{
+	"extends": "../tsconfig.json",
+	"include": ["@types/*.d.ts", "valid/**/*.ts"],
+	"compilerOptions": {
+		/* Emit */
+		"noEmit": true,
+
+		/* Projects */
+		"incremental": false
+	}
+}

package/__tests__/valid/compilerOptions/typeChecking/01 allowUnreachableCode.ts

@@ -0,0 +1,7 @@
+export const fn = function (n: number) {
+	if (n > 5) {
+		return true;
+	} else {
+		return false;
+	}
+};

package/__tests__/valid/compilerOptions/typeChecking/02 allowUnusedLabels.ts

@@ -0,0 +1,7 @@
+export const verifyAge = function (age: number) {
+	// Forgot 'return' statement
+	if (age > 18) {
+		return true;
+	}
+	return;
+};

package/__tests__/valid/compilerOptions/typeChecking/04 exactOptionalPropertyTypes.ts

@@ -0,0 +1,4 @@
+{
+	const settings: UserDefaults = {};
+	settings.colorThemeOverride = 'dark';
+}

package/__tests__/valid/compilerOptions/typeChecking/05 noFallthroughCasesInSwitch.ts

@@ -0,0 +1,11 @@
+{
+	const a: number = 6;
+	switch (a) {
+		case 0:
+			console.log('even');
+			break;
+		case 1:
+			console.log('odd');
+			break;
+	}
+}

package/__tests__/valid/compilerOptions/typeChecking/06 noImplicitAny.ts

@@ -0,0 +1,7 @@
+{
+	const fn = function (s: string) {
+		// No error?
+		console.log(s.substr(3));
+	};
+	fn('42');
+}

package/__tests__/valid/compilerOptions/typeChecking/07 noImplicitOverride.ts

@@ -0,0 +1,11 @@
+class Album {
+	setup() {}
+}
+
+class MLAlbum extends Album {
+	override setup() {}
+}
+
+class SharedAlbum extends Album {
+	override setup() {}
+}

package/__tests__/valid/compilerOptions/typeChecking/08 noImplicitReturns.ts

@@ -0,0 +1,8 @@
+export const lookupHeadphonesManufacturer = function (color: 'blue' | 'black'): string {
+	if (color === 'blue') {
+		return 'beats';
+	} else {
+		('bose');
+	}
+	return '';
+};

package/__tests__/valid/compilerOptions/typeChecking/09 noImplicitThis.ts

@@ -0,0 +1,15 @@
+class Rectangle {
+	width: number;
+	height: number;
+
+	constructor(width: number, height: number) {
+		this.width = width;
+		this.height = height;
+	}
+
+	getAreaFunction() {
+		return () => {
+			return this.width * this.height;
+		};
+	}
+}

package/__tests__/valid/compilerOptions/typeChecking/10 noPropertyAccessFromIndexSignature.ts

@@ -0,0 +1,7 @@
+{
+	const settings: GameSettings = { speed: 'fast', quality: 'high' };
+	settings.speed;
+	settings.quality;
+
+	settings['username'];
+}

package/__tests__/valid/compilerOptions/typeChecking/11 noUncheckedIndexedAccess.ts

@@ -0,0 +1,8 @@
+
+{
+	// Declared as existing
+	const sysName = env.NAME;
+	const os = env.OS;
+
+	console.debug(sysName.trim(), os.trim());
+}

package/__tests__/valid/compilerOptions/typeChecking/12 noUnusedLocals.ts

@@ -0,0 +1,3 @@
+(modelID: number) => {
+	return { type: 'keyboard', modelID };
+};

package/__tests__/valid/compilerOptions/typeChecking/13 noUnusedParameters.ts

@@ -0,0 +1,5 @@
+() => {
+	const defaultModelID = 23;
+
+	return { type: 'keyboard', modelID: defaultModelID };
+};

package/package.json

@@ -1,14 +1,10 @@
 {
 	"name": "@w0s/tsconfig",
-	"version": "1.0.1",
+	"version": "1.1.0",
 	"description": "TSConfig file used on w0s.jp",
 	"keywords": [
 		"tsconfig"
 	],
-	"homepage": "https://github.com/SaekiTominaga/tsconfig#readme",
-	"bugs": {
-		"url": "https://github.com/SaekiTominaga/tsconfig/issues"
-	},
 	"license": "MIT",
 	"author": "Saeki Tominaga",
 	"files": [
@@ -17,14 +13,14 @@
 	"main": "tsconfig.json",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/SaekiTominaga/tsconfig.git"
+		"url": "git+https://github.com/SaekiTominaga/w0s.git"
 	},
 	"scripts": {
 		"test": "tsc --project __tests__/tsconfig-valid.json",
 		"test-invalid": "tsc --project __tests__/tsconfig-invalid.json"
 	},
 	"devDependencies": {
-		"typescript": "^4.9.3"
+		"typescript": "^5.1.3"
 	},
 	"publishConfig": {
 		"access": "public"

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022 "><S>aekiTominaga
-
-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.