feat: migrate to typescript

.eslintrc.yml

@@ -1,19 +1,24 @@
 # https://eslint.org/docs/rules/
 
 root: true
+parser: '@typescript-eslint/parser'
 parserOptions:
-  sourceType: script
+  sourceType: module
   ecmaVersion: 2018
 env:
   es6: true
   node: true
 plugins:
   - prettier
   - import
+  - '@typescript-eslint'
+ignorePatterns:
+  - lib
+
 extends:
-  - eslint:recommended
-  - plugin:import/recommended
   - plugin:prettier/recommended
+  - plugin:@typescript-eslint/eslint-recommended
+
 rules:
   # Prettier
   prettier/prettier:
@@ -118,7 +123,7 @@ rules:
   func-names:
     - 2
     - as-needed
-  func-style: 2
+  func-style: 0
   linebreak-style: 2
   lines-between-class-members: 2
   max-len:

.gitignore

@@ -14,3 +14,4 @@ node_modules/
 pkg/*
 test/.sass-cache/
 true-*.gem
+.idea

lib/constants.d.ts

@@ -0,0 +1,22 @@
+export declare const MODULE_TOKEN = "# Module: ";
+export declare const MODULE_NESTING_TOKEN = " :: ";
+export declare const SUMMARY_TOKEN = "# SUMMARY ";
+export declare const END_SUMMARY_TOKEN = "----------";
+export declare const TEST_TOKEN = "Test: ";
+export declare const PASS_TOKEN = "\u2714 ";
+export declare const FAIL_TOKEN = "\u2716 FAILED: [";
+export declare const END_FAIL_TOKEN = "]";
+export declare const ASSERT_TOKEN = "ASSERT: ";
+export declare const FAILURE_DETAIL_TOKEN = "- ";
+export declare const FAILURE_TYPE_START_TOKEN = "[";
+export declare const FAILURE_TYPE_END_TOKEN = "]";
+export declare const OUTPUT_TOKEN = "Output: ";
+export declare const EXPECTED_TOKEN = "Expected: ";
+export declare const DETAILS_SEPARATOR_TOKEN = ": ";
+export declare const OUTPUT_START_TOKEN = "OUTPUT";
+export declare const OUTPUT_END_TOKEN = "END_OUTPUT";
+export declare const EXPECTED_START_TOKEN = "EXPECTED";
+export declare const EXPECTED_END_TOKEN = "END_EXPECTED";
+export declare const CONTAINED_START_TOKEN = "CONTAINED";
+export declare const CONTAINED_END_TOKEN = "END_CONTAINED";
+export declare const ASSERT_END_TOKEN = "END_ASSERT";

lib/index.d.ts

@@ -0,0 +1,36 @@
+import type { Options } from 'sass';
+import { Node } from 'css';
+export interface TrueOptions {
+    sass?: typeof import('sass');
+    describe: (description: string, fn: () => void) => void;
+    it: (description: string, fn: () => void) => void;
+    contextLines?: number;
+}
+export interface Assertion {
+    description: string;
+    output?: string;
+    assertionType?: string;
+    expected?: string;
+    details?: string;
+    passed?: boolean;
+}
+export interface Test {
+    test: string;
+    assertions: Assertion[];
+}
+export interface Module {
+    module: string;
+    tests: Test[];
+    modules?: Module[];
+}
+export declare type Context = {
+    modules: Module[];
+    currentModule?: Module;
+    currentTest?: Test;
+    currentAssertion?: Assertion;
+    currentOutputRules?: Node[];
+    currentExpectedRules?: Node[];
+};
+export declare function formatFailureMessage(assertion: Assertion): string;
+export declare function runSass(sassOptions: Options, trueOptions: TrueOptions): void;
+export declare function parse(rawCss: Readonly<string>, ctxLines?: Readonly<number>): Module[];