feat: initial commit

- add assert
- add type helpers: Equals, Extends, HasProperties

.gitignore

@@ -0,0 +1,3 @@
+dist/
+node_modules/
+yarn.lock

README.md

@@ -0,0 +1,50 @@
+# typescript-test-utils
+
+Helper types for testing your package exported types
+
+- Only depends on typescript installed.
+- Easly extendable
+
+## Usage
+
+You test them with the assert method ( wich is just a placeholder, it doesn't run anything ) and the type helpers
+
+```ts
+import { assert, HasProperties } from "typescript-test-utils";
+
+assert<true>(true); // ok
+assert<false>(true); // nop
+
+type MyType = { a: string };
+assert<HasProperties<MyType, "a">>(true); // ok
+assert<HasProperties<MyType, "a">>(false); // nop
+assert<HasProperties<MyType, "b">>(true); // nop
+assert<HasProperties<MyType, "b">>(false); // ok
+```
+
+And just run tsc on your test files to check for type errors
+
+```json
+{
+  "scripts": {
+    "test": "tsc --noEmit src/*.test.ts"
+  }
+}
+```
+
+## Assertions
+
+There are currently some implemented, if you have any idea for a new one send a PR or open an issue
+
+```ts
+import { assert, HasProperties, Extends, Equals } from "typescript-test-utils";
+
+HasProperties<{ a: string, b: number }, "a" | "b"> // true
+assert<HasProperties<{ a: string, b: number }, "a" | "c">>(true) // false
+
+Extends<{ a: string, b: string >, { a: string }> // true
+Extends<{ a: string, b: string >, { c: string }> // false
+
+Equals<{ a: string }, { a: string }> // true
+Equals<{ a: string, b: string }, { a: string }> // false
+```

package.json

@@ -0,0 +1,46 @@
+{
+  "name": "typescript-test-utils",
+  "version": "1.0.0",
+  "keywords": [
+    "test",
+    "types",
+    "typescript"
+  ],
+  "license": "MIT",
+  "author": "Daniel Perez Alvarez <danielpza@protonmail.com>",
+  "files": [
+    "dist"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "prebuild": "rm -rf dist",
+    "build": "tsc",
+    "prepare": "npm run build",
+    "test": "tsc --noEmit src/*.test.ts"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "npm test && pretty-quick --staged",
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+    }
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^7.2.1",
+    "@commitlint/config-conventional": "^7.1.2",
+    "husky": "^1.1.3",
+    "prettier": "^1.14.3",
+    "pretty-quick": "^1.8.0",
+    "standard-version": "^4.4.0",
+    "typescript": "^3.1.6"
+  },
+  "description": "Helper types for testing your package exported types",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/danielpa9708/typescript-test-utils.git"
+  },
+  "bugs": {
+    "url": "https://github.com/danielpa9708/typescript-test-utils/issues"
+  },
+  "homepage": "https://github.com/danielpa9708/typescript-test-utils#readme"
+}

src/index.test.ts

@@ -0,0 +1,11 @@
+import { assert, HasProperties, Extends, Equals } from "./index";
+
+type DataType = { a: string; b: string };
+
+assert<HasProperties<DataType, "a">>(true);
+assert<HasProperties<DataType, "a" | "b">>(true);
+assert<HasProperties<DataType, "a" | "b" | "c">>(false);
+assert<HasProperties<DataType, "c">>(false);
+assert<Extends<DataType, { c: string }>>(false);
+assert<Extends<DataType, { a: string; b: string }>>(true);
+assert<Equals<DataType, { a: string; b: string }>>(true);

src/index.ts

@@ -0,0 +1,10 @@
+type IndexType = string | number | symbol;
+type ObjectWithProperties<K extends IndexType> = { [id in K]: any };
+export type Equals<T, K> = T extends K ? (K extends T ? true : false) : false;
+export type Extends<T, K> = T extends K ? true : false;
+export type HasProperties<T, K extends IndexType> = Extends<
+  T,
+  ObjectWithProperties<K>
+>;
+
+export function assert<T>(expected: T) {}

tsconfig.json

@@ -0,0 +1,60 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    "target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */,
+    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    "declaration": true /* Generates corresponding '.d.ts' file. */,
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "outDir": "./dist" /* Redirect output structure to the directory. */,
+    "rootDir": "./src" /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
+    // "composite": true,                     /* Enable project compilation */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true /* Enable all strict type-checking options. */,
+    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+  },
+  "exclude": ["**/*.test.ts"]
+}