feat(init): 🎉 Initial commit

Author: itpropro

.eslintrc.cjs

@@ -0,0 +1,8 @@
+module.exports = {
+  extends: ['@antfu/eslint-config-ts'],
+  rules: {
+    'operator-linebreak': 'off',
+    'linebreak-style': ['error', 'unix'],
+    'eol-last': ['error', 'always'],
+  },
+}

.github/workflows/publish.yml

@@ -0,0 +1,40 @@
+name: Publish package
+on:
+  release:
+    types: [created]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 7
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "16"
+          registry-url: "https://registry.npmjs.org"
+          cache: "pnpm"
+      - run: pnpm install
+      - name: Build
+        run: pnpm run build
+      - name: Run tests
+        run: pnpm run test
+      - name: Update package.json
+        shell: pwsh
+        run: |
+          $env:RELEASE_VERSION = $env:GITHUB_REF.split('/')[2]
+          echo "RELEASE_VERSION=$env:RELEASE_VERSION" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf-8 -Append
+          $content = Get-Content .\package.json
+          $content = $content | foreach-object { $_ -replace '(?<prefix>^.+"version": ")(.+)(?<suffix>",)$', "`${prefix}$env:RELEASE_VERSION`${suffix}" } 
+          $content | foreach-object { [System.Text.RegularExpressions.Regex]::Unescape($_) } |  Out-File .\package.json -Force -Encoding ascii
+      - uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: "ci(package-json): :bookmark: Bumped package.json version to ${{ env.RELEASE_VERSION }}"
+          commit_user_email: jdamaschke@visorian.com
+          branch: main
+      - run: pnpm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test-build.yml

@@ -0,0 +1,26 @@
+name: Test and build
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, closed]
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 7
+      - name: Set node version to 16
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: pnpm
+      - run: pnpm install
+      - name: Run typecheck
+        run: pnpm run typecheck
+      - name: Run tests
+        run: pnpm run test

.gitignore

@@ -0,0 +1,8 @@
+# Dependency directories
+node_modules
+
+# Optional eslint cache
+.eslintcache
+
+# Build
+dist

.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+  "vitest.enable": true,
+  "prettier.enable": false,
+  "editor.formatOnSave": false,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  },
+  "typescript.format.semicolons": "remove",
+  "typescript.format.enable": true,
+  "typescript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis": false,
+  "typescript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets": false,
+  "typescript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBraces": true,
+  "typescript.preferences.quoteStyle": "single",
+}

CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contribution Guide
+
+Thanks for your interest in contributing, all contributions are welcome and this section should help you get started.
+
+## Local setup
+
+- Clone this repository
+- Make sure you have PNPM and Node16+ installed. We recommend using VSCode.
+- Check out a new branch for your contribution (`git checkout -b 'feature/fantastic-new-function'`)
+
+## Commit convention
+
+Before contributing, you should be familiar with the following concepts:
+
+- [Semantic Versioning](https://semver.org/)
+- [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
+- [gitmoji](https://gitmoji.dev/) - Usage of gitmoji is optional, but highly preferred. It's helping a lot with identifying the exact type of commit on first sight and has basically no overhead when using tools like `gacp`
+
+To create valid commit messages, you have to use conventional commits. For the type, it's preferred to use emojis with optional text and to use scopes where possible. We use the following defined types with optional scopes to be able to comply with semver and make automatic CHANGELOG generation and tagging/versioning possible:
+
+- build
+- chore
+- ci
+- docs
+- feat
+- fix
+- perf
+- refactor
+- revert
+- style
+- test
+
+We recommend to use a tool like [gitmoji-cli](https://github.com/carloscuesta/gitmoji-cli) or [gacp](https://github.com/vivaxy/gacp) to make following these requirements easier.
+
+Note that `fix:` and `feat:` are for code changes. For typo or document changes, use `docs:` or `chore:` instead.
+
+## Pull request
+
+If you finished your change, you can create a pull request (PR) to get them merged. If you are not familiar with the process, GitHub has a [guide on PRs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
+
+:warning: **Before creatign a PR, please make sure that you added tests for new features if you added some and that no tests are failing (`pnpm run test`).**
+
+If you are closing issues with a PR, please reference the issues in the PR description (`fix/fixes #123` where 123 is the issue id).

README.md

@@ -0,0 +1,68 @@
+# @itpropro/tree-structure-ts
+
+## Introduction
+
+This module help interacting with `Tree` structures. It is optimized to work with big trees without causing overflows. Therefore it doesn't use recursion and the implementations for `preOrder` and `postOrder` traversals use `Promise.all` for concurrency to traverse multiple nodes at ones.
+It is fully typed and has over 95% test coverage.
+
+- Zero dependency
+- Fully typed
+- Fast
+- No recursion -> no memory overflows
+
+## Installation
+
+To install the module, run the following command:
+
+```bash
+pnpm install @itpropro/tree-structure-ts
+```
+
+## Usage
+
+To create a new `Tree` instance, use the `Tree` constructor:
+
+```typescript
+const tree = new Tree('root')
+const root = tree.root
+```
+
+To add a child node to a TreeNode, use the addChild method:
+
+```typescript
+const child1 = root.addChild('child1')
+const child2 = root.addChild('child2')
+```
+
+To get all nodes in the tree below a TreeNode, use the all method:
+
+```typescript
+const nodes = root.all()
+```
+
+To traverse a tree, use the traverse method:
+
+```typescript
+root.traverse((node) => {
+  // This function is called for each node in the tree
+})
+```
+
+You can specify the traversal order by passing one of the following values to the traverse method:
+
+- breadthFirst (the default): visits nodes in breadth-first order
+- depthFirst: visits nodes in depth-first order
+- preOrder: visits the current node, then traverses the left subtree, then traverses the right subtree
+- postOrder: traverses the left subtree, then traverses the right subtree, then visits the current node
+
+for all avalaible methods and fields, please read the detailed documentation of the `Tree` and `TreeNode` class: [Class docs](modules.md).
+
+## Contribution
+
+See [Contributing Guide](https://github.com/itpropro/tree-structure-ts/blob/main/CONTRIBUTING.md).
+
+## License
+
+Made with :heart:
+
+Published under [MIT License](./LICENCE).

coverage/coverage-summary.json

@@ -0,0 +1,86 @@
+{
+  "total": {
+    "lines": {
+      "total": 238,
+      "covered": 233,
+      "skipped": 0,
+      "pct": 97.89
+    },
+    "statements": {
+      "total": 238,
+      "covered": 233,
+      "skipped": 0,
+      "pct": 97.89
+    },
+    "functions": {
+      "total": 16,
+      "covered": 16,
+      "skipped": 0,
+      "pct": 100
+    },
+    "branches": {
+      "total": 48,
+      "covered": 45,
+      "skipped": 0,
+      "pct": 93.75
+    },
+    "branchesTrue": {
+      "total": 0,
+      "covered": 0,
+      "skipped": 0,
+      "pct": "Unknown"
+    }
+  },
+  "E:\\repos\\tree-structure-ts\\src\\Tree.ts": {
+    "lines": {
+      "total": 80,
+      "covered": 79,
+      "skipped": 0,
+      "pct": 98.75
+    },
+    "functions": {
+      "total": 5,
+      "covered": 5,
+      "skipped": 0,
+      "pct": 100
+    },
+    "statements": {
+      "total": 80,
+      "covered": 79,
+      "skipped": 0,
+      "pct": 98.75
+    },
+    "branches": {
+      "total": 18,
+      "covered": 17,
+      "skipped": 0,
+      "pct": 94.44
+    }
+  },
+  "E:\\repos\\tree-structure-ts\\src\\TreeNode.ts": {
+    "lines": {
+      "total": 158,
+      "covered": 154,
+      "skipped": 0,
+      "pct": 97.46
+    },
+    "functions": {
+      "total": 11,
+      "covered": 11,
+      "skipped": 0,
+      "pct": 100
+    },
+    "statements": {
+      "total": 158,
+      "covered": 154,
+      "skipped": 0,
+      "pct": 97.46
+    },
+    "branches": {
+      "total": 30,
+      "covered": 28,
+      "skipped": 0,
+      "pct": 93.33
+    }
+  }
+}