Cambiar idioma: English

Instrucciones

Warning

Esta sección es un borrador.

Las instrucciones son las piezas fundamentales de la automatización en Sublime Text. Las asignaciones de teclas, los menús y las macros funcionan mediante instrucciones.

Las instrucciones aceptan parámetros y pueden estar dirigidas a un búfer, una ventana o la aplicación Sublime Text.

Existen instrucciones predefinidas e instrucciones creadas. Las predefinidas forman parte del núcleo del editor, mientras que las creadas se definen en complementos (archivos de Python). Entre las instrucciones creadas se pueden distinguir las distribuidas —que siempre se incluyen con el editor—, y las del usuario, que añade el propio usuario. No es necesario memorizar esta clasificación; su único propósito es simplificar las explicaciones en esta guía.

Instrucciones predefinidas

Las proporciona Sublime Text y el usuario no tiene acceso al código.

Instrucciones creadas

Se crean con archivos de Python.

Convenciones para los nombres de las instrucciones

Por covención, los nombres de las clases que definen instrucciones se escriben en LetraJorobada y se sufijan con Command (p. ej.: MyNewCommand, NukeCommand, DuplicateLineCommand).

Sublime Text unifica todos los nombres de las instrucciones suprimiendo el sufijo Command y separando palabras con guiones bajos. Siguiendo con los ejemplos anteriores, nos darían:

  • my_new
  • nuke
  • duplicate_line

Nótese que el nombre de la clase que define una instrucción y el nombre de la instrucción propiamente dicho son diferentes, aunque el segundo se deriva del primero. La transformación se realiza en sublime_plugin.py, archivo que se puede encontrar en el mismo directorio de la instalación de Sublime Text.

Si al ejecutar una instrucción con view.run_command() o una función similar Sublime Text no la encuentra, la función fallará silenciosamente.

Uso de instrucciones

Hay varias formas de utilizar una instrucción, pero si solo quieres probarla, puedes utilizar la consola de Python (CTRL+`).

window.run_command("echo", {"one": 1, "two": 2})

Exploración de instrucciones existentes

Todas las instrucciones creadas en Python se pueden encontrar en el directorio Packages. En particular, bajo Packages/Default puedes ver muchas de las instrucciones más utilizadas.