Merge pull request #33 from Himenon/feature/export-static

feat(export-static): add `--export-static` option

Author: Himenon

.vscode/launch.json

@@ -13,6 +13,16 @@
       "program": "${workspaceFolder}/packages/cli/bin/code-dependency.js",
       "outFiles": ["${workspaceFolder}/**/*.js"],
       "args": ["--source", "src"]
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "export static",
+      "skipFiles": ["<node_internals>/**"],
+      "cwd": "${workspaceFolder}/packages/cli",
+      "program": "${workspaceFolder}/packages/cli/bin/code-dependency.js",
+      "outFiles": ["${workspaceFolder}/**/*.js"],
+      "args": ["--source", "src", "--export-static", "${workspaceFolder}/packages/cli/output"]
     }
   ]
 }

lerna.json

@@ -11,14 +11,10 @@
     "publish": {
       "access": "public",
       "allowBranch": "master",
-      "ignoreChanges": [
-        "CHANGELOG.md"
-      ]
+      "ignoreChanges": ["CHANGELOG.md"]
     }
   },
-  "packages": [
-    "packages/*"
-  ],
+  "packages": ["packages/*"],
   "version": "0.3.6",
   "npmClient": "yarn",
   "registry": "https://registry.npmjs.org/",

packages/cli/.gitignore

@@ -8,3 +8,4 @@ package-lock.json
 private_npm_cache
 data
 dist
+output

packages/cli/README.md

@@ -51,6 +51,29 @@ cruise ignore pattern (default: "node_modules"). [see](https://github.com/sverwe
 code-dependency --source ./src --exclude node_modules
 ```
 
+**--export-static**
+
+generate static site.
+
+```bash
+code-dependency --source ./src --exclude node_modules --export-static ./docs
+```
+
+**--public-path**
+
+```bash
+code-dependency --source ./src --exclude node_modules --export-static ./docs --public-path /docs
+code-dependency --source ./src --exclude node_modules --export-static ./docs --public-path https://himenon.github.io/code-dependency/
+```
+
+**--dry-run** (experimental)
+
+if failed generate static file and retry generate static file only unfinished path.
+
+```bash
+code-dependency --source ./src --exclude node_modules --export-static ./docs --dry-run
+```
+
 ## License
 
 @code-dependency/cli is [MIT licensed](https://github.com/Himenon/code-dependency/blob/master/LICENSE).

packages/cli/package.json

@@ -33,9 +33,11 @@
     "build:webpack": "webpack --config ./scripts/build.ts",
     "clean": "rimraf ./lib ./build ./dist",
     "develop": "cross-env NODE_ENV=development yarn build:webpack --watch",
+    "export:static": "node ./bin/code-dependency.js --source ./src --exclude node_modules --export-static ./output --public-path http://localhost:5000/output",
+    "generate:docs": "node ./bin/code-dependency.js --source ./src --exclude node_modules --export-static ../../docs --public-path https://himenon.github.io/code-dependency/",
     "server": "nodemon ./bin/code-dependency.js --source ./src --exclude node_modules",
     "start": "run-p develop server",
-    "test": "jest -c jest.config.json",
+    "test": "jest -c jest.config.json && yarn export:static",
     "test:depcruise": "depcruise --validate .dependency-cruiser.json src",
     "ts": "ts-node -P tsconfig.json"
   },
@@ -56,7 +58,9 @@
     "react-router-dom": "^5.1.2",
     "recursive-readdir": "^2.2.2",
     "resolve-pkg": "^2.0.0",
-    "tsconfig": "^7.0.0"
+    "rimraf": "^3.0.1",
+    "tsconfig": "^7.0.0",
+    "urljoin": "^0.1.5"
   },
   "devDependencies": {
     "@types/compression": "^1.0.1",
@@ -65,7 +69,8 @@
     "@types/fs-extra": "^8.0.1",
     "@types/pretty": "^2.0.0",
     "@types/react": "^16.9.17",
-    "@types/react-dom": "^16.9.4"
+    "@types/react-dom": "^16.9.4",
+    "@types/rimraf": "^2.0.3"
   },
   "publishConfig": {
     "access": "public"

packages/cli/scripts/webpack.config.ts

@@ -1,5 +1,6 @@
 import * as path from "path";
 import * as webpack from "webpack";
+import { CleanWebpackPlugin } from "clean-webpack-plugin";
 
 const ProgressBarPlugin = require("progress-bar-webpack-plugin");
 const FriendlyErrorsWebpackPlugin = require("friendly-errors-webpack-plugin");
@@ -47,6 +48,7 @@ export const generateConfig = ({ isProduction }: Option): webpack.Configuration[
       plugins: [
         new ProgressBarPlugin(),
         new FriendlyErrorsWebpackPlugin(),
+        new CleanWebpackPlugin(),
         new webpack.DefinePlugin({
           "process.env.NODE_ENV": JSON.stringify("production"),
           "process.env.isProduction": JSON.stringify(isProduction),

packages/cli/src/cli/index.ts

@@ -10,6 +10,9 @@ interface CLIArguments {
   tsConfig?: PathFactory.Type;
   exclude?: string;
   webpackConfig?: PathFactory.Type;
+  exportStatic?: PathFactory.Type;
+  publicPath?: string;
+  dryRun: boolean;
 }
 
 export const validateCliArguments = (args: commander.Command): CLIArguments => {
@@ -25,6 +28,9 @@ export const validateCliArguments = (args: commander.Command): CLIArguments => {
     tsConfig: args["tsConfig"] && PathFactory.create({ source: args["tsConfig"] }),
     exclude: args["exclude"],
     webpackConfig: args["webpackConfig"] && PathFactory.create({ source: args["webpackConfig"] }),
+    exportStatic: args["exportStatic"] && PathFactory.create({ source: args["exportStatic"] }),
+    publicPath: args["publicPath"],
+    dryRun: !!args["dryRun"],
   };
 };
 
@@ -36,6 +42,9 @@ export const executeCommandLine = (): CLIArguments => {
     .option("--ts-config [path]", "tsconfig.json path", undefined)
     .option("--webpack-config [path]", "webpack.config.js path (only js file)")
     .option("--exclude [string pattern]", "cruise exclude pattern", "node_modules")
+    .option("--export-static [static directory]", "static file hosting directory")
+    .option("--public-path [host public path]", "the base path for all the assets")
+    .option("--dry-run", "only use --export-static option")
     .parse(process.argv);
   return validateCliArguments(commander);
 };

packages/cli/src/constants/router.ts

@@ -0,0 +1,11 @@
+export const routes = {
+  project: {
+    path: "/project",
+  },
+  assets: {
+    path: "/assets",
+  },
+  api: {
+    path: "/api",
+  },
+};

packages/cli/src/controller/StylesheetsController.tsx renamed to packages/cli/src/controller/AssetController.tsx

@@ -3,6 +3,6 @@ import { find } from "../utils";
 
 export const create = () => {
   const router = express.Router();
-  router.use("/", express.static(find("@code-dependency/view/dist/stylesheets")));
+  router.use("/", express.static(find("@code-dependency/view/dist/")));
   return router;
 };

packages/cli/src/controller/IndexController.tsx renamed to packages/cli/src/controller/ProjectController.tsx

@@ -1,6 +1,6 @@
 import express from "express";
 import ReactDOMServer from "react-dom/server";
-import { IndexView } from "../view";
+import { ProjectView } from "../view";
 import * as Service from "../service";
 import * as Config from "../config";
 
@@ -9,8 +9,16 @@ export const create = (service: Service.Type, config: Config.Type) => {
   router.get("/", async (req, res) => {
     const serverUrl = `${req.protocol}://${req.hostname}:${config.server.port}`;
     try {
-      const props: IndexView.Props = { serverUrl, url: req.url, context: {}, service, filePathList: config.filePathList };
-      const html = ReactDOMServer.renderToString(await IndexView.create(props));
+      const props: ProjectView.Props = {
+        serverUrl,
+        publicPath: serverUrl,
+        url: req.url,
+        pathname: req.query.pathname,
+        context: {},
+        service,
+        filePathList: config.filePathList,
+      };
+      const html = ReactDOMServer.renderToString(await ProjectView.create(props));
       res.send(html);
       res.end();
     } catch (error) {