noda

noda

NOde Developing Assistant

Table of contents

• Get Started
• API
• Examples
• Why noda
• Honorable Dependents
• About
• References

Links

• CHANGE LOG
• Homepage

Get Started

const noda = require('noda');

const foo = noda.inRequire('util/foo');
// require <homedir>/util/foo.js
// Here <homedir> is home directory of current node.js package(module).

const bar = noda.osRequire('./foo/bar');
// require ./foo/bar/<platform>.js
// Here platform equals to the returned value of os.platform().

const lib = noda.requireDir('./lib');
// require all sub modules in ./lib and return a hash object

API

Before read APIs, please understand that

• The phrase "current package" refers to the NPM package which contains the nodejs file where code noda.* located.
• Parameter subpath refers to pathname relative to the basepath of "current package".

• noda.currentPackage()
  Return the object parsed from package.json which belongs to current package.

• noda.inExists(string subpath, boolean resolveAsModule)
  Judge whether file or directory exists. If resolveAsModule set true, subpath will be tentatively regarded as JS/JSON module path in the current package when the exact file not exists.
  This method is synchronuous.

• noda.inRead(string subpath [, string encoding, boolean nullIfNotFound ])
  Read content of file.

• noda.inRequire(string subpath)
  Require js or json.

• noda.inRequireDir(string dirname, Array | string ignores)
  Based on requireDir(), but the dirname is regarded as relative path to home directory of the package in which the caller is located.

  ignores includes those that SHOULD NOT be required. If '*/' contained in ignores, all sub directories will not be required whether or not index.js exists in the sub directories. If '*' contained in ignores, all .js files will not be required.

• noda.inResolve(string subpath)
  Resolve the subpath into an absolute path.

• noda.osRequire(string dirname)
  Require module whose name is same with the name of current platform. Relative dirname is acceptable.

• noda.requireDir(string dirname, Array | string ignores)
  Read the directory and require all javascript modules except those excluded, and returned them in an object with keys equal to modules' name. Relative dirname is acceptable.
  ATTENTION：Directory "node_modules" is always ignored whether or not it is explictly added in ignores.

• noda.existsInPackage
  Alias of noda.inExists.

• noda.readInPackage
  Alias of noda.inRead.

• noda.requireInPackage
  Alias of noda.inRequire.

• noda.requireDirInPackage
  Alias of noda.inRequireDir.

• noda.resolveInPackage
  Alias of noda.inResolve.

Examples

Suppose that there is an NPM package named ching:

+ ching
  + bin
  + command
  + lib
  + node_modules
  + util
  . CHANGELOG.md
  . conf.js
  . index.js
  . package.json
  . README.md

Let's see what noda can do.

// FILE: ching/command/init/index.js
const noda = require('noda');

// Read ching/package.json and return the parsed JSON object.
noda.currentPackage();

// Require ching/util/rc.js and return.
noda.inRequire('util/rc');

Why noda

Honorable Dependents

About

References