scriptic

Escrutico

Secretic es un lenguaje de plantilla de texto de texto rápido, potente, seguro y liviano para .NET, con un modo de compatibilidad para analizar las plantillas liquid .

Secretic es una bifurcación directa y extensión a, escriba y, por lo tanto, hereda todas sus características increíbles, al tiempo que agrega soporte para diseños y secciones (similar a .NET Razor's) (ver más abajo).

Lo siguiente se aplica igualmente a los escrutinos y la escriba:

 // Parse a scriban template
var template = Template . Parse ( " Hello {{name}}! " ) ;
var result = template . Render ( new { Name = " World " } ) ; // => "Hello World!" 

Scriban es un lenguaje de plantilla de texto de texto rápido, potente, seguro y liviano para .NET, con un modo de compatibilidad para analizar las plantillas liquid .

 // Parse a scriban template
var template = Template . Parse ( " Hello {{name}}! " ) ;
var result = template . Render ( new { Name = " World " } ) ; // => "Hello World!" 

Analice una plantilla de líquido usando el lenguaje líquido:

 // Parse a liquid template
var template = Template . ParseLiquid ( " Hello {{name}}! " ) ;
var result = template . Render ( new { Name = " World " } ) ; // => "Hello World!" 

El lenguaje es muy versátil, fácil de leer y usar, similar a las plantillas de líquido:

 var template = Template . Parse ( @"
<ul id='products'>
  {{ for product in products }}
    <li>
      <h2>{{ product.name }}</h2>
           Price: {{ product.price }}
           {{ product.description | string.truncate 15 }}
    </li>
  {{ end }}
</ul>
" ) ;
var result = template . Render ( new { Products = this . ProductList } ) ;

AVISO

De manera predeterminada, las propiedades y los métodos de los objetos .NET se expusen automáticamente con minúsculas y _ nombres. Significa que una propiedad como MyMethodIsNice estará expuesta como my_method_is_nice . Esta es la convención predeterminada, originalmente para que coincida con el comportamiento de las plantillas líquidas. Si desea cambiar este comportamiento, debe usar un Delegado MemberRenamer

Características de los escrita/escribas

• Muy eficiente , analizador rápido y un tiempo de ejecución liviano . CPU y basura amigable. Consulte los puntos de referencia para obtener más detalles.
• Impulsado por un lexer/analizador que proporciona un árbol de sintaxis abstracto completo, rápido, versátil y robusto , más eficiente que los analizadores basados ​​en regex.
  • Ubicación precisa del código fuente (ruta, columna y línea) para informes de errores
  • Escriba una AST a una representación textual de un script , con Template.ToText , permitiendo manipular scripts en la memoria y volver a salvarlos en el disco, útil para los escenarios de actualización de script de ida y vuelta
• Compatible con liquid utilizando el método Template.ParseLiquid
  • Si bien el lenguaje liquid es menos potente que la escriba, este modo permite migrar del liquid al lenguaje scriban fácilmente
  • Con el modo AST TO TEXT, puede convertir un script liquid en un script de Scriban usando Template.ToText Template.ParseLiquid
  • Como el lenguaje líquido no está estrictamente definido y, de hecho, hay varias versiones de sintaxis líquida, existen restricciones al usar plantillas líquidas con Scriban, consulte el documento de soporte líquido en Scriban para obtener más detalles.
• Tiempo de ejecución extensible que proporciona muchos puntos de extensibilidad
• Control preciso de la salida de texto en blanco
• Lenguaje destinado completo que incluye if / else / for / while , expresiones ( x = 1 + 2 ), condiciones ... etc.
• Llamadas de funciones y tuberías ( myvar | string.capitalize )
  • Funciones personalizadas directamente en el idioma a través de la instrucción func y permiten los punteros/delegados de la función a través de la alias @ directive
  • Atrae las funciones personalizadas .NET de la API de tiempo de ejecución con muchas opciones para interactuar con los objetos .NET.
• Objetos complejos (JavaScript/JSON Like Objects x = {mymember: 1} ) y matrices (por ejemplo, x = [1,2,3,4] )
• Permitir pasar un bloque de declaraciones a una función, típicamente utilizada por la instrucción wrap
• Varias funciones integradas:
  • arrays functions
  • date
  • html
  • maths functions
  • object
  • regex functions
  • string functions
  • timespan
• Declaraciones de múltiples líneas sin tener que adoptar cada línea por {{...}}
• Parser seguro y tiempo de ejecución seguro, lo que le permite controlar qué objetos y funciones están expuestos

Colorante de sintaxis

Puede instalar la extensión de Scriban para el código Visual Studio para obtener coloración de sintaxis para scripts de escribas (sin HTML) y archivos HTML de Scriban. Tenga en cuenta que la extensión no reconoce las características escrita en la parte superior de Scriban.

Extensiones específicas

Scriptic agrega algunas palabras clave adicionales al lenguaje de secuencias de comandos:

• layout : por ejemplo, la directiva {{layout "_main_layout.htmls"}} indica el archivo de diseño para la página actual. Los diseños se pueden anidar, es decir, un archivo de diseño puede tener una directiva layout . Sin embargo, solo puede haber una directiva layout en un archivo determinado. Todo el concepto de diseño se modela después de las vistas de afeitar .NET.
• body : un marcador de posición dentro de un archivo de diseño que indica dónde se representará el contenido de la página.
• section , por ejemplo {{section "main-menu}"}} en una página es un fragmento reutilizable de HTML y Scrutic. El contenido de una sección se representa donde se coloca una directiva render correspondiente.
• render - Por ejemplo {{render "main-menu"}} indica dónde se debe representar una sección dada en un archivo de diseño. Las secciones también se pueden definir y representar dentro de la misma página. La misma sección se puede representar varias veces, por lo que es una forma conveniente de aislar fragmentos de marcado pequeños y reutilizables.
• markdown : se puede usar de dos maneras diferentes:
  • Como una declaración {{markdown}} <markdown text goes here> {{end}} , en cuyo caso el texto dentro del par markdown-end se trata como markdown puro (no debe contener expresiones especiales)
  • o como una función especial (pseudo-), {{markdown "mdfilename.md"}} , en cuyo caso se extrae el archivo de markdown externo especificado; El archivo de Markdown también puede contener declaraciones y expresiones escrógicas. Se evalúan antes de procesar la sintaxis de Markdown.

La palabra clave markdown solo funciona cuando proporciona un renderizador de texto de Markdown. Esto se hace de manera similar a cómo se especifican los cargadores de plantilla externos:

context . Markdown = new MarkdownRenderer ( ) ;

Donde MarkdownRenderer implementa la interfaz IStringTransformer :

 public interface IStringTransformer
{
    string Render ( string text ) ;
}

El transformador puede hacer una serie arbitraria de transformaciones en el texto, pero tenía la intención de funcionar bien con un procesador de Markdown como Markdig (curiosamente, del mismo autor que Scriban).

Documentación

• Consulte el documento del idioma para obtener una descripción de la sintaxis del lenguaje de escribas.
• Consulte el documento de funciones incorporadas para la lista de las funciones incorporadas de Scriban.
• Consulte el documento de tiempo de ejecución para obtener una descripción de la API de tiempo de ejecución .NET para compilar y ejecutar plantillas.
• Consulte el documento de soporte líquido para obtener más detalles sobre el soporte de plantillas líquidas.
• Vea la publicación del blog "Implementar un motor de plantilla de texto para .NET" del autor de Scriban para algunos detalles detrás de la escena.

Binarios

Scriban ha estado disponible por un tiempo como un paquete Nuget :. Sabricic no está disponible en Nuget todavía.

Sabricación todavía es mucho trabajo en progreso. No ha logrado el mismo nivel de estabilidad y madurez que la escriba. Dicho esto, los escrutinos son solo una extensión menor de Scriban, por lo que disfruta de muchos beneficios de su base de código maduro. Sin embargo, es posible que hayamos roto algo inadvertidamente ... de todos modos, usamos Sabrárices para el trabajo de producción. Ymmv. Use bajo su propio riesgo.

Puntos de referencia

¡Scriptic/Scriban es ardiente rápido ! Para obtener más detalles, puede consultar el documento de referencia.

Licencia

Este software se lanza bajo la licencia BSD-Cláusula 2.

Proyectos relacionados

• dotliquid: puerto .net del motor de plantilla de líquido
• Motor de plantilla de líquido .NET .NET .NET
• Nustache: plantillas sin lógica para .net
• Handleebars.net: .NET Puerto de manillars.js

Créditos

Sin embargo, el logotipo escrógico, claramente inspirado en el rompecabezas de Scriban, es un trabajo original de Andrew J. Wozniewicz (archivo de origen CorelDraw incluido).

Autores

Scriban fue creado y está siendo mantenido por Alexandre Mutel, también conocido como XOFX. Sabricic fue bifurcado de Scriban y extendido por Andrew J. Wozniewicz (también conocido como ANCZ).