barrelize 1.2.2 → 1.3.0

package/README.md

@@ -80,9 +80,11 @@ Create a `.barrelize` file in your project root. The configuration file uses JSO
   "singleQuote": true, // Use single quotes for exports (default: true)
   "semi": true, // Add semicolons after exports (default: true)
   "insertFinalNewline": true, // Add newline at end of file (default: true)
-  // Configure multiple directories to generate barrels for
-  "directories": [
+  // Configure multiple barrels to generate barrels for
+  "barrels": [
     {
+      // Name of the index file (default: "index.ts")
+      "name": "index.ts",
       // Root directory to start from (default: "")
       "path": "src",
       // Files to include in the barrel (default: ["**/*.ts"])
@@ -91,8 +93,6 @@ Create a `.barrelize` file in your project root. The configuration file uses JSO
       "exclude": ["**/*.test.ts", "**/*.spec.ts"],
       // Optional ordering of exports (default: [])
       "order": ["types", "constants", "utils"],
-      // Name of the index file (default: "index.ts")
-      "indexFilePath": "index.ts",
       // Optional string replacements in export paths
       "replace": [
         {

package/lib/index.js

@@ -591,10 +591,10 @@ class CAC extends EventEmitter {
 }
 const cac = (name2 = "") => new CAC(name2);
 const name = "barrelize";
-const version = "1.2.1";
+const version = "1.2.2";
 function cliInit() {
   const cli = cac(name);
-  cli.command("[config path]", `Generate 'index.ts' files for all directories`).action(async (config) => {
+  cli.command("[config path]", `Generate barrel files`).action(async (config) => {
     await runGenerateCommand({ configPath: config || ".barrelize" });
   });
   cli.command("init [config path]", "Create .barrelize config file if does not exist").example("barrelize init").example("barrelize init .barrelize").example("barrelize init root/.barrelize").action(async (path2 = ".barrelize") => {
@@ -614,12 +614,12 @@ function cliInit() {
 }
 const configTemplate = {
   $schema: "node_modules/barrelize/schema.json",
-  directories: [
+  barrels: [
     {
+      name: "index.ts",
       path: "src",
       include: ["**/*.ts"],
-      exclude: ["**/*.test.ts"],
-      indexFilePath: "index.ts"
+      exclude: ["**/*.test.ts"]
     }
   ]
 };
@@ -959,23 +959,23 @@ const DEFAULT_CONFIG = {
   include: ["**/*.ts"],
   exclude: [],
   order: [],
-  indexFilePath: "index.ts",
+  name: "index.ts",
   replace: [{ find: "\\.ts$", replacement: "" }],
   singleQuote: true,
   semi: true,
   insertFinalNewline: true
 };
 const validateConfig = (() => {
-  const _io0 = (input, _exceptionable = true) => (void 0 === input.$schema || "string" === typeof input.$schema) && (void 0 === input.singleQuote || "boolean" === typeof input.singleQuote) && (void 0 === input.semi || "boolean" === typeof input.semi) && (void 0 === input.insertFinalNewline || "boolean" === typeof input.insertFinalNewline) && (Array.isArray(input.directories) && input.directories.every((elem, _index1) => "object" === typeof elem && null !== elem && false === Array.isArray(elem) && _io1(elem, _exceptionable))) && (1 === Object.keys(input).length || Object.keys(input).every((key2) => {
-    if (["$schema", "singleQuote", "semi", "insertFinalNewline", "directories"].some((prop) => key2 === prop))
+  const _io0 = (input, _exceptionable = true) => (void 0 === input.$schema || "string" === typeof input.$schema) && (void 0 === input.singleQuote || "boolean" === typeof input.singleQuote) && (void 0 === input.semi || "boolean" === typeof input.semi) && (void 0 === input.insertFinalNewline || "boolean" === typeof input.insertFinalNewline) && (Array.isArray(input.barrels) && input.barrels.every((elem, _index1) => "object" === typeof elem && null !== elem && false === Array.isArray(elem) && _io1(elem, _exceptionable))) && (1 === Object.keys(input).length || Object.keys(input).every((key2) => {
+    if (["$schema", "singleQuote", "semi", "insertFinalNewline", "barrels"].some((prop) => key2 === prop))
       return true;
     const value = input[key2];
     if (void 0 === value)
       return true;
     return false;
   }));
-  const _io1 = (input, _exceptionable = true) => (void 0 === input.path || "string" === typeof input.path) && (void 0 === input.include || Array.isArray(input.include) && input.include.every((elem, _index2) => "string" === typeof elem)) && (void 0 === input.exclude || Array.isArray(input.exclude) && input.exclude.every((elem, _index3) => "string" === typeof elem)) && (void 0 === input.order || Array.isArray(input.order) && input.order.every((elem, _index4) => "string" === typeof elem)) && (void 0 === input.indexFilePath || "string" === typeof input.indexFilePath) && (void 0 === input.replace || Array.isArray(input.replace) && input.replace.every((elem, _index5) => "object" === typeof elem && null !== elem && _io2(elem, _exceptionable))) && (void 0 === input.singleQuote || "boolean" === typeof input.singleQuote) && (void 0 === input.semi || "boolean" === typeof input.semi) && (void 0 === input.insertFinalNewline || "boolean" === typeof input.insertFinalNewline) && (0 === Object.keys(input).length || Object.keys(input).every((key2) => {
-    if (["path", "include", "exclude", "order", "indexFilePath", "replace", "singleQuote", "semi", "insertFinalNewline"].some((prop) => key2 === prop))
+  const _io1 = (input, _exceptionable = true) => (void 0 === input.name || "string" === typeof input.name) && (void 0 === input.path || "string" === typeof input.path) && (void 0 === input.include || Array.isArray(input.include) && input.include.every((elem, _index2) => "string" === typeof elem)) && (void 0 === input.exclude || Array.isArray(input.exclude) && input.exclude.every((elem, _index3) => "string" === typeof elem)) && (void 0 === input.order || Array.isArray(input.order) && input.order.every((elem, _index4) => "string" === typeof elem)) && (void 0 === input.replace || Array.isArray(input.replace) && input.replace.every((elem, _index5) => "object" === typeof elem && null !== elem && _io2(elem, _exceptionable))) && (void 0 === input.singleQuote || "boolean" === typeof input.singleQuote) && (void 0 === input.semi || "boolean" === typeof input.semi) && (void 0 === input.insertFinalNewline || "boolean" === typeof input.insertFinalNewline) && (0 === Object.keys(input).length || Object.keys(input).every((key2) => {
+    if (["name", "path", "include", "exclude", "order", "replace", "singleQuote", "semi", "insertFinalNewline"].some((prop) => key2 === prop))
       return true;
     const value = input[key2];
     if (void 0 === value)
@@ -1006,24 +1006,24 @@ const validateConfig = (() => {
     path: _path + ".insertFinalNewline",
     expected: "(boolean | undefined)",
     value: input.insertFinalNewline
-  }), (Array.isArray(input.directories) || _report(_exceptionable, {
-    path: _path + ".directories",
-    expected: "Array<DirectoryConfig>",
-    value: input.directories
-  })) && input.directories.map((elem, _index6) => ("object" === typeof elem && null !== elem && false === Array.isArray(elem) || _report(_exceptionable, {
-    path: _path + ".directories[" + _index6 + "]",
-    expected: "DirectoryConfig",
+  }), (Array.isArray(input.barrels) || _report(_exceptionable, {
+    path: _path + ".barrels",
+    expected: "Array<BarrelConfig>",
+    value: input.barrels
+  })) && input.barrels.map((elem, _index6) => ("object" === typeof elem && null !== elem && false === Array.isArray(elem) || _report(_exceptionable, {
+    path: _path + ".barrels[" + _index6 + "]",
+    expected: "BarrelConfig",
     value: elem
-  })) && _vo1(elem, _path + ".directories[" + _index6 + "]", _exceptionable) || _report(_exceptionable, {
-    path: _path + ".directories[" + _index6 + "]",
-    expected: "DirectoryConfig",
+  })) && _vo1(elem, _path + ".barrels[" + _index6 + "]", _exceptionable) || _report(_exceptionable, {
+    path: _path + ".barrels[" + _index6 + "]",
+    expected: "BarrelConfig",
     value: elem
   })).every((flag) => flag) || _report(_exceptionable, {
-    path: _path + ".directories",
-    expected: "Array<DirectoryConfig>",
-    value: input.directories
+    path: _path + ".barrels",
+    expected: "Array<BarrelConfig>",
+    value: input.barrels
   }), 1 === Object.keys(input).length || (false === _exceptionable || Object.keys(input).map((key2) => {
-    if (["$schema", "singleQuote", "semi", "insertFinalNewline", "directories"].some((prop) => key2 === prop))
+    if (["$schema", "singleQuote", "semi", "insertFinalNewline", "barrels"].some((prop) => key2 === prop))
       return true;
     const value = input[key2];
     if (void 0 === value)
@@ -1034,7 +1034,11 @@ const validateConfig = (() => {
       value
     });
   }).every((flag) => flag))].every((flag) => flag);
-  const _vo1 = (input, _path, _exceptionable = true) => [void 0 === input.path || "string" === typeof input.path || _report(_exceptionable, {
+  const _vo1 = (input, _path, _exceptionable = true) => [void 0 === input.name || "string" === typeof input.name || _report(_exceptionable, {
+    path: _path + ".name",
+    expected: "(string | undefined)",
+    value: input.name
+  }), void 0 === input.path || "string" === typeof input.path || _report(_exceptionable, {
     path: _path + ".path",
     expected: "(string | undefined)",
     value: input.path
@@ -1074,10 +1078,6 @@ const validateConfig = (() => {
     path: _path + ".order",
     expected: "(Array<string> | undefined)",
     value: input.order
-  }), void 0 === input.indexFilePath || "string" === typeof input.indexFilePath || _report(_exceptionable, {
-    path: _path + ".indexFilePath",
-    expected: "(string | undefined)",
-    value: input.indexFilePath
   }), void 0 === input.replace || (Array.isArray(input.replace) || _report(_exceptionable, {
     path: _path + ".replace",
     expected: "(Array<__type> | undefined)",
@@ -1107,7 +1107,7 @@ const validateConfig = (() => {
     expected: "(boolean | undefined)",
     value: input.insertFinalNewline
   }), 0 === Object.keys(input).length || (false === _exceptionable || Object.keys(input).map((key2) => {
-    if (["path", "include", "exclude", "order", "indexFilePath", "replace", "singleQuote", "semi", "insertFinalNewline"].some((prop) => key2 === prop))
+    if (["name", "path", "include", "exclude", "order", "replace", "singleQuote", "semi", "insertFinalNewline"].some((prop) => key2 === prop))
       return true;
     const value = input[key2];
     if (void 0 === value)
@@ -8824,9 +8824,9 @@ const glob = Object.assign(glob_, {
   unescape
 });
 glob.glob = glob;
-async function globPaths(cwd, directoryConfig) {
-  const ignore = [...directoryConfig.exclude ?? DEFAULT_CONFIG.exclude, "**/index.ts", "**/index.js"];
-  let paths = await glob(directoryConfig.include ?? DEFAULT_CONFIG.include, {
+async function globPaths(cwd, barrelConfig) {
+  const ignore = [...barrelConfig.exclude ?? DEFAULT_CONFIG.exclude, "**/index.ts", "**/index.js"];
+  let paths = await glob(barrelConfig.include ?? DEFAULT_CONFIG.include, {
     cwd,
     ignore,
     nodir: true,
@@ -8835,134 +8835,17 @@ async function globPaths(cwd, directoryConfig) {
   paths = paths.map((file) => file.replace(/\\/g, "/"));
   return paths;
 }
-const validateOutputConfig = (() => {
-  const _io0 = (input, _exceptionable = true) => "string" === typeof input.cwd && (Array.isArray(input.directories) && input.directories.every((elem, _index1) => "object" === typeof elem && null !== elem && _io1(elem, _exceptionable))) && (2 === Object.keys(input).length || Object.keys(input).every((key2) => {
-    if (["cwd", "directories"].some((prop) => key2 === prop))
-      return true;
-    const value = input[key2];
-    if (void 0 === value)
-      return true;
-    return false;
-  }));
-  const _io1 = (input, _exceptionable = true) => Array.isArray(input.files) && input.files.every((elem, _index2) => "string" === typeof elem) && (void 0 === input.order || Array.isArray(input.order) && input.order.every((elem, _index3) => "string" === typeof elem)) && (1 === Object.keys(input).length || Object.keys(input).every((key2) => {
-    if (["files", "order"].some((prop) => key2 === prop))
-      return true;
-    const value = input[key2];
-    if (void 0 === value)
-      return true;
-    return false;
-  }));
-  const _vo0 = (input, _path, _exceptionable = true) => ["string" === typeof input.cwd || _report(_exceptionable, {
-    path: _path + ".cwd",
-    expected: "string",
-    value: input.cwd
-  }), (Array.isArray(input.directories) || _report(_exceptionable, {
-    path: _path + ".directories",
-    expected: "Array<__type>",
-    value: input.directories
-  })) && input.directories.map((elem, _index4) => ("object" === typeof elem && null !== elem || _report(_exceptionable, {
-    path: _path + ".directories[" + _index4 + "]",
-    expected: "__type",
-    value: elem
-  })) && _vo1(elem, _path + ".directories[" + _index4 + "]", _exceptionable) || _report(_exceptionable, {
-    path: _path + ".directories[" + _index4 + "]",
-    expected: "__type",
-    value: elem
-  })).every((flag) => flag) || _report(_exceptionable, {
-    path: _path + ".directories",
-    expected: "Array<__type>",
-    value: input.directories
-  }), 2 === Object.keys(input).length || (false === _exceptionable || Object.keys(input).map((key2) => {
-    if (["cwd", "directories"].some((prop) => key2 === prop))
-      return true;
-    const value = input[key2];
-    if (void 0 === value)
-      return true;
-    return _report(_exceptionable, {
-      path: _path + _accessExpressionAsStringExports._accessExpressionAsString(key2),
-      expected: "undefined",
-      value
-    });
-  }).every((flag) => flag))].every((flag) => flag);
-  const _vo1 = (input, _path, _exceptionable = true) => [(Array.isArray(input.files) || _report(_exceptionable, {
-    path: _path + ".files",
-    expected: "Array<string>",
-    value: input.files
-  })) && input.files.map((elem, _index5) => "string" === typeof elem || _report(_exceptionable, {
-    path: _path + ".files[" + _index5 + "]",
-    expected: "string",
-    value: elem
-  })).every((flag) => flag) || _report(_exceptionable, {
-    path: _path + ".files",
-    expected: "Array<string>",
-    value: input.files
-  }), void 0 === input.order || (Array.isArray(input.order) || _report(_exceptionable, {
-    path: _path + ".order",
-    expected: "(Array<string> | undefined)",
-    value: input.order
-  })) && input.order.map((elem, _index6) => "string" === typeof elem || _report(_exceptionable, {
-    path: _path + ".order[" + _index6 + "]",
-    expected: "string",
-    value: elem
-  })).every((flag) => flag) || _report(_exceptionable, {
-    path: _path + ".order",
-    expected: "(Array<string> | undefined)",
-    value: input.order
-  }), 1 === Object.keys(input).length || (false === _exceptionable || Object.keys(input).map((key2) => {
-    if (["files", "order"].some((prop) => key2 === prop))
-      return true;
-    const value = input[key2];
-    if (void 0 === value)
-      return true;
-    return _report(_exceptionable, {
-      path: _path + _accessExpressionAsStringExports._accessExpressionAsString(key2),
-      expected: "undefined",
-      value
-    });
-  }).every((flag) => flag))].every((flag) => flag);
-  const __is = (input, _exceptionable = true) => "object" === typeof input && null !== input && _io0(input, true);
-  let errors;
-  let _report;
-  return _createStandardSchemaExports._createStandardSchema((input) => {
-    if (false === __is(input)) {
-      errors = [];
-      _report = _validateReportExports._validateReport(errors);
-      ((input2, _path, _exceptionable = true) => ("object" === typeof input2 && null !== input2 || _report(true, {
-        path: _path + "",
-        expected: "OutputConfig",
-        value: input2
-      })) && _vo0(input2, _path + "", true) || _report(true, {
-        path: _path + "",
-        expected: "OutputConfig",
-        value: input2
-      }))(input, "$input", true);
-      const success = 0 === errors.length;
-      return success ? {
-        success,
-        data: input
-      } : {
-        success,
-        errors,
-        data: input
-      };
-    }
-    return {
-      success: true,
-      data: input
-    };
-  });
-})();
-async function generateBarrel(rootPath, directoryConfig) {
-  const cwd = resolve(rootPath, directoryConfig.path ?? DEFAULT_CONFIG.path);
-  let paths = await globPaths(cwd, directoryConfig);
-  paths = handlePathOrder(directoryConfig, paths);
-  paths = handlePathReplacement(directoryConfig, paths);
+async function generateBarrel(rootPath, barrelConfig) {
+  const cwd = resolve(rootPath, barrelConfig.path ?? DEFAULT_CONFIG.path);
+  let paths = await globPaths(cwd, barrelConfig);
+  paths = handlePathOrder(barrelConfig, paths);
+  paths = handlePathReplacement(barrelConfig, paths);
   return paths;
 }
 async function generateBarrels(rootPath, configPath, config) {
-  for (const directoryConfig of config.directories) {
-    const indexFileBasePath = directoryConfig.indexFilePath ?? DEFAULT_CONFIG.indexFilePath;
-    const indexFileRelativePath = join(directoryConfig.path ?? DEFAULT_CONFIG.path, indexFileBasePath);
+  for (const barrel of config.barrels) {
+    const indexFileBasePath = barrel.name ?? DEFAULT_CONFIG.name;
+    const indexFileRelativePath = join(barrel.path ?? DEFAULT_CONFIG.path, indexFileBasePath);
     const indexFileAbsolutePath = resolve(rootPath, indexFileRelativePath);
     const indexDirectory = dirname(indexFileAbsolutePath);
     if (!existsSync(indexDirectory)) {
@@ -8970,10 +8853,10 @@ async function generateBarrels(rootPath, configPath, config) {
       console.error(logWarning(`  Please verify the directory path in your '${configPath}' configuration`));
       continue;
     }
-    const paths = await generateBarrel(rootPath, directoryConfig);
-    const quote = directoryConfig.singleQuote ?? config.singleQuote ?? DEFAULT_CONFIG.singleQuote ? "'" : '"';
-    const semiIfNeeded = directoryConfig.semi ?? config.semi ?? DEFAULT_CONFIG.semi ? ";" : "";
-    const newLineIfNeeded = directoryConfig.insertFinalNewline ?? config.insertFinalNewline ?? DEFAULT_CONFIG.insertFinalNewline ? "\n" : "";
+    const paths = await generateBarrel(rootPath, barrel);
+    const quote = barrel.singleQuote ?? config.singleQuote ?? DEFAULT_CONFIG.singleQuote ? "'" : '"';
+    const semiIfNeeded = barrel.semi ?? config.semi ?? DEFAULT_CONFIG.semi ? ";" : "";
+    const newLineIfNeeded = barrel.insertFinalNewline ?? config.insertFinalNewline ?? DEFAULT_CONFIG.insertFinalNewline ? "\n" : "";
     const formatExportLine = (path2) => `export * from ${quote}./${path2}${quote}${semiIfNeeded}`;
     const content = paths.map(formatExportLine).join("\n") + newLineIfNeeded;
     const exportedText = `${paths.length} file${plural(paths)} exported`;
@@ -9094,6 +8977,5 @@ export {
   pathsDifferences,
   runGenerateCommand,
   runInitCommand,
-  validateConfig,
-  validateOutputConfig
+  validateConfig
 };

package/lib/src/config/config.d.ts

@@ -1,9 +1,9 @@
-export type DirectoryConfig = {
+export type BarrelConfig = {
+    name?: string;
     path?: string;
     include?: string[];
     exclude?: string[];
     order?: string[];
-    indexFilePath?: string;
     replace?: {
         find: string;
         replacement: string;
@@ -17,7 +17,7 @@ export type Config = {
     singleQuote?: boolean;
     semi?: boolean;
     insertFinalNewline?: boolean;
-    directories: DirectoryConfig[];
+    barrels: BarrelConfig[];
 };
-export declare const DEFAULT_CONFIG: Required<DirectoryConfig>;
+export declare const DEFAULT_CONFIG: Required<BarrelConfig>;
 export declare const validateConfig: ((input: unknown) => import('typia').IValidation<Config>) & import('@standard-schema/spec').StandardSchemaV1<unknown, Config>;

package/lib/src/generate/generate-barrel.d.ts

@@ -1,2 +1,2 @@
-import { DirectoryConfig } from '../index.ts';
-export declare function generateBarrel(rootPath: string, directoryConfig: DirectoryConfig): Promise<string[]>;
+import { BarrelConfig } from '../index.ts';
+export declare function generateBarrel(rootPath: string, barrelConfig: BarrelConfig): Promise<string[]>;

package/lib/src/generate/glob-paths.d.ts

@@ -1,2 +1,2 @@
-import { DirectoryConfig } from '../index.ts';
-export declare function globPaths(cwd: string, directoryConfig: DirectoryConfig): Promise<string[]>;
+import { BarrelConfig } from '../index.ts';
+export declare function globPaths(cwd: string, barrelConfig: BarrelConfig): Promise<string[]>;

package/lib/src/generate/handle-path-order.d.ts

@@ -1,2 +1,2 @@
-import { DirectoryConfig } from '../index.ts';
-export declare function handlePathOrder(config: DirectoryConfig, paths: string[]): string[];
+import { BarrelConfig } from '../index.ts';
+export declare function handlePathOrder(config: BarrelConfig, paths: string[]): string[];

package/lib/src/generate/handle-path-replacement.d.ts

@@ -1,2 +1,2 @@
-import { DirectoryConfig } from '../index.ts';
-export declare function handlePathReplacement(config: DirectoryConfig, files: string[]): string[];
+import { BarrelConfig } from '../index.ts';
+export declare function handlePathReplacement(config: BarrelConfig, files: string[]): string[];

package/lib/src/index.d.ts

@@ -8,7 +8,6 @@ export * from './log/log-validation-error';
 export * from './config/config';
 export * from './config/parse-config';
 export * from './generate/glob-paths';
-export * from './config/output-config';
 export * from './generate/generate-barrel';
 export * from './generate/generate-barrels';
 export * from './generate/handle-path-order';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "barrelize",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "Automatically generating index (barrel) files",
   "scripts": {
     "build": "npm run schema && vite build",

package/schema.json

@@ -17,11 +17,15 @@
       "type": "boolean",
       "default": true
     },
-    "directories": {
+    "barrels": {
       "type": "array",
       "items": {
         "type": "object",
         "properties": {
+          "name": {
+            "type": "string",
+            "default": "index.ts"
+          },
           "path": {
             "type": "string",
             "default": ""
@@ -49,10 +53,6 @@
             },
             "default": []
           },
-          "indexFilePath": {
-            "type": "string",
-            "default": "index.ts"
-          },
           "replace": {
             "type": "array",
             "items": {
@@ -95,6 +95,6 @@
     }
   },
   "required": [
-    "directories"
+    "barrels"
   ]
 }

package/lib/src/config/output-config.d.ts

@@ -1,8 +0,0 @@
-export type OutputConfig = {
-    cwd: string;
-    directories: {
-        files: string[];
-        order?: string[];
-    }[];
-};
-export declare const validateOutputConfig: ((input: unknown) => import('typia').IValidation<OutputConfig>) & import('@standard-schema/spec').StandardSchemaV1<unknown, OutputConfig>;