@efebia/yaml-to-ts 0.0.1

package/lib/generateDeclaration.d.ts

@@ -0,0 +1,23 @@
+import * as prettier from 'prettier';
+export type Declaration = string | {
+    type: 'array';
+    value: Declaration;
+} | {
+    [key: string]: any;
+};
+export declare const generateDeclaration: (currentValue: any) => Declaration;
+export type StringifyKeyValue = {
+    k?: string;
+    v: string;
+};
+export type StringifyOptions = {
+    bracketsAround?: boolean;
+};
+type BuildConfig = {
+    prettierConfig: prettier.Config;
+    outFile: string;
+    interfaceName: string;
+    dryRun: boolean;
+};
+export declare const build: (jsonObj: object, configs: BuildConfig) => Promise<void>;
+export {};

package/lib/generateDeclaration.js

@@ -0,0 +1,78 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.build = exports.generateDeclaration = void 0;
+const promises_1 = require("fs/promises");
+const prettier = __importStar(require("prettier"));
+const generateDeclaration = (currentValue) => {
+    if (typeof currentValue !== 'object')
+        return typeof currentValue;
+    if (Array.isArray(currentValue)) {
+        return {
+            type: 'array',
+            value: (0, exports.generateDeclaration)(currentValue[0]),
+        };
+    }
+    return Object.entries(currentValue).reduce((acc, [key, value]) => {
+        acc[key] = (0, exports.generateDeclaration)(value);
+        return acc;
+    }, {});
+};
+exports.generateDeclaration = generateDeclaration;
+const stringify = (keyValue, opts = { bracketsAround: true }) => {
+    if (keyValue.k) {
+        if (opts.bracketsAround)
+            return `${keyValue.k}: {\n${keyValue.v}\n}`;
+        return `${keyValue.k}: ${keyValue.v}`;
+    }
+    if (opts.bracketsAround)
+        return `{\n${keyValue.v}\n}`;
+    return keyValue.v;
+};
+const generateStringDeclaration = (value, key) => {
+    if (typeof value !== 'object')
+        return stringify({ k: key, v: value.replace("'", '') }, { bracketsAround: false });
+    if (Object.hasOwn(value, 'type') && value['type'] === 'array') {
+        return stringify({ v: `${generateStringDeclaration(value['value'])}[]`, k: key }, { bracketsAround: false });
+    }
+    const insideKeys = Object.entries(value)
+        .map(([k, v]) => generateStringDeclaration(v, k))
+        .join(';\n');
+    return stringify({ k: key, v: insideKeys });
+};
+const build = async (jsonObj, configs) => {
+    const objectInterfaceDeclaration = (0, exports.generateDeclaration)(jsonObj);
+    const stringDeclaration = generateStringDeclaration(objectInterfaceDeclaration);
+    const typescriptDeclaration = `export interface ${configs.interfaceName} ${stringDeclaration}`;
+    const formatted = prettier.format(typescriptDeclaration, configs.prettierConfig);
+    if (configs.dryRun) {
+        console.log(formatted);
+        return;
+    }
+    await (0, promises_1.writeFile)(configs.outFile, prettier.format(typescriptDeclaration, configs.prettierConfig), {
+        encoding: 'utf-8',
+    });
+};
+exports.build = build;

package/lib/yaml-to-ts.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/lib/yaml-to-ts.js

@@ -0,0 +1,100 @@
+#!/usr/bin/env node
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const promises_1 = require("fs/promises");
+const yaml = __importStar(require("js-yaml"));
+const path = __importStar(require("path"));
+const prettier_1 = __importDefault(require("prettier"));
+const yargs_1 = __importDefault(require("yargs"));
+const helpers_1 = require("yargs/helpers");
+const generateDeclaration_js_1 = require("./generateDeclaration.js");
+const parsedArgs = (0, helpers_1.hideBin)(process.argv);
+(0, yargs_1.default)(parsedArgs)
+    .command('$0 <input-file> [--prettier-file prettier-file-URI] [--out-file out-file-URI] [--dry-run] [--interface-name name]', 'Build TS interface from YAML file', (args) => {
+    return args
+        .positional('input-file', {
+        alias: 'i',
+        type: 'string',
+        description: 'YAML Input file',
+        demandOption: true
+    })
+        .option('prettier-file', {
+        alias: 'p',
+        type: 'string',
+        description: 'Prettier configuration file',
+    })
+        .option('out-file', {
+        alias: 'o',
+        type: 'string',
+        description: 'Output file',
+        default: path.join(process.cwd(), 'declaration.d.ts'),
+    })
+        .option('dry-run', {
+        alias: 'd',
+        type: 'boolean',
+        description: 'Perform a dry run',
+        default: false,
+    })
+        .option('interface-name', {
+        alias: 'int',
+        type: 'string',
+        description: 'Define interface name',
+        default: 'Declaration',
+    })
+        .strict();
+}, async (argv) => {
+    const fileVal = await (0, promises_1.readFile)(argv.inputFile, {
+        encoding: 'utf-8',
+    });
+    const parsedYaml = yaml.load(fileVal);
+    let prettierConfig = {
+        printWidth: 80,
+        tabWidth: 4,
+        semi: true,
+        singleQuote: true,
+        endOfLine: 'lf',
+        trailingComma: 'es5',
+        bracketSpacing: true,
+        arrowParens: 'always',
+        parser: 'typescript',
+    };
+    if (argv.prettierFile) {
+        const resolvedConfig = await prettier_1.default.resolveConfig(argv.prettierFile);
+        if (resolvedConfig) {
+            prettierConfig = resolvedConfig;
+        }
+    }
+    await (0, generateDeclaration_js_1.build)(parsedYaml, {
+        interfaceName: argv.interfaceName,
+        outFile: argv.outFile,
+        prettierConfig,
+        dryRun: argv.dryRun,
+    });
+})
+    .parse();

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@efebia/yaml-to-ts",
+  "version": "0.0.1",
+  "description": "Build TS interface declaration from yml file",
+  "type": "module",
+  "main": "lib/yaml-to-ts.js",
+  "scripts": {
+    "build": "tsc"
+  },
+  "license": "ISC",
+  "dependencies": {
+    "js-yaml": "^4.1.0",
+    "prettier": "^2.6.2",
+    "yargs": "^17.4.1"
+  },
+  "devDependencies": {
+    "@types/js-yaml": "^4.0.5",
+    "@types/node": "^17.0.23",
+    "@types/prettier": "^2.6.0",
+    "@types/yargs": "^17.0.10",
+    "typescript": "^4.6.3"
+  },
+  "files": [
+    "/lib"
+  ],
+  "bin": "lib/yaml-to-ts.js"
+}