fix: types typo

README.md

@@ -75,7 +75,7 @@ The results are similar to the following:
     "name": "react",
     "in": 195657,
     "out": 1,
-    "instable": 0.000005110958918112216,
+    "instability": 0.000005110958918112216,
     "label": "Stable"
   }
 ]

src/__snapshots__/index.spec.ts.snap

@@ -5,9 +5,9 @@ Array [
   Object {
     "fanIn": 10000,
     "fanOut": 1,
+    "instability": 0.00009999000099990002,
     "label": "Stable",
     "name": "react",
-    "stability": 0.00009999000099990002,
   },
 ]
 `;
@@ -17,35 +17,35 @@ Array [
   Object {
     "fanIn": 1,
     "fanOut": 0,
-    "instable": 0,
+    "instability": 0,
     "label": "Stable",
     "name": "a",
   },
   Object {
     "fanIn": 1,
     "fanOut": 1,
-    "instable": 0.5,
+    "instability": 0.5,
     "label": "Normal",
     "name": "b",
   },
   Object {
     "fanIn": 1,
     "fanOut": 2,
-    "instable": 0.6666666666666666,
+    "instability": 0.6666666666666666,
     "label": "Flexible",
     "name": "c",
   },
   Object {
     "fanIn": 1,
     "fanOut": 3,
-    "instable": 0.75,
+    "instability": 0.75,
     "label": "Flexible",
     "name": "d",
   },
   Object {
     "fanIn": 1,
     "fanOut": 4,
-    "instable": 0.8,
+    "instability": 0.8,
     "label": "Instable",
     "name": "e",
   },

src/cli/index.spec.ts

@@ -17,7 +17,7 @@ describe('CLI tool Tests', () => {
             name: 'react',
             fanIn: 10000,
             fanOut: 1,
-            stability: 0.00009999000099990002,
+            instability: 0.00009999000099990002,
             label: 'Stable',
           },
         ],

src/cli/index.ts

@@ -5,7 +5,7 @@ import { analyze } from '../index';
 const program = new Command();
 
 async function bootstrap(argv = process.argv) {
-  program.name('sdp-analyzer').description('A cli tool for analyzing package stability').version(VERSION);
+  program.name('sdp-analyzer').description('A cli tool for analyzing package instability').version(VERSION);
   program
     .command('analyze')
     .argument('<string>', 'the local package path or a npm package name')

src/core/index.ts

@@ -1,5 +1,5 @@
 // SDP expressions:
-// Stability = Fan-out / (Fan-in + Fan-out)
+// Instability = Fan-out / (Fan-in + Fan-out)
 export function evaluate(fanOut: number, fanIn: number) {
   if (fanOut === 0 && fanIn === 0) {
     return 0;

src/platforms/npm-package/__snapshots__/index.spec.ts.snap

@@ -5,9 +5,9 @@ Array [
   Object {
     "fanIn": 10000,
     "fanOut": 0,
+    "instability": 0,
     "label": "Stable",
     "name": "lodash",
-    "stability": 0,
   },
 ]
 `;
@@ -17,16 +17,16 @@ Array [
   Object {
     "fanIn": 10000,
     "fanOut": 1,
+    "instability": 0.00009999000099990002,
     "label": "Stable",
     "name": "react",
-    "stability": 0.00009999000099990002,
   },
   Object {
     "fanIn": 10000,
     "fanOut": 5,
+    "instability": 0.0004997501249375312,
     "label": "Stable",
     "name": "vue",
-    "stability": 0.0004997501249375312,
   },
 ]
 `;
@@ -36,16 +36,16 @@ Array [
   Object {
     "fanIn": 10000,
     "fanOut": 1,
+    "instability": 0.00009999000099990002,
     "label": "Stable",
     "name": "react",
-    "stability": 0.00009999000099990002,
   },
   Object {
     "fanIn": 10000,
     "fanOut": 5,
+    "instability": 0.0004997501249375312,
     "label": "Stable",
     "name": "vue",
-    "stability": 0.0004997501249375312,
   },
 ]
 `;
@@ -55,9 +55,9 @@ Array [
   Object {
     "fanIn": 10000,
     "fanOut": 1,
+    "instability": 0.00009999000099990002,
     "label": "Stable",
     "name": "react",
-    "stability": 0.00009999000099990002,
   },
 ]
 `;

src/platforms/npm-package/index.ts

@@ -2,7 +2,7 @@ import { exec } from 'child_process';
 import nodeFetch from 'node-fetch';
 import { promisify } from 'util';
 import { load as cheerioLoad } from 'cheerio';
-import type { Dep, NpmDependency } from '../../types';
+import type { SDPResults, NpmDependency } from '../../types';
 import { evaluate } from '../../core';
 import { getStablityLabel } from '../../utils/label';
 
@@ -101,7 +101,7 @@ export async function countNpmPackageDependants(packageName: string, version: st
 }
 
 // To analyze one or multiple packages on the npm repository, like react, vue, express, etc.
-export async function analyze(packageNames: string): Promise<Dep[]> {
+export async function analyze(packageNames: string): Promise<SDPResults[]> {
   try {
     const normalizedPackageNames = packageNames.split(',');
     const depsPromises = normalizedPackageNames.map(async packageName => {
@@ -114,13 +114,13 @@ export async function analyze(packageNames: string): Promise<Dep[]> {
         countNpmPackageDependants(packageName, version),
       ]);
       const fanOut = dependencies.length;
-      const stability = fanOut === 0 ? 0 : evaluate(fanOut, dependants);
+      const instability = fanOut === 0 ? 0 : evaluate(fanOut, dependants);
       return {
         name: packageName,
         fanIn: dependants,
         fanOut,
-        stability,
-        label: getStablityLabel(stability),
+        instability,
+        label: getStablityLabel(instability),
       };
     });
 

src/platforms/workspaces/yarn/__snapshots__/index.spec.ts.snap

@@ -5,35 +5,35 @@ Array [
   Object {
     "fanIn": 1,
     "fanOut": 0,
-    "instable": 0,
+    "instability": 0,
     "label": "Stable",
     "name": "a",
   },
   Object {
     "fanIn": 1,
     "fanOut": 1,
-    "instable": 0.5,
+    "instability": 0.5,
     "label": "Normal",
     "name": "b",
   },
   Object {
     "fanIn": 1,
     "fanOut": 2,
-    "instable": 0.6666666666666666,
+    "instability": 0.6666666666666666,
     "label": "Flexible",
     "name": "c",
   },
   Object {
     "fanIn": 1,
     "fanOut": 3,
-    "instable": 0.75,
+    "instability": 0.75,
     "label": "Flexible",
     "name": "d",
   },
   Object {
     "fanIn": 1,
     "fanOut": 4,
-    "instable": 0.8,
+    "instability": 0.8,
     "label": "Instable",
     "name": "e",
   },

src/platforms/workspaces/yarn/index.ts

@@ -3,6 +3,7 @@ import fg from 'fast-glob';
 import jsonfile from 'jsonfile';
 import { evaluate } from '../../../core';
 import { getStablityLabel } from '../../../utils/label';
+import { SDPResults } from '../../../types';
 
 // To read the dependencies of a package using workspaces.
 export function readWorkspacesDependencies(packagePath: string) {
@@ -34,7 +35,7 @@ export function readWorkspacesDependencies(packagePath: string) {
 }
 
 // To analyze workspaces using Yarn package manager, such as ./my-yarn-workspaces-project
-export async function analyze(packagePath: string) {
+export async function analyze(packagePath: string): Promise<SDPResults[]> {
   try {
     const dependencyMap = readWorkspacesDependencies(packagePath);
     if (dependencyMap.length === 0) {
@@ -53,11 +54,11 @@ export async function analyze(packagePath: string) {
     });
     return Promise.resolve(
       deps.map(dep => {
-        const stablility = evaluate(dep.fanOut, dep.fanIn);
+        const instability = evaluate(dep.fanOut, dep.fanIn);
         return {
           ...dep,
-          instable: stablility,
-          label: getStablityLabel(stablility),
+          instability,
+          label: getStablityLabel(instability),
         };
       }),
     );

src/types.ts

@@ -1,8 +1,8 @@
-export interface Dep {
+export interface SDPResults {
   name: string;
   fanIn: number;
   fanOut: number;
-  stability: number;
+  instability: number;
   label: string;
 }
 export interface NpmDependency {

src/utils/label.ts

@@ -1,10 +1,10 @@
-// The label is determined based on the value of stability
-export function getStablityLabel(stablility: number) {
-  if (stablility < 0.2) {
+// The label is determined based on the value of instability
+export function getStablityLabel(instability: number) {
+  if (instability < 0.2) {
     return 'Stable';
-  } else if (stablility < 0.6) {
+  } else if (instability < 0.6) {
     return 'Normal';
-  } else if (stablility < 0.8) {
+  } else if (instability < 0.8) {
     return 'Flexible';
   } else {
     return 'Instable';