init

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+DS_Store

.mocharc.js

@@ -0,0 +1,8 @@
+/** @type {import('mocha').MochaOptions} */
+// process.env.TS_NODE_PROJECT = 'tsconfig.json';
+module.exports = {
+  require: 'ts-node/register',
+  spec: ['tests/**/*.test.ts'],
+  'watch-files': ['src/**/*.ts', 'tests/**/*.ts'],
+  timeout: 10000
+};

.npmignore

@@ -0,0 +1,9 @@
+tests
+src
+.github
+.vscode
+node_modules
+tsconfig.json
+tsup.config.ts
+.mocharc.js
+README.md

.npmrc

@@ -0,0 +1 @@
+@operationspark.org/ts-assertion:registry=https://npm.pkg.github.com

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "cSpell.words": ["tsup"]
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Operation Spark
+
+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.

README.md

@@ -4,6 +4,121 @@ This library provides assertions for testing types
 
 ## Installation
 
+```sh
+npm install -D @operationspark.org/ts-assertion
+```
+
+## Usage
+
+### `CodeCheckerOptions`
+
+| Name          | Description                        |            |
+| ------------- | ---------------------------------- | ---------- |
+| `pathname`    | Pathname to input file             | `Optional` |
+| `globalTypes` | string of globally available types | `Optional` |
+| `globalPaths` | string of globally available paths | `Optional` |
+
+### `CodeChecker` Methods
+
+| Name     | Description                                                    | Returns |
+| -------- | -------------------------------------------------------------- | ------- |
+| `test`   | Test the code string and return a boolean if the code is valid | boolean |
+| `assert` | Test the code string. Chain `isValid()` or `isNotValid()`      | void    |
+
+### `CodeChecker` global config
+
+Set global configurations for all instances of `CodeChecker`
+
+```ts
+import { CodeChecker } from '@operationspark.org/ts-assertion';
+
+CodeChecker.config.setGlobalPaths([
+  'path/to/file.ts',
+  'path/to/other/file.d.ts'
+]); // default is []
+CodeChecker.config.setVerbose(true); // default: false
+```
+
+### Basic Usage (No Options)
+
+```ts
+import { CodeChecker } from '@operationspark.org/ts-assertion';
+
+const checker = new CodeChecker();
+
+// Test returns boolean. `true` if the code is valid
+checker.test('const str: string = "test";'); // true
+checker.test('const str: string = 1;'); // false
+
+// Assert throws an error if the code is not valid
+checker.assert('const str: string = "test";').isValid();
+
+// Assert throws an error if the code is valid
+checker.assert('const str: string = 1;').isNotValid();
+```
+
+### Advanced Usage (With Options)
+
+> `path/to/file.ts`
+>
+> ```ts
+> export type StringType = string;
+> export type NumberType = number;
+> export type BooleanType = boolean;
+> ```
+
+```ts
+import { CodeChecker } from '@operationspark.org/ts-assertion';
+
+const options:  = {
+  pathname: 'path/to/file.ts',
+  globalTypes: 'type PrimitiveType = string | number | boolean;',
+  globalPaths: ['path/to/file.ts', 'path/to/other/file.d.ts'],
+};
+type TypeNames = 'StringType' | 'NumberType' | 'BooleanType';
+const checker = new CodeChecker<TypeNames>(options);
+
+
+// Test returns boolean. `true` if the code is valid
+checker.test('const str: StringType = "test";') // true
+checker.test('const str: string = 1;') // false
+
+// Assert throws an error if the code is not valid/invalid
+checker.assert('const str: StringType = "test";').isValid();
+checker.assert('const str: string = 1;').isNotValid();
+
+// Or more specifically, just test the type in the file
+checker.test(
+  'const str: StringType = "test";',
+  'StringType'
+) // true
+checker.assert(
+  'const str: StringType = "test";', 'StringType'
+).isValid();
+```
+
+## Development
+
+### Setup
+
 ```sh
 npm install
 ```
+
+### Test
+
+```sh
+npm test
+```
+
+#### Watch
+
+```sh
+npm run test:dev
+```
+
+### Publish
+
+```sh
+npm run publish:npm
+```