Remove .tmpl extension from Jinja templates in core

Remove .tmpl extension from Jinja templates in core

Jinja templates generally use the extension of the file they generate:
"A template is simply a text file. It can generate any text-based format
(HTML, XML, CSV, LaTeX, etc.). It doesn’t have a specific extension,
.html or .xml are just fine."
http://jinja.pocoo.org/docs/templates/

However, we needed to add an extension (here .tmpl) to prevent
check-webkit-style in presubmit scripts from complaining about style,
since it can't understand Jinja syntax.

I fixed this in this CL:
Issue 22514002: Disable check-webkit-style for Jinja templates
https://codereview.chromium.org/22514002/

...and thus there is no more need for these extensions.

I've left the .tmpl for the macros.tmpl file, as that not a specific
output (it's just Jinja macros).

This issue arose in the bindings, so I fixed it there, and for consistency
I'm proposing to change it in core as well; see thread:
https://codereview.chromium.org/21006006/#msg8
https://codereview.chromium.org/21006006/#msg11
https://codereview.chromium.org/21006006/#msg13
https://codereview.chromium.org/21006006/#msg14
https://codereview.chromium.org/21006006/#msg15

[Nils Barth (inactive), 2013-08-08 02:02:26]

Hi Timothy (+ Eric & Dimitri),

Just a lil' renaming patch:
I fixed the presubmit scripts so check-webkit-style doesn't
complain about Jinja templates (instead it skips them),
so we don't need the .tmpl extensions any more!
Hope this simplifies things a little bit.

Cheers, Nils

[haraken, 2013-08-08 02:20:21]

On 2013/08/08 02:02:26, Nils Barth wrote:
> Hi Timothy (+ Eric & Dimitri),
> 
> Just a lil' renaming patch:
> I fixed the presubmit scripts so check-webkit-style doesn't
> complain about Jinja templates (instead it skips them),
> so we don't need the .tmpl extensions any more!
> Hope this simplifies things a little bit.
> 
> Cheers, Nils

This change looks good to me, but other folks might have another thought.

Another reason why we suffix the template file with .tmpl is to make it clearer
that it's a template file.

[Nils Barth (inactive), 2013-08-08 02:24:06]

On 2013/08/08 02:20:21, haraken wrote:
> This change looks good to me, but other folks might have another thought.

Yup – thoughts, other folks?

> Another reason why we suffix the template file with .tmpl is to make it
clearer
> that it's a template file.

True, but these are in templates/ directories, which make it rather clear.

[Timothy Loh, 2013-08-08 02:47:34]

On 2013/08/08 02:24:06, Nils Barth wrote:
> > Another reason why we suffix the template file with .tmpl is to make it
> clearer
> > that it's a template file.
> 
> True, but these are in templates/ directories, which make it rather clear.

This seems fine to me, consistency is good. lgtm.

[Nils Barth (inactive), 2013-08-08 05:11:22]

On 2013/08/08 02:47:34, Timothy Loh wrote:
> This seems fine to me, consistency is good. lgtm.

Thanks Timothy!
Eric, Dimitri: OWNERS?

[esprehn, 2013-08-08 16:14:05]

This is going to do sad things to syntax highlighting in people's editors. Most
do not have per directory syntax detection and use the file extension instead.
This also prevents you from having a different editor associated with jinja
files and cpp files for "double click to open".

What benefit does this have?

[dglazkov, 2013-08-08 16:14:13]

I am okay with this. Eric?

[eseidel, 2013-08-08 18:28:19]

I don't really care one way or the other.

Like Elliot I suspect that my editor would behave better with an explicit suffix
instead of having to tell it each time that these really aren't .cpp files.

[Nils Barth (inactive), 2013-08-09 10:50:19]

Thanks for feedback, and for raising syntax/editor issues.
AFAICT it's generally easier and better behaved *without* an additional
extension, as then it falls back on C++ (with some funny text), rather than
being an unknown ".tmpl" type.

Thanks to this thread, I just added Jinja highlighting to my Vim setup, and it's
actually *easier* if these use the .cpp/.h suffixes (w/o .tmpl), since then I
just add Jinja highlighting on top of the existing C++.

If anyone else is editing these files much and has another (esp. better) system,
I'd be happy to standardize on that.
For editors that can only handle file extensions, .tmpl.cpp/.tmpl.h might be
better, since it has fallback to .cpp/.h.?

Elliot, are you editing these files, or do you know anyone who is?


AFAICT, the reasoning behind Jinja using the extension of the underlying file is
that it's *basically* the underlying file type, with some template additions.
So if you're opening a "Jinja C++ template", usually the best guess is "a C++
file (with some weirdness)", and that's both how you want to edit it and
highlight it.

So calling the file .cpp/.h means it's opened with your usual C++ editor with at
least roughly highlighted correctly.
If it's instead .cpp.tmpl or .h.tmpl, you need to add new file extension, and
then I'd still just get C++ highlighting.
So unless you're doing extra work to get Jinja-specific highlighting, you get no
benefit and additional cost from the extra .tmpl.


For reference, here's what I just whipped up for Vim:
(I'm not Vim expert, but this WFM.)

1. Download Jinja syntax highlighting:
http://www.vim.org/scripts/script.php?script_id=1856
...to ~/.vim/syntax/jinja.vim

2. Put the below in .vimrc

" Per:
" Different syntax highlighting within regions of a file
"
http://vim.wikia.com/wiki/Different_syntax_highlighting_within_regions_of_a_file
" ...removing the textSnipHl section (since want to include the delimiters
" for Jinja).
"
" ...and using syntax from:
" http://www.vim.org/scripts/script.php?script_id=1856

function! TextEnableCodeSnip(filetype,start,end) abort
  let ft=toupper(a:filetype)
  let group='textGroup'.ft
  if exists('b:current_syntax') 
    let s:current_syntax=b:current_syntax
    " Remove current syntax definition, as some syntax files (e.g. cpp.vim)
    " do nothing if b:current_syntax is defined.
    unlet b:current_syntax
  endif
  execute 'syntax include @'.group.' syntax/'.a:filetype.'.vim'
  try
    execute 'syntax include @'.group.' after/syntax/'.a:filetype.'.vim'
  catch
  endtry
  if exists('s:current_syntax')
    let b:current_syntax=s:current_syntax
  else
    unlet b:current_syntax
  endif
  execute 'syntax region textSnip'.ft.'
  \ start="'.a:start.'" end="'.a:end.'"
  \ contains=@'.group
endfunction

" Jinja template highlighting
" Default delimiters are {{ }}, {% %}, and {# #}, per:
" http://jinja.pocoo.org/docs/templates/
au BufNewFile,BufRead */templates/* call TextEnableCodeSnip('jinja', '{{', '}}')
au BufNewFile,BufRead */templates/* call TextEnableCodeSnip('jinja', '{%', '%}')
au BufNewFile,BufRead */templates/* call TextEnableCodeSnip('jinja', '{#', '#}')