❤
npm
Sign UpSign In

rrq

1.1.1 • Public • Published

RRQ npm version

Build Status Coverage Status

requireをルートディレクトリからの指定で呼び出せるようになります。

#before 
require('../../pathTest/c/cc/c')
 
# after 
rrq('pathTest/c/cc/c')

install

npm install rrq
touch .rrqrc

インストール後、プロジェクトルートに[.rrqrc]というファイルを作成します。空で構いません。
このファイルのある場所をルートと認識してパスを解析します。

  • ファイル名は[.rrqrc]でなくても[.rrq]で始まるものならなんでも構いません。
  • 例[.rrq][.rrqrc][.rrq.conf.yaml]等

how to use

rrq = require('rrq').require2
 
# use of require 
c1 = require('../../pathTest/c/cc/c')
c1('c1')
 
# use of rrq 
c2 = rrq('pathTest/c/cc/c')
c2('c2')
 
# get require path 
requirePath = require('rrq').requirePath
 
cpath = requirePath(__dirname,'pathTest/c/cc/c')
console.log('require:', cpath)
c3 = require(cpath)
c3('c3')
 
###
c required
c1 test ok
c2 test ok
require: ../../pathTest/c/cc/c
c3 test ok
###

require2(path)

ルートディレクトリからのパスでrequireする

rrq = require('rrq').require2
# or 
# rrq = require('rrq').require 
 
# use of require 
c1 = require('../../pathTest/c/cc/c')
c1('c1')
 
# use of rrq 
c2 = rrq('pathTest/c/cc/c')
c2('c2')

requirePath(from,to)

ルートディレクトリからのパスでrequireするパスを取得する
path.relative(from, to) と同じですが、fromを__dirname、toをルートからのパスで指定できます。
第一引数は __dirnameで固定です。 path.relative(from, to)との違いは、[../]で始まるパス以外は先頭に[./]を付与します。

rq = require('rrq')
rq.requirePath(__dirname,'pathTest/c/cc/c')
# ../../pathTest/c/cc/c 

projectRoot()

ルートディレクトリのパスを取得する

rq = require('rrq')
root = rq.projectRoot()
# or 
# root = rq.root() 
 
console.log root
 
# /Users/hoge/path/to/myProject 

confpath()

プロジェクトルートに置いたファイルのパスを取得

rq = require('rrq')
conf = rq.confpath()
 
# このファイルに設定等を書いて読み込む時に使います 
# 例 
config = require('yaml-config').readConfig(conf)

Readme

Keywords

Package Sidebar

Install

npm i rrq

Repository

github.com/mick-whats/rrq

Homepage

github.com/mick-whats/rrq

Weekly Downloads

0

Version

1.1.1

License

MIT

Last publish

Collaborators

  • whats
Try on RunKit
Report malware