الصفحة الرئيسية>المتعلقة بالبرمجة>شفرة المصدر الأخرى
تنزيل

ts-json-مولد المخطط

نسخة موسعة من https://github.com/xiag-ag/typescript-to-json-schema.

مستوحاة من YousefED/typescript-json-schema . إليك قائمة الاختلافات:

  • يتجنب هذا التنفيذ استخدام typeChecker.getTypeAtLocation() (لذلك ربما يحتفظ بالأسماء المستعارة الصحيحة للنوع)
  • تم تقسيم معالجة AST وتنسيق مخطط JSON إلى خطوتين مستقلتين
  • لا يتم عرض الأنواع والواجهات والتعدادات غير المصدرة في قسم definitions في مخطط JSON

المساهمين

أصبح هذا المشروع ممكنا من قبل مجتمع من المساهمين. نحن نرحب بالمساهمات من أي نوع (القضايا، التعليمات البرمجية، الوثائق، الأمثلة، الاختبارات، ...). يرجى قراءة قواعد السلوك لدينا.

استخدام سطر الأوامر

قم بتشغيل منشئ المخطط باستخدام npx: 

npx ts-json-schema-generator --path ' my/project/**/*.ts ' --type ' My.Type.Name '

أو قم بتثبيت الحزمة ثم قم بتشغيلها 

npm install --save ts-json-schema-generator
./node_modules/.bin/ts-json-schema-generator --path ' my/project/**/*.ts ' --type ' My.Type.Name '

لاحظ أن الأنظمة الأساسية المختلفة (مثل Windows) قد تستخدم فواصل مسارات مختلفة لذا قد يتعين عليك ضبط الأمر أعلاه.

لاحظ أيضًا أنك تحتاج إلى اقتباس المسارات بعلامة * وإلا فإن الصدفة ستوسع المسارات وبالتالي ستمرر المسار الأول فقط إلى المولد.

افتراضيًا، سيستخدم منشئ سطر الأوامر ملف tsconfig.json في دليل العمل الحالي، أو الدليل الأصلي الأول الذي يحتوي على ملف tsconfig.json حتى جذر نظام الملفات. إذا كنت تريد استخدام ملف tsconfig.json مختلف، فيمكنك استخدام خيار --tsconfig . على وجه الخصوص، إذا كنت بحاجة إلى استخدام خيارات ترجمة مختلفة للأنواع، فقد ترغب في إنشاء ملف tsconfig.json منفصل لإنشاء المخطط فقط.

خيارات 

  -p, --path <path>              Source file path
  -t, --type <name>              Type name
  -i, --id <name>                $id for generated schema
  -f, --tsconfig <path>          Custom tsconfig.json path
  -e, --expose <expose>          Type exposing (choices: "all", "none", "export", default: "export")
  -j, --jsDoc <extended>         Read JsDoc annotations (choices: "none", "basic", "extended", default: "extended")
  --markdown-description         Generate `markdownDescription` in addition to `description`.
  --functions <functions>        How to handle functions. `fail` will throw an error. `comment` will add a comment. `hide` will treat the function like a NeverType or HiddenType.
                                 (choices: "fail", "comment", "hide", default: "comment")
  --minify                       Minify generated schema (default: false)
  --unstable                     Do not sort properties
  --strict-tuples                Do not allow additional items on tuples
  --no-top-ref                   Do not create a top-level $ref definition
  --no-type-check                Skip type checks to improve performance
  --no-ref-encode                Do not encode references
  -o, --out <file>               Set the output file (default: stdout)
  --validation-keywords [value]  Provide additional validation keywords to include (default: [])
  --additional-properties        Allow additional properties for objects with no index signature (default: false)
  -V, --version                  output the version number
  -h, --help                     display help for command

الاستخدام البرمجي 

 // main.js

const tsj = require ( "ts-json-schema-generator" ) ;
const fs = require ( "fs" ) ;

/** @type {import('ts-json-schema-generator/dist/src/Config').Config} */
const config = {
    path : "path/to/source/file" ,
    tsconfig : "path/to/tsconfig.json" ,
    type : "*" , // Or <type-name> if you want to generate schema for that one type only
} ;

const outputPath = "path/to/output/file" ;

const schema = tsj . createGenerator ( config ) . createSchema ( config . type ) ;
const schemaString = JSON . stringify ( schema , null , 2 ) ;
fs . writeFile ( outputPath , schemaString , ( err ) => {
    if ( err ) throw err ;
} ) ;

قم بتشغيل منشئ المخطط عبر node main.js .

التنسيق المخصص

يمكن توسيع التنسيق المضمن عن طريق إنشاء منسق مخصص وإضافته إلى المنسق الرئيسي:

  1. أولاً نقوم بإنشاء منسق، في هذه الحالة لتنسيق أنواع الوظائف (لاحظ أن هناك واحدًا مدمجًا): 
 // my-function-formatter.ts
import { BaseType , Definition , FunctionType , SubTypeFormatter } from "ts-json-schema-generator" ;
import ts from "typescript" ;

export class MyFunctionTypeFormatter implements SubTypeFormatter {
    // You can skip this line if you don't need childTypeFormatter
    public constructor ( private childTypeFormatter : TypeFormatter ) { }

    public supportsType ( type : BaseType ) : boolean {
        return type instanceof FunctionType ;
    }

    public getDefinition ( type : FunctionType ) : Definition {
        // Return a custom schema for the function property.
        return {
            type : "object" ,
            properties : {
                isFunction : {
                    type : "boolean" ,
                    const : true ,
                } ,
            } ,
        } ;
    }

    // If this type does NOT HAVE children, generally all you need is:
    public getChildren ( type : FunctionType ) : BaseType [ ] {
        return [ ] ;
    }

    // However, if children ARE supported, you'll need something similar to
    // this (see src/TypeFormatter/{Array,Definition,etc}.ts for some examples):
    public getChildren ( type : FunctionType ) : BaseType [ ] {
        return this . childTypeFormatter . getChildren ( type . getType ( ) ) ;
    }
}
  1. ثم نضيف المنسق كطفل إلى المنسق الأساسي باستخدام رد الاتصال المعزز: 
 import { createProgram , createParser , SchemaGenerator , createFormatter } from "ts-json-schema-generator" ;
import { MyFunctionTypeFormatter } from "./my-function-formatter.ts" ;
import fs from "fs" ;

const config = {
    path : "path/to/source/file" ,
    tsconfig : "path/to/tsconfig.json" ,
    type : "*" , // Or <type-name> if you want to generate schema for that one type only
} ;

// We configure the formatter an add our custom formatter to it.
const formatter = createFormatter ( config , ( fmt , circularReferenceTypeFormatter ) => {
    // If your formatter DOES NOT support children, e.g. getChildren() { return [] }:
    fmt . addTypeFormatter ( new MyFunctionTypeFormatter ( ) ) ;
    // If your formatter DOES support children, you'll need this reference too:
    fmt . addTypeFormatter ( new MyFunctionTypeFormatter ( circularReferenceTypeFormatter ) ) ;
} ) ;

const program = createProgram ( config ) ;
const parser = createParser ( program , config ) ;
const generator = new SchemaGenerator ( program , parser , formatter , config ) ;
const schema = generator . createSchema ( config . type ) ;
const outputPath = "path/to/output/file" ;

const schemaString = JSON . stringify ( schema , null , 2 ) ;
fs . writeFile ( outputPath , schemaString , ( err ) => {
    if ( err ) throw err ;
} ) ;

تحليل مخصص

على غرار التنسيق المخصص، يعمل توسيع التحليل المدمج بنفس الطريقة تقريبًا:

  1. أولاً نقوم بإنشاء محلل، في هذه الحالة لتحليل أنواع البناء: 
 // my-constructor-parser.ts
import { Context , StringType , ReferenceType , BaseType , SubNodeParser } from "ts-json-schema-generator" ;
// use typescript exported by TJS to avoid version conflict
import ts from "ts-json-schema-generator" ;

export class MyConstructorParser implements SubNodeParser {
    supportsNode ( node : ts . Node ) : boolean {
        return node . kind === ts . SyntaxKind . ConstructorType ;
    }
    createType ( node : ts . Node , context : Context , reference ?: ReferenceType ) : BaseType | undefined {
        return new StringType ( ) ; // Treat constructors as strings in this example
    }
}
  1. ثم نضيف المحلل اللغوي كطفل إلى المحلل اللغوي الأساسي باستخدام رد الاتصال المعزز: 
 import { createProgram , createParser , SchemaGenerator , createFormatter } from "ts-json-schema-generator" ;
import { MyConstructorParser } from "./my-constructor-parser.ts" ;
import fs from "fs" ;

const config = {
    path : "path/to/source/file" ,
    tsconfig : "path/to/tsconfig.json" ,
    type : "*" , // Or <type-name> if you want to generate schema for that one type only
} ;

const program = createProgram ( config ) ;

// We configure the parser an add our custom parser to it.
const parser = createParser ( program , config , ( prs ) => {
    prs . addNodeParser ( new MyConstructorParser ( ) ) ;
} ) ;

const formatter = createFormatter ( config ) ;
const generator = new SchemaGenerator ( program , parser , formatter , config ) ;
const schema = generator . createSchema ( config . type ) ;
const outputPath = "path/to/output/file" ;

const schemaString = JSON . stringify ( schema , null , 2 ) ;
fs . writeFile ( outputPath , schemaString , ( err ) => {
    if ( err ) throw err ;
} ) ;

الحالة الحالية

  • أنواع interface
  • أنواع enum
  • أنواع union ، tuple ، type[]
  • Date ، RegExp ، أنواع URL
  • string boolean وأنواع number
  • "value" ، 123 ، true ، false ، null ، حرفية undefined
  • اكتب الأسماء المستعارة
  • الأدوية العامة
  • typeof
  • keyof
  • أنواع مشروطة
  • وظائف
  • Promise<T> يفتح لـ T
  • التجاوزات (مثل @format )

تشغيل محليا

yarn --silent run run --path 'test/valid-data/type-mapped-array/*.ts' --type 'MyObject'

تصحيح

yarn --silent run debug --path 'test/valid-data/type-mapped-array/*.ts' --type 'MyObject'

والاتصال عبر بروتوكول مصحح الأخطاء.

يعد AST Explorer رائعًا لمطوري هذه الأداة!

نشر

تتم معالجة النشر من خلال عملية ما قبل النشر ذات فرعين، والتي تم تكوينها في publish-auto.yml . يجب أن تستند جميع التغييرات إلى الفرع next الافتراضي، ويتم نشرها تلقائيًا.

  • يتم نشر العلاقات العامة التي تم إنشاؤها في الفرع الافتراضي تلقائيًا إلى علامة الإصدار المسبق next على NPM. يمكن تثبيت النتيجة باستخدام npm install ts-json-schema-generator@next
    • عند الدمج في next ، يرجى استخدام استراتيجية squash and merge .
  • لإصدار إصدار ثابت جديد، افتح PR من next إلى stable باستخدام رابط المقارنة هذا.
    • عند الدمج من next إلى stable ، يرجى استخدام استراتيجية create a merge commit .
يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل