Workcube Extension for VS Code

Genel Kullanım

• Custom tag'ler <cf yazılınca listelenir.

  • Seçilen tag, zorunlu parametreleri ve gerekiyorsa kapanış etiketi ile eklenir.
  • Tag'in açıklaması öneri listesinde ve fare ile üzerine gelince (hover) görünür.
  • wrk: ile başlayan snippet'lar kaldırıldı; cfloop, cftry_cfc, cf_box dump gibi elle yazılmış yardımcılar duruyor.

• Parametreler custom tag'in içinde Ctrl+Space ile listelenir.

  • <cf_box |> içinde Ctrl+Space -> sadece cf_box parametreleri gelir.
  • Tag içinde boşluk bıraktığınızda liste kendiliğinden açılır.
  • Zaten yazılmış parametreler listede tekrar gösterilmez.
  • Seçilen parametre id="" şeklinde, varsayılan değeri seçili olarak eklenir.
  • Parametrenin açıklaması, kaynak dosyadaki cfparam yorumundan gelir.
  • Eski Ctrl+Shift+Space kısayolu da aynı listeyi açar.

• getLang: <cf_get_lang> ile yazılmış sözcükleri, #getLang()# formatına dönüştürme fonksiyonudur.

  • Ctrl+Shift+L kısayolu ile kullanılabilir.
  • Ctrl+Shift+P menüsünden Workcube: Convert <cf_get_lang> to #getLang()# seçeneği ile de kullanılabilir.

• wdata: ile başlayan snippet'lar workdata component'leridir.

  • <cfset get_department = CreateObject("component","workdata.get_department") /> satırını üretir.

• combo_name:list <cf_wrk_combo query_name=""> içinde kullanılabilecek component adlarını listeler.

Snippet'ların Güncellenmesi

Custom tag, açıklama ve workdata snippet'leri elle yazılmaz; kaynak koddan üretilir:

cd vscode/workcube-extension
python3 tools/gen_snippets.py --dry-run   # sadece özet
python3 tools/gen_snippets.py             # dosyaları yazar

Üreteç şunları tarar:

• CustomTags/*.cfm -> snippets/tag_params.json (tag + parametre + açıklama; ext.js okur)
• snippets/customtags.json artık yalnızca elle yazılmış snippet'leri tutar, üretilmez
• CustomTags/*.cfm -> snippets/descriptions.json (sadece açıklaması olmayan tag'ler)
• workdata/*.cfc, V16/workdata/*.cfc -> snippets/workdata.json

Elle yazılmış snippet'ler (cf_box dump, cftry_cfc vb.), elle yazılmış description'lar ve tag_params.json içindeki required (zorunlu parametre) listeleri korunur, üzerine yazılmaz. Yeni bir custom tag eklendiğinde üreteci tekrar çalıştırmak yeterlidir.

Parametre açıklaması eklemek için kaynak dosyaya yorum yazmak yeterlidir:

<cfparam name="attributes.more" default="1"><!--- Form'da daha fazlası yoksa 0 --->
<!--- Pencere genişliği --->
<cfparam name="attributes.width" default="600">

Geliştirme

Parametre tamamlamasının kontrolü (VS Code gerekmez):

node tools/test_completion.js

Ctrl+Space listesinde custom tag parametrelerinin yanında başka öneri görmek istemiyorsanız, kullanıcı ayarlarınıza şunu ekleyebilirsiniz:

"[cfml]": { "editor.suggest.showSnippets": false }