feat(info): adding more functionality to info package

packages/info/README.md

@@ -9,22 +9,55 @@ This package returns a set of information related to the local environment.
 ## Installation
 
 ```bash
+#npm
 npm i -D @webpack-cli/info
+
+#yarn
+yarn add @webpack-cli/info -D
 ```
 
 ## Usage
 
+### Args / Flags
+
+#### Output format
+
+| Flag         | Description                   | Type        |     |     |
+| ------------ | ----------------------------- | ----------- | --- | --- |
+| `--json`     | To get the output as JSON     | [ boolean ] |     |     |
+| `--markdown` | To get the output as markdown | [ boolean ] |     |     |
+
+#### Options
+
+| Flag                   | Description                                                    | Type        |
+| ---------------------- | -------------------------------------------------------------- | ----------- |
+| `--help`               | Show help                                                      | [ boolean ] |
+| `--version`            | Show version number                                            | [ boolean ] |
+| `--system` , `--sys`   | System information ( OS, CPU )                                 | [ boolean ] |
+| `--binaries` , `--bin` | Installed binaries                                             | [ boolean ] |
+| `--browsers`           | Installed web browsers                                         | [ boolean ] |
+| `--npmg`               | Globally installed NPM packages ( webpack & webpack-cli only ) | [ boolean ] |
+| `--npmPackages`        | Info about webpack installed in the project                    | [ boolean ] |
+
 ### Node
 
 ```js
-const envinfo = require("@webpack-cli/info").default;
-envinfo();
+const info = require("webpack-cli/packages/info").default;
+
+async function wrapperFunc() {
+	let envinfo = await info({
+		/* Custom Config */
+	});
+}
+wrapperFunc();
 ```
 
+**Custom Config** => Custom arguments are key pair boolean values.
+
 ### CLI (via `webpack-cli`)
 
 ```bash
-npx webpack-cli info
+webpack-cli info --FLAGS #Flags are optional for custom output
 ```
 
 [downloads]: https://img.shields.io/npm/dm/@webpack-cli/info.svg

packages/info/__tests__/index.test.ts

@@ -1,15 +1,45 @@
-import { information } from "../index";
-
-describe("info", () => {
-	it("should return the information of the enviroment", async () => {
-		const returnedInformation = information();
-		const expectedInformation = {
-			Binaries: ["Node", "Yarn", "npm"],
-			Browsers: ["Chrome", "Firefox", "Safari"],
-			System: ["OS", "CPU"],
-			npmGlobalPackages: ["webpack", "webpack-cli"],
-			npmPackages: "*webpack*"
-		};
+import { informationType } from "../index";
+
+describe("infoSystem", () => {
+	it("should return the information of the system", async () => {
+		const returnedInformation = informationType("system");
+		const expectedInformation = { System: ["OS", "CPU", "Memory"] };
+
+		expect(returnedInformation).toEqual(expectedInformation);
+	});
+});
+
+describe("infoBinaries", () => {
+	it("should return the information of the binaries", async () => {
+		const returnedInformation = informationType("binaries");
+		const expectedInformation = { Binaries: ["Node", "Yarn", "npm"] };
+
+		expect(returnedInformation).toEqual(expectedInformation);
+	});
+});
+
+describe("infoBrowsers", () => {
+	it("should return the information of the browsers installed", async () => {
+		const returnedInformation = informationType("browsers");
+		const expectedInformation = { Browsers: ["Chrome", "Firefox", "Safari"] };
+
+		expect(returnedInformation).toEqual(expectedInformation);
+	});
+});
+
+describe("infoNpmGlobal", () => {
+	it("should return the information of the NPM global packages", async () => {
+		const returnedInformation = informationType("npmg");
+		const expectedInformation = { npmGlobalPackages: ["webpack", "webpack-cli"] };
+
+		expect(returnedInformation).toEqual(expectedInformation);
+	});
+});
+
+describe("infoNpm", () => {
+	it("should return the information of the NPM packages (webpack)", async () => {
+		const returnedInformation = informationType("npm");
+		const expectedInformation = { npmPackages: "*webpack*" };
 
 		expect(returnedInformation).toEqual(expectedInformation);
 	});

packages/info/commands.ts

@@ -0,0 +1,13 @@
+export const AVAILABLE_COMMANDS: string[] = [
+	"binaries",
+	"system",
+	"browsers",
+	"npmGlobalPackages",
+	"npmPackages",
+	"bin",
+	"sys",
+	"npmg",
+	"npm"
+];
+export const AVAILABLE_FORMATS: string[] = ["json", "markdown"];
+export const IGNORE_FLAGS: string[] = ["_", "$0"];

packages/info/index.ts

@@ -1,29 +1,66 @@
+import chalk from "chalk";
 import * as envinfo from "envinfo";
 import * as process from "process";
+import { argv } from "./options";
 
-/**
- * Prints debugging information for webpack issue reporting
- */
+import { AVAILABLE_COMMANDS, AVAILABLE_FORMATS, IGNORE_FLAGS } from "./commands";
 
 interface Information {
-	Binaries: string[];
-	Browsers: string[];
-	System: string[];
-	npmGlobalPackages: string[];
-	npmPackages: string | string[];
+	Binaries?: string[];
+	Browsers?: string[];
+	System?: string[];
+	npmGlobalPackages?: string[];
+	npmPackages?: string | string[];
 }
 
-// eslint-disable-next-line
-export function information(): Information {
-	return {
-		Binaries: ["Node", "Yarn", "npm"],
-		Browsers: ["Chrome", "Firefox", "Safari"],
-		System: ["OS", "CPU"],
-		npmGlobalPackages: ["webpack", "webpack-cli"],
-		npmPackages: "*webpack*"
-	};
+const CONFIG = {};
+const DEFAULT_DETAILS: Information = {
+	Binaries: ["Node", "Yarn", "npm"],
+	Browsers: ["Chrome", "Firefox", "Safari"],
+	System: ["OS", "CPU", "Memory"],
+	npmGlobalPackages: ["webpack", "webpack-cli"],
+	npmPackages: "*webpack*"
+};
+
+let DETAILS_OBJ = {};
+
+export function informationType(type: string): Information {
+	switch (type) {
+		case "system":
+			return { System: ["OS", "CPU", "Memory"] };
+		case "binaries":
+			return { Binaries: ["Node", "Yarn", "npm"] };
+		case "browsers":
+			return { Browsers: ["Chrome", "Firefox", "Safari"] };
+		case "npmg":
+			return { npmGlobalPackages: ["webpack", "webpack-cli"] };
+		case "npm":
+			return { npmPackages: "*webpack*" };
+	}
 }
+export default async function info(CustomArgv: object): Promise<void> {
+	const CUSTOM_AGRUMENTS: boolean = typeof CustomArgv === "object";
+	const args = CUSTOM_AGRUMENTS ? CustomArgv : argv;
+
+	Object.keys(args).forEach(
+		(flag): void => {
+			if (IGNORE_FLAGS.includes(flag)) {
+				return;
+			} else if (AVAILABLE_COMMANDS.includes(flag)) {
+				const flagVal = informationType(flag);
+				DETAILS_OBJ = { ...DETAILS_OBJ, ...flagVal };
+			} else if (AVAILABLE_FORMATS.includes(flag)) {
+				CONFIG[flag] = true;
+			} else {
+				// Invalid option
+				process.stdout.write("\n" + chalk.bgRed(flag) + chalk.red(" is an invalid option" + "\n"));
+				return;
+			}
+		}
+	);
+
+	const OUTPUT = await envinfo.run(Object.keys(DETAILS_OBJ).length ? DETAILS_OBJ : DEFAULT_DETAILS, CONFIG);
+	!CUSTOM_AGRUMENTS ? process.stdout.write(OUTPUT + "\n") : null;
 
-export default async function info(): Promise<void> {
-	process.stdout.write(await envinfo.run(information()));
+	return OUTPUT;
 }

packages/info/options.ts

@@ -0,0 +1,46 @@
+import * as yargs from "yargs";
+export const argv = yargs
+	.option("system", {
+		alias: "sys",
+		demandOption: false,
+		describe: "System information (OS, CPU)",
+		type: "boolean"
+	})
+	.option("binaries", {
+		alias: "bin",
+		demandOption: false,
+		describe: "Installed binaries",
+		type: "boolean"
+	})
+
+	.option("browsers", {
+		demandOption: false,
+		describe: "Installed web browsers",
+		type: "boolean"
+	})
+	.option("npmg", {
+		demandOption: false,
+		describe: "Globally installed NPM packages (webpack & webpack-cli only)",
+		type: "boolean"
+	})
+	.option("npmPackages", {
+		demandOption: false,
+		describe: "Info about webpack installed in the project",
+		type: "boolean"
+	})
+	.option("json", {
+		demandOption: false,
+		describe: "To get the output as JSON",
+		type: "boolean"
+	})
+	.option("json", {
+		demandOption: false,
+		describe: "To get the output as JSON",
+		type: "boolean"
+	})
+	.option("markdown", {
+		demandOption: false,
+		describe: "To get the output as markdown",
+		type: "boolean"
+	})
+	.group(["json", "markdown"], `Output format`).argv;