Issue5 single install (#6)

* 🚑 Fixes (#5) * 📝 Updated CI/CD * 📝 Updated README * 🚑 Updated CICD to run internal build first
zeon256 · Aug 1, 2023 · cd6b0bf · cd6b0bf
1 parent 92f4c71
commit cd6b0bf
Show file tree

Hide file tree

Showing 10 changed files with 73 additions and 52 deletions.
diff --git a/.github/workflows/node.yml b/.github/workflows/node.yml
@@ -32,7 +32,7 @@ jobs:
 
         # need to build library first 
       - name: Build Lib project
-        run: npm run build:lib
+        run: npm run build:libInternal && npm run build:lib
 
       - name: Build CLI project
         run: npm run build:cli
@@ -45,34 +45,20 @@ jobs:
         with:
           name: release-artifact
           path: |
-            packages/cli/dist
             packages/lib/dist
+            dist
             package.lock.json
             package.json
       
       - name: Publish Library to NPM (dry run)
         # Only run if the commit is tagged with release/v<version>
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}          
-        run: npm set //registry.npmjs.org/:_authToken=$NODE_AUTH_TOKEN && cd packages/lib && npm publish --dry-run
+        run: npm set //registry.npmjs.org/:_authToken=$NODE_AUTH_TOKEN && npm publish --dry-run
 
-      - name: Publish CLI to NPM (dry run)
-        # Only run if the commit is tagged with release/v<version>
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npm set //registry.npmjs.org/:_authToken=$NODE_AUTH_TOKEN && cd packages/cli && npm publish --dry-run
-
       - name: Publish Library to NPM
         # Only run if the commit is tagged with release/v<version>
         if: startsWith(github.ref, 'refs/tags/release/v')
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}          
-        run: npm set //registry.npmjs.org/:_authToken=$NODE_AUTH_TOKEN && cd packages/lib && npm publish
-
-      - name: Publish CLI to NPM
-        # Only run if the commit is tagged with release/v<version>
-        if: startsWith(github.ref, 'refs/tags/release/v')
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npm set //registry.npmjs.org/:_authToken=$NODE_AUTH_TOKEN && cd packages/cli && npm publish
-
+        run: npm set //registry.npmjs.org/:_authToken=$NODE_AUTH_TOKEN && npm publish
diff --git a/README.md b/README.md
@@ -2,23 +2,19 @@
 > mdtable2json is a TypeScript library and CLI tool that allows you to transpile tables in your markdown file to minified JSON. With mdtable2json, you can easily convert your markdown table data into a structured JSON format.
 
 ## Features
+- ESModule support
 - Convert markdown tables to JSON
 - Command-line interface (CLI) tool for easy conversion
 - Multiple knobs available for customizing the conversion process. Don't need to minify? No problem! Prefer Array of Structures (AoS) over Structure of Arrays (SoA)? We got you covered!
 
-## Installation (CLI)
+## Installation (CLI and Library)
 ```bash
-npm install -g mdt2json-cli
-```
-
-## Installation (Library)
-```bash
-npm install mdt2json-ts
+npm install -g mdt2json
 ```
 
 ## CLI Usage
 ```bash
-Usage: mdt2json-cli-cli [options]
+Usage: mdt2json [options]
 
 Options:
   -f, --file <file>         file to transpile
@@ -32,7 +28,7 @@ Options:
 
 ## Library Usage
 ```typescript
-import { MarkdownTable2Json, JsonLayout } from 'mdt2json-ts';
+import { MarkdownTable2Json, JsonLayout } from 'mdt2json';
 
 const markdownString = `your_markdown_string_here`;
 const transpiler     = new MarkdownTable2Json({markdownString, layout: JsonLayout.AoS , minify: true });

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,15 +1,43 @@
 {
   "name": "mdt2json",
-  "version": "0.1.0",
-  "description": "Markdown Table to Minified JSON Transpiler",
-  "main": "index.js",
+  "version": "0.2.0",
+  "description": "Configurable Markdown Table to Minified JSON Transpiler",
+  "main": "./dist/lib/lib.js",
+  "types": "./dist/lib/lib.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/lib/lib.d.ts",
+      "default": "./dist/lib/lib.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "bin": {
+    "mdt2json": "./dist/cli/main.js",
+    "shebangify": "./shebangify.js" 
+  },
+  "files": [
+    "dist"
+  ],
+  "readme": "README.md",
+  "keywords": [
+    "markdown",
+    "table",
+    "json",
+    "transpiler"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zeon256/mdtable2json"
+  },
   "workspaces": [
     "packages/cli",
     "packages/lib"
   ],
   "scripts": {
-    "build:cli": "npm run cleanBuild -w packages/cli",
+    "build:cli": "npm run cleanBuild -w packages/cli && node ./shebangify.cjs ./dist/cli/main.js",
     "build:lib": "npm run cleanBuild -w packages/lib",
+    "build:libInternal": "npm run cleanBuild:internal -w packages/lib",
     "test:lib": "npm run test -w packages/lib"
   },
   "author": "Budi Syahiddin",

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,16 +1,14 @@
 {
   "name": "mdt2json-cli",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Markdown Table to Minified JSON Transpiler CLI tool",
   "type": "module",
-  "main": "./dist/main.js",
-  "bin": "./dist/main.js",
   "scripts": {
-    "cleanBuild": "rm -rf ./dist && tsc && chmod +x ./dist/main.js && ../../shebangify ./dist/main.js"
+    "cleanBuild": "rm -rf ../../dist/cli && tsc && chmod +x ../../dist/cli/main.js"
   },
   "dependencies": {
     "commander": "^11.0.0",
-    "mdt2json-ts": "*"
+    "mdt2json": "*"
   },
   "author": "Budi Syahiddin",
   "license": "MIT"

diff --git a/packages/cli/src/main.ts b/packages/cli/src/main.ts
@@ -1,5 +1,5 @@
 import { Command } from "commander";
-import { JsonLayout, MarkdownTable2Json } from "mdt2json-ts/dist/lib.js";
+import { JsonLayout, MarkdownTable2Json } from "mdt2json-ts";
 import fs from "fs";
 
 (() => {

diff --git a/packages/cli/tsconfig.json b/packages/cli/tsconfig.json
@@ -6,7 +6,7 @@
     "rootDir": "src",
     "moduleResolution": "Node",
     "declaration": true,
-    "outDir": "./dist",
+    "outDir": "../../dist/cli",
     "isolatedModules": true,
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,

diff --git a/packages/lib/package.json b/packages/lib/package.json
@@ -1,18 +1,25 @@
 {
   "name": "mdt2json-ts",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Markdown Table to Minified JSON Transpiler",
   "main": "./dist/lib.js",
-  "files": ["dist", "src", "tests"],
+  "private": true,
+  "files": [
+    "dist",
+    "src",
+    "tests"
+  ],
   "dist": {
     "type": "module",
     "main": "./dist/lib.js",
     "module": "./dist/lib.js",
     "types": "./dist/lib.d.ts"
   },
+  "types": "./dist/lib.d.ts",
   "type": "module",
   "scripts": {
-    "cleanBuild": "rm -rf ./dist && tsc",
+    "cleanBuild": "rm -rf ../../dist/lib && tsc",
+    "cleanBuild:internal": "rm -rf ./dist && tsc --outDir ./dist",
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --verbose  --config jest-unit.config.json"
   },
   "author": "Budi Syahiddin",
@@ -27,6 +34,7 @@
   },
   "dependencies": {
     "commander": "^11.0.0",
+    "mdt2json": "^0.2.0",
     "remark": "^14.0.3",
     "remark-gfm": "^3.0.1",
     "remark-parse": "^10.0.2",

diff --git a/packages/lib/tsconfig.json b/packages/lib/tsconfig.json
@@ -6,7 +6,7 @@
     "rootDir": "src",
     "moduleResolution": "Node",
     "declaration": true,
-    "outDir": "./dist",
+    "outDir": "../../dist/lib",
     "isolatedModules": true,
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,

diff --git a/shebangify → shebangify.cjs b/shebangify → shebangify.cjs
@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 const fs = require('fs');
 const path = process.argv[2];
 let data = "#!/usr/bin/env node\n\n";