noderaft v2.1.0

Noderaft

Problem:

Imagine if you have a million js drafts/demos/whatever and have to deal with: 1. Storing it somewhere 1. Sorting it somehow 1. Extracting and executing certain parts of it

Solution:

Noderaft is the useful tool that allows you to store your js-things in one place, group them and execute (certain parts | all together)

Installation

All you have to do to get it running is 1. Create a folder for your js-things mkdir drafts 1. Open that folder cd drafts 1. Initialize empty repo npm init -y 1. Install sandbox npm install noderaft. It will create a src folder in your drafts project folder.

Primary concepts

• Module is just a file in your src folder where your drafts live
  • Module has one or multiple sections
  • Each module should export an object with ModuleShape
• Section is a field of ModuleShape
  • KEY will be the name of section
  • VALUE is function to be executed
• ModuleShape

module.exports = {
  'section-name': () => {
    console.log('code to be executed');
  }
}

• Helpers. You can use helpers, defined in global object like below.

module.exports = {
  'section-example-1': () => {
    const instruction = 'execute your code here';
    white({ instruction });
    green('write logs in different colors');
    yellow('create as many sections as you need');
    black('section is just an object value (function to be executed)');
    red('object key used to determine different code sections');
    blue('comment here');
  },
  'my-custom-section': () => {
    green('separate module code to any sections as you want');

    divide('divide blocks to separate code in any section');
    empty();
    // shortcut for empty string
    yellow('explore objects in depth');
    const a = { b: { c: { d: { e: { f: { g: { h: 'basta' } } } } } } };
    red(a);
    green(depth(a));
  },
};

Examples of usage

After you get prev step done, you can simply use it by 2 commands: start and create

npx nd create examples1 functions arrays

creates the file examples1.js with sections 'functions' and 'arrays'

npx nd create examples2

creates the file examples2.js with one 'main' section

npx nd start examples1 functions arrays

executes the file examples1.js with sections 'functions' and 'arrays'

npx nd start examples2

executes the file examples2.js with all its sections