solists 0.2.0 → 0.3.0

package/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2023 Emmanuel Ferdman
+
+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.

package/README.md

@@ -1,4 +1,10 @@
-# Self-organizing lists in TypeScript
+<p align="center">
+  <a href="https://github.com/emmanuel-ferdman/solists">
+    <picture>
+      <img src="img/logo.png" height="128">
+    </picture>
+  </a>
+</p>
 
 The library provides a powerful and flexible implementation of the [self-organizing list](https://en.wikipedia.org/wiki/Self-organizing_list) data structure written in TypeScript. It offers support for multiple heuristic algorithms such as [Frequency Count](#Frequency-Count), [Move to Front](#Move-to-Front) and [Transpose](#Transpose). In addition to custom methods, the data structure also includes a selection of methods with behavior equivalent to that of JavaScript's built-in [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) data structure.
 
@@ -47,10 +53,10 @@ At the t-th item selection:
 ### Rearrange upon creation
 In literature, some self-organizing list implementations activate a heuristic after every creation operation (like `insert()`, `push()`, `unshift()`, etc.). This means that immediately after a new node is added to the list, the relevant heuristic is triggered and the list is rearranged.
 
-This library supports both of these approaches. By default, the list is only rearranged when searched. To activate the option for rearranging the list upon creation, use `rearrange_on_creation=true` when creating a new SoList instance. See the example below for more details.
+This library supports both of these approaches. By default, the list is only rearranged when searched. To activate the option for rearranging the list upon creation, use `rearrangeOnCreation=true` when creating a new SoList instance. See the example below for more details.
 
 Methods which perform rearrange of the list:
-- Rearrange upon search: `at()`, `find()`, `findIndex()`, `findLast()`, `findLastIndex()`, `includes()`, `indexOf()` and `lastIndexOf`.
+- Rearrange upon search: `at()`, `find()`, `findIndex()`, `findLast()`, `findLastIndex()`, `includes()`, `indexOf()` and `lastIndexOf()`.
 - Rearrange upon creation: `constructor` (initialization from an iterable), `insert()`, `push()` and `unshift()`.
 
 ## Installation
@@ -139,8 +145,8 @@ List of methods of SoList:
 |`includes()`|Determines whether a SoList includes a certain value among its entries|
 |`indexOf()`|Returns the first index at which a given element can be found in a SoList|
 |`insert()`|Adds an element into a specific index of a SoList|
-|`isEqual()`|Checks if the SoList is equal to a given iterable|
 |`isEmpty()`|Checks if the SoList does not contain any elements|
+|`isEqual()`|Checks if the SoList is equal to a given iterable|
 |`join()`|Joins all elements of SoList into a string separated by commas or a specified separator string|
 |`keys()`|Returns a SoList iterator object of keys|
 |`lastIndexOf()`|Returns the last index at which a given element can be found in a SoList|
@@ -166,7 +172,7 @@ Although SoList implements most of the methods of JS-Array (with identical behav
 - Unlike JS-Array, SoList does not support empty items (for example `[1,,3]`).
 - Currently, the `every()`, `filter()`, `find()`, `findIndex()`, `findLast()`, `findLastIndex()`, `flatMap()` and `some()` don't support the `thisArg` argument.
 - Unsupported JS-Array methods: `group()` and `groupToMap()`.
-- Additional custom methods of SoList: `insert()`, `isEqual()`, `isEmpty()` and `remove()`.
+- Additional custom methods of SoList: `insert()`, `isEmpty()`, `isEqual()` and `remove()`.
 
 ## Contributing
 
@@ -176,4 +182,8 @@ Please make sure to update tests as appropriate and run existing ones using:
 
 ```
 npm run test
-```
+```
+
+## License
+
+The library is freely distributable under the terms of the [MIT license](LICENSE).

package/dist/DoublyLinkedList.js

@@ -379,7 +379,7 @@ class DoublyLinkedList {
         }
         const deleted = new DoublyLinkedList();
         if (this.length > 0 && deleteCount > 0) {
-            let prev = this._getNode(start - 1);
+            const prev = this._getNode(start - 1);
             let current = prev ? prev.next : this.head;
             for (let index = 0; index < deleteCount; index += 1) {
                 deleted.push(current.value);
@@ -388,7 +388,6 @@ class DoublyLinkedList {
             }
             if (prev === null) {
                 this.head = current;
-                prev = current;
                 if (current) {
                     current.prev = null;
                 }
@@ -441,20 +440,10 @@ class DoublyLinkedList {
         for (const [index, node] of this._nodes(0, this.length)) {
             const value = node.value == null ? "" : node.value;
             if (index !== this.length - 1) {
-                if (locales == null || options == null) {
-                    result = result.concat(value.toLocaleString()) + separator;
-                }
-                else {
-                    result = result.concat(value.toLocaleString(locales, options)) + separator;
-                }
+                result = result.concat(value.toLocaleString(locales, options)) + separator;
             }
             else {
-                if (locales == null || options == null) {
-                    result = result.concat(value.toLocaleString());
-                }
-                else {
-                    result = result.concat(value.toLocaleString(locales, options));
-                }
+                result = result.concat(value.toLocaleString(locales, options));
             }
         }
         return result;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "solists",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Implementation of self-organizing lists",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -20,19 +20,20 @@
     "self-organizing-list"
   ],
   "author": "Emmanuel Ferdman",
-  "license": "ISC",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/emmanuel-ferdman/solists/issues"
   },
   "homepage": "https://github.com/emmanuel-ferdman/solists#readme",
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.46.0",
-    "@typescript-eslint/parser": "^5.46.0",
-    "eslint": "^8.29.0",
+    "@typescript-eslint/eslint-plugin": "^7.5.0",
+    "@typescript-eslint/parser": "^7.5.0",
+    "eslint": "^8.57.0",
+    "mocha": "^10.4.0",
     "nyc": "^15.1.0",
     "ts-mocha": "^10.0.0",
-    "ts-node": "^10.9.1",
-    "typescript": "^4.9.4"
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.3"
   },
   "files": [
     "dist"