docgen-tool 3.0.0 → 3.0.2

package/package.json

@@ -1,14 +1,19 @@
 {
   "name": "docgen-tool",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "A tool for creating HTML and PDF documentation",
   "main": "dist/docgen.js",
   "bin": {
     "docgen": "dist/docgen.js"
   },
+  "files": [
+    "dist/*"
+  ],
   "scripts": {
+    "clean": "rimraf dist/",
+    "copy-files": "copyfiles -u 1 src/example/* dist/",
     "dev": "ts-node docgen.js run",
-    "build": "tsc -p tsconfig.json",
+    "build": "yarn clean && tsc -p tsconfig.json && yarn copy-files",
     "run:build": "dist/docgen.js",
     "build:docs": "ts-node docgen.js run -i ./source/user-guide -o ./docs -p -m -n -d 40000",
     "test": "npm run prettier:check",
@@ -42,9 +47,11 @@
   },
   "devDependencies": {
     "@types/node": "^20.3.1",
+    "copyfiles": "^2.4.1",
     "eslint": "^8.43.0",
     "eslint-config-prettier": "^8.8.0",
     "prettier": "^2.1.2",
+    "rimraf": "^5.0.1",
     "ts-node": "^10.9.1",
     "tslib": "^2.5.3",
     "typescript": "^5.1.3"

package/.gitattributes

@@ -1 +0,0 @@
-* text=auto eol=lf

package/.github/workflows/deploy-website.yml

@@ -1,28 +0,0 @@
-name: Deploy Website
-on:
-  push:
-    branches: [ master ]
-permissions:
-  contents: write
-jobs:
-  build-and-deploy:
-    concurrency: ci-${{ github.ref }}
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout 🛎️
-        uses: actions/checkout@v3
-
-      - name: Install and Build 🔧
-        run: |
-          sudo apt-get install -y xfonts-base xfonts-75dpi
-          wget https://github.com/wkhtmltopdf/packaging/releases/download/0.12.6.1-2/wkhtmltox_0.12.6.1-2.jammy_amd64.deb
-          sudo dpkg -i wkhtmltox_0.12.6.1-2.jammy_amd64.deb
-          sudo apt-get -f install -y
-          wkhtmltopdf -V
-          yarn install --frozen-lockfile
-          yarn build:docs
-
-      - name: Deploy 🚀
-        uses: JamesIves/github-pages-deploy-action@v4
-        with:
-          folder: . # directory to deploy

package/.prettierignore

@@ -1,4 +0,0 @@
-docs/
-dist/
-source/require/webknife
-source/optional/katex

package/.prettierrc

@@ -1,4 +0,0 @@
-{
-  "singleQuote": true,
-  "trailingComma": "all"
-}

package/docgen.js

@@ -1,95 +0,0 @@
-#!/usr/bin/env node
-
-let docgen = require('./source/docgen.js');
-let program = require('commander');
-
-let generator = new docgen(process);
-
-const scaffold = (command) => {
-  generator.setOptions(command);
-  generator.scaffold();
-};
-
-const run = (command) => {
-  generator.setOptions(command);
-  generator.run();
-};
-
-/*
-    parse command-line arguments with node commander
-        commander help: http://slides.com/timsanteford/conquering-commander-js
-        command-line conventions: http://docopt.org
-*/
-
-program.version(generator.getVersion()).usage('[command] [--option]');
-
-program
-  .command('scaffold')
-  .usage('[--option]')
-  .description('create a template input directory')
-  .option(
-    '-o, --output [path]',
-    'path to the output directory (default: ./)',
-    './',
-  )
-  .option('-v, --verbose', 'show verbose output including detailed errors')
-  .action((command) => {
-    scaffold(command);
-  });
-
-program
-  .command('run')
-  .usage('[--option]')
-  .description('create a static website from an input directory')
-  .option(
-    '-i, --input [path]',
-    'path to the input directory [default: ./]',
-    './',
-  )
-  .option(
-    '-o, --output [path]',
-    'path to the output directory [default: ./output]',
-    './output',
-  )
-  .option('-v, --verbose', 'show verbose output including detailed errors')
-  .option(
-    '-t, --page-toc',
-    'show a page table of contents at the top of each web page',
-  )
-  .option('-p, --pdf', 'create a PDF document')
-  .option(
-    '-d, --pdf-delay [milliseconds]',
-    'delay PDF printing to allow time for dynamic rendering [default: 2000]',
-    '2000',
-  )
-  .option('-m, --math-katex', 'enable KaTex mathematical expressions')
-  .option('-n, --math-mathjax', 'enable MathJax mathematical expressions')
-  .option(
-    '-r, --redirect',
-    'create an index.html in the parent directory that redirects to the homepage',
-  )
-  .option(
-    '-s, --set-version [version]',
-    'override parameters.version (useful for build tools) [default: false]',
-    false,
-  )
-  .option(
-    '-R, --set-release-date [date]',
-    'override parameters.date (useful for build tools) [default: false]',
-    false,
-  )
-  .option(
-    '-w, --wkhtmltopdf-path [path]',
-    'specify a custom path to wkhtmltopdf [default: wkhtmltopdf]',
-    'wkhtmltopdf',
-  )
-  .action((command) => {
-    run(command);
-  });
-
-program.parse(process.argv);
-
-//if no arguments were provided, show help and then exit
-if (!process.argv.slice(2).length) {
-  program.help();
-}

package/index.html

@@ -1,10 +0,0 @@
-<!doctype html>
-<html> 
-<head>
- <title>DocGen - a documentation tool</title>
- <meta http-equiv="REFRESH" content="0;url=docs/index.html">
-</head>
-<body>
- <a href="docs/index.html" style="color:#ccc;font-size:12px">Redirect to homepage</a>
-</body>
-</html>

package/source/__test__/test-run/contents.json

@@ -1,12 +0,0 @@
-[
-  {
-    "heading": "Test Run",
-    "column": 1,
-    "pages": [
-      {
-        "title": "Overview",
-        "source": "overview.txt"
-      }
-    ]
-  }
-]

package/source/__test__/test-run/overview.txt

@@ -1,3 +0,0 @@
-# DocGen Test Case
-
-An example documentation site for testing.

package/source/__test__/test-run/parameters.json

@@ -1,32 +0,0 @@
-{
-  "title": "DocGen test case",
-  "name": "DocGen test case",
-  "version": "1.0.0",
-  "date": "27/06/2023",
-  "organization": {
-    "name": "DocGen Test Case",
-    "url": "https://www.inkit.com"
-  },
-  "author": {
-    "name": "DocGen Test Case",
-    "url": "https://www.inkit.com"
-  },
-  "owner": {
-    "name": "DocGen Test Case",
-    "url": "https://www.inkit.com"
-  },
-  "contributors": [],
-  "website": {
-    "name": "Github",
-    "url": "https://github.com/mtmacdonald/docgen"
-  },
-  "backlink": {
-    "name": "",
-    "url": ""
-  },
-  "module": "",
-  "id": "",
-  "summary": "DocGen test case.",
-  "marking": "MIT License.",
-  "legalese": ""
-}

package/source/__test__/test-run/release-notes.txt

@@ -1,4 +0,0 @@
-DocGen Test Case 1.0.0 released 27/06/2023
-------------------------------------------
-
-- Initial version of test case