@touk/federated-types 1.2.1 → 1.3.0-beta.1

package/README.md

@@ -14,7 +14,6 @@ npm install @touk/federated-types
 
 You'll also need to place a `federation.config.json` in each package being federated. It will contain the remote name and exported members. These properties are used in Webpack's `ModuleFederationPlugin` configuration object. An example:
 
-
 ```json
 //federation.config.json
 
@@ -28,11 +27,9 @@ You'll also need to place a `federation.config.json` in each package being feder
 
 It's recommended that you spread these properties into your ModuleFederationPlugin configuration, like so:
 
-
 ```javascript
 //webpack.config.js
 
-const deps = require('../package.json').dependencies;
 const federationConfig = require('./federation.config.json');
 
 module.exports = {
@@ -42,9 +39,7 @@ module.exports = {
         new ModuleFederationPlugin({
             ...federationConfig,
             filename: "remoteEntry.js",
-            shared: {
-                ...deps,
-            },
+            shared: { ... },
         }),
     ],
 
@@ -55,7 +50,6 @@ module.exports = {
 
 Then you can call `make-federated-types` from your `scripts` block in your package's `package.json` file:
 
-
 ```javascript
 //package.json
 
@@ -68,7 +62,6 @@ This will write new package to the `node_modules/@types/__federated_types` in yo
 
 If you would rather specify a directory in which to write the typing files, you can pass an `--outputDir` parameter to the command like so:
 
-
 ```javascript
 //package.json
 
@@ -76,6 +69,7 @@ scripts: {
     "make-types": "make-federated-types --outputDir ../../my_types/"
 }
 ```
+
 You can add an `--saveToNodeModules` parameter to save in both places.
 
 If you would like to specify custom path to the config, you can pass `--config` parameter like so:
@@ -87,3 +81,43 @@ scripts: {
     "make-types": "make-federated-types --config ./path/to/my/config.json --outputDir ../../my_types/"
 }
 ```
+
+## Inline configuration (without config file)
+
+If you prefer not to maintain a separate `federation.config.json` file, you can provide the configuration directly via CLI arguments using `--name` and `--exposes`:
+
+```bash
+make-federated-types \
+  --name myApp \
+  --exposes App ./src/App.tsx \
+  --exposes Button ./src/components/Button.tsx \
+  --outputDir ./types
+```
+
+### Inline config features:
+
+- **Multiple exposures**: Use `--exposes` multiple times, each followed by a key and file path
+- **Auto-prefix**: Keys without `./` prefix are automatically normalized (e.g., `App` becomes `./App`)
+- **Shell-friendly**: Works with tab completion for file paths
+- **Priority**: Inline config takes precedence over `--config` and auto-discovery
+
+### Examples:
+
+```bash
+# Simple inline config
+make-federated-types --name app2 --exposes Button ./src/Button.tsx
+
+# Multiple exposures
+make-federated-types \
+  --name app2 \
+  --exposes ./Button ./src/Button.tsx \
+  --exposes ./Header ./src/Header.tsx
+
+# Nested keys (auto-prefixed with ./)
+make-federated-types \
+  --name app2 \
+  --exposes components/Button ./src/components/Button.tsx \
+  --exposes utils/helpers ./src/utils/helpers.ts
+```
+
+**Note**: When using inline config, both `--name` and at least one `--exposes` are required.

package/cli.js

@@ -7,11 +7,16 @@ const ts = require('typescript');
 
 const formatHost = {
     getCurrentDirectory: ts.sys.getCurrentDirectory,
-    getNewLine: () => ts.sys.newLine
+    getNewLine: () => ts.sys.newLine,
 };
 
 function reportDiagnostic(diagnostic) {
-  console.log("TS Error", diagnostic.code, ":", ts.flattenDiagnosticMessageText( diagnostic.messageText, formatHost.getNewLine()));
+    console.log(
+        'TS Error',
+        diagnostic.code,
+        ':',
+        ts.flattenDiagnosticMessageText(diagnostic.messageText, formatHost.getNewLine())
+    );
 }
 
 const [nodeModules] = findNodeModules({ cwd: process.argv[1], relative: false });
@@ -24,23 +29,43 @@ const getArg = (argName) => {
     const argIndex = process.argv.indexOf(argName);
     return argIndex !== -1 ? process.argv[argIndex + 1] : null;
 };
+const getAllArgs = (argName) => {
+    const results = [];
+    let i = 2; // process.argv starts with node and script path
+
+    while (i < process.argv.length) {
+        if (process.argv[i] === argName) {
+            // Next two arguments are key and value
+            if (i + 2 < process.argv.length) {
+                results.push([process.argv[i + 1], process.argv[i + 2]]);
+                i += 3; // skip argName, key, value
+            } else {
+                console.error(`ERROR: --exposes requires two arguments (key path)`);
+                process.exit(1);
+            }
+        } else {
+            i++;
+        }
+    }
+    return results;
+};
 
 const nodeModulesOutputDir = path.resolve(nodeModules, '@types/__federated_types/');
 const saveToNodeMoulesArg = hasArg('--saveToNodeModules');
 const outDirArg = getArg('--outputDir');
 
-const outputDir = outDirArg
-    ? path.resolve('./', outDirArg)
-    : nodeModulesOutputDir;
+const outputDir = outDirArg ? path.resolve('./', outDirArg) : nodeModulesOutputDir;
 
-const outputDirs = outputDir !== nodeModulesOutputDir && saveToNodeMoulesArg
-    ? [nodeModulesOutputDir, outputDir]
-    : [outputDir];
+const outputDirs =
+    outputDir !== nodeModulesOutputDir && saveToNodeMoulesArg
+        ? [nodeModulesOutputDir, outputDir]
+        : [outputDir];
 
 const configPathArg = getArg('--config');
-const configPath = configPathArg
-    ? path.resolve(configPathArg)
-    : null;
+const configPath = configPathArg ? path.resolve(configPathArg) : null;
+
+const nameArg = getArg('--name');
+const exposesArgs = getAllArgs('--exposes');
 
 const findFederationConfig = (base) => {
     let files = fs.readdirSync(base);
@@ -56,27 +81,57 @@ const findFederationConfig = (base) => {
         }
     }
 
-    for( let i = 0; i < queue.length; i++ ) {
+    for (let i = 0; i < queue.length; i++) {
         return findFederationConfig(queue[i]);
     }
 };
 
-if (configPath && !fs.existsSync(configPath)) {
-    console.error(`ERROR: Unable to find a provided config: ${configPath}`);
-    process.exit(1);
-}
+let federationConfig;
 
-const federationConfigPath = configPath || findFederationConfig('./');
+// Priority: inline config > --config > auto-find
+if (nameArg || exposesArgs.length > 0) {
+    // Inline config mode
+    if (!nameArg || exposesArgs.length === 0) {
+        console.error('ERROR: Both --name and --exposes are required for inline config');
+        process.exit(1);
+    }
 
+    if (configPath) {
+        console.warn('WARNING: Both inline config and --config provided. Using inline config.');
+    }
 
-if (federationConfigPath === undefined) {
-    console.error(`ERROR: Unable to find a federation.config.json file in this package`);
-    process.exit(1);
-}
+    const exposes = {};
+
+    exposesArgs.forEach(([key, value]) => {
+        // Normalize key - add ./ if missing
+        const normalizedKey = key.startsWith('./') ? key : `./${key}`;
+        exposes[normalizedKey] = value;
+    });
+
+    federationConfig = {
+        name: nameArg,
+        exposes: exposes,
+    };
+
+    console.log('Using inline config:', JSON.stringify(federationConfig, null, 2));
+} else {
+    // File-based config (current behavior)
+    if (configPath && !fs.existsSync(configPath)) {
+        console.error(`ERROR: Unable to find a provided config: ${configPath}`);
+        process.exit(1);
+    }
+
+    const federationConfigPath = configPath || findFederationConfig('./');
 
-console.log(`Using config file: ${federationConfigPath}`);
+    if (federationConfigPath === undefined) {
+        console.error(`ERROR: Unable to find a federation.config.json file in this package`);
+        process.exit(1);
+    }
+
+    console.log(`Using config file: ${federationConfigPath}`);
+    federationConfig = require(federationConfigPath);
+}
 
-const federationConfig = require(federationConfigPath);
 const compileFiles = Object.values(federationConfig.exposes);
 const compileKeys = Object.keys(federationConfig.exposes);
 
@@ -97,16 +152,16 @@ try {
         declaration: true,
         emitDeclarationOnly: true,
         skipLibCheck: true,
-        jsx: 'react',
+        jsx: ts.JsxEmit.React,
         esModuleInterop: true,
     });
 
     const { emitSkipped, diagnostics } = program.emit();
 
-    diagnostics.forEach(reportDiagnostic)
+    diagnostics.forEach(reportDiagnostic);
 
     if (emitSkipped) {
-        process.exit(0)
+        process.exit(0);
     }
 
     let typing = fs.readFileSync(outFile, { encoding: 'utf8', flag: 'r' });
@@ -114,19 +169,23 @@ try {
     const moduleRegex = RegExp(/declare module "(.*)"/, 'g');
     const moduleNames = [];
 
+    let execResults;
     while ((execResults = moduleRegex.exec(typing)) !== null) {
         moduleNames.push(execResults[1]);
     }
 
     moduleNames.forEach((name) => {
         // exposeName - relative name of exposed component (if not found - just take moduleName)
-        const [exposeName = name, ...aliases] = compileKeys.filter(key => federationConfig.exposes[key].endsWith(name));
+        const [exposeName = name, ...aliases] = compileKeys.filter((key) => {
+            const normalizedPath = federationConfig.exposes[key].replace(/\.(tsx?|jsx?)$/, '');
+            return normalizedPath.endsWith(name);
+        });
         const regex = RegExp(`"${name}"`, 'g');
 
         const moduleDeclareName = getModuleDeclareName(exposeName);
 
         // language=TypeScript
-        const createAliasModule = name => `
+        const createAliasModule = (name) => `
             declare module "${getModuleDeclareName(name)}" {
                 export * from "${moduleDeclareName}"
             }
@@ -138,7 +197,7 @@ try {
         ].join('\n');
     });
 
-    outputDirs.forEach(_outputDir => {
+    outputDirs.forEach((_outputDir) => {
         const _outFile = path.resolve(_outputDir, `${federationConfig.name}.d.ts`);
 
         console.log('writing typing file:', _outFile);
@@ -152,7 +211,10 @@ try {
 
             if (!fs.existsSync(packageJsonPath)) {
                 console.debug('writing package.json:', packageJsonPath);
-                fs.copyFileSync(path.resolve(__dirname, 'typings.package.tmpl.json'), packageJsonPath);
+                fs.copyFileSync(
+                    path.resolve(__dirname, 'typings.package.tmpl.json'),
+                    packageJsonPath
+                );
             } else {
                 console.debug(packageJsonPath, 'already exists');
             }

package/package.json

@@ -1,47 +1,48 @@
 {
-  "name": "@touk/federated-types",
-  "description": "share typings for your federated typescript packages around your mono-repo",
-  "version": "1.2.1",
-  "author": "Julian Wielga <j@touk.pl>",
-  "bin": {
-    "make-federated-types": "./cli.js"
-  },
-  "contributors": [
-    "Jonathan Greene <jgreene@pixability.com>"
-  ],
-  "dependencies": {
-    "find-node-modules": "2.1.3"
-  },
-  "devDependencies": {
-    "@commitlint/cli": "17.1.2",
-    "@commitlint/config-conventional": "13.2.0",
-    "@semantic-release/changelog": "6.0.3",
-    "@semantic-release/git": "10.0.1",
-    "husky": "8.0.3",
-    "prettier": "3.6.2",
-    "semantic-release": "19.0.5"
-  },
-  "files": [
-    "cli.js",
-    "typings.package.tmpl.json"
-  ],
-  "keywords": [
-    "module-federation",
-    "mono-repo",
-    "typescript",
-    "typings"
-  ],
-  "license": "MIT",
-  "main": "cli.js",
-  "peerDependencies": {
-    "typescript": ">4.0.0"
-  },
-  "repository": "touk/federated-types.git",
-  "scripts": {
-    "semantic-release": "semantic-release",
-    "test": "npm run make-types -workspaces --if-present"
-  },
-  "workspaces": [
-    "./packages/*"
-  ]
+    "name": "@touk/federated-types",
+    "description": "share typings for your federated typescript packages around your mono-repo",
+    "version": "1.3.0-beta.1",
+    "author": "Julian Wielga <j@touk.pl>",
+    "bin": {
+        "make-federated-types": "./cli.js"
+    },
+    "contributors": [
+        "Jonathan Greene <jgreene@pixability.com>"
+    ],
+    "dependencies": {
+        "find-node-modules": "2.1.3"
+    },
+    "devDependencies": {
+        "@commitlint/cli": "^20.4.2",
+        "@commitlint/config-conventional": "^20.4.2",
+        "@semantic-release/changelog": "^6.0.3",
+        "@semantic-release/git": "10.0.1",
+        "husky": "^9.1.7",
+        "prettier": "^3.8.1",
+        "semantic-release": "^25.0.3",
+        "typescript": "^5.9.3"
+    },
+    "files": [
+        "cli.js",
+        "typings.package.tmpl.json"
+    ],
+    "keywords": [
+        "module-federation",
+        "mono-repo",
+        "typescript",
+        "typings"
+    ],
+    "license": "MIT",
+    "main": "cli.js",
+    "peerDependencies": {
+        "typescript": ">4.0.0"
+    },
+    "repository": "touk/federated-types.git",
+    "scripts": {
+        "semantic-release": "semantic-release",
+        "test": "npm run make-types -workspaces --if-present"
+    },
+    "workspaces": [
+        "./packages/*"
+    ]
 }