alignment-compass - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

jest.config.js

+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

lib/classes/test-calculator.test.ts

+import { ICompassTest } from "../types/compass-test.interface";
+import { TestCalculator } from '../classes/test-calculator.class';
+
+describe('tests', () => {
+
+    test('should calculate primitive test results correctly', () => {
+
+        const results = TestCalculator.CalculateTestResults([
+            {
+                answer: 1,
+                weights: [1, 0],
+            }
+        ])
+
+        expect(results).toStrictEqual([1, 0]);
+    });
+
+    test('should calculate a more complex test', () => {
+        
+        const results = TestCalculator.CalculateTestResults([
+            {
+                answer: 1,
+                weights: [1, 0],
+            },
+            {
+                answer: 0.5,
+                weights: [0, 1],
+            },
+            {
+                answer: -1,
+                weights: [0.5, -1],
+            },
+            {
+                answer: -0.5,
+                weights: [-1, 1],
+            }
+        ]);
+
+        expect(results).toStrictEqual([0.4, 0.3333333333333333]);
+
+    });
+
+});

lib/types/compass-test-result.interface.ts

+// Code Written by CodingVampyre 2021; Licensed under MIT
+
+export type ICompassTestResult = [number, number];

lib/classes/test-calculator.class.ts

 // Code Written by CodingVampyre 2021; Licensed under MIT
 
 import { IAnsweredAnswer } from "../types/answered-answer.interface";
+import { ICompassTestResult } from "../types/compass-test-result.interface";
 
@@ -12,3 +13,3 @@ /** Used to calculate test results */
 	 */
-	public static CalculateTestResults(answers: IAnsweredAnswer[]) {
+	public static CalculateTestResults(answers: IAnsweredAnswer[]): ICompassTestResult {
 		// Calculate Max value on each axis
@@ -15,0 +16,0 @@ let max = [0, 0];

lib/index.ts

@@ -8,1 +8,2 @@ // Test Calculator
 export * from './types/compass-test.interface';
+export * from './types/compass-test-result.interface';

package.json

 {
   "name": "alignment-compass",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "a library to create compass tests",
-  "main": "index.js",
+  "main": "dist/index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest"
   },
   "keywords": [],
   "author": "",
-  "license": "ISC"
+  "license": "ISC",
+  "devDependencies": {
+    "@types/jest": "^26.0.20",
+    "jest": "^26.6.3",
+    "ts-jest": "^26.5.0",
+    "typescript": "^4.1.3"
+  }
 }

README.md

 # alignment-compass
- a library to create compass tests
+
+## Description
+Alignment-Compass-Tests are tests to create groups to align an individuals position into a larger frame.
+Those compasses are models of more complex issues.
+This library shall help creating individual tests in typescript.
+I created this library out of a react compass test I was making.
+
+## How To Install
+1. Install using `npm i -s alignment-compass`
+
+## How To Use
+You need a frontend that takes an `ICompassTest` and renders a form, asking each question.
+Each question should be answered by choosing between five answers:
+
+* disagree (-1)
+* somewhat disagree (-0.5)
+* neutral/unsure (0)
+* somewhat agree (0.5)
+* agree (1)
+
+To each of this answers, an `IAnsewreredAnswer` should be created:
+
+```typescript
+const answeres: IAnsweredAnswer[] = [
+    {
+        answer: 1,
+        weights: [1, 0],
+    },
+    {
+        answer: -0.5,
+        weights: [0, 1],
+    }
+];
+```
+The `answer` Stores the value of the answer the user provided via the UI.
+It should be a value between -1 (disagree) and 1 (agree).
+
+The `weights` are used to determine which axes are influenced.
+It is an array with [X-Axis-Weight, Y-Axis-Weight] format. 
+Maximum value is calculated automatically when calculating the final result.
+
+### Examples 
+* `[1, 0]` moves the cursor 1 part in x-direction.
+* `[0, 1]` moves the cursor 1 part in y-direction.
+* `[-1, -0.5]` moves the cursor 1 part in negative x-direction and 0.5 parts in negative y direction.
+
+## Example Usage
+```typescript
+import { ICompassTest, TestCalculator } from 'alignment-compass';
+
+// This is the Test that will be rendered by your frontend
+const test: ICompassTest = {
+    name: 'Demo Test',
+    description: 'A Test just to demonstrate the Result Algorithm',
+    labels: {
+        xAxis: {
+            low: 'Low X Tier',
+            high: 'High X Tier',
+        },
+        yAxis: {
+            low: 'Low Y Tier',
+            high: 'High Y Tier',
+        },
+    },
+    questions: [
+        {
+            text: 'Do you want to score high on X tier?',
+            weights: [1, 0],
+        },
+        {
+            text: 'Do you want to score high on Y tier?',
+            weights: [0, 1],
+        }
+    ]
+}
+
+// This part is technology specific and should be written by you
+// It can be a react/angular component or an API.
+const answers: IAnsweredAnswer[] = MyUi.createTestUI(test).startTest();
+
+// Now, you can use there answeres to calculate the final result.
+const result: ICompassTestResult = TestCalculator.CalculateTestResults(answers);
+
+// Print Results
+console.log(`Your result is X=${result[0]} and Y=${result[1]}`);
+```

Fixed alerts

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9549

82.65%

Number of package files

13

30%

Lines of code

153

36.61%

Number of low quality alerts

1

-50%

Number of lines in readme file

88

2833.33%

Worsened metrics

Dev dependency count

4

Infinity%

No dependency changes