Merge pull request #53 from darkriszty/feature/npm

Feature/npm

Author: darkriszty

CHANGELOG.md

@@ -6,6 +6,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ## [Unreleased]
 
+## 3.2.2 - 2020-01-11
+### Added
+- Issue #49: NPM package support.
+
+## 3.2.1 - 2020-01-01
+### Fixed
+- Issue #50: Dockerfile improvements.
+
 ## 3.2.0 - 2020-12-14
 ### Added
 - Issue #47: Support for indented tables.

README.md

@@ -1,59 +1,97 @@
-# Markdown table prettifier extension for Visual Studio Code
+# Markdown table prettifier
 
 [![Test Status](https://github.com/darkriszty/MarkdownTablePrettify-VSCodeExt/workflows/Tests/badge.svg)](https://github.com/darkriszty/MarkdownTablePrettify-VSCodeExt/actions)
+[![Visual Studio Code extension](https://img.shields.io/visual-studio-marketplace/v/darkriszty.markdown-table-prettify?color=success&label=VSCode)](https://marketplace.visualstudio.com/items?itemName=darkriszty.markdown-table-prettify)
+[![Docker image](https://img.shields.io/docker/v/darkriszty/prettify-md?color=success&label=Docker)](https://hub.docker.com/r/darkriszty/prettify-md/tags?page=1&ordering=last_updated)
+[![NPM package](https://img.shields.io/npm/v/markdown-table-prettify?color=success)](https://www.npmjs.com/package/markdown-table-prettify)
 
 Makes tables more readable for humans. Compatible with the Markdown writer plugin's table formatter feature in Atom.
 
-## Features
+## Feature highlights
 
 - Remove redundant ending table border if the beginning has no border, so the table _will not end_ with "|".
 - Create missing ending table border if the beginning already has a border, so the table _will end_ with "|".
 - Save space by not right-padding the last column if the table has no border.
 - Support empty columns inside tables.
 - Support column alignment options with ":".
-- CLI and docker support to prettify files.
+- Find and format multiple tables.
+- Support indented tables.
+
+## Visual Studio Code
 
 ![feature X](assets/animation.gif)
 
-### CLI formatting
+The extension is available for markdown language mode. It can either prettify a selection (`Format Selection`) or the entire document (`Format Document`).
+A VSCode command called `Prettify markdown tables` is also available to format the currently opened document. 
 
-Formatting files or checking if they're already formatted is possible from the command line. This requires `node` and `npm`.
+Configurable settings:
+- The maximum texth length of a selection/entire document to consider for formatting. Defaults to 1M chars. (limit does not apply from CLI or NPM).
+- Keyboard shortcut to prettify the currently opened markdown document. Default: CTRL+ALT+M (CMD+ALT+M on Mac).
 
-The extension has to be downloaded and compiled:
-- Locate the installed extension path or download the extension from Github.
-- Go to the extension directory.
-- Run `npm install`.
-- Run `npm run compile`.
+## NPM
 
-The typical location of the installed extension (your actual version might differ):
-- Windows: `%USERPROFILE%\.vscode\extensions\darkriszty.markdown-table-prettify-3.0.0`
-- macOS: `~/.vscode/extensions/darkriszty.markdown-table-prettify-3.0.0`
-- Linux: `~/.vscode/extensions/darkriszty.markdown-table-prettify-3.0.0`
+The core formatting logic is available as an NPM package: `npm install --save markdown-table-prettify`. The Typescript code is compiled down to ES5 and shipped inside the package.
 
-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.
+It currently exposes the entry point also used by the _CLI_. It can be used from regular NodeJS or web apps:
+
+```JS
+import { CliPrettify } from 'markdown-table-prettify';
+// or
+const { CliPrettify } = require('markdown-table-prettify');
 
-> 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.
+console.log(CliPrettify.prettify(
+`hello|world
+-|-
+foo|bar`));
 
-### Formatting with docker
+/* Output:
+hello | world
+------|------
+foo   | bar
+*/
+```
 
-The core formatting logic of the extension is also available as a node docker image: `docker pull darkriszty/prettify-md`.
+## Docker
+
+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.
 
-## Extension Settings
+## CLI
 
-The extension is available for markdown language mode. It can either prettify a selection (`Format Selection`) or the entire document (`Format Document`).
-A VSCode command called `Prettify markdown tables` is also available to format the currently opened document. 
+Formatting files or checking if they're already formatted is possible from the command line. This requires `node` and `npm` (optionally also `npx`).
 
-Configurable settings:
-- The maximum texth length of a selection/entire document to consider for formatting. Defaults to 1M chars. There is no limit when running from the command line.
-- Keyboard shortcut to prettify the currently opened markdown document. Default: CTRL+ALT+M (CMD+ALT+M on Mac).
+### 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.
+
+> 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.
+
+### Installation
+
+To access the CLI, the extension can either be used from the Github sources, from the already instaledl VSCode extension or from NPM.
+
+#### Compiling from the source code
+
+- Download the source code.
+- Go to the extension directory.
+- Run `npm install`.
+- Run `npm run compile`.
+
+#### Using the already installed VSCode extension
+
+Locate the installed extension path. The typical location of the installed extension:
+- Windows: `%USERPROFILE%\.vscode\extensions\darkriszty.markdown-table-prettify-{version}`
+- macOS: `~/.vscode/extensions/darkriszty.markdown-table-prettify-{version}`
+- Linux: `~/.vscode/extensions/darkriszty.markdown-table-prettify-{version}`
+
+#### 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`).
 
 ## Known Issues
 

cli/index.ts

@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 import { CliPrettify } from "./cliPrettify";
 import { InputReader } from "./inputReader";
 

gulpfile.js

@@ -1,7 +1,14 @@
 var gulp = require("gulp");
+var merge = require("gulp-merge-json");
 
 gulp.task("copy-systemTest-resources", function() {
     return gulp
             .src("test/systemTests/resources/*")
             .pipe(gulp.dest("out/test/systemTests/resources"));
-});
+});
+
+gulp.task("merge-packagejson-for-npm-dist", function () {
+    return gulp.src("package.*json")
+        .pipe(merge({fileName: "package.json"}))
+        .pipe(gulp.dest("out"));
+});