data-structure-typed 1.21.4 → 1.32.0

package/.auto-changelog

@@ -0,0 +1,9 @@
+{
+  "output": "CHANGELOG.md",
+  "template": "./.auto-changelog-template.hbs",
+  "ignoreCommitPattern": "Continuous Integration Build Artifacts",
+  "startingVersion": "v1.3.6",
+  "package": true,
+  "unreleased": true,
+  "commitLimit": false
+}

package/.auto-changelog-template.hbs

@@ -0,0 +1,36 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## References
+
+- [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+- [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
+- [`auto-changelog`](https://github.com/CookPete/auto-changelog)
+
+{{#each releases}}
+  {{#if tag}}
+    {{#if href}}
+      ## [{{title}}]({{href}}) ({{niceDate}})
+    {{else}}
+      ## {{title}} ({{niceDate}})
+    {{/if}}
+  {{else}}
+    ## [{{title}}](https://github.com/zrwusa/data-structure-typed/compare/{{diff}}.main) (upcoming)
+  {{/if}}
+
+  {{#if summary}}
+    {{summary}}
+  {{/if}}
+
+  {{! List merges except for dependency updates }}
+  {{#commit-list merges heading='### Changes' exclude='(Update dependency .+to .+\d+)|(Update .+to .+\d+)'}}
+    - {{message}} {{#if href}}[`#{{id}}`]({{href}}){{/if}}
+  {{/commit-list}}
+
+  {{! List merges with `Update dependency ` somewhere in the message }}
+  {{#commit-list merges heading='### Dependency Updates' message='(Update dependency .+to .+\d+)|(Update .+to .+\d+)'}}
+    - {{message}} {{#if href}}[`#{{id}}`]({{href}}){{/if}}
+  {{/commit-list}}
+
+{{/each}}

package/.eslintrc.js

@@ -0,0 +1,61 @@
+module.exports = {
+  'extends': [
+    'plugin:@typescript-eslint/recommended',
+    'prettier'
+  ],
+  'rules': {
+    'import/no-anonymous-default-export': 'off',
+    '@typescript-eslint/no-unused-vars': 'error',
+    '@typescript-eslint/ban-ts-comment': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    // add new line above comment
+    'lines-around-comment': [
+      'error',
+      {
+        'beforeLineComment': false,
+        'beforeBlockComment': true,
+        'allowBlockStart': true,
+        'allowClassStart': true,
+        'allowObjectStart': true,
+        'allowArrayStart': true
+      }
+    ],
+    // add new line above return
+    'newline-before-return': 'off',
+    // add new line below import
+    'import/newline-after-import': [
+      'error',
+      {
+        'count': 1
+      }
+    ],
+    '@typescript-eslint/ban-types': [
+      'error',
+      {
+        'extendDefaults': true,
+        'types': {
+          '{}': false
+        }
+      }
+    ]
+  },
+  'plugins': [
+    'import'
+  ],
+  'settings': {
+    'import/parsers': {
+      '@typescript-eslint/parser': [
+        '.ts'
+      ]
+    },
+    'import/resolver': {
+      'typescript': {
+        'alwaysTryTypes': true,
+        'project': [
+          './tsconfig.json'
+        ]
+      }
+    }
+  }
+}

package/.gitattributes

@@ -0,0 +1,112 @@
+# Common settings that generally should always be used with your language specific settings
+
+# Auto detect text files and perform LF normalization
+*          text=auto
+
+#
+# The above will handle all files NOT found below
+#
+
+# Documents
+*.bibtex   text diff=bibtex
+*.doc	        diff=astextplain
+*.DOC	        diff=astextplain
+*.docx          diff=astextplain
+*.DOCX          diff=astextplain
+*.dot           diff=astextplain
+*.DOT           diff=astextplain
+*.pdf           diff=astextplain
+*.PDF           diff=astextplain
+*.rtf           diff=astextplain
+*.RTF	        diff=astextplain
+*.md       text
+*.tex      text diff=tex
+*.adoc     text
+*.textile  text
+*.mustache text
+*.csv      text
+*.tab      text
+*.tsv      text
+*.txt      text
+*.sql      text
+
+# Graphics
+*.png      binary
+*.jpg      binary
+*.jpeg     binary
+*.gif      binary
+*.tif      binary
+*.tiff     binary
+*.ico      binary
+# SVG treated as an asset (binary) by default.
+*.svg      text
+# If you want to treat it as binary,
+# use the following line instead.
+# *.svg    binary
+*.eps      binary
+
+# Scripts
+*.bash     text eol=lf
+*.fish     text eol=lf
+*.sh       text eol=lf
+# These are explicitly windows files and should use crlf
+*.bat      text eol=crlf
+*.cmd      text eol=crlf
+*.ps1      text eol=crlf
+
+# Serialisation
+*.json     text
+*.toml     text
+*.xml      text
+*.yaml     text
+*.yml      text
+
+# Archives
+*.7z       binary
+*.gz       binary
+*.tar      binary
+*.tgz      binary
+*.zip      binary
+
+# Text files where line endings should be preserved
+*.patch    -text
+
+#
+# Exclude files from exporting
+#
+
+.gitattributes export-ignore
+.gitignore     export-ignore
+
+# Java sources
+*.java          text diff=java
+*.gradle        text diff=java
+*.gradle.kts    text diff=java
+
+# These files are text and should be normalized (Convert crlf => lf)
+*.css           text diff=css
+*.df            text
+*.htm           text diff=html
+*.html          text diff=html
+*.js            text
+*.jsp           text
+*.jspf          text
+*.jspx          text
+*.properties    text
+*.tld           text
+*.tag           text
+*.tagx          text
+*.xml           text
+
+# These files shouldn't be taken into account for statistics
+# since they are from external libraries
+
+
+# These files are binary and should be left untouched
+# (binary is a macro for -text -diff)
+*.class         binary
+*.dll           binary
+*.ear           binary
+*.jar           binary
+*.so            binary
+*.war           binary

package/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [19.x, 20.x]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build
+        run: npm run build
+
+      - name: Run tests
+        run: npm test

package/.prettierignore

@@ -0,0 +1,6 @@
+src/types/data-structures/abstract-binary-tree.ts
+src/types/data-structures/binary-tree.ts
+src/types/data-structures/bst.ts
+src/types/data-structures/avl-tree.ts
+src/types/data-structures/tree-multiset.ts
+src/types/data-structures/rb-tree.ts

package/.prettierrc.js

@@ -0,0 +1,16 @@
+module.exports = {
+  arrowParens: 'avoid',
+  bracketSpacing: true,
+  htmlWhitespaceSensitivity: 'css',
+  insertPragma: false,
+  bracketSameLine: false,
+  jsxSingleQuote: true,
+  printWidth: 120,
+  proseWrap: 'preserve',
+  quoteProps: 'as-needed',
+  requirePragma: false,
+  singleQuote: true,
+  tabWidth: 2,
+  trailingComma: 'none',
+  useTabs: false
+}

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## References
+
+- [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+- [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
+- [`auto-changelog`](https://github.com/CookPete/auto-changelog)
+
+## [v1.32.0](https://github.com/zrwusa/data-structure-typed/compare/v1.12.9...main) (upcoming)
+
+## [v1.12.9](https://github.com/zrwusa/data-structure-typed/compare/v1.12.8...v1.12.9) (14 August 2023)
+
+## [v1.12.8](https://github.com/zrwusa/data-structure-typed/compare/v1.3.6...v1.12.8) (14 August 2023)
+
+## v1.3.6 (21 September 2023)

package/CODE-OF-CONDUCT.md

@@ -0,0 +1,80 @@
+# Contributor Covenant Code of Conduct
+
+## Our Commitment
+
+We, as members, contributors, and leaders, solemnly pledge to ensure that participation in our community is an experience free from harassment for everyone, regardless of their age, body size, visible or invisible disabilities, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We commit to engaging in behaviors that foster an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Positive behaviors that contribute to a thriving community environment encompass:
+
+- Demonstrating empathy and kindness towards others
+- Showing respect for diverse opinions, viewpoints, and experiences
+- Providing and graciously accepting constructive feedback
+- Acknowledging mistakes, offering apologies to those affected, and learning from these experiences
+- Prioritizing the greater good of the community over individual interests
+
+Unacceptable behaviors include:
+
+- Employing sexualized language or imagery, as well as making sexual advances of any nature
+- Engaging in trolling, making insulting or derogatory comments, and launching personal or political attacks
+- Participating in public or private harassment
+- Revealing others' private information, such as physical or email addresses, without their explicit consent
+- Any other conduct that could reasonably be deemed inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders bear the responsibility of clarifying and enforcing our standards of acceptable behavior. They will take fair and appropriate corrective actions in response to any behavior they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the authority and duty to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that do not align with this Code of Conduct. They will communicate the reasons for moderation decisions when deemed necessary.
+
+## Scope
+
+This Code of Conduct is applicable in all community spaces and extends to instances when an individual officially represents the community in public spaces. Examples of representing our community include using an official email address, posting through an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at zrwusa@gmail.com. All complaints will be promptly and fairly reviewed and investigated.
+
+All community leaders are obligated to uphold the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will adhere to these Community Impact Guidelines when determining consequences for actions that violate this Code of Conduct:
+
+### Correction
+
+Community Impact: The use of inappropriate language or other unprofessional or unwelcome behavior within the community.
+
+Consequence: A private, written warning from community leaders, providing clarity regarding the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### Warning
+
+Community Impact: A violation through a single incident or a series of actions.
+
+Consequence: A warning with consequences for continued behavior. No interaction with the individuals involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed for a specified period of time. This includes refraining from interactions in community spaces as well as external channels like social media. Violating these terms may result in a temporary or permanent ban.
+
+### Temporary Ban
+
+Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
+
+Consequence: A temporary ban from any form of interaction or public communication with the community for a specified period. No public or private interaction with the individuals involved, including unsolicited interaction with those enforcing the Code of Conduct, is permitted during this time. Violating these terms may lead to a permanent ban.
+
+### Permanent Ban
+
+Community Impact: Demonstrating a pattern of violating community standards, including sustained inappropriate behavior, harassment of an individual, or aggression towards or disparagement of classes of individuals.
+
+Consequence: A permanent ban from any form of public interaction within the community.
+
+[//]: # (## Attribution)
+
+[//]: # ()
+[//]: # (The Community Impact Guidelines drew inspiration from Mozilla's code of conduct enforcement ladder.)
+
+[//]: # ()
+[//]: # (For answers to common questions about this code of conduct, please refer to the FAQ at https://www.zrwusa.org/faq.)
+
+[//]: # ()
+[//]: # (Translations are available at https://www.zrwusa.org/translations.)

package/COMMANDS.md

@@ -0,0 +1,28 @@
+# Commands
+
+Overview of the commands to test, run and build this project as well as those that were used to set up it.
+
+## Most important commands for development
+
+- `npm install` Installs all dependencies and creates the folder `node_modules`, that is needed for all following commands.
+- `npm run changelog` Update CHANGELOG.md
+- `npm login` + `npm publish` To publish a new release. Be sure to run npm run package first.
+
+## Commands to test, run and build the project
+
+- `npm test` Run all unit tests (using Jest) with reporting coverage
+
+[//]: # (- `npm run coverage-badge` Updates code coverage badge inside `README.md`)
+- `npm run build:docs` Generates JSDoc Documentation in folder "docs"
+- `npm run build` Build the application for production including es6(ESModule), es5(CommonJS) and minification(UMD)
+
+## Commands used to set up the project
+
+- `npm audit fix` Fixes vulnerabilities
+- `npm install typedoc --save-dev` Setup TypeScript Documentation (typedoc)
+- `npm install eslint --save-dev` Setup linter (static code quality analyzer)
+- `npx eslint --init` Initialize linter configuration file
+
+## References
+
+- [ESLint - Getting Started](https://eslint.org/docs/user-guide/getting-started)