是否可以使用通配符从目录中的所有文件导入模块?
Is it possible to import modules from all files in a directory, using a wildcard?
使用 ES6,我可以像这样从一个文件中导入多个导出文件:
import {ThingA, ThingB, ThingC} from 'lib/things';
但是,我喜欢每个文件一个模块的组织方式。我最终得到这样的进口:
import ThingA from 'lib/things/ThingA';
import ThingB from 'lib/things/ThingB';
import ThingC from 'lib/things/ThingC';
我希望能够做到这一点:
import {ThingA, ThingB, ThingC} from 'lib/things/*';
或类似的东西,每个文件包含一个默认导出,并且每个模块的名称与其文件相同。
这可能吗?
我认为这是不可能的,但据我所知,模块名称的解析取决于模块加载器,因此可能有支持此功能的加载器实现。
在那之前,您可以在 lib/things/index.js
处使用仅包含
的中间 "module file"
export * from 'ThingA';
export * from 'ThingB';
export * from 'ThingC';
它会让你做
import {ThingA, ThingB, ThingC} from 'lib/things';
只是答案中已经提供的主题的变体,但是这个怎么样:
在Thing
,
export default function ThingA () {}
在things/index.js
,
export {default as ThingA} from './ThingA'
export {default as ThingB} from './ThingB'
export {default as ThingC} from './ThingC'
然后去消费其他地方的所有东西,
import * as things from './things'
things.ThingA()
或者只消费一些东西,
import {ThingA,ThingB} from './things'
如果您不在 A、B、C 中导出默认值,而只是导出 {},则可以这样做
// things/A.js
export function A() {}
// things/B.js
export function B() {}
// things/C.js
export function C() {}
// foo.js
import * as Foo from ./thing
Foo.A()
Foo.B()
Foo.C()
我用过几次它们(特别是构建大量对象将数据拆分到多个文件(例如 AST 节点)),为了构建它们,我制作了一个小脚本(我刚刚添加了它)到 npm,以便其他人都可以使用它)。
用法(目前需要使用babel来使用导出文件):
$ npm install -g folder-module
$ folder-module my-cool-module/
生成包含以下内容的文件:
export {default as foo} from "./module/foo.js"
export {default as default} from "./module/default.js"
export {default as bar} from "./module/bar.js"
...etc
然后你就可以使用文件了:
import * as myCoolModule from "my-cool-module.js"
myCoolModule.foo()
当前的答案提出了一种解决方法,但我很困惑为什么这不存在,所以我创建了一个 babel
插件来执行此操作。
安装使用:
npm i --save-dev babel-plugin-wildcard
然后将其添加到您的 .babelrc
中:
{
"plugins": ["wildcard"]
}
有关详细安装信息,请参阅 repo
这允许您这样做:
import * as Things from './lib/things';
// Do whatever you want with these :D
Things.ThingA;
Things.ThingB;
Things.ThingC;
同样,repo 包含有关它究竟做了什么的更多信息,但这样做可以避免创建 index.js
文件,并且也会在编译时发生以避免执行 readdir
s 在运行时。
对于较新的版本,您也可以完全按照您的示例进行操作:
import { ThingsA, ThingsB, ThingsC } from './lib/things/*';
效果同上
@Bergi 回答的另一种方法
// lib/things/index.js
import ThingA from './ThingA';
import ThingB from './ThingB';
import ThingC from './ThingC';
export default {
ThingA,
ThingB,
ThingC
}
使用
import {ThingA, ThingB, ThingC} from './lib/things';
这不完全是您要求的,但是,通过这种方法,我可以在我的其他文件中遍历 componentsList
并使用 componentsList.map(...)
等函数,我发现它非常有用!
import StepOne from './StepOne';
import StepTwo from './StepTwo';
import StepThree from './StepThree';
import StepFour from './StepFour';
import StepFive from './StepFive';
import StepSix from './StepSix';
import StepSeven from './StepSeven';
import StepEight from './StepEight';
const componentsList= () => [
{ component: StepOne(), key: 'step1' },
{ component: StepTwo(), key: 'step2' },
{ component: StepThree(), key: 'step3' },
{ component: StepFour(), key: 'step4' },
{ component: StepFive(), key: 'step5' },
{ component: StepSix(), key: 'step6' },
{ component: StepSeven(), key: 'step7' },
{ component: StepEight(), key: 'step8' }
];
export default componentsList;
伟大的 gugly muglys!这比它需要的要难。
导出一个平面默认值
这是使用 spread 的好机会(下面 { ...Matters, ...Contacts }
中的 ...
:
// imports/collections/Matters.js
export default { // default export
hello: 'World',
something: 'important',
};
// imports/collections/Contacts.js
export default { // default export
hello: 'Moon',
email: 'hello@example.com',
};
// imports/collections/index.js
import Matters from './Matters'; // import default export as var 'Matters'
import Contacts from './Contacts';
export default { // default export
...Matters, // spread Matters, overwriting previous properties
...Contacts, // spread Contacts, overwriting previosu properties
};
// imports/test.js
import collections from './collections'; // import default export as 'collections'
console.log(collections);
然后,到(来自项目根目录/):
$ npm install --save-dev @babel/core @babel/cli @babel/preset-env @babel/node
(trimmed)
$ npx babel-node --presets @babel/preset-env imports/test.js
{ hello: 'Moon',
something: 'important',
email: 'hello@example.com' }
导出一棵树状默认值
如果您不想覆盖属性,请更改:
// imports/collections/index.js
import Matters from './Matters'; // import default as 'Matters'
import Contacts from './Contacts';
export default { // export default
Matters,
Contacts,
};
输出将是:
$ npx babel-node --presets @babel/preset-env imports/test.js
{ Matters: { hello: 'World', something: 'important' },
Contacts: { hello: 'Moon', email: 'hello@example.com' } }
导出多个没有默认值的命名导出
如果您专注于 DRY,导入的语法也会发生变化:
// imports/collections/index.js
// export default as named export 'Matters'
export { default as Matters } from './Matters';
export { default as Contacts } from './Contacts';
这将创建 2 个没有默认导出的命名导出。然后更改:
// imports/test.js
import { Matters, Contacts } from './collections';
console.log(Matters, Contacts);
输出:
$ npx babel-node --presets @babel/preset-env imports/test.js
{ hello: 'World', something: 'important' } { hello: 'Moon', email: 'hello@example.com' }
导入所有命名导出
// imports/collections/index.js
// export default as named export 'Matters'
export { default as Matters } from './Matters';
export { default as Contacts } from './Contacts';
// imports/test.js
// Import all named exports as 'collections'
import * as collections from './collections';
console.log(collections); // interesting output
console.log(collections.Matters, collections.Contacts);
注意前面示例中的 destructuring import { Matters, Contacts } from './collections';
。
$ npx babel-node --presets @babel/preset-env imports/test.js
{ Matters: [Getter], Contacts: [Getter] }
{ hello: 'World', something: 'important' } { hello: 'Moon', email: 'hello@example.com' }
在实践中
鉴于这些源文件:
/myLib/thingA.js
/myLib/thingB.js
/myLib/thingC.js
创建 /myLib/index.js
来捆绑所有文件违背了 import/export 的目的。首先将所有内容都设置为全局,而不是通过 import/export 通过 index.js "wrapper files".
将所有内容设置为全局
如果你想要一个特定的文件,import thingA from './myLib/thingA';
在你自己的项目中。
只有在为 npm 打包或在多年的多团队项目中为模块创建带有导出的 "wrapper file" 才有意义。
走到这一步了吗?有关详细信息,请参阅 docs。
此外,Whosebug 终于支持三个 `s 作为代码栅栏标记了。
您现在可以使用 async import():
import fs = require('fs');
然后:
fs.readdir('./someDir', (err, files) => {
files.forEach(file => {
const module = import('./' + file).then(m =>
m.callSomeMethod();
);
// or const module = await import('file')
});
});
你也可以使用 require:
const moduleHolder = []
function loadModules(path) {
let stat = fs.lstatSync(path)
if (stat.isDirectory()) {
// we have a directory: do a tree walk
const files = fs.readdirSync(path)
let f,
l = files.length
for (var i = 0; i < l; i++) {
f = pathModule.join(path, files[i])
loadModules(f)
}
} else {
// we have a file: load it
var controller = require(path)
moduleHolder.push(controller)
}
}
然后将您的 moduleHolder 与动态加载的控制器一起使用:
loadModules(DIR)
for (const controller of moduleHolder) {
controller(app, db)
}
类似于已接受的问题,但它允许您在每次创建索引文件时无需向索引文件添加新模块即可进行扩展:
./modules/moduleA.js
export const example = 'example';
export const anotherExample = 'anotherExample';
./modules/index.js
// require all modules on the path and with the pattern defined
const req = require.context('./', true, /.js$/);
const modules = req.keys().map(req);
// export all modules
module.exports = modules;
./example.js
import { example, anotherExample } from './modules'
如果你使用的是 webpack。这会自动导入文件并导出为 api 命名空间。
因此无需在每次添加文件时都进行更新。
import camelCase from "lodash-es";
const requireModule = require.context("./", false, /\.js$/); //
const api = {};
requireModule.keys().forEach(fileName => {
if (fileName === "./index.js") return;
const moduleName = camelCase(fileName.replace(/(\.\/|\.js)/g, ""));
api[moduleName] = {
...requireModule(fileName).default
};
});
export default api;
对于 Typescript 用户;
import { camelCase } from "lodash-es"
const requireModule = require.context("./folderName", false, /\.ts$/)
interface LooseObject {
[key: string]: any
}
const api: LooseObject = {}
requireModule.keys().forEach(fileName => {
if (fileName === "./index.ts") return
const moduleName = camelCase(fileName.replace(/(\.\/|\.ts)/g, ""))
api[moduleName] = {
...requireModule(fileName).default,
}
})
export default api
我能够借鉴用户 atilkan 的方法并稍微修改一下:
对于 Typescript 用户;
require.context('@/folder/with/modules', false, /\.ts$/).keys().forEach((fileName => {
import('@/folder/with/modules' + fileName).then((mod) => {
(window as any)[fileName] = mod[fileName];
const module = new (window as any)[fileName]();
// use module
});
}));
节点?这样做:
用 index.js 创建文件夹,在索引文件中添加:
var GET = require('./GET');
var IS = require('./IS');
var PARSE = require('./PARSE');
module.exports = { ...GET, ...IS, ...PARSE};
并且,在文件 GET.js 中,或 IS.js 正常导出:
module.exports = { /* something as you like */}
现在,您只需要包括 index.js,例如:
const Helper = require('./YourFolder');
Helper 将包含 YourFolder 中的所有功能。
美好的一天!
使用 ES6,我可以像这样从一个文件中导入多个导出文件:
import {ThingA, ThingB, ThingC} from 'lib/things';
但是,我喜欢每个文件一个模块的组织方式。我最终得到这样的进口:
import ThingA from 'lib/things/ThingA';
import ThingB from 'lib/things/ThingB';
import ThingC from 'lib/things/ThingC';
我希望能够做到这一点:
import {ThingA, ThingB, ThingC} from 'lib/things/*';
或类似的东西,每个文件包含一个默认导出,并且每个模块的名称与其文件相同。
这可能吗?
我认为这是不可能的,但据我所知,模块名称的解析取决于模块加载器,因此可能有支持此功能的加载器实现。
在那之前,您可以在 lib/things/index.js
处使用仅包含
export * from 'ThingA';
export * from 'ThingB';
export * from 'ThingC';
它会让你做
import {ThingA, ThingB, ThingC} from 'lib/things';
只是答案中已经提供的主题的变体,但是这个怎么样:
在Thing
,
export default function ThingA () {}
在things/index.js
,
export {default as ThingA} from './ThingA'
export {default as ThingB} from './ThingB'
export {default as ThingC} from './ThingC'
然后去消费其他地方的所有东西,
import * as things from './things'
things.ThingA()
或者只消费一些东西,
import {ThingA,ThingB} from './things'
如果您不在 A、B、C 中导出默认值,而只是导出 {},则可以这样做
// things/A.js
export function A() {}
// things/B.js
export function B() {}
// things/C.js
export function C() {}
// foo.js
import * as Foo from ./thing
Foo.A()
Foo.B()
Foo.C()
我用过几次它们(特别是构建大量对象将数据拆分到多个文件(例如 AST 节点)),为了构建它们,我制作了一个小脚本(我刚刚添加了它)到 npm,以便其他人都可以使用它)。
用法(目前需要使用babel来使用导出文件):
$ npm install -g folder-module
$ folder-module my-cool-module/
生成包含以下内容的文件:
export {default as foo} from "./module/foo.js"
export {default as default} from "./module/default.js"
export {default as bar} from "./module/bar.js"
...etc
然后你就可以使用文件了:
import * as myCoolModule from "my-cool-module.js"
myCoolModule.foo()
当前的答案提出了一种解决方法,但我很困惑为什么这不存在,所以我创建了一个 babel
插件来执行此操作。
安装使用:
npm i --save-dev babel-plugin-wildcard
然后将其添加到您的 .babelrc
中:
{
"plugins": ["wildcard"]
}
有关详细安装信息,请参阅 repo
这允许您这样做:
import * as Things from './lib/things';
// Do whatever you want with these :D
Things.ThingA;
Things.ThingB;
Things.ThingC;
同样,repo 包含有关它究竟做了什么的更多信息,但这样做可以避免创建 index.js
文件,并且也会在编译时发生以避免执行 readdir
s 在运行时。
对于较新的版本,您也可以完全按照您的示例进行操作:
import { ThingsA, ThingsB, ThingsC } from './lib/things/*';
效果同上
@Bergi 回答的另一种方法
// lib/things/index.js
import ThingA from './ThingA';
import ThingB from './ThingB';
import ThingC from './ThingC';
export default {
ThingA,
ThingB,
ThingC
}
使用
import {ThingA, ThingB, ThingC} from './lib/things';
这不完全是您要求的,但是,通过这种方法,我可以在我的其他文件中遍历 componentsList
并使用 componentsList.map(...)
等函数,我发现它非常有用!
import StepOne from './StepOne';
import StepTwo from './StepTwo';
import StepThree from './StepThree';
import StepFour from './StepFour';
import StepFive from './StepFive';
import StepSix from './StepSix';
import StepSeven from './StepSeven';
import StepEight from './StepEight';
const componentsList= () => [
{ component: StepOne(), key: 'step1' },
{ component: StepTwo(), key: 'step2' },
{ component: StepThree(), key: 'step3' },
{ component: StepFour(), key: 'step4' },
{ component: StepFive(), key: 'step5' },
{ component: StepSix(), key: 'step6' },
{ component: StepSeven(), key: 'step7' },
{ component: StepEight(), key: 'step8' }
];
export default componentsList;
伟大的 gugly muglys!这比它需要的要难。
导出一个平面默认值
这是使用 spread 的好机会(下面 { ...Matters, ...Contacts }
中的 ...
:
// imports/collections/Matters.js
export default { // default export
hello: 'World',
something: 'important',
};
// imports/collections/Contacts.js
export default { // default export
hello: 'Moon',
email: 'hello@example.com',
};
// imports/collections/index.js
import Matters from './Matters'; // import default export as var 'Matters'
import Contacts from './Contacts';
export default { // default export
...Matters, // spread Matters, overwriting previous properties
...Contacts, // spread Contacts, overwriting previosu properties
};
// imports/test.js
import collections from './collections'; // import default export as 'collections'
console.log(collections);
然后,到
$ npm install --save-dev @babel/core @babel/cli @babel/preset-env @babel/node
(trimmed)
$ npx babel-node --presets @babel/preset-env imports/test.js
{ hello: 'Moon',
something: 'important',
email: 'hello@example.com' }
导出一棵树状默认值
如果您不想覆盖属性,请更改:
// imports/collections/index.js
import Matters from './Matters'; // import default as 'Matters'
import Contacts from './Contacts';
export default { // export default
Matters,
Contacts,
};
输出将是:
$ npx babel-node --presets @babel/preset-env imports/test.js
{ Matters: { hello: 'World', something: 'important' },
Contacts: { hello: 'Moon', email: 'hello@example.com' } }
导出多个没有默认值的命名导出
如果您专注于 DRY,导入的语法也会发生变化:
// imports/collections/index.js
// export default as named export 'Matters'
export { default as Matters } from './Matters';
export { default as Contacts } from './Contacts';
这将创建 2 个没有默认导出的命名导出。然后更改:
// imports/test.js
import { Matters, Contacts } from './collections';
console.log(Matters, Contacts);
输出:
$ npx babel-node --presets @babel/preset-env imports/test.js
{ hello: 'World', something: 'important' } { hello: 'Moon', email: 'hello@example.com' }
导入所有命名导出
// imports/collections/index.js
// export default as named export 'Matters'
export { default as Matters } from './Matters';
export { default as Contacts } from './Contacts';
// imports/test.js
// Import all named exports as 'collections'
import * as collections from './collections';
console.log(collections); // interesting output
console.log(collections.Matters, collections.Contacts);
注意前面示例中的 destructuring import { Matters, Contacts } from './collections';
。
$ npx babel-node --presets @babel/preset-env imports/test.js
{ Matters: [Getter], Contacts: [Getter] }
{ hello: 'World', something: 'important' } { hello: 'Moon', email: 'hello@example.com' }
在实践中
鉴于这些源文件:
/myLib/thingA.js
/myLib/thingB.js
/myLib/thingC.js
创建 /myLib/index.js
来捆绑所有文件违背了 import/export 的目的。首先将所有内容都设置为全局,而不是通过 import/export 通过 index.js "wrapper files".
如果你想要一个特定的文件,import thingA from './myLib/thingA';
在你自己的项目中。
只有在为 npm 打包或在多年的多团队项目中为模块创建带有导出的 "wrapper file" 才有意义。
走到这一步了吗?有关详细信息,请参阅 docs。
此外,Whosebug 终于支持三个 `s 作为代码栅栏标记了。
您现在可以使用 async import():
import fs = require('fs');
然后:
fs.readdir('./someDir', (err, files) => {
files.forEach(file => {
const module = import('./' + file).then(m =>
m.callSomeMethod();
);
// or const module = await import('file')
});
});
你也可以使用 require:
const moduleHolder = []
function loadModules(path) {
let stat = fs.lstatSync(path)
if (stat.isDirectory()) {
// we have a directory: do a tree walk
const files = fs.readdirSync(path)
let f,
l = files.length
for (var i = 0; i < l; i++) {
f = pathModule.join(path, files[i])
loadModules(f)
}
} else {
// we have a file: load it
var controller = require(path)
moduleHolder.push(controller)
}
}
然后将您的 moduleHolder 与动态加载的控制器一起使用:
loadModules(DIR)
for (const controller of moduleHolder) {
controller(app, db)
}
类似于已接受的问题,但它允许您在每次创建索引文件时无需向索引文件添加新模块即可进行扩展:
./modules/moduleA.js
export const example = 'example';
export const anotherExample = 'anotherExample';
./modules/index.js
// require all modules on the path and with the pattern defined
const req = require.context('./', true, /.js$/);
const modules = req.keys().map(req);
// export all modules
module.exports = modules;
./example.js
import { example, anotherExample } from './modules'
如果你使用的是 webpack。这会自动导入文件并导出为 api 命名空间。
因此无需在每次添加文件时都进行更新。
import camelCase from "lodash-es";
const requireModule = require.context("./", false, /\.js$/); //
const api = {};
requireModule.keys().forEach(fileName => {
if (fileName === "./index.js") return;
const moduleName = camelCase(fileName.replace(/(\.\/|\.js)/g, ""));
api[moduleName] = {
...requireModule(fileName).default
};
});
export default api;
对于 Typescript 用户;
import { camelCase } from "lodash-es"
const requireModule = require.context("./folderName", false, /\.ts$/)
interface LooseObject {
[key: string]: any
}
const api: LooseObject = {}
requireModule.keys().forEach(fileName => {
if (fileName === "./index.ts") return
const moduleName = camelCase(fileName.replace(/(\.\/|\.ts)/g, ""))
api[moduleName] = {
...requireModule(fileName).default,
}
})
export default api
我能够借鉴用户 atilkan 的方法并稍微修改一下:
对于 Typescript 用户;
require.context('@/folder/with/modules', false, /\.ts$/).keys().forEach((fileName => {
import('@/folder/with/modules' + fileName).then((mod) => {
(window as any)[fileName] = mod[fileName];
const module = new (window as any)[fileName]();
// use module
});
}));
节点?这样做:
用 index.js 创建文件夹,在索引文件中添加:
var GET = require('./GET');
var IS = require('./IS');
var PARSE = require('./PARSE');
module.exports = { ...GET, ...IS, ...PARSE};
并且,在文件 GET.js 中,或 IS.js 正常导出:
module.exports = { /* something as you like */}
现在,您只需要包括 index.js,例如:
const Helper = require('./YourFolder');
Helper 将包含 YourFolder 中的所有功能。
美好的一天!