Merge pull request #29 from Himenon/add-cli-option

feat: add exclude,webpack options

Author: Himenon

.lintstagedrc

@@ -1,5 +1,5 @@
 {
-  "*.{js,jsx,json,yml,yaml,html}": ["prettier --write", "git add"],
-  "*.{ts,tsx}": ["yarn run format", "yarn run lint", "git add"],
+  "*.{js,jsx,json,yml,yaml,html,md}": ["prettier --write", "git add"],
+  "*.{ts,tsx}": ["yarn format", "prettier --write", "git add"],
   "package.json": ["sort-package-json", "git add"]
 }

CHANGELOG.md

@@ -4,14 +4,11 @@ All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
 <a name="0.3.3"></a>
+
 ## 0.3.3 (2020-01-07)
 
 **Note:** Version bump only for package code-dependency
 
-
-
-
-
 <a name="0.3.2"></a>
 
 ## 0.3.2 (2020-01-07)

README.md

@@ -13,6 +13,8 @@ code-dependency --source ./src
 # open localhost:3000
 ```
 
+see [other option](./packages/cli/README.md#option).
+
 ![code dependency usage image](./docs/code-dependency-image.png)
 
 ## Core development UI / APi

lerna.json

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

packages/cli/CHANGELOG.md

@@ -4,14 +4,11 @@ All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
 <a name="0.3.3"></a>
+
 ## 0.3.3 (2020-01-07)
 
 **Note:** Version bump only for package @code-dependency/cli
 
-
-
-
-
 <a name="0.3.2"></a>
 
 ## 0.3.2 (2020-01-07)

packages/cli/README.md

@@ -6,6 +6,51 @@
 code-dependency --source ./src
 ```
 
+## Option
+
+**-s --source** (required)
+
+Source directory path
+
+```bash
+code-dependency --source ./src
+code-dependency --source /home/app/src
+```
+
+**-p --port**
+
+Server port number (default 3000).
+
+```bash
+code-dependency --source ./src --p 4000
+code-dependency --source ./src --port 4000
+```
+
+**--ts-config**
+
+`tsconfig.json` path. [see](https://github.com/sverweij/dependency-cruiser/blob/develop/doc/cli.md#--ts-config-use-a-typescript-configuration-file-project)
+
+```bash
+code-dependency --source ./src --ts-config ./tsconfig.json
+```
+
+**--webpack-config**
+
+`webpack.config.js` path. (JavaScript only) [see](https://github.com/sverweij/dependency-cruiser/blob/develop/doc/cli.md#--webpack-config-use-the-resolution-options-of-a-webpack-configuration)
+
+```bash
+code-dependency --source ./src --webpack-config webpack.config.js
+code-dependency --source ./src --webpack-config your.config.js
+```
+
+**--exclude**
+
+cruise ignore pattern (default: "node_modules"). [see](https://github.com/sverweij/dependency-cruiser/blob/develop/doc/cli.md#--exclude-exclude-dependencies-from-being-cruised)
+
+```bash
+code-dependency --source ./src --exclude node_modules
+```
+
 ## License
 
 @code-dependency/cli is [MIT licensed](https://github.com/Himenon/code-dependency/blob/master/LICENSE).

packages/cli/package.json

@@ -33,7 +33,7 @@
     "build:webpack": "webpack --config ./scripts/build.ts",
     "clean": "rimraf ./lib ./build ./dist",
     "develop": "cross-env NODE_ENV=development yarn build:webpack --watch",
-    "server": "nodemon ./bin/code-dependency.js --source ./src",
+    "server": "nodemon ./bin/code-dependency.js --source ./src --exclude node_modules",
     "start": "run-p develop server",
     "test": "jest -c jest.config.json",
     "test:depcruise": "depcruise --validate .dependency-cruiser.json src",

packages/cli/scripts/webpack.config.ts

@@ -47,6 +47,7 @@ export const generateConfig = ({ isProduction }: Option): webpack.Configuration[
         new ProgressBarPlugin(),
         new FriendlyErrorsWebpackPlugin(),
         new webpack.DefinePlugin({
+          "process.env.NODE_ENV": JSON.stringify("production"),
           "process.env.isProduction": JSON.stringify(isProduction),
           "process.env.VERSION": JSON.stringify(require("../package.json").version),
         }),

packages/cli/src/cli/PathFactory.ts

@@ -19,6 +19,8 @@ export const convertSourceToAbsolutePath = (source: string, context: string = pr
 export const create = ({ context = process.cwd(), source }: Params) => {
   const absolutePath = convertSourceToAbsolutePath(source);
   return {
+    original: source,
+    binRelativePath: path.relative(__dirname, source),
     rootDir: path.dirname(absolutePath),
     rootAbsolutePath: absolutePath,
   };

packages/cli/src/cli/index.ts

@@ -7,29 +7,35 @@ const isInvalidPath = require("is-invalid-path");
 interface CLIArguments {
   source: PathFactory.Type;
   port: number;
-  tsconfig?: PathFactory.Type;
+  tsConfig?: PathFactory.Type;
+  exclude?: string;
+  webpackConfig?: PathFactory.Type;
 }
 
 export const validateCliArguments = (args: commander.Command): CLIArguments => {
   if (typeof args["source"] !== "string" || isInvalidPath(args["source"])) {
     throw new SourcePathInvalidError("`--source` arguments does not selected.");
   }
-  if (args["tsconfig"] && isInvalidPath(args["source"])) {
+  if (args["tsConfig"] && isInvalidPath(args["source"])) {
     throw new SourcePathInvalidError("`--source` arguments does not selected.");
   }
   return {
     source: PathFactory.create({ source: args["source"] }),
     port: args["port"],
-    tsconfig: args["tsconfig"] && PathFactory.create({ source: args["tsconfig"] }),
+    tsConfig: args["tsConfig"] && PathFactory.create({ source: args["tsConfig"] }),
+    exclude: args["exclude"],
+    webpackConfig: args["webpackConfig"] && PathFactory.create({ source: args["webpackConfig"] }),
   };
 };
 
 export const executeCommandLine = (): CLIArguments => {
   commander
     .version(process.env.VERSION!) // add webpack.DefinePlugin
-    .option("-s --source [value]", "Source Directory or File")
-    .option("-p --port [value]", "Port number", 3000)
-    .option("--tsconfig [value]", "tsconfig.json path", undefined)
+    .option("-s --source [directory]", "Source directory")
+    .option("-p --port [number]", "Port number", 3000)
+    .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")
     .parse(process.argv);
   return validateCliArguments(commander);
 };