docs: Add Identifiers Changelog entry

.github/workflows/CreateRelease.yml

@@ -4,7 +4,6 @@ on:
     push:
         branches:
             - main
-            - 'dev/*'
         paths:
             - 'package.json'
     workflow_dispatch: # Allows manual execution of the workflow.
@@ -23,8 +22,14 @@ jobs:
               with:
                   node-version: '20.8.0'
 
-            - name: Install dependencies, run tests and build
+            - name: Install Dependencies
-              run: npm run prepare:deploy
+              run: npm install
+
+            - name: Run Tests
+              run: npm run test:verbose
+
+            - name: Build the Project
+              run: npm run build:tsc
 
             - name: Get the version
               id: get_version
@@ -72,9 +77,8 @@ jobs:
                   echo "Generating release notes from ${{ env.PREVIOUS_TAG }} to HEAD..."
                   repo_url=$(git config --get remote.origin.url)
                   notes=$(git log ${{ env.PREVIOUS_TAG }}..HEAD --pretty=format:"- [\`%h\`]($repo_url/commit/%H): %s%n")
-                  echo "See [CHANGELOG.md](./CHANGELOG.md) for more details."
+                  echo "Release notes:"
                   echo "$notes"
-                  echo ""
                   echo "### Changes in this release" > release_notes.md
                   echo "$notes" >> release_notes.md
               shell: bash
@@ -86,6 +90,17 @@ jobs:
                   git config --local user.email "actions@github.com"
               shell: bash
 
+            # - name: Create temporary branch
+            #   id: create_temp_branch
+            #   if: steps.check_version.outputs.skip_release == 'false'
+            #   run: |
+            #       git checkout --orphan release/v${{ env.VERSION }}
+            #       git reset
+            #       rm -f .gitignore
+            #       git add README.md package.json LICENSE dist/ src/ tsconfig.json
+            #       git commit -m "Prepare files for release ${{ env.VERSION }}"
+            #   shell: bash
+
             - name: Create and push tag
               id: create_tag
               if: steps.check_version.outputs.skip_release == 'false'
@@ -96,15 +111,6 @@ jobs:
                   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
               shell: bash
 
-            - name: Set Release Prerelease Flag
-              id: set_prerelease_flag
-              run: |
-                  if [[ "${{ github.ref }}" == "refs/heads/main" ]]; then
-                    echo "PRE_RELEASE=false" >> $GITHUB_ENV
-                  elif [[ "${{ github.ref }}" == refs/heads/dev/* ]]; then
-                    echo "PRE_RELEASE=true" >> $GITHUB_ENV
-                  fi
-
             - name: Release
               if: steps.check_version.outputs.skip_release == 'false'
               uses: softprops/action-gh-release@v2
@@ -112,6 +118,6 @@ jobs:
                   tag_name: ${{ env.VERSION }}
                   name: Release ${{ env.VERSION }}
                   body_path: release_notes.md
-                  prerelease: ${{ env.PRE_RELEASE }}
+                  prerelease: true
               env:
                   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/ValidateBranchName.yml

@@ -3,7 +3,7 @@ name: Validate Branch Name on Pull Request
 on:
     pull_request:
         branches:
-            - UNDEFINED
+            - main
 
 jobs:
     validate-branch-name-on-pull-request:

CHANGELOG.md

@@ -9,7 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Add pre release building to release workflow on dev/* branches an version changes.
+- feat: Add a full description of `Identifiers` as JSDoc comment.
+  This establishes the definition of what an `Identifiers` is.
 
 
 ### Deprecated

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "ts-injex",
-  "version": "0.1.0",
+  "version": "0.0.9",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "ts-injex",
-      "version": "0.1.0",
+      "version": "0.0.9",
       "license": "MIT",
       "dependencies": {
         "eslint-plugin-prettier": "^5.2.1",
@@ -18,7 +18,7 @@
         "@types/node": "^20.14.11",
         "@typescript-eslint/eslint-plugin": "^8.1.0",
         "@typescript-eslint/parser": "^8.1.0",
-        "axios": "^1.7.7",
+        "axios": "^1.7.2",
         "eslint-plugin-deprecation": "^3.0.0",
         "eslint-plugin-import": "^2.29.1",
         "eslint-plugin-jsdoc": "^50.2.2",
@@ -2026,9 +2026,9 @@
       }
     },
     "node_modules/axios": {
-      "version": "1.7.7",
+      "version": "1.7.4",
-      "resolved": "https://registry.npmjs.org/axios/-/axios-1.7.7.tgz",
+      "resolved": "https://registry.npmjs.org/axios/-/axios-1.7.4.tgz",
-      "integrity": "sha512-S4kL7XrjgBmvdGut0sN3yJxqYzrDOnivkBiN0OFs6hLiUam3UPvswUo0kqGyhqUZGEOytHyumEdXsAkgCOUf3Q==",
+      "integrity": "sha512-DukmaFRnY6AzAALSH4J2M3k6PkaC+MfaAGdEERRWcC9q3/TWQwLpHR8ZRLKTdQ3aBDL64EdluRDjJqKw+BPZEw==",
       "dev": true,
       "dependencies": {
         "follow-redirects": "^1.15.6",

package.json

@@ -22,8 +22,7 @@
     "docs:fix:coverage": "node scripts/fix-coverage-paths.cjs",
     "docs:generate:badge": "node scripts/generate-badge.cjs",
     "docs:fix:escape": "node scripts/replace-doc-escaping.cjs",
-    "version:show": "node -e \"console.log(require('./package.json').version)\"",
+    "version:show": "node -e \"console.log(require('./package.json').version)\""
-    "prepare:deploy": "npm install && npm run test:verbose && npm run build:tsc"
   },
   "repository": {
     "type": "git",
@@ -47,7 +46,7 @@
     "ts-jest": "^29.2.3",
     "typedoc": "^0.26.5",
     "istanbul-badges-readme": "^1.9.0",
-    "axios": "^1.7.7"
+    "axios": "^1.7.2"
   },
   "dependencies": {
     "eslint-plugin-prettier": "^5.2.1",

src/types/Identifier.ts

@@ -1,11 +1,35 @@
 /**
- * The dependency identifier.
+ * ## The dependency identifier
- * You can use any string as identifier.
+ *
- * To create order, it is also possible to
+ * You can use any string or Symbol as identifier. The identifier is used to
- * provide these with a separator: `GroupA.ClassZ`.
+ * register a class in the TSinjex DI (Dependency Injection) container.
- * The convection for naming is as follows:
+ * See **Hierarchical identifiers** for more information on `.` in identifiers.
- * The name should generally correspond to the interface that is relevant.
+ *
- * I.e. a class `ClassA` that implements the interface `IClassA` and is
+ * ### Hierarchical identifiers
- * registered as a dependent class is registered under the interface name `IClassA`.
+ * To create hierarchical identifiers, you can use a dot `.` as a separator.
+ * E.g. `Parent.Child` or `Parent.Child.Grandchild`.
+ *
+ * ### Merge functionality
+ * You can merge multiple dependencies into one by resolving them with
+ * a identifier that is a prefix of the actual identifiers.
+ * E.g. `Parent` resolves `Parent.*` and returns a mixin of all children.
+ * Merging will only work, if the main identifier is not registered.
+ * Grandchildren are not included in the mixin but you can use something like
+ * `Parent.Child.Grandchild` to merge all direct children of Grandchild,
+ * e.g. `Parent.Child.Grandchild.*`.
+ * If you don't want to allow merging, you must register the dependencies
+ * with the full identifier. E.g. `Parent` or `Parent.Child.Grandchild`.
+ *
+ * ### Naming convention
+ * The name of a dependency should generally correspond to the interface that is implemented.
+ * E.g. a class `ClassA` that implements the interface `IClassA` and is registered
+ * as a dependent class is registered under the interface name `IClassA`.
+ *
+ * The mixin parts of the class are registered under the interface name `IClassA.*`.
+ * E.g. `IClassA.IClassZ`, `IClassA.IClassY`, etc.
+ *
+ * #### Static/Constructor Identifier naming
+ * The identifier for a static or constructor dependency should be the same as the class name
+ * postfixed with `_`. E.g. `IClassA_` for the the static or constructor interface of class `IClassA`.
  */
 export type Identifier = string | symbol;