مشاركة عبر

Invoke-Formatter

الوحدة النمطية:
PSScriptAnalyzer Module

تنسيق نص برنامج نصي استنادا إلى إعدادات الإدخال أو الإعدادات الافتراضية.

بناء الجملة

Default (افتراضي) 

Invoke-Formatter
    [-ScriptDefinition] <string>
    [[-Settings] <Object>]
    [[-Range] <int[]>]
    [<CommonParameters>]

الوصف

يأخذ cmdlet إدخال سلسلة وينسقها وفقا لإعدادات محددة. إذا لم يتم توفير معلمة إعدادات، يفترض cmdlet إعدادات تنسيق التعليمات البرمجية الافتراضية كما هو محدد في .

أمثلة

مثال 1 - تنسيق نص البرنامج النصي للإدخل باستخدام الإعدادات الافتراضية

$scriptDefinition = @'
function foo {
"hello"
  }
'@

Invoke-Formatter -ScriptDefinition $scriptDefinition

function foo {
    "hello"
}

مثال 2 - تنسيق برنامج الإدخال النصي باستخدام الإعدادات المعرفة في hashtable

$scriptDefinition = @'
function foo {
"hello"
}
'@

$settings = @{
    IncludeRules = @("PSPlaceOpenBrace", "PSUseConsistentIndentation")
    Rules = @{
        PSPlaceOpenBrace = @{
            Enable = $true
            OnSameLine = $false
        }
        PSUseConsistentIndentation = @{
            Enable = $true
        }
    }
}

Invoke-Formatter -ScriptDefinition $scriptDefinition -Settings $settings

function foo
{
    "hello"
}

المثال 3 - تنسيق نص السكريبت الإدخال باستخدام الإعدادات المعرفة في ملف '.psd1'

Invoke-Formatter -ScriptDefinition $scriptDefinition -Settings /path/to/settings.psd1

المعلمات

-Range

النطاق الذي يجب أن يتم التنسيق داخله. يجب أن تكون قيمة هذه المعلمة صفيفا من أربعة أعداد صحيحة. يجب أن تكون هذه الأرقام أكبر من 0. تمثل الأعداد الصحيحة الأربعة القيم الأربع التالية بهذا الترتيب:

  • رقم سطر البداية
  • رقم عمود البدء
  • رقم سطر النهاية
  • إنهاء رقم العمود

خصائص المعلمات

النوع:

Int32[]

القيمة الافتراضية:None
يدعم أحرف البدل:False
DontShow:False

مجموعات المعلمات

(All)
Position:3
إلزامي:False
القيمة من مسار معالجة البيانات:True
القيمة من مسار معالجة البيانات حسب اسم الخاصية:True
القيمة من الوسائط المتبقية:False

-ScriptDefinition

يتم تمثيل نص البرنامج النصي الذي سيتم تنسيقه كسلسلة. هذا ليس كائن ScriptBlock.

خصائص المعلمات

النوع:String
القيمة الافتراضية:None
يدعم أحرف البدل:False
DontShow:False

مجموعات المعلمات

(All)
Position:1
إلزامي:True
القيمة من مسار معالجة البيانات:True
القيمة من مسار معالجة البيانات حسب اسم الخاصية:True
القيمة من الوسائط المتبقية:False

-Settings

الإعدادات قابلة للتجزئة أو مسار إلى ملف بيانات PowerShell () يحتوي على الإعدادات.

خصائص المعلمات

النوع:Object
القيمة الافتراضية:CodeFormatting
يدعم أحرف البدل:False
DontShow:False

مجموعات المعلمات

(All)
Position:2
إلزامي:False
القيمة من مسار معالجة البيانات:True
القيمة من مسار معالجة البيانات حسب اسم الخاصية:True
القيمة من الوسائط المتبقية:False

CommonParameters

يدعم cmdlet هذا المعلمات الشائعة: -Debug و -ErrorAction و -ErrorVariable و -InformationAction و -InformationVariable و -OutBuffer و -OutVariable و -PipelineVariable و -ProgressAction و -Verbose و -WarningAction و -WarningVariable. لمزيد من المعلومات، راجع about_CommonParameters.

المخرجات

String

نتيجة السلسلة المنسقة.