refactor: improved typing, readme fixes (#26)

* refactor: improved typing, readme fixes

* 1.10.1

README.md

@@ -86,15 +86,15 @@ In addition to steps from Basic Usage, you can improve results by changing some
 
 The main configuration is stored in the `config.json` file in a root directory and you can change this config file according to your needs:
 
-```
+```json
 {
   "tailwind": true,
   "theme": "minimalistic",
   "locale": "en"
 }
 ```
 
-There possible to run hot-reload server to develop your own theme with custom markup, styles, and scripts. To start dev-server just run command `npm run dev`. This command will start server on 8080 port ([http://localhost:8080](http://localhost:8080). By default, this address will be opened with a first status code, defined in `src` directory, which corresponds to configured `locale` value. You can choose any other code to continue specific page development. Don't be surprised with injected parts of code in a rendered page, because this is a part of hot-reload mode. Any change of the main configuration will require dev-server restart. The only configured theme and locale directories are watching during development.
+There possible to run hot-reload server to develop your own theme with custom markup, styles, and scripts. To start dev-server just run command `npm run dev`. This command will start server on 8080 port ([http://localhost:8080](http://localhost:8080)). By default, this address will be opened with a first status code, defined in `src` directory, which corresponds to configured `locale` value. You can choose any other code to continue specific page development. Don't be surprised with injected parts of code in a rendered page, because this is a part of hot-reload mode. Any change of the main configuration will require dev-server restart. The only configured theme and locale directories are watching during development.
 
 
 ### Templates
@@ -132,7 +132,7 @@ The config snippet itself I would recommend to place in the `/etc/nginx/snippets
 
 Here is an example of web server configuration with included the error pages snippet:
 
-```
+```nginx
 server {
   server_name example.com;
   access_log /var/log/nginx/example.access.log;

dev/server.ts

@@ -15,7 +15,7 @@ import { MessagesEnum } from "../messages";
 import { pr } from "../path-registry";
 
 import { DEFAULTS } from "../lib/constants";
-import { Config, TemplateVariables } from "../lib/interfaces";
+import { Config, TemplateVariables } from "../lib/models";
 import { DI_TOKENS } from "../lib/tokens";
 
 const STATUS_PATH_REGEX = /^\/([0-9]{3})$/i;

index.ts

@@ -7,7 +7,7 @@ import { Main } from "./lib/classes/Main";
 import { initContainer } from "./container";
 import { pr } from "./path-registry";
 
-import { Config } from "./lib/interfaces";
+import { Config } from "./lib/models";
 import { Messages } from "./lib/classes/Messages";
 import { MessagesEnum } from "./messages";
 

lib/classes/ChildProcessWrapper.ts

@@ -8,7 +8,7 @@ export interface IChildProcessWrapper {
 
 @injectable()
 export class ChildProcessWrapper implements IChildProcessWrapper {
-  exec(cmd: string) {
+  exec(cmd: string): Promise<{ stdout: string; stderr: string }> {
     return promisify(exec)(cmd);
   }
 }

lib/classes/Compiler.ts

@@ -6,7 +6,7 @@ import { ILogger } from "./Logger";
 import { Messages } from "./Messages";
 import { Renderer } from "./Renderer";
 
-import { Config, SnippetVariables, TemplateVariables } from "../interfaces";
+import { Config, SnippetVariables, TemplateVariables } from "../models";
 import { DI_TOKENS } from "../tokens";
 import { MessagesEnum } from "../../messages";
 import { PathRegistry } from "./PathRegistry";

lib/classes/FileSystemHelper.ts

@@ -1,6 +1,6 @@
 import { injectable, inject } from "inversify";
 
-import { Config } from "../interfaces";
+import { Config } from "../models";
 import { Messages } from "./Messages";
 import { Styler } from "./Styler";
 import { ILogger } from "./Logger";

lib/classes/FileSystemWrapper.ts

@@ -14,36 +14,36 @@ export interface IFileSystemWrapper {
   readDir(path: string): Promise<string[]>;
   readFile(path: string): Promise<Buffer>;
   rm(path: string, opts?: fs.RmOptions): Promise<void>;
-  writeFile(path: string, data: string, opts?: WriteOptions);
+  writeFile(path: string, data: string, opts?: WriteOptions): Promise<void>;
 }
 
 @injectable()
 export class NodeFS implements IFileSystemWrapper {
-  access(path: string) {
+  access(path: string): Promise<void> {
     return fsp.access(path);
   }
 
-  cp(src: string, dest: string, opts?: fs.CopyOptions) {
+  cp(src: string, dest: string, opts?: fs.CopyOptions): Promise<void> {
     return fsp.cp(src, dest, opts);
   }
 
-  mkdir(path: string, opts?: fs.MakeDirectoryOptions) {
+  mkdir(path: string, opts?: fs.MakeDirectoryOptions): Promise<string> {
     return fsp.mkdir(path, opts);
   }
 
-  readDir(path: string) {
+  readDir(path: string): Promise<string[]> {
     return fsp.readdir(path);
   }
 
-  readFile(path: string) {
+  readFile(path: string): Promise<Buffer> {
     return fsp.readFile(path);
   }
 
-  rm(path: string, opts?: fs.RmOptions) {
+  rm(path: string, opts?: fs.RmOptions): Promise<void> {
     return fsp.rm(path, opts);
   }
 
-  writeFile(path: string, data: string, opts?: WriteOptions) {
+  writeFile(path: string, data: string, opts?: WriteOptions): Promise<void> {
     return fsp.writeFile(path, data, opts);
   }
 }

lib/classes/Logger.ts

@@ -6,7 +6,7 @@ export interface ILogger {
 
 @injectable()
 export class Logger implements ILogger {
-  print(message: string) {
+  print(message: string): void {
     console.log(message);
   }
 }

lib/classes/Main.ts

@@ -7,7 +7,7 @@ import { IStyler } from "./Styler";
 import { Messages } from "./Messages";
 import { PathRegistry } from "./PathRegistry";
 
-import { Config } from "../interfaces";
+import { Config } from "../models";
 import { DI_TOKENS } from "../tokens";
 import { MessagesEnum } from "../../messages";
 
@@ -22,7 +22,7 @@ export class Main {
     @inject(DI_TOKENS.PATH) private pr: PathRegistry
   ) {}
 
-  async start() {
+  async start(): Promise<void> {
     const startTime = Date.now();
 
     this.logger.print(Messages.info(MessagesEnum.START));

lib/classes/Messages.ts

@@ -1,6 +1,6 @@
 import { render } from "mustache";
 
-import { AnyVariables } from "../interfaces";
+import { AnyVariables } from "../models";
 
 export class Messages {
   static error(msg: string, vars: AnyVariables = {}): string {

lib/classes/PathRegistry.ts

@@ -12,7 +12,7 @@ export class PathRegistry {
     this.init(paths);
   }
 
-  private init(paths: AnyStringObject) {
+  private init(paths: AnyStringObject): void {
     this.registry = new Map(
       Object.entries(paths).map(([key, value]) => {
         return [key, this.resolveToCwd(value)];

lib/classes/Renderer.ts

@@ -1,11 +1,11 @@
 import { render } from "mustache";
 import Typograf from "typograf";
 
-import { SnippetVariables, TemplateVariables } from "../interfaces";
+import { SnippetVariables, TemplateVariables } from "../models";
 import { TYPOGRAF_LOCALES } from "../constants";
 
 export class Renderer {
-  static renderTemplate(template: string, vars: TemplateVariables) {
+  static renderTemplate(template: string, vars: TemplateVariables): string {
     if (TYPOGRAF_LOCALES.has(vars.locale)) {
       const tp = new Typograf({ locale: [TYPOGRAF_LOCALES.get(vars.locale)], htmlEntity: { type: "name" } });
       for (const prop in vars) {
@@ -15,7 +15,7 @@ export class Renderer {
     return render(template, vars, null, { escape: (str) => str });
   }
 
-  static renderSnippet(template: string, vars: SnippetVariables) {
+  static renderSnippet(template: string, vars: SnippetVariables): string {
     return render(template, vars);
   }
 }

lib/classes/Styler.ts

@@ -20,7 +20,7 @@ export class Styler implements IStyler {
     @inject(DI_TOKENS.LOGGER) private logger: ILogger
   ) {}
 
-  async buildTailwind(input: string, output: string) {
+  async buildTailwind(input: string, output: string): Promise<void> {
     const cmd = Styler.getTailwindCommand(input, output);
 
     this.logger.print(Messages.info(MessagesEnum.TAILWIND_START));
@@ -30,7 +30,7 @@ export class Styler implements IStyler {
     this.logger.print(Messages.info(MessagesEnum.TAILWIND_DONE));
   }
 
-  static getTailwindCommand(input: string, output: string) {
+  static getTailwindCommand(input: string, output: string): string {
     return `INPUT="${input}" OUTPUT="${output}" npm run build:tailwind`;
   }
 

lib/constants.ts

@@ -1,4 +1,4 @@
-import { Defaults } from "./interfaces.js";
+import { Defaults } from "./models.js";
 import { DefaultPaths } from "./_constants.js";
 
 export const DEFAULTS: Defaults = {

lib/interfaces.ts → lib/models.ts

@@ -4,7 +4,7 @@ export type Config = {
   theme: string;
 };
 
-export interface Defaults {
+export type Defaults = {
   ASSETS: string;
   CONFIG: string;
   DIST: string;
@@ -14,17 +14,17 @@ export interface Defaults {
   TAILWIND_IN: string;
   TAILWIND_OUT: string;
   THEMES: string;
-}
+};
 
-export interface AnyVariables {
+export type AnyVariables = {
   [key: string]: string | number;
-}
+};
 
-export interface TemplateVariables extends AnyVariables {
+export type TemplateVariables = {
   locale: string;
   version: string;
-}
+} & AnyVariables;
 
-export interface SnippetVariables {
+export type SnippetVariables = {
   codes: number[];
-}
+};

package.json

@@ -1,6 +1,6 @@
 {
   "name": "error-pages",
-  "version": "1.10.0",
+  "version": "1.10.1",
   "description": "Lightweight tool to create static HTTP Error Pages in minimalistic adaptive and accessible design with customization and localization support",
   "main": "index.ts",
   "scripts": {

test/Compiler.spec.ts

@@ -9,7 +9,7 @@ import { IFileSystemHelper, MockFileSystemHelper } from "../lib/classes/FileSyst
 import { ILogger, MockLogger } from "../lib/classes/Logger";
 import { Messages } from "../lib/classes/Messages";
 
-import { Config } from "../lib/interfaces";
+import { Config } from "../lib/models";
 import { DI_TOKENS } from "../lib/tokens";
 import { MessagesEnum } from "../messages";
 import { PathRegistry } from "../lib/classes/PathRegistry";

test/FileSystemHelper.spec.ts

@@ -8,7 +8,7 @@ import { IFileSystemWrapper, MockFS } from "../lib/classes/FileSystemWrapper";
 import { ILogger, MockLogger } from "../lib/classes/Logger";
 import { Messages } from "../lib/classes/Messages";
 
-import { Config } from "../lib/interfaces";
+import { Config } from "../lib/models";
 import { DI_TOKENS } from "../lib/tokens";
 import { MessagesEnum } from "../messages";
 import { PathRegistry } from "../lib/classes/PathRegistry";

test/Renderer.spec.ts

@@ -1,7 +1,7 @@
 import { assert } from "chai";
 
 import { Renderer } from "../lib/classes/Renderer";
-import { SnippetVariables, TemplateVariables } from "../lib/interfaces";
+import { SnippetVariables, TemplateVariables } from "../lib/models";
 
 describe("class Renderer", () => {
   describe("renderTemplate()", () => {