diff options
-rw-r--r-- | changelog.md | 5 | ||||
-rw-r--r-- | doc/filters.rst | 9 | ||||
-rw-r--r-- | doc/intern.rst | 2 | ||||
-rw-r--r-- | tests/template/sunset.nimf (renamed from tests/template/sunset.tmpl) | 0 | ||||
-rw-r--r-- | tests/template/template_various.nim | 2 | ||||
-rw-r--r-- | tools/niminst/buildbat.nimf (renamed from tools/niminst/buildbat.tmpl) | 0 | ||||
-rw-r--r-- | tools/niminst/buildsh.nimf (renamed from tools/niminst/buildsh.tmpl) | 2 | ||||
-rw-r--r-- | tools/niminst/deinstall.nimf (renamed from tools/niminst/deinstall.tmpl) | 0 | ||||
-rw-r--r-- | tools/niminst/inno.nimf (renamed from tools/niminst/inno.tmpl) | 0 | ||||
-rw-r--r-- | tools/niminst/install.nimf (renamed from tools/niminst/install.tmpl) | 0 | ||||
-rw-r--r-- | tools/niminst/makefile.nimf (renamed from tools/niminst/makefile.tmpl) | 2 | ||||
-rw-r--r-- | tools/niminst/niminst.nim | 14 | ||||
-rw-r--r-- | tools/niminst/nsis.nimf (renamed from tools/niminst/nsis.tmpl) | 0 | ||||
-rw-r--r-- | tools/nimweb.nim | 2 | ||||
-rw-r--r-- | tools/website.nimf (renamed from tools/website.tmpl) | 0 |
15 files changed, 23 insertions, 15 deletions
diff --git a/changelog.md b/changelog.md index 6ec83212d..7cc2a3b63 100644 --- a/changelog.md +++ b/changelog.md @@ -88,6 +88,11 @@ proc enumToString*(enums: openArray[enum]): string = ### Language changes +- The standard extension for SCF (source code filters) files was changed from + ``.tmpl`` to ``.nimf``, + it's more recognizable and allows tools like github to recognize it as Nim, + see [#9647](https://github.com/nim-lang/Nim/issues/9647). + The previous extension will continue to work. ### Tool changes - `jsondoc` now include a `moduleDescription` field with the module diff --git a/doc/filters.rst b/doc/filters.rst index e8106749e..40346ecaf 100644 --- a/doc/filters.rst +++ b/doc/filters.rst @@ -31,13 +31,16 @@ Usage ===== First, put your SCF code in a separate file with filters specified in the first line. -**Note:** You can name your SCF file with any file extension you want, but the conventional extension is ``.tmpl``. +**Note:** You can name your SCF file with any file extension you want, but the +conventional extension is ``.nimf`` +(it used to be ``.tmpl`` but that was too generic, for example preventing github to +recognize it as Nim source file). -If we use `generateXML` code shown above and call the SCF file `xmlGen.tmpl` +If we use `generateXML` code shown above and call the SCF file `xmlGen.nimf` In your `main.nim`: .. code-block:: nim - include "xmlGen.tmpl" + include "xmlGen.nimf" echo generateXML("John Smith","42") diff --git a/doc/intern.rst b/doc/intern.rst index 0fa4fd7b6..b71ad592f 100644 --- a/doc/intern.rst +++ b/doc/intern.rst @@ -31,7 +31,7 @@ Path Purpose reStructuredText files ``lib`` the Nim library ``web`` website of Nim; generated by ``nimweb`` - from the ``*.txt`` and ``*.tmpl`` files + from the ``*.txt`` and ``*.nimf`` files ============ =================================================== diff --git a/tests/template/sunset.tmpl b/tests/template/sunset.nimf index 465b12a5e..465b12a5e 100644 --- a/tests/template/sunset.tmpl +++ b/tests/template/sunset.nimf diff --git a/tests/template/template_various.nim b/tests/template/template_various.nim index f1135d5bb..029942621 100644 --- a/tests/template/template_various.nim +++ b/tests/template/template_various.nim @@ -180,7 +180,7 @@ block symchoicefield: import os, times -include "sunset.tmpl" +include "sunset.nimf" block ttempl: const tabs = [["home", "index"], diff --git a/tools/niminst/buildbat.tmpl b/tools/niminst/buildbat.nimf index 6767461e3..6767461e3 100644 --- a/tools/niminst/buildbat.tmpl +++ b/tools/niminst/buildbat.nimf diff --git a/tools/niminst/buildsh.tmpl b/tools/niminst/buildsh.nimf index acd58bda2..04ef35653 100644 --- a/tools/niminst/buildsh.tmpl +++ b/tools/niminst/buildsh.nimf @@ -1,7 +1,7 @@ #? stdtmpl(subsChar='?') | standard #proc generateBuildShellScript(c: ConfigData): string = # result = "#! /bin/sh\n# Generated from niminst\n" & -# "# Template is in tools/niminst/buildsh.tmpl\n" & +# "# Template is in tools/niminst/buildsh.nimf\n" & # "# To regenerate run ``niminst csource`` or ``koch csource``\n" set -e diff --git a/tools/niminst/deinstall.tmpl b/tools/niminst/deinstall.nimf index 8b4477369..8b4477369 100644 --- a/tools/niminst/deinstall.tmpl +++ b/tools/niminst/deinstall.nimf diff --git a/tools/niminst/inno.tmpl b/tools/niminst/inno.nimf index ef2da8a75..ef2da8a75 100644 --- a/tools/niminst/inno.tmpl +++ b/tools/niminst/inno.nimf diff --git a/tools/niminst/install.tmpl b/tools/niminst/install.nimf index a78914ecd..a78914ecd 100644 --- a/tools/niminst/install.tmpl +++ b/tools/niminst/install.nimf diff --git a/tools/niminst/makefile.tmpl b/tools/niminst/makefile.nimf index aadd0e94d..3467f025e 100644 --- a/tools/niminst/makefile.tmpl +++ b/tools/niminst/makefile.nimf @@ -1,7 +1,7 @@ #? stdtmpl(subsChar='?') | standard #proc generateMakefile(c: ConfigData): string = # result = "# Generated from niminst\n" & -# "# Template is in tools/niminst/makefile.tmpl\n" & +# "# Template is in tools/niminst/makefile.nimf\n" & # "# To regenerate run ``niminst csource`` or ``koch csource``\n" CC ??= gcc diff --git a/tools/niminst/niminst.nim b/tools/niminst/niminst.nim index 3c5572a07..9e428993a 100644 --- a/tools/niminst/niminst.nim +++ b/tools/niminst/niminst.nim @@ -126,13 +126,13 @@ proc skipRoot(f: string): string = inc i if result.len == 0: result = f -include "inno.tmpl" -include "nsis.tmpl" -include "buildsh.tmpl" -include "makefile.tmpl" -include "buildbat.tmpl" -include "install.tmpl" -include "deinstall.tmpl" +include "inno.nimf" +include "nsis.nimf" +include "buildsh.nimf" +include "makefile.nimf" +include "buildbat.nimf" +include "install.nimf" +include "deinstall.nimf" # ------------------------- configuration file ------------------------------- diff --git a/tools/niminst/nsis.tmpl b/tools/niminst/nsis.nimf index f4eb1d0cd..f4eb1d0cd 100644 --- a/tools/niminst/nsis.tmpl +++ b/tools/niminst/nsis.nimf diff --git a/tools/nimweb.nim b/tools/nimweb.nim index b7fee220a..460135f49 100644 --- a/tools/nimweb.nim +++ b/tools/nimweb.nim @@ -71,7 +71,7 @@ proc initConfigData(c: var TConfigData) = c.gitCommit = output.strip c.quotations = initTable[string, tuple[quote, author: string]]() -include "website.tmpl" +include "website.nimf" # ------------------------- configuration file ------------------------------- diff --git a/tools/website.tmpl b/tools/website.nimf index 9e5eb2460..9e5eb2460 100644 --- a/tools/website.tmpl +++ b/tools/website.nimf |