@dekproject/scope

@dekproject/scope

Scope global driver

What does the CLI do?

• Creates a global scope
• Keep accessible properties in all scripts that perform import
• Eliminates the need to import previously imported modules
• Simple plugin importation
• Imports controllers and routes

Instalation

To install we recommend using the Yarn

$ yarn add @dekproject/scope --save

Functions

The scope has 3 basic functions, SET, GET and USE, and the last one receives an object that will be incorporated

import { $ } from "@dekproject/scope";

$.set("name", "Bob");
console.log($.name);

$.use({
    age: 26,
    email: "[e-mail]";
});

console.log($.name, $.age, $.email);

Wait

You can request a dependency wait to perform the debug action

import { $ } from "@dekproject/scope";

setTimeout(() => {
    $.set("name", "Bob");
    console.log("set name:", $.name);
}, 2000);

$.wait(["name"], 5000).then(() => {
    console.log(`The 'name' was loaded: ${$.name}`);
}).catch((err) => {
    console.log(err);
    process.exit(1);
});

Plugins

There are a number of plugins that can be added to the scope available at https://github.com/dekproject, which is intended to facilitate integration with other services that require configuration or prior upload for use such as MongoDB, Redis, Elastic Search and others.

In the example below we will import the Mongoose plugin:

$ yarn add @dekproject/mongoose dotenv --save
$ nano .env

.env

MONGO_HOST=localhost
MONGO_PORT=27017
MONGO_DB=test

import express from "express";
import dotenv from "dotenv";
import { $, plugins, routes } from "@dekproject/scope";

(async () => {
    dotenv.config();
    await plugins("node_modules/@dekproject");

    $.wait(["mongoose"], 5000).then(() => {
        app.use(await routes("./routes"));
    }).catch((err) => {
        console.log(err);
        process.exit(1);
    });
})();

models/user.js

import mongoose from "mongoose";

export default mongoose.model("User", new mongoose.Schema({
    name: { type: String, required: true },
    user: { type: String, required: true, index: true, unique: true },
    pass: { type: String, required: true, trim: true },
}, { collection: "users" }));

controllers/user.js

import User from "../models/user";

export let getUser = (req, res) => {
    User.findById(req.params.id, (err, user) => {
        if(err) console.error(err);
        else console.log(user);
    });
}

routes/user.js

import { getUser } from "../controllers/user";

export default async (router) => {
    router.route("/user/:id").get(getUser);
};

Build

To make changes in code and buildar for testing use the command

$ yarn build