@ts-for-gir/generator-html-doc 4.0.0-beta.4 → 4.0.0-beta.40

package/README.md

@@ -16,5 +16,18 @@
   <img src="https://raw.githubusercontent.com/gjsify/ts-for-gir/main/.github/feeling.gif" />
 </p>
 
-# Generator base
-HTML Documentation generator for ts-for-gir.
+# HTML Documentation Generator
+
+## Status: Not Yet Implemented
+
+This package currently serves as a placeholder and basic framework for implementing an HTML documentation generator based on GIR types. It does not contain actual functionality yet.
+
+## Purpose
+
+The intended purpose of this package is to provide a way to generate HTML documentation from GObject introspection data, similar to how the `generator-typescript` package generates TypeScript definitions. When implemented, it would allow for generating human-readable API documentation websites.
+
+## Implementation
+
+This package implements the `Generator` interface from `@ts-for-gir/generator-base` but its methods currently throw "Not implemented" errors. It provides the basic structure needed for anyone who wants to implement a full HTML documentation generator for GObject introspection types.
+
+If you're interested in implementing this feature, contributions are welcome! Feel free to use this package as a starting point for building a complete HTML documentation generator.

package/package.json

@@ -1,29 +1,23 @@
 {
   "name": "@ts-for-gir/generator-html-doc",
-  "version": "4.0.0-beta.4",
+  "version": "4.0.0-beta.40",
   "description": "HTML Documentation generator for ts-for-gir",
-  "module": "lib/index.js",
-  "main": "lib/index.js",
+  "main": "src/index.ts",
+  "module": "src/index.ts",
   "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"
+    "check": "tsc --noEmit"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/gjsify/ts-for-gir.git"
   },
-  "author": "Pascal Garber <pascal@artandcode.studio>",
+  "author": "Pascal Garber <pascal@mailfreun.de>",
   "files": [
-    "lib",
-    "templates"
+    "src"
   ],
   "license": "Apache-2.0",
   "bugs": {
@@ -31,21 +25,21 @@
   },
   "homepage": "https://github.com/gjsify/ts-for-gir#readme",
   "keywords": [
-    "generator"
+    "generator",
+    "html",
+    "documentation",
+    "gir"
   ],
+  "exports": {
+    ".": "./src/index.ts"
+  },
   "devDependencies": {
-    "@types/node": "^20.12.8",
-    "@typescript-eslint/eslint-plugin": "^7.8.0",
-    "@typescript-eslint/parser": "^7.8.0",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.1.3",
-    "prettier": "^3.2.5",
-    "rimraf": "^5.0.5",
-    "typescript": "^5.4.5"
+    "@types/node": "^24.11.0",
+    "rimraf": "^6.1.3",
+    "typescript": "^5.9.3"
   },
   "dependencies": {
-    "@ts-for-gir/generator-base": "^4.0.0-beta.4",
-    "@ts-for-gir/lib": "^4.0.0-beta.4"
+    "@ts-for-gir/generator-base": "^4.0.0-beta.40",
+    "@ts-for-gir/lib": "^4.0.0-beta.40"
   }
 }

package/src/html-doc-generator.ts

@@ -0,0 +1,29 @@
+import type { Generator } from "@ts-for-gir/generator-base";
+import type { GirModule, NSRegistry, OptionsGeneration } from "@ts-for-gir/lib";
+import { DANGER_HTML_DOC_GENERATOR_NOT_IMPLEMENTED, Logger } from "@ts-for-gir/lib";
+
+/**
+ * A template that can be used to implement an HTML Documentation Generator
+ */
+export class HtmlDocGenerator implements Generator {
+	protected log: Logger;
+	protected readonly config: OptionsGeneration;
+	protected readonly registry: NSRegistry;
+	constructor(config: OptionsGeneration, registry: NSRegistry) {
+		this.config = config;
+		this.registry = registry;
+		this.log = new Logger(config.verbose, HtmlDocGenerator.name);
+	}
+
+	async start(): Promise<void> {
+		return Promise.resolve(this.log.danger(DANGER_HTML_DOC_GENERATOR_NOT_IMPLEMENTED));
+	}
+
+	generate(_module: GirModule): Promise<void> {
+		throw new Error("Method not implemented.");
+	}
+
+	finish(_girModules: GirModule[]): Promise<void> {
+		throw new Error("Method not implemented.");
+	}
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from "./html-doc-generator.ts";

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

@@ -1,14 +0,0 @@
-import { Logger } from '@ts-for-gir/lib';
-import { Generator } from '@ts-for-gir/generator-base';
-import type { OptionsGeneration, GirModule, NSRegistry } 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: OptionsGeneration;
-    protected log: Logger;
-    constructor(config: OptionsGeneration);
-    start(_registry: NSRegistry): Promise<void>;
-    generate(_registry: NSRegistry, _module: GirModule): Promise<void>;
-    finish(_registry: NSRegistry): Promise<void>;
-}

package/lib/html-doc-generator.js

@@ -1,23 +0,0 @@
-/* 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.verbose, HtmlDocGenerator.name);
-    }
-    async start(_registry) {
-        return Promise.resolve(this.log.danger(DANGER_HTML_DOC_GENERATOR_NOT_IMPLEMENTED));
-    }
-    generate(_registry, _module) {
-        throw new Error('Method not implemented.');
-    }
-    finish(_registry) {
-        throw new Error('Method not implemented.');
-    }
-}
-//# sourceMappingURL=html-doc-generator.js.map

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

@@ -1 +0,0 @@
-{"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,MAAyB;QAAzB,WAAM,GAAN,MAAM,CAAmB;QACpD,IAAI,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAA;IAChE,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,SAAqB;QAC7B,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,yCAAyC,CAAC,CAAC,CAAA;IACtF,CAAC;IAED,QAAQ,CAAC,SAAqB,EAAE,OAAkB;QAC9C,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;IAC9C,CAAC;IAED,MAAM,CAAC,SAAqB;QACxB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;IAC9C,CAAC;CACJ"}

package/lib/index.d.ts

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

package/lib/index.js

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

package/lib/index.js.map

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