New: First release

Author: roman.vasilev

README.md

@@ -0,0 +1,35 @@
+# nest-config
+Configuration module for Nest.js (wraps [convict](https://github.com/mozilla/node-convict) module).
+
+INSTALL
+---
+```
+npm i -S nest-config
+```
+
+USAGE
+---
+```ts
+import { ConfigModule } from 'nest-config';
+import { Module } from '@nestjs/common';
+
+@Module({
+    imports: [ConfigModule.forRoot(schema: convict.Schema<T> | string)],
+})
+export class AppModule {
+}
+
+```
+
+```ts
+export class UserController {
+    
+    constructor (
+        private config: ConfigService
+    ) { }
+
+    hello() {
+        const foo = this.config.get<string>('foo');
+    }
+}
+```

package.json

@@ -3,7 +3,23 @@
   "version": "0.0.0-dev",
   "description": "Nest config module",
   "main": "dist/index.js",
-  "scripts": {},
+  "typings": "src/index.ts",
+  "engines": {
+    "node": "^8 || ^9 || ^10"
+  },
+  "scripts": {
+    "_setup": "npm i -g commitizen semantic-release-cli",
+    "mocha": "node -r ts-node/register/transpile-only node_modules/mocha/bin/_mocha",
+    "test:w": "npm run mocha -- --watch-extensions ts --watch src/**/*.spec.ts",
+    "test": "npm run test:r",
+    "test:r": "npm run mocha -- src/*.spec.ts",
+    "semantic-release": "node -r ts-node/register/transpile-only node_modules/semantic-release/bin/semantic-release.js",
+    "prepublishOnly": "npm run build",
+    "build": "tsc",
+    "prebuild": "npm run clean",
+    "clean": "rimraf dist",
+    "commit": "git-cz"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/unlight/nest-config.git"
@@ -19,14 +35,63 @@
   },
   "homepage": "https://github.com/unlight/nest-config#readme",
   "peerDependencies": {
-    "@nestjs/common": ">=5.0.0 <6"
+    "@nestjs/common": "^5"
   },
   "devDependencies": {
-    "reflect-metadata": "^0.1.12",
+    "@nestjs/common": "^5",
+    "@nestjs/core": "^5",
+    "@nestjs/testing": "^5.0.1",
+    "@semantic-release/changelog": "^2.0.2",
+    "@semantic-release/git": "^5.0.0",
+    "@semantic-release/npm": "^3.3.0",
     "@types/convict": "^4.2.0",
-    "rxjs": "^6.0.0"
+    "@types/mocha": "^5.2.0",
+    "@types/node": "^10.1.2",
+    "cz-adapter-eslint": "^0.1.2",
+    "mocha": "^5.2.0",
+    "reflect-metadata": "^0.1.12",
+    "rimraf": "^2.6.2",
+    "rxjs": "^6.2.0",
+    "semantic-release": "^15.5.0",
+    "ts-node": "^6.0.5",
+    "typescript": "^2.8.3"
   },
   "dependencies": {
-    "convict": "^4.2.0"
+    "convict": "^4.2.0",
+    "tslib": "^1.9.1"
+  },
+  "release": {
+    "generateNotes": {
+      "preset": "eslint"
+    },
+    "analyzeCommits": {
+      "preset": "eslint"
+    },
+    "verifyConditions": [
+      "@semantic-release/changelog",
+      "@semantic-release/github",
+      "@semantic-release/npm",
+      "@semantic-release/git"
+    ],
+    "prepare": [
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/git"
+    ],
+    "publish": [
+      "@semantic-release/npm",
+      "@semantic-release/github"
+    ],
+    "success": [
+      "@semantic-release/github"
+    ],
+    "fail": [
+      "@semantic-release/github"
+    ]
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-adapter-eslint"
+    }
   }
 }

src/config.module.ts

@@ -0,0 +1,20 @@
+import { Global, Module, DynamicModule, Provider } from '@nestjs/common';
+import { ConfigService } from './config.service';
+import { Schema } from 'convict';
+import convict = require('convict');
+
+@Global()
+@Module({})
+export class ConfigModule {
+    static forRoot<T = any>(schema: Schema<T> | string): DynamicModule {
+        const config = convict(schema).validate();
+        const providers: Provider[] = [
+            { provide: ConfigService, useValue: new ConfigService<T>(config) },
+        ];
+        return {
+            module: ConfigModule,
+            providers: providers,
+            exports: providers,
+        };
+    }
+}

src/config.service.spec.ts

@@ -0,0 +1,32 @@
+import { ConfigService } from './config.service';
+import { ConfigModule } from './config.module';
+import { Test, TestingModule } from '@nestjs/testing';
+import assert = require('assert');
+
+let testingModule: TestingModule;
+let configService: ConfigService;
+
+beforeEach(async () => {
+    testingModule = await Test.createTestingModule({
+        imports: [ConfigModule.forRoot({
+            a: { default: 'A' }
+        })],
+    }).compile();
+});
+
+it('smoke', () => {
+    assert(ConfigService);
+    configService = testingModule.get(ConfigService);
+    assert(configService instanceof ConfigService);
+});
+
+it('should get value key a', () => {
+    const result = configService.get<string>('a');
+    assert(result === 'A');
+});
+
+it('should fail if trying to get unknown key', () => {
+    assert.throws(() => {
+        configService.get<string>('foo');
+    }, `cannot find configuration param 'foo'`);
+});

src/config.service.ts

@@ -1,15 +1,14 @@
 import { Injectable } from '@nestjs/common';
 import * as convict from 'convict';
-import { Config } from './app.config';
 
 @Injectable()
-export class ConfigService {
+export class ConfigService<T = any> {
 
     constructor(
-        private config: convict.Config<Config>
+        private readonly config: convict.Config<T>
     ) { }
 
-    get<T = any>(key: string): T {
+    get<R = any>(key: string) {
         return this.config.get(key);
     }
 }

src/example.app.module.spec.ts

@@ -0,0 +1,8 @@
+import { ConfigModule } from './config.module';
+import { Module } from '@nestjs/common';
+
+@Module({
+    imports: [ConfigModule.forRoot({})],
+})
+export class AppModule {
+}

src/index.ts

@@ -0,0 +1,2 @@
+export { ConfigModule } from './config.module';
+export { ConfigService } from './config.service';

tsconfig.json

@@ -10,11 +10,11 @@
     // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
     // "sourceMap": true,                     /* Generates corresponding '.map' file. */
     // "outFile": "./",                       /* Concatenate and emit output to single file. */
-    // "outDir": "./",                        /* Redirect output structure to the directory. */
+    "outDir": "dist",                        /* Redirect output structure to the directory. */
     // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "removeComments": true,                /* Do not emit comments to output. */
+    "removeComments": false,                /* Do not emit comments to output. */
     // "noEmit": true,                        /* Do not emit outputs. */
-    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
     // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
     // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
 
@@ -41,7 +41,7 @@
     // "typeRoots": [],                       /* List of folders to include type definitions from. */
     // "types": [],                           /* Type declaration files to be included in compilation. */
     // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "esModuleInterop": true,                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
     // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
 
     /* Source Map Options */
@@ -51,7 +51,13 @@
     // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
 
     /* Experimental Options */
-    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
-  }
+    "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+  },
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "src/**/*.spec.ts"
+  ]
 }