@ts-for-gir/generator-html-doc 3.0.0-beta.11

package/README.md

@@ -0,0 +1,20 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/gjsify/ts-for-gir/main/.github/ts-for-gir.png" />
+  <h1 align="center">TS <small>for</small> GIR</h1>
+</p>
+
+<p align="center">
+  <img src="https://badgen.net/github/checks/gjsify/ts-for-gir" />
+  <img src="https://badgen.net/github/license/gjsify/ts-for-gir" />
+  <img src="https://badgen.net/npm/v/@ts-for-gir/cli" />
+  <img src="https://badgen.net/npm/dw/@ts-for-gir/cli" />
+</p>
+
+<p align="center">TypeScript type definition generator for GObject introspection GIR files</p>
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/gjsify/ts-for-gir/main/.github/feeling.gif" />
+</p>
+
+# Generator base
+HTML Documentation generator for ts-for-gir.

package/lib/html-doc-generator.d.ts

@@ -0,0 +1,12 @@
+import { Logger } from '@ts-for-gir/lib';
+import { Generator } from '@ts-for-gir/generator-base';
+import type { GenerateConfig, GirModulesGrouped, InheritanceTable, GirModule } from '@ts-for-gir/lib';
+/**
+ * A template that can be used to implement an HTML Documentation Generator
+ */
+export declare class HtmlDocGenerator implements Generator {
+    protected readonly config: GenerateConfig;
+    protected log: Logger;
+    constructor(config: GenerateConfig);
+    start(girModules: GirModule[], girModulesGrouped: GirModulesGrouped[], inheritanceTable: InheritanceTable): Promise<void>;
+}

package/lib/html-doc-generator.js

@@ -0,0 +1,17 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { Logger, DANGER_HTML_DOC_GENERATOR_NOT_IMPLEMENTED } from '@ts-for-gir/lib';
+/**
+ * A template that can be used to implement an HTML Documentation Generator
+ */
+export class HtmlDocGenerator {
+    config;
+    log;
+    constructor(config) {
+        this.config = config;
+        this.log = new Logger(config.environment, config.verbose, HtmlDocGenerator.name);
+    }
+    async start(girModules, girModulesGrouped, inheritanceTable) {
+        return Promise.resolve(this.log.danger(DANGER_HTML_DOC_GENERATOR_NOT_IMPLEMENTED));
+    }
+}
+//# sourceMappingURL=html-doc-generator.js.map

package/lib/html-doc-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"html-doc-generator.js","sourceRoot":"","sources":["../src/html-doc-generator.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,OAAO,EAAE,MAAM,EAAE,yCAAyC,EAAE,MAAM,iBAAiB,CAAA;AAKnF;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAEM;IADrB,GAAG,CAAQ;IACrB,YAA+B,MAAsB;QAAtB,WAAM,GAAN,MAAM,CAAgB;QACjD,IAAI,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,OAAO,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAA;IACpF,CAAC;IACM,KAAK,CAAC,KAAK,CACd,UAAuB,EACvB,iBAAsC,EACtC,gBAAkC;QAElC,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,yCAAyC,CAAC,CAAC,CAAA;IACtF,CAAC;CACJ"}

package/lib/index.d.ts

@@ -0,0 +1 @@
+export * from './html-doc-generator.js';

package/lib/index.js

@@ -0,0 +1,2 @@
+export * from './html-doc-generator.js';
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA"}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@ts-for-gir/generator-html-doc",
+  "version": "3.0.0-beta.11",
+  "description": "HTML Documentation generator for ts-for-gir",
+  "module": "lib/index.js",
+  "main": "lib/index.js",
+  "type": "module",
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "yarn lint && yarn build:ts",
+    "build:ts": "tsc",
+    "clear": "yarn clear:build",
+    "clear:build": "rimraf ./lib",
+    "watch": "yarn build:ts -- --watch",
+    "lint": "eslint . --ext .ts,.tsx --fix"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gjsify/ts-for-gjs.git"
+  },
+  "author": "Pascal Garber <pascal@artandcode.studio>",
+  "files": [
+    "lib",
+    "templates"
+  ],
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/gjsify/ts-for-gjs/issues"
+  },
+  "homepage": "https://github.com/gjsify/ts-for-gjs#readme",
+  "keywords": [
+    "generator"
+  ],
+  "devDependencies": {
+    "@types/node": "^18.14.0",
+    "@typescript-eslint/eslint-plugin": "^5.53.0",
+    "@typescript-eslint/parser": "^5.53.0",
+    "eslint": "^8.34.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "prettier": "^2.8.4",
+    "rimraf": "^4.1.2",
+    "typescript": "^4.9.5"
+  },
+  "dependencies": {
+    "@ts-for-gir/generator-base": "^3.0.0-beta.11",
+    "@ts-for-gir/lib": "^3.0.0-beta.11"
+  }
+}