Merge pull request #63 from darkriszty/fb/column-padding

Fb/column padding

Author: darkriszty

README.md

@@ -29,7 +29,8 @@ A VSCode command called `Prettify markdown tables` is also available to format t
 ### Configurable settings:
 - The maximum texth length of a selection/entire document to consider for formatting. Default: 1M chars (limit does not apply from CLI or NPM).
 - Additional languages to support formatting for besides `markdown`. See possible configurable values [here](https://code.visualstudio.com/docs/languages/identifiers#_known-language-identifiers). Default: `[ ]`.
-- Keyboard shortcut to prettify the currently opened markdown document. Default: CTRL+ALT+M (CMD+ALT+M on Mac).
+- Column padding to make the columns more spaced out from each other. Default: `0` (no extra spacing/padding).
+- Keyboard shortcut to prettify the currently opened markdown document. Default: <kbd>CTRL</kbd>+<kbd>ALT</kbd>+<kbd>M</kbd> (<kbd>CMD</kbd>+<kbd>ALT</kbd>+<kbd>M</kbd> on Mac).
 
 ## NPM
 
@@ -46,42 +47,51 @@ console.log(CliPrettify.prettify(
 `hello|world
 -|-
 foo|bar`));
-
 /* Output:
 hello | world
 ------|------
 foo   | bar
 */
-```
 
-## Docker
+// specifying a column padding
+console.log(CliPrettify.prettify(
+`hello|world
+-|-
+foo|bar`, { columnPadding: 1 }));
+/* Output:
+ hello  |  world
+ ------ | ------
+ foo    |  bar
+*/
 
-The core formatting logic is available as a node docker image: `docker pull darkriszty/prettify-md`.
+```
 
-Available features from docker:
-- To prettify a file: `docker container run -i darkriszty/prettify-md < input.md`.
-- To prettify a file and save the output: `docker container run -i darkriszty/prettify-md < input.md > output.md`.
-- To check whether a file is prettyfied or not: `docker container run -i darkriszty/prettify-md --check < input.md`. This will fail with an exception and return code `1` if the file is not prettyfied.
+## Docker & CLI
 
-## CLI
+The core formatting logic is available as a node docker image: `docker pull darkriszty/prettify-md` or as a stand alone CLI tool.
 
-Formatting files or checking if they're already formatted is possible from the command line. This requires `node` and `npm` (optionally also `npx`).
+Formatting files or checking if they're already formatted is also possible from the command line without docker. This requires `node` and `npm` (optionally also `npx`).
 
-### Available features from the command line:
-- To prettify a file: `npm run --silent prettify-md < input.md`.
-- To prettify a file and save the output: `npm run --silent prettify-md < input.md > output.md`.
-- To check whether a file is prettyfied or not: `npm run --silent check-md < input.md`. This will fail with an exception and return code `1` if the file is not prettyfied.
+| Feature                               | Docker                                                                        | CLI                                                            |
+|---------------------------------------|-------------------------------------------------------------------------------|----------------------------------------------------------------|
+| Prettify a file                       | `docker container run -i darkriszty/prettify-md < input.md`                   | `npm run --silent prettify-md < input.md`                      |
+| Prettify a file and save the output   | `docker container run -i darkriszty/prettify-md < input.md > output.md`       | `npm run --silent prettify-md < input.md > output.md`          |
+| Check whether a file is pretty or not | `docker container run -i darkriszty/prettify-md --check < input.md`           | `npm run --silent check-md < input.md`                         |
+| Use `1` as column padding             | `docker container run -i darkriszty/prettify-md --columnPadding=1 < input.md` | `npm run --silent prettify-md -- --columnPadding=1 < input.md` |
 
-> Note: the `--silent` switch sets the NPM log level to silent, which is useful to hide the executed file name and concentrate on the actual output.
+> Notes:
+> * The prettify check (`--check` or `check-md`) will fail with an exception and return code `1` if the file is not prettyfied.
+> * The `--silent` switch sets the NPM log level to silent, which is useful to hide the executed file name and concentrate on the actual output.
+> * The `--` after the npm run script part is needed for npm to forward the arguments (for instance `--columnPadding=1`) to the actual prettyfier script.
+> * Optionally, use `npx` to prettify files: `npx markdown-table-prettify < input.md` instead of `npm run --silent prettify-md < input.md`.
 
 ### Installation
 
-To access the CLI, the extension can either be used from the Github sources, from the already instaledl VSCode extension or from NPM.
+To access the CLI, the extension can either be used from the Github sources, from the already installed VSCode extension or from NPM.
 
 #### Compiling from the source code
 
-- Download the source code.
-- Go to the extension directory.
+- Clone or download the source code.
 - Run `npm install`.
 - Run `npm run compile`.
 
@@ -94,7 +104,7 @@ Locate the installed extension path. The typical location of the installed exten
 
 #### Getting it from NPM
 
-Install the NPM package `npm install -g markdown-table-prettify`. Optionally, use `npx` to prettify files: `npx markdown-table-prettify < input.md` (instead of `npm run --silent prettify-md < input.md`).
+Install the NPM package `npm install -g markdown-table-prettify`. 
 
 ## Known Issues
 

cli/argumentsParser.ts

@@ -0,0 +1,29 @@
+import { CliOptions } from "./cliOptions";
+
+export function parseArguments(processArgs: string[]): CliOptions {
+    return <CliOptions> {
+        check: Boolean(hasArgument(ArgumentNames.CHECK_ARG) || false),
+        columnPadding: Number(getArgumentValue(ArgumentNames.PADDING_ARG) || 0)
+    };
+
+    function hasArgument(key: string): boolean {
+        return processArgs.length > 2 && processArgs.find(arg => arg.startsWith("--" + key)) !== undefined;
+    }
+
+    function getArgumentValue(key: string): string {
+        const hasArguments = processArgs.length > 2;
+        const split = (hasArguments
+            ? processArgs.find(arg => arg.startsWith("--" + key)) || ""
+            : "")
+            .split("=");
+
+        return split.length == 2
+            ? split[1]
+            : null;
+    }
+}
+
+class ArgumentNames {
+    public static readonly CHECK_ARG : string = "check";
+    public static readonly PADDING_ARG : string = "columnPadding";
+}

cli/cliOptions.ts

@@ -0,0 +1,4 @@
+export interface CliOptions {
+    check: Boolean;
+    columnPadding: number;
+}

cli/cliPrettify.ts

@@ -1,11 +1,13 @@
+import { CliOptions}  from "./cliOptions";
 import { MultiTablePrettyfier } from "../src/prettyfiers/multiTablePrettyfier";
 import { TableFinder } from "../src/tableFinding/tableFinder";
 import { TableValidator } from "../src/modelFactory/tableValidator";
 import { SelectionInterpreter } from "../src/modelFactory/selectionInterpreter";
 import { TableFactory } from "../src/modelFactory/tableFactory";
 import { AlignmentFactory } from "../src/modelFactory/alignmentFactory";
-import { TrimmerTransformer } from "../src/modelFactory/transformers/trimmerTransformer";
 import { BorderTransformer } from "../src/modelFactory/transformers/borderTransformer";
+import { TrimmerTransformer } from "../src/modelFactory/transformers/trimmerTransformer";
+import { FairTableIndentationDetector } from "../src/modelFactory/tableIndentationDetector";
 import { ConsoleLogger } from "../src/diagnostics/consoleLogger";
 import { SingleTablePrettyfier } from "../src/prettyfiers/singleTablePrettyfier";
 import { NoSizeLimitChecker } from "../src/prettyfiers/sizeLimit/noSizeLimitChecker";
@@ -15,22 +17,22 @@ import { ContentPadCalculator } from "../src/padCalculation/contentPadCalculator
 import { PadCalculatorSelector } from "../src/padCalculation/padCalculatorSelector";
 import { AlignmentMarkerStrategy } from "../src/viewModelFactories/alignmentMarking";
 import { TableStringWriter } from "../src/writers/tableStringWriter";
-import { FairTableIndentationDetector } from "../src/modelFactory/tableIndentationDetector";
+import { ValuePaddingProvider } from "../src/writers/valuePaddingProvider";
 
 export class CliPrettify {
 
-    public static prettify(text: string): string {
-        const prettyfier = this.createPrettyfier();
+    public static prettify(text: string, options?: CliOptions): string {
+        const prettyfier = this.createPrettyfier(options);
         return prettyfier.formatTables(text);
     }
 
-    public static check(text: string): void {
-        if (this.prettify(text) !== text) {
+    public static check(text: string, options?: CliOptions): void {
+        if (this.prettify(text, options) !== text) {
             throw new Error("The input file is not prettyfied!");
         }
     }
 
-    private static createPrettyfier(): MultiTablePrettyfier {
+    private static createPrettyfier(options?: CliOptions): MultiTablePrettyfier {
         const logger = new ConsoleLogger();
         return new MultiTablePrettyfier(
             new TableFinder(new TableValidator(new SelectionInterpreter(true))),
@@ -43,10 +45,10 @@ export class CliPrettify {
                 ),
                 new TableValidator(new SelectionInterpreter(false)),
                 new TableViewModelFactory(new RowViewModelFactory(
-                    new ContentPadCalculator(new PadCalculatorSelector(), " "), 
+                    new ContentPadCalculator(new PadCalculatorSelector(), " "),
                     new AlignmentMarkerStrategy(":")
                 )),
-                new TableStringWriter(),
+                new TableStringWriter(new ValuePaddingProvider(options?.columnPadding ?? 0)),
                 [ logger ],
                 new NoSizeLimitChecker()
             ),

cli/index.ts

@@ -1,12 +1,14 @@
 #!/usr/bin/env node
 
+import { parseArguments } from "./argumentsParser";
+import { CliOptions } from "./cliOptions";
 import { CliPrettify } from "./cliPrettify";
 import { InputReader } from "./inputReader";
 
-const checkOnly = process.argv.length > 2 || process.argv.find(arg => arg === "--check");
+const cliOptions: CliOptions = parseArguments(process.argv);
 
 InputReader.subscribe(input =>
-    checkOnly
-        ? CliPrettify.check(input)
-        : process.stdout.write(CliPrettify.prettify(input))
+    cliOptions.check
+        ? CliPrettify.check(input, cliOptions)
+        : process.stdout.write(CliPrettify.prettify(input, cliOptions))
 );