cleanup pr

- revert unneeded changes in package.json
- revert files moved to src

Author: erikyo

.gitignore

@@ -1,4 +1,4 @@
 /node_modules
-lib
+/@types
 npm-debug.log
 .DS_Store

src/index.d.ts renamed to index.d.ts

@@ -1,8 +1,9 @@
 import { Transform } from "readable-stream";
+
 import {Buffer} from "safe-buffer";
 
 export declare module 'encoding' {
-    export function convert(buf: Buffer, charset: string): Buffer;
+    export function convert(buf: Buffer, toCharset: string, fromCharset: string): Buffer;
 }
 
 export interface Compiler {
@@ -37,13 +38,13 @@ export interface parserOptions {
     validation?: boolean;
 }
 
-export interface PoParser {
+export interface po {
     parse: (buffer: Buffer | string, defaultCharset?: string) => GetTextTranslations;
     compile: (table: GetTextTranslations, options?: parserOptions) => Buffer;
     createParseStream: (options?: parserOptions, transformOptions?: import('readable-stream').TransformOptions) => Transform;
 }
 
-export interface MoParser {
+export interface mo {
     parse: (buffer: Buffer | string, defaultCharset?: string) => GetTextTranslations;
     compile: (table: GetTextTranslations, options?: parserOptions) => Buffer;
 }

index.js

@@ -0,0 +1,27 @@
+import * as poParser from './lib/poparser.js';
+import poCompiler from './lib/pocompiler.js';
+import moParser from './lib/moparser.js';
+import moCompiler from './lib/mocompiler.js';
+
+/**
+ * Translation parser and compiler for PO files
+ * @see https://www.gnu.org/software/gettext/manual/html_node/PO.html
+ *
+ * @type {import("./index.d.ts").po} po
+ */
+export const po = {
+    parse: poParser.parse,
+    createParseStream: poParser.stream,
+    compile: poCompiler
+};
+
+/**
+ * Translation parser and compiler for PO files
+ * @see https://www.gnu.org/software/gettext/manual/html_node/MO.html
+ *
+ * @type {import("./index.d.ts").mo} mo
+ */
+export const mo = {
+    parse: moParser,
+    compile: moCompiler
+};

src/mocompiler.js renamed to lib/mocompiler.js

@@ -1,13 +1,13 @@
 import { Buffer } from 'safe-buffer';
 import encoding from 'encoding';
-import { compareMsgid, formatCharset, generateHeader, HEADERS } from './shared.js';
+import { HEADERS, formatCharset, generateHeader, compareMsgid } from './shared.js';
 import contentType from 'content-type';
 
 /**
  * Exposes general compiler function. Takes a translation
  * object as a parameter and returns binary MO object
  *
- * @param {import('./index.js').gettextTranslations} table Translation object
+ * @param {import('./index.d.ts').GetTextTranslations} table Translation object
  * @return {Buffer} Compiled binary MO object
  */
 export default function (table) {
@@ -20,10 +20,10 @@ export default function (table) {
  * Creates a MO compiler object.
  *
  * @constructor
- * @param {import('./index.js').gettextTranslations} table Translation table as defined in the README
- * @return {import('./index.js').Compiler} Compiler
+ * @param {import('./index.d.ts').GetTextTranslations} table Translation table as defined in the README
+ * @return {import('./index.d.ts').Compiler} Compiler
  */
-function Compiler (table ) {
+function Compiler (table = {}) {
   this._table = table;
 
   let { headers = {}, translations = {} } = this._table;
@@ -71,8 +71,6 @@ function Compiler (table ) {
   this._writeFunc = 'writeUInt32LE';
 
   this._handleCharset();
-
-  return this;
 }
 
 /**
@@ -151,7 +149,7 @@ Compiler.prototype._generateList = function () {
 /**
  * Calculate buffer size for the final binary object
  *
- * @param {import('./index.js').GettextTranslations} list An array of translation strings from _generateList
+ * @param {import('./index.d.ts').GetTextTranslations} list An array of translation strings from _generateList
  * @return {Object} Size data of {msgid, msgstr, total}
  */
 Compiler.prototype._calculateSize = function (list) {
@@ -186,7 +184,7 @@ Compiler.prototype._calculateSize = function (list) {
 /**
  * Generates the binary MO object from the translation list
  *
- * @param {import('./index.js').GettextTranslations} list translation list
+ * @param {import('./index.d.ts').GetTextTranslations} list translation list
  * @param {Object} size Byte size information
  * @return {Buffer} Compiled MO object
  */
@@ -240,7 +238,7 @@ Compiler.prototype._build = function (list, size) {
 };
 
 /**
- * Compiles the translation object into a binary MO object
+ * Compiles translation object into a binary MO object
  *
  * @return {Buffer} Compiled MO object
  */

src/moparser.js renamed to lib/moparser.js

@@ -1,6 +1,8 @@
-import { compareMsgid, foldLine, formatCharset, generateHeader, HEADERS } from './shared.js';
-import contentType from 'content-type';
+import { Buffer } from 'safe-buffer';
 import encoding from 'encoding';
+import { HEADERS, foldLine, compareMsgid, formatCharset, generateHeader } from './shared.js';
+import contentType from 'content-type';
+
 
 /**
  * Exposes general compiler function. Takes a translation

src/pocompiler.js renamed to lib/pocompiler.js

@@ -17,24 +17,15 @@
   "engines": {
     "node": ">=18"
   },
-  "files": [
-    "lib",
-    "test",
-    "*.json",
-    "*.md",
-    "license.txt"
-  ],
   "scripts": {
-    "start": "tsc --watch",
-    "build": "tsc",
-    "lint": "eslint src/*.js test/*.js",
+    "lint": "eslint lib/*.js test/*.js index.js",
     "test-generate-mo": "msgfmt test/fixtures/latin13.po -o test/fixtures/latin13.mo & msgfmt test/fixtures/utf8.po -o test/fixtures/utf8.mo & msgfmt test/fixtures/obsolete.po -o test/fixtures/obsolete.mo",
     "test": "mocha",
     "preversion": "npm run lint && npm test",
-    "postversion": "git push && git push --tags"
+    "postversion": "git push && git push --tags",
+    "prepublish": "tsc && npm run lint && npm run test"
   },
-  "main": "./lib/index.js",
-  "types": "./lib/index.d.ts",
+  "main": "./index.js",
   "license": "MIT",
   "dependencies": {
     "content-type": "^1.0.5",
@@ -46,15 +37,16 @@
     "@types/chai": "latest",
     "@types/content-type": "^1.1.8",
     "@types/mocha": "latest",
+    "@types/readable-stream": "^4.0.11",
     "@typescript-eslint/eslint-plugin": "^6.18.1",
     "@typescript-eslint/parser": "^6.14.0",
-    "chai": "^5.1.0",
+    "chai": "^5.0.3",
     "eslint": "^8.56.0",
     "eslint-config-standard": "^17.1.0",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-n": "^16.6.2",
     "eslint-plugin-promise": "^6.1.1",
-    "mocha": "^10.4.0",
+    "mocha": "^10.3.0",
     "typescript": "^5.4.4"
   },
   "keywords": [