@kizahasi/ot-string - npm Package Compare versions

Comparing version 0.2.2 to 0.2.3

dist/types/index.d.ts

@@ -1,2 +0,2 @@
-import { CustomResult } from '@kizahasi/result';
+import { Result } from '@kizahasi/result';
 export declare class PositiveInt {
@@ -91,3 +91,3 @@ private source;
         second: Operation;
-    }) => CustomResult<{
+    }) => Result<{
         firstPrime: Operation;
@@ -116,7 +116,7 @@ secondPrime: Operation;
         action: Operation;
-    }) => CustomResult<string, ApplyError<PositiveInt>>;
+    }) => Result<string, ApplyError<PositiveInt>>;
     const applyAndRestore: ({ prevState, action, }: {
         prevState: string;
         action: Operation;
-    }) => CustomResult<{
+    }) => Result<{
         nextState: string;
@@ -128,7 +128,7 @@ restored: TextTwoWayOperation.Operation;
         second: Operation;
-    }) => CustomResult<Operation, ComposeAndTransformError>;
+    }) => Result<Operation, ComposeAndTransformError>;
     const transform: ({ first, second, }: {
         first: Operation;
         second: Operation;
-    }) => CustomResult<{
+    }) => Result<{
         firstPrime: Operation;
@@ -156,7 +156,7 @@ secondPrime: Operation;
         action: Operation;
-    }) => CustomResult<string, ApplyError<PositiveInt>>;
+    }) => Result<string, ApplyError<PositiveInt>>;
     const applyBackAndRestore: ({ nextState, action, }: {
         nextState: string;
         action: Operation;
-    }) => CustomResult<{
+    }) => Result<{
         prevState: string;
@@ -168,3 +168,3 @@ restored: TextTwoWayOperation.Operation;
         second: Operation;
-    }) => CustomResult<Operation, ComposeAndTransformError>;
+    }) => Result<Operation, ComposeAndTransformError>;
     const invert: (source: Operation) => TextOperation<NonEmptyString, PositiveInt>;
@@ -171,0 +171,0 @@ const toUnit: (source: Operation) => OperationUnit[];

package.json

 {
-    "version": "0.2.2",
+    "version": "0.2.3",
     "license": "MIT",
@@ -16,5 +16,5 @@ "main": "dist/cjs/index.js",
         "test": "jest",
-        "prepare": "yarn build",
+        "prepare": "yarn build && husky install",
         "lint": "eslint src test",
-        "prettier": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\""
+        "prettier": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\" \".github/**/*.yml\""
     },
@@ -50,2 +50,3 @@ "prettier": {
         "fast-check": "^2.14.0",
+        "husky": "^7.0.0",
         "jest": "^27.0.6",
@@ -58,5 +59,6 @@ "prettier": "^2.3.2",
     "dependencies": {
-        "@kizahasi/result": "^0.3.0",
+        "@kizahasi/option": "^0.1.3",
+        "@kizahasi/result": "^1.0.0",
         "diff-match-patch": "^1.0.5"
     }
 }

README.md

 # @kizahasi/ot-string
 
+![GitHub](https://img.shields.io/github/license/kizahasi/ot-string) [![npm version](https://img.shields.io/npm/v/@kizahasi/ot-string.svg?style=flat)](https://www.npmjs.com/package/@kizahasi/ot-string) ![minified size](https://img.shields.io/bundlephobia/min/@kizahasi/ot-string) [![CI](https://github.com/kizahasi/ot-string/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/kizahasi/ot-string/actions/workflows/main.yml) [![publish](https://github.com/kizahasi/ot-string/actions/workflows/publish.yml/badge.svg?branch=release)](https://github.com/kizahasi/ot-string/actions/workflows/publish.yml)
+
 Operational Transfomation library for string.
 
-## Example
+## Installation
 
+Run `npm install @kizahasi/ot-string` or `yarn add @kizahasi/ot-string`
+
+## Usage
+
 ```typescript
@@ -8,0 +14,0 @@ import { TextTwoWayOperation, TextUpOperation, TextDownOperation } from '@kizahasi/ot-string';

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

93

increased by6.9%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

336091

decreased by-0.62%

Dependency count

3

increased by50%

Dev dependency count

13

increased by8.33%

Lines of code

2405

decreased by-0.74%

Dependency changes

• + Added@kizahasi/option@^0.1.3

• + Added@kizahasi/option@0.1.3(transitive)

• + Added@kizahasi/result@1.1.0(transitive)

• - Removed@kizahasi/result@0.3.0(transitive)

• Updated@kizahasi/result@^1.0.0