手动符号链接(和Windows连接)

examples目录中不能包含一个node_modules，该node_modules带有指向项目根目录的符号链接吗?/因此允许示例使用require('project')，尽管这并没有删除映射，但它允许源代码使用require('project')而不是require('../../')。

我已经对此进行了测试，它确实适用于v0.6.18。

项目目录清单:

$ ls -lR project
project:
drwxr-xr-x 3 user user 4096 2012-06-02 03:51 examples
-rw-r--r-- 1 user user   49 2012-06-02 03:51 index.js

project/examples:
drwxr-xr-x 2 user user 4096 2012-06-02 03:50 node_modules
-rw-r--r-- 1 user user   20 2012-06-02 03:51 test.js

project/examples/node_modules:
lrwxrwxrwx 1 user user 6 2012-06-02 03:50 project -> ../../

index.js的内容将一个值赋给exports对象的一个属性，并调用console.log，并用一条消息声明它是必需的。test.js的内容是require('project')。

自动化的符号链接

手动创建符号链接的问题是，每次你npm ci时，你都会丢失符号链接。如果您使符号链接进程成为依赖项，那么就没有问题。

模块basetag是一个postinstall脚本，它在每次运行npm install或npm ci时创建一个名为$的符号链接(或Windows连接):

npm install --save basetag

node_modules/$ -> ..

这样，您就不需要对代码或require系统进行任何特殊修改。$成为您可以从中进行请求的根。

var foo = require('$/lib/foo.js');

如果你不喜欢使用$，而更喜欢#或其他(除了@，这是npm的一个特殊字符)，你可以fork它并进行更改。

注意:虽然Windows符号链接(到文件)需要管理员权限，但Windows连接(到目录)不需要管理员权限。这是一种安全、可靠、跨平台的解决方案。

我实现这一点的方法是创建“本地链接模块”。

的文件夹结构为例

db ¬ 
    models ¬
        index.js
    migrations
    seed
    config.json

routes ¬
    index.js
    user ¬
        index.js

如果从。/routes/user/index.js我想访问/db/models/index.js我会写

require('../../db/models/index.js')

为了使/db/models/index.js可以从任何地方访问，我在db文件夹中创建了一个名为_module_的文件夹，其中包含一个包。Json和一个main.js文件。

# package.json
{
    "name": "db", <-- change this to what you want your require name to be
    "version": "1.0.0",
    "description": "",
    "author": "",
    "repository": {},
    "main": "main.js"
}

// main.js
module.exports = require('../../db/models/index');

main.js中的路径必须是相对的，就像文件在node_modules中一样

node_modules ¬
    db ¬
        main.js

然后你可以运行npm install ./db/_module_，这将把。/db/_module_中的文件复制到。/node_modules/db中，在应用程序包的依赖项下创建一个条目。json之类的

"db": "file:db/_module_"

您现在可以在任何地方使用此包

const db = require('db');

当你运行npm install时，它会自动安装你的其他模块，工作跨平台(没有符号链接)，并且不需要第三方包。

我创建了一个名为rekiure的节点模块

它允许您在不使用相对路径的情况下进行要求

https://npmjs.org/package/rekuire

它非常容易使用

你可以在app.js中定义这样的东西:

requireFromRoot = (function(root) {
    return function(resource) {
        return require(root+"/"+resource);
    }
})(__dirname);

然后任何时候你想从根目录中要求一些东西，无论你在哪里，你只需要使用requireFromRoot而不是普通的require。到目前为止对我来说还不错。

同样的问题我遇到过很多次。这可以通过使用basetag npm包来解决。它本身不一定是必需的，只是在node_modules中创建到基本路径的符号链接时安装。

const localFile = require('$/local/file')
// instead of
const localFile = require('../../local/file')

使用$/…Prefix将始终引用相对于应用程序根目录的文件。

来源:我如何创建basetag来解决这个问题

这里有关于这个问题的很好的讨论。

我遇到了同样的架构问题:想要给我的应用程序更多的组织和内部名称空间，但没有:

将应用程序模块与外部依赖项混合，或者为特定于应用程序的代码使用私有NPM回购 使用相对要求，使得重构和理解更加困难 使用符号链接或更改节点路径，这可能会模糊源代码位置，并且不能很好地进行源代码控制

最后，我决定使用文件命名约定而不是目录来组织我的代码。结构应该是这样的:

npm-shrinkwrap.json package.json node_modules .．. src app.js app.config.js app.models.bar.js app.models.foo.js app.web.js app.web.routes.js .．.

然后在代码中:

var app_config = require('./app.config');
var app_models_foo = require('./app.models.foo');

或者只是

var config = require('./app.config');
var foo = require('./app.models.foo');

和往常一样，外部依赖项可以从node_modules中获得:

var express = require('express');

通过这种方式，所有应用程序代码都按层次结构组织成模块，相对于应用程序根，所有其他代码都可以使用。

当然，主要的缺点是在文件浏览器中，您不能展开/折叠树，就好像它实际上被组织成目录一样。但我喜欢它非常明确所有代码的来源，而且它没有使用任何“魔法”。