juglans

Directories

• Directories
• Instruction
  • Install Juglans
  • QuickStart
• API Introduce
  • Set app config
  • Inject your custom injects
  • Import your plugins
  • Run app
  • Plug in communication between plug-ins
• Design Philosophy
• Injects
  • Built-in Injects
    • validator
    • events
    • reverse
    • schedule
    • status
• Plugins
  • Built-in Plugins
  • Custom your plugins
• MIT License

Instruction

Set up the application of basic measures quickly, and expand the application through plug-ins

Install Juglans

$ npm i juglans -S

QuickStart

new Juglans({ name: 'Juglans V1.0' })
.Config(config)
.Inject(inject)
.Use(function({ router }) {
  router.get('/hello', ctx => {
    ctx.status = 200
    ctx.body = {
      message: 'juglans'
    }
  })
})
.Run()

3. For more details, Please reference to juglans_template.

API Introduce

Set app config

By way of setting contructor params

new Juglans({ name: 'Juglans V1.0' })

By way of setting config function

app.Config(config)

Note: The config pass py contructor would be overided by app.config

Inject your custom injects

All injects would be provided as plugins params next by next.
Init injects by Inject function

// inject init objectd
app.Inject(inject)

Set injects by plugin ret

// inject init objectd
const plugin = ({ router }) => {
    return {
        myInject: 123
    }
}

Note1: Those injects from plugins ret only use after those plugin has been executed.
Note2: Inject entity is a object with key and value, those has same keys entity would be overided by those pass by lastly.

Import your plugins

// import plugins
app.Use(
  function({ router }) {
    router.get('/hello', ctx => {
      ctx.status = 200
      ctx.body = {
        message: 'juglans'
      }
    })
  }
)

Run app

// run app and listen callback
app.Run(({ httpProxy, config }) => {
  httpProxy.listen(utils.some(config.port, 3000), err => {
    if (!err) {
      console.log(`App:${config.name}`)
      console.log(`App:${config.NODE_ENV}`)
      console.log(`App:runing on Port:${config.port}`)
    } else {
      console.error(err)
    }
  })
})

Plug in communication between plug-ins

app.Use(function ({ router, test, events }) {
  events.on('hello', function (message) {
    console.log(message)
  })
  events.emit('hello', 'first message')
})

Design Philosophy

Injects

Built-in Injects

validator

tdegrunt/jsonschema

app.Use(function ({ validator, test, events }) {
  validator.addSchema({
    'id': '/openapi.puData',
    'type': 'object',
    'properties': {
      'app_id': {
        'type': 'string',
        'required': true
      },
      'method': {
        'type': 'string',
        'required': true
      }
    }
  }
  , '/openapi.puData')
  const validateRet = validator.validate(puData, validator.schemas['/openapi.puData'])
})

events

app.Use(function ({ router, test, events }) {
  events.on('hello', function (message) {
    console.log(message)
  })
  events.emit('hello', 'first message')
})

reverse

function isManager ({ router }) {
  router.get('/user/aux/manager', async (ctx) => {
    try {
      let username = ctx.query.username
      username = username || ctx.request.body.username
      const isManager = await userServices.isManager(username)
      ctx.status = 200
      ctx.body = { isManager }
    } catch (error) {
      logger.error(error.stack)
      ctx.status = 500
      ctx.body = { message: error.message }
    }
  })
}
app.Use(function ({ reverse, test, events }) {
  reverse.Register(isManager)
})

schedule

const defineSchedule = {
  name: 'Hello',
  corn: '*/10 * * * * *',
  job: async function () {
    console.log('Hello job!')
  }
}
app.Use(function ({ reverse, test, events }) {
 schedule.scheduleJob(defineSchedule.corn, defineSchedule.job)
})

status

Plugins

Built-in Plugins

• juglans-addition
• juglans-openapi
• juglans-captcha
• juglans-delivery
• juglans-identify
• juglans-logger
• juglans-proxy
• juglans-role
• juglans-upload

Custom your plugins

Juglans is a plugins framework that can take two different kinds of parameters as plugins:

• Common plugins

// Defined your plugins
const MyPlugin = ({ A, B }) => async ({ router, config }) => {
    // your code
}
// Use your plugins
app.Use(MyPlugin({ A: 12, B: 11 }))

• Advanced plugins

// Defined your plugins
function MyPlugin({ A, B }) {
}
MyPlugin.prototype.plugin = ({ router, config }) => {
    // your code
}
// Use your plugins
app.Use(new MyPlugin({ A: 12, B: 11 }))
// or
app.Use((new MyPlugin({ A: 12, B: 11 })).plugin)

MIT License

Copyright (c) 2018-2020 Double

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.