@mstream/di - npm Package Compare versions

Comparing version 2.0.1 to 2.0.2

.eslintrc.json

@@ -25,5 +25,4 @@ {
       { "blankLine": "always", "next": "block-like", "prev": "*" }
-    ],
-    "quotes": ["error", "backtick"]
+    ]
   }
 }

CHANGELOG.md

@@ -5,4 +5,6 @@ # Changelog
 
-### 2.0.1 (2023-01-18)
+### 2.0.2 (2023-01-19)
 
+### 2.0.1 (2023-01-19)
+
 ## 2.0.0 (2023-01-18)
@@ -9,0 +11,0 @@

docs/REFERENCE.md

@@ -1,17 +0,16 @@
-<a name="module_index"></a>
+<a name="module_di"></a>
 
-## index
+## di
 
-- [index](#module_index)
+- [di](#module_di)
   - _static_
-    - [.contextBuilder()](#module_index.contextBuilder) ⇒ <code>ContextBuilder</code>
+    - [.contextBuilder()](#module_di.contextBuilder) ⇒ <code>ContextBuilder</code>
   - _inner_
-    - [~BuildFn](#module_index..BuildFn) ⇒ <code>object</code>
-    - [~RegisterFn](#module_index..RegisterFn) ⇒ <code>ContextBuilder</code>
-    - [~RegisterEagerFn](#module_index..RegisterEagerFn) ⇒ <code>ContextBuilder</code>
-    - [~ContextBuilder](#module_index..ContextBuilder) : <code>object</code>
+    - [~BuildFn](#module_di..BuildFn) ⇒ <code>object</code>
+    - [~RegisterFn](#module_di..RegisterFn) ⇒ <code>ContextBuilder</code>
+    - [~ContextBuilder](#module_di..ContextBuilder) : <code>object</code>
 
-<a name="module_index.contextBuilder"></a>
+<a name="module_di.contextBuilder"></a>
 
-### index.contextBuilder() ⇒ <code>ContextBuilder</code>
+### di.contextBuilder() ⇒ <code>ContextBuilder</code>
 
@@ -21,13 +20,13 @@ Creates a builder which allow to register
 
-**Kind**: static method of [<code>index</code>](#module_index)  
-<a name="module_index..BuildFn"></a>
+**Kind**: static method of [<code>di</code>](#module_di)  
+<a name="module_di..BuildFn"></a>
 
-### index~BuildFn ⇒ <code>object</code>
+### di~BuildFn ⇒ <code>object</code>
 
-**Kind**: inner typedef of [<code>index</code>](#module_index)  
-<a name="module_index..RegisterFn"></a>
+**Kind**: inner typedef of [<code>di</code>](#module_di)  
+<a name="module_di..RegisterFn"></a>
 
-### index~RegisterFn ⇒ <code>ContextBuilder</code>
+### di~RegisterFn ⇒ <code>ContextBuilder</code>
 
-**Kind**: inner typedef of [<code>index</code>](#module_index)
+**Kind**: inner typedef of [<code>di</code>](#module_di)
 
@@ -39,24 +38,12 @@ | Param   | Type                  |
 
-<a name="module_index..RegisterEagerFn"></a>
+<a name="module_di..ContextBuilder"></a>
 
-### index~RegisterEagerFn ⇒ <code>ContextBuilder</code>
+### di~ContextBuilder : <code>object</code>
 
-**Kind**: inner typedef of [<code>index</code>](#module_index)
-
-| Param   | Type                  |
-| ------- | --------------------- |
-| name    | <code>string</code>   |
-| creator | <code>function</code> |
-
-<a name="module_index..ContextBuilder"></a>
-
-### index~ContextBuilder : <code>object</code>
-
-**Kind**: inner typedef of [<code>index</code>](#module_index)  
+**Kind**: inner typedef of [<code>di</code>](#module_di)  
 **Properties**
 
-| Name          | Type                         | Description                                             |
-| ------------- | ---------------------------- | ------------------------------------------------------- |
-| build         | <code>BuildFn</code>         | builds a context with registered dependencies inside it |
-| register      | <code>RegisterFn</code>      | register a depenency                                    |
-| registerEager | <code>RegisterEagerFn</code> | registers an eager dependency                           |
+| Name     | Type                    | Description                                             |
+| -------- | ----------------------- | ------------------------------------------------------- |
+| build    | <code>BuildFn</code>    | builds a context with registered dependencies inside it |
+| register | <code>RegisterFn</code> | register a depenency                                    |

example/package.json

 {
-  "name": "example",
+  "name": "@mstream/di-example",
   "version": "1.0.0",
@@ -4,0 +4,0 @@ "description": "",

package.json

 {
   "name": "@mstream/di",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "",
   "private": false,
   "type": "module",
-  "main": "src/index.js",
+  "main": "src/di.js",
   "scripts": {
-    "format:docs": "prettier --write docs",
-    "format": "npm run format:docs",
-    "generate:docs": "rm -f docs/REFERENCE.md && jsdoc2md src/index.js > docs/REFERENCE.md && npm run format:docs",
+    "format:docs": "cd docs && npm run format",
+    "format:js": "prettier --write src && prettier --write test",
+    "format:md": "prettier --write *.md",
+    "format": "npm run format:docs && npm run format:js && npm run format:md",
+    "generate:docs": "cd docs && npm run generate",
     "generate": "npm run generate:docs",
     "lint:commits": "commitlint --to HEAD",
+    "lint:docs": "cd docs && npm run lint",
     "lint:example": "cd example && npm run lint",
     "lint:js": "eslint .",
     "lint:md": "markdown-link-check *.md",
-    "lint": "npx prettier --check . && npm run lint:commits && npm run lint:js && npm run lint:md && npm run lint:example",
+    "lint": "prettier --check . && npm run lint:commits && npm run lint:docs && npm run lint:js && npm run lint:md && npm run lint:example",
     "release:git": "standard-version",
@@ -40,3 +43,2 @@ "release:gh": "conventional-github-releaser",
     "eslint-config-prettier": "^8",
-    "jsdoc-to-markdown": "^8",
     "markdown-link-check": "^3",
@@ -43,0 +45,0 @@ "prettier": "^2",

README.md

@@ -7,3 +7,5 @@ # DI
 
+- [how-to guide](docs/HOW-TO.md)
 - [reference](docs/REFERENCE.md)
+- [tutorial](docs/TUTORIAL.md)
 
@@ -13,2 +15,2 @@ ## Usage Examples
 - [reference application](example/src/index.js)
-- [tests](test/index.test.js)
+- [tests](test/di.test.js)

No alert changes

Improved metrics

Total package byte prevSize

358532

101.06%

Dev dependency count

9

-10%

Number of package files

27

28.57%

Lines of code

9457

101.21%

Number of lines in readme file

15

15.38%

No dependency changes