Merge pull request #91 from lsndr/v1

version 1.0.0

Author: lsndr

.eslintrc.js

@@ -3,12 +3,58 @@ module.exports = {
     'eslint:recommended',
     'plugin:@typescript-eslint/recommended',
     'plugin:prettier/recommended',
+    'plugin:import/recommended',
+    'plugin:import/typescript',
   ],
   plugins: ['@typescript-eslint'],
-  rules: {
-    '@typescript-eslint/no-explicit-any': 'off',
-  },
+  ignorePatterns: ['dist', '/coverage', 'node_modules'],
   env: {
     node: true,
   },
+  overrides: [
+    {
+      files: ['*.ts'],
+      extends: [
+        'eslint:recommended',
+        'plugin:@typescript-eslint/recommended',
+        'plugin:prettier/recommended',
+        'plugin:import/recommended',
+        'plugin:import/typescript',
+      ],
+      parserOptions: {
+        project: ['tsconfig.eslint.json'],
+      },
+      rules: {
+        '@typescript-eslint/interface-name-prefix': 'off',
+        '@typescript-eslint/explicit-function-return-type': 'off',
+        '@typescript-eslint/explicit-module-boundary-types': 'off',
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/ban-ts-comment': 'off',
+        'import/no-cycle': 'error',
+        'import/no-unresolved': 'error',
+        '@typescript-eslint/no-for-in-array': 'error',
+        'no-implied-eval': 'off',
+        '@typescript-eslint/no-implied-eval': 'error',
+        '@typescript-eslint/no-misused-promises': 'error',
+        'require-await': 'off',
+        '@typescript-eslint/require-await': 'error',
+        '@typescript-eslint/restrict-plus-operands': 'error',
+        '@typescript-eslint/unbound-method': 'error',
+      },
+      settings: {
+        'import/parsers': {
+          '@typescript-eslint/parser': ['.ts'],
+        },
+        'import/resolver': {
+          typescript: {},
+        },
+      },
+    },
+    {
+      files: ['examples/**/*.ts'],
+      rules: {
+        'import/no-unresolved': 'off',
+      },
+    },
+  ],
 };

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 1.0.0 - ?
+
+- hooks removed
+- added createModule function
+- simplified and exported types
+- added ModuleRef class
+
 ## 0.1.1 - 2022-02-13
 
 - fix: hook invocation message

README.md

@@ -30,7 +30,6 @@ Each module is an isolated DI container. Modules can be used to group related de
 
 @Module({
   imports: [/* modules to import */],
-  hooks: [/* hooks */],
   providers: [/* providers */],
   exports: [/* providers and modules to export */]
 })
@@ -47,14 +46,6 @@ export class AppModule {
     // invoked after modules initialisation
   }
 
-  async beforeHooks() {
-    // invoked before hooks
-  }
-
-  async afterHooks() {
-    // invoked after hooks
-  }
-
   async beforeStop() {
     // invoked before application stops
   }
@@ -175,17 +166,9 @@ class AppModule {
 }
 ```
 
-## Hooks
-
-Hooks are constructors that can not be injected anywhere but invoked once the application has bootstrapped.
-
-For instance, hooks can be used to register routes of your web application.
-
-See [examples](https://github.com/lsndr/moject/tree/master/examples).
-
 ## App Factory
 
-Use `App` class to initialise modules and run hooks as shown below:
+Use `App` class to initialise modules and start an app as shown below:
 
 ```typescript
 import { AppModule } from './app.module';
@@ -197,7 +180,7 @@ const app = App.create(AppModule);
 app.start().catch(console.error);
 ```
 
-Once `app.start` is called, all your modules get initialised, dependencies resolved, and hooks invoked.
+Once `app.start` is called, all your modules get initialised and dependencies resolved.
 
 ## Logger