@touk/federated-types 1.1.0 → 1.2.0-beta.2

package/README.md

@@ -14,9 +14,10 @@ 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:
 
-#### `federation.config.json`
 
 ```json
+//federation.config.json
+
 {
     "name": "app2",
     "exposes": {
@@ -27,9 +28,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:
 
-#### `webpack.config.js`
 
 ```javascript
+//webpack.config.js
 
 const deps = require('../package.json').dependencies;
 const federationConfig = require('./federation.config.json');
@@ -54,9 +55,10 @@ module.exports = {
 
 Then you can call `make-federated-types` from your `scripts` block in your package's `package.json` file:
 
-#### `package.json`
 
-```json
+```javascript
+//package.json
+
 scripts: {
     "make-types": "make-federated-types"
 }
@@ -66,19 +68,21 @@ 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:
 
-#### `package.json`
 
-```json
+```javascript
+//package.json
+
 scripts: {
     "make-types": "make-federated-types --outputDir ../../my_types/"
 }
 ```
-
-#### `package.json`
+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:
 
-```json
+```javascript
+//package.json
+
 scripts: {
     "make-types": "make-federated-types --config ./path/to/my/config.json --outputDir ../../my_types/"
 }

package/cli.js

@@ -6,8 +6,8 @@ const findNodeModules = require('find-node-modules');
 const ts = require('typescript');
 
 const formatHost = {
-  getCurrentDirectory: ts.sys.getCurrentDirectory,
-  getNewLine: () => ts.sys.newLine
+    getCurrentDirectory: ts.sys.getCurrentDirectory,
+    getNewLine: () => ts.sys.newLine
 };
 
 function reportDiagnostic(diagnostic) {
@@ -16,16 +16,26 @@ function reportDiagnostic(diagnostic) {
 
 const [nodeModules] = findNodeModules({ cwd: process.argv[1], relative: false });
 
+const hasArg = (argName) => {
+    const argIndex = process.argv.indexOf(argName);
+    return argIndex !== -1;
+};
 const getArg = (argName) => {
     const argIndex = process.argv.indexOf(argName);
     return argIndex !== -1 ? process.argv[argIndex + 1] : null;
 };
 
+const nodeModulesOutputDir = path.resolve(nodeModules, '@types/__federated_types/');
+const saveToNodeMoulesArg = hasArg('--saveToNodeModules');
 const outDirArg = getArg('--outputDir');
 
 const outputDir = outDirArg
     ? path.resolve('./', outDirArg)
-    : path.resolve(nodeModules, '@types/__federated_types/');
+    : nodeModulesOutputDir;
+
+const outputDirs = outputDir !== nodeModulesOutputDir && saveToNodeMoulesArg
+    ? [nodeModulesOutputDir, outputDir]
+    : [outputDir];
 
 const configPathArg = getArg('--config');
 const configPath = configPathArg
@@ -69,7 +79,6 @@ console.log(`Using config file: ${federationConfigPath}`);
 const federationConfig = require(federationConfigPath);
 const compileFiles = Object.values(federationConfig.exposes);
 const compileKeys = Object.keys(federationConfig.exposes);
-const outFile = path.resolve(outputDir, `${federationConfig.name}.d.ts`);
 
 function getModuleDeclareName(exposeName) {
     // windows paths 🤦
@@ -77,6 +86,7 @@ function getModuleDeclareName(exposeName) {
 }
 
 try {
+    const outFile = path.resolve(outputDir, `${federationConfig.name}.d.ts`);
     if (fs.existsSync(outFile)) {
         fs.unlinkSync(outFile);
     }
@@ -128,39 +138,41 @@ try {
         ].join('\n');
     });
 
-    console.log('writing typing file:', outFile);
+    outputDirs.forEach(_outputDir => {
+        const _outFile = path.resolve(_outputDir, `${federationConfig.name}.d.ts`);
 
-    fs.writeFileSync(outFile, typing);
+        console.log('writing typing file:', _outFile);
+        fs.mkdirSync(path.dirname(_outFile), { recursive: true });
+        fs.writeFileSync(_outFile, typing);
 
-    // if we are writing to the node_modules/@types directory, add a package.json file
-    if (outputDir.includes(path.join('node_modules', '@types'))) {
-        const packageJsonPath = path.resolve(outputDir, 'package.json');
+        console.debug(`using output dir: ${_outputDir}`);
+        // if we are writing to the node_modules/@types directory, add a package.json file
+        if (_outputDir.includes(path.join('node_modules', '@types'))) {
+            const packageJsonPath = path.resolve(_outputDir, 'package.json');
 
-        if (!fs.existsSync(packageJsonPath)) {
-            console.debug('writing package.json:', packageJsonPath);
-            fs.copyFileSync(path.resolve(__dirname, 'typings.package.tmpl.json'), packageJsonPath);
-        } else {
-            console.debug(packageJsonPath, 'already exists');
+            if (!fs.existsSync(packageJsonPath)) {
+                console.debug('writing package.json:', packageJsonPath);
+                fs.copyFileSync(path.resolve(__dirname, 'typings.package.tmpl.json'), packageJsonPath);
+            } else {
+                console.debug(packageJsonPath, 'already exists');
+            }
         }
-    } else {
-        console.debug('not writing to node modules, dont need a package.json');
-    }
 
-    // write/update the index.d.ts file
-    const indexPath = path.resolve(outputDir, 'index.d.ts');
-    const importStatement = `export * from './${federationConfig.name}';`;
-
-    if (!fs.existsSync(indexPath)) {
-        console.log('creating index.d.ts file');
-        fs.writeFileSync(indexPath, `${importStatement}\n`);
-    } else {
-        console.log('updating index.d.ts file');
-        const contents = fs.readFileSync(indexPath);
-        if (!contents.includes(importStatement)) {
-            fs.writeFileSync(indexPath, `${contents}${importStatement}\n`);
-        }
-    }
+        // write/update the index.d.ts file
+        const indexPath = path.resolve(_outputDir, 'index.d.ts');
+        const importStatement = `export * from './${federationConfig.name}';`;
 
+        if (!fs.existsSync(indexPath)) {
+            console.log('creating index.d.ts file');
+            fs.writeFileSync(indexPath, `${importStatement}\n`);
+        } else {
+            console.log('updating index.d.ts file');
+            const contents = fs.readFileSync(indexPath);
+            if (!contents.includes(importStatement)) {
+                fs.writeFileSync(indexPath, `${contents}${importStatement}\n`);
+            }
+        }
+    });
     console.debug('Success!');
 } catch (e) {
     console.error(`ERROR:`, e);

package/package.json

@@ -1,20 +1,25 @@
 {
   "name": "@touk/federated-types",
-  "version": "1.1.0",
   "description": "share typings for your federated typescript packages around your mono-repo",
-  "main": "cli.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 0",
-    "semantic-release": "semantic-release"
-  },
+  "version": "1.2.0-beta.2",
   "author": "Julian Wielga <j@touk.pl>",
+  "bin": {
+    "make-federated-types": "./cli.js"
+  },
   "contributors": [
     "Jonathan Greene <jgreene@pixability.com>"
   ],
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/touk/federated-types.git"
+  "dependencies": {
+    "find-node-modules": "2.1.3"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "17.1.2",
+    "@commitlint/config-conventional": "13.2.0",
+    "@semantic-release/changelog": "6.0.1",
+    "@semantic-release/git": "10.0.1",
+    "husky": "8.0.1",
+    "prettier": "2.7.1",
+    "semantic-release": "19.0.5"
   },
   "files": [
     "cli.js",
@@ -22,26 +27,21 @@
   ],
   "keywords": [
     "module-federation",
+    "mono-repo",
     "typescript",
-    "typings",
-    "mono-repo"
+    "typings"
   ],
-  "bin": {
-    "make-federated-types": "./cli.js"
-  },
+  "license": "MIT",
+  "main": "cli.js",
   "peerDependencies": {
-    "typescript": "^4.0.5"
+    "typescript": ">4.0.0"
   },
-  "devDependencies": {
-    "@commitlint/cli": "^13.1.0",
-    "@commitlint/config-conventional": "^13.1.0",
-    "@semantic-release/changelog": "^5.0.1",
-    "@semantic-release/git": "^9.0.0",
-    "husky": "^7.0.1",
-    "prettier": "^2.1.2",
-    "semantic-release": "^17.4.4"
+  "repository": "touk/federated-types.git",
+  "scripts": {
+    "semantic-release": "semantic-release",
+    "test": "npm run make-types -workspaces --if-present"
   },
-  "dependencies": {
-    "find-node-modules": "^2.1.2"
-  }
+  "workspaces": [
+    "./packages/*"
+  ]
 }