add support for dynamic import

Author: zvs001

README.md

@@ -12,13 +12,15 @@ You can use it like on example below.
 App will exit if there at least on step is failed.
 Check all connections before starting server:
 
-You can create file for your services like `service-startup.ts`
+You can create file for your services like `service-startup.ts`. 
+Note that this file will be important automatically, 
+so you don't need to import it. But you can create own separate files
+
 ```typescript
-import colors from 'colors'
-import starter from 'service-startup'
+import serviceStartup from 'service-startup'
 // databases and others...
 
-export default starter([
+serviceStartup.addPrioritizedSteps([
   {
     name: 'PostgreSQL',
     onRun:  () => client.connect(),
@@ -27,24 +29,31 @@ export default starter([
     name: 'MongoDB',
     onRun: () => connectMongo(),
   },
-  {
-    name: 'Media Service',
-    envBlackList: ['test'],
-    onRun: async () => {
-      mediaApi.setCredentials(config.media)
-      await mediaApi.me.info()
-    },
+])
+```
+
+Also you can add steps from inside single library files to support dynamic import:
+
+```tsx
+// lib/media.ts
+import serviceStartup from 'service-startup'
+
+serviceStartup.addStep({
+  name: 'Media Service',
+  envBlackList: ['test'],
+  onRun: async () => {
+    mediaApi.setCredentials(config.media)
+    await mediaApi.me.info()
   },
-], {
-  successSymbol: colors.green('[READY]'),
 })
 ```
 
+
 You can use it to wait for services start at `server.ts`:
 ```typescript
-import startServices from './startServices'
+import serviceStartup from 'service-startup'
 
-startServices.then(() => {
+serviceStartup.start().then(() => {
   server.listen(3000, () => {
     console.log(`Listening port: 3000`)
   })

index.ts

@@ -1,5 +1,5 @@
-import starter from './src/starter'
+import serviceStartup from './src/startup'
 
-export * from './src/starter'
+export * from './src/startup'
 
-export default starter
+export default serviceStartup

package.json

@@ -1,6 +1,6 @@
 {
   "name": "service-startup",
-  "version": "0.1.1",
+  "version": "1.0.0",
   "description": "",
   "main": "./index",
   "scripts": {

src/classes/StepsList.ts

@@ -0,0 +1,36 @@
+import _ from 'lodash'
+
+export interface StartupStep {
+  name: string
+  onRun: Function
+  isRequired?: boolean
+  envWhiteList?: string | string[]
+  envBlackList?: string | string[]
+}
+
+
+class StepsList {
+  steps: StartupStep[] = []
+
+  addStep(step: StartupStep) {
+    if(!step) return null
+    this.steps.push(step)
+  }
+
+  addSteps(steps: StartupStep[]) {
+    steps = _.compact(steps)
+    this.steps = this.steps.concat(steps)
+  }
+
+  addPrioritizedSteps(steps: StartupStep[]) {
+    steps = _.compact(steps)
+    this.steps = steps.concat(this.steps)
+  }
+
+  getSteps(): StartupStep[] {
+    return this.steps
+  }
+}
+
+
+export default StepsList

src/executeStep.ts

@@ -1,16 +1,16 @@
 // import { Spinner } from 'cli-spinner'
-import logSymbols from 'log-symbols'
-import isEnvOk from './isEnvOk'
-import { StarterStep } from './stepsList'
+import isEnvOk from './utils/isEnvOk'
+import { StartupStep } from './classes/StepsList'
+import colors from 'colors'
 
 export interface ExecuteStepConfig {
   successSymbol?: string
   errorSymbol?: string
   env?: string
 }
 
-async function executeStep(step: StarterStep, config?: ExecuteStepConfig) {
-  const { successSymbol = logSymbols.success, errorSymbol = logSymbols.error, env = process.env.NODE_ENV } = config || { }
+async function executeStep(step: StartupStep, config?: ExecuteStepConfig) {
+  const { successSymbol = colors.green('[READY]'), errorSymbol = colors.red('[ERROR]'), env = process.env.NODE_ENV } = config || { }
 
   const {
     name = '', isRequired = true, envBlackList, envWhiteList,

src/utils/resolveUtils.ts src/lib/resolveUtils.ts

@@ -0,0 +1,29 @@
+import StepsList, { StartupStep } from './classes/StepsList'
+import executeStep, { ExecuteStepConfig } from './executeStep'
+import fileUtil from './utils/fileUtil'
+import logStartupInfo from './utils/logStartupInfo'
+
+export { StartupStep }
+export interface StarterConfig extends ExecuteStepConfig {
+}
+
+
+class ServiceStartup extends StepsList {
+  async start(config?: StarterConfig) {
+    await fileUtil.requireRootDefaultSetupFile()
+
+    logStartupInfo()
+
+    const { steps } = this
+
+    for (let i = 0; i < steps.length; i++) {
+      const step = steps[i]
+
+      await executeStep(step, config)
+    }
+  }
+}
+
+
+const serviceStartup = new ServiceStartup()
+export default serviceStartup

src/starter.ts

@@ -0,0 +1,33 @@
+import resolveUtils from '../lib/resolveUtils'
+
+function requireRootDefaultSetupFile() {
+  const path = resolveUtils.resolvePathFromRoot('service-startup')
+  try {
+    require(path)
+  } catch (e) {
+    // seems file is not created...
+  }
+}
+
+function getInfoFromRootPackageJson() {
+  const packageJsonPath  = resolveUtils.resolvePathFromRoot('package.json')
+  try {
+    const packageJson = require(packageJsonPath)
+
+    if(!packageJson) return  null
+    return {
+      name: packageJson.name,
+      version: packageJson.version,
+    }
+  } catch (e) {
+    // seems file is not created...
+  }
+
+  return  null
+}
+
+
+export default {
+  requireRootDefaultSetupFile,
+  getInfoFromRootPackageJson,
+}

src/startup.ts

@@ -0,0 +1,53 @@
+import fileUtil from './fileUtil'
+
+function buildCentralizedMessage (message: string, { txtBefore, txtAfter, length } : {
+  length: number
+  txtBefore: string,
+  txtAfter: string
+}) {
+  let msg = message
+  while (msg.length < length - (txtBefore.length + txtAfter.length)) {
+    if(msg.length % 2 === 0) {
+      msg += ' '
+    } else {
+      msg = " " + msg
+    }
+  }
+
+  return `${txtBefore}${msg}${txtAfter}`
+}
+
+function logStartupInfo() {
+  const info = fileUtil.getInfoFromRootPackageJson()
+
+  const date = new Date()
+  let logList = [
+    "********************************************************",
+    "***********             Startup             ************",
+  ]
+  let borderTxt = '***********'
+  const length = logList[0].length
+
+  if(info) {
+    const infoTxt = buildCentralizedMessage(` ${info.name} (${info.version}) `, {
+      txtAfter: borderTxt,
+      txtBefore: borderTxt,
+      length
+    })
+
+    logList.splice(2, 0, infoTxt)
+  }
+
+
+  logList.push(buildCentralizedMessage(date.toISOString(), {
+    txtAfter: borderTxt,
+    txtBefore: borderTxt,
+    length
+  }))
+  logList.push(logList[0])
+
+  console.log(logList.join('\n'))
+}
+
+
+export default logStartupInfo