generator-latex-template 0.3.0 → 0.6.0

package/README.md

@@ -1,4 +1,4 @@
-# generator-latex-template ![Tests](https://github.com/latextemplates/generator-latex-template/workflows/Tests/badge.svg) [![npm version](http://img.shields.io/npm/v/generator-latex-template.svg?style=flat)](https://npmjs.org/package/generator-latex-template "View this project on npm")
+# LaTeX Template Generator [![npm version](http://img.shields.io/npm/v/generator-latex-template.svg?style=flat)](https://npmjs.org/package/generator-latex-template "View this project on npm")
 
 > Generates latextemplates (e.g., for thesis, workshops, conferences, IEEEtran, LNCS, ...) out of "micro-templates"
 
@@ -108,8 +108,9 @@ In the long run, the contents of the `paper.tex` (and similar) files in reposito
   - Run `npx yo <path-to-git-repository>`
     - Windows: `npx yo c:\git-repositories\latextemplates\generator-latex-template`
   - Parameters can be set using command line
-    - Windows: `npx yo c:\git-repositories\latextemplates\generator-latex-template --texlive=tl2021 --documentclass=scientific-thesis --latexcompiler=lualatex --bibtextool=biblatex --language=en --font=arial --listings=listings --cleveref=true --enquotes=csquotes --tweak_outerquote=babel --todo=pdfcomment --examples=true --howtotext=true`
-    - Windows automatic generation of a LNCS template (with pdflatex and bibtex): `npx yo c:\git-repositories\latextemplates\generator-latex-template --documentclass=lncs --latexcompiler=pdflatex --bibtextool=bibtex --texlive=tl2021 --language=en --font=default --listings=listings --cleveref=true --enquotes=csquotes --tweak_outerquote=babel --todo=pdfcomment --examples=true --howtotext=true`
+    - Linux: `npx yo /tmp/repo --documentclass=lncs --overleaf=false --texlive=2021 --latexcompiler=pdflatex --bibtextool=bibtex --docker=false --language=en --font=default --listings=listings --cleveref=true --enquotes=csquotes --tweak_outerquote=babel --todo=pdfcomment --howtotext=true --examples=true`
+    - Windows: `npx yo c:\git-repositories\latextemplates\generator-latex-template --documentclass=scientific-thesis --overleaf=false --texlive=2021 --latexcompiler=pdflatex --bibtextool=bibtex --docker=false --language=en --font=default --listings=listings --cleveref=true --enquotes=csquotes --tweak_outerquote=babel --todo=pdfcomment  --howtotext=true --examples=true`
+    - Windows automatic generation of a LNCS template (with pdflatex and bibtex): `npx yo c:\git-repositories\latextemplates\generator-latex-template --documentclass=lncs --overleaf=false --texlive=2021 --latexcompiler=pdflatex --bibtextool=bibtex --docker=false --language=en --font=default --listings=listings --cleveref=true --enquotes=csquotes --tweak_outerquote=babel --todo=pdfcomment --howtotext=true --examples=true`
   - Run `latexmk` to build the PDF
 - Update npm dependencies
   - `npx npm-update-all`. See [FreeCodeCamp](https://www.freecodecamp.org/news/10-npm-tricks-that-will-make-you-a-pro-a945982afb25/) for more details.
@@ -117,6 +118,16 @@ In the long run, the contents of the `paper.tex` (and similar) files in reposito
   - See <https://github.com/yeoman/generator/releases> for changes in the generator.
 - When one encounters `Cannot find module 'yeoman-generator'`, please update the npm dependencies.
   That error ocurred when using version `4.13.0` and `5.4.2` was available.
+- In case of the error "Error: EACCES, permission denied '/root/.config/configstore/insight-yo.json'", one needs to execute `chmod g+rwx /root /root/.config /root/.config/configstore`
+- Check GitHub actions
+  - Use [actionlint](https://github.com/rhysd/actionlint#readme)
+  - Use [vs.code GitHub actions plugin](https://marketplace.visualstudio.com/items?itemName=cschleiden.vscode-github-actions)
+- When adding a new package:
+  1. execute `npx` with `--generatereitzig`
+  2. run `pdflatex`
+  3. run `.../generate-texlivefile.sh`
+  4. copy `Texlivefile` to the root of the source repository
+  5. adapt `Texlivefile` as required
 
 ### Useful snippets
 
@@ -160,6 +171,8 @@ ejslint.cmd c:\git-repositories\latextemplates\generator-latex-template\generato
 The code is licensed [0BSD](https://choosealicense.com/licenses/0bsd/#), the snippets (both LaTeX and text) 0BSD, too.
 See [benbalter/talks#15](https://github.com/benbalter/talks/issues/15#issuecomment-599704662), for a reasoning, why [CC0](https://creativecommons.org/share-your-work/public-domain/cc0/) cannot be used.
 
+`generators/app/templates/splncs04nat.bst` is taken from [tpavlic/splncs04nat](https://github.com/tpavlic/splncs04nat) and is MIT-licensed.
+
 [hyperref]: https://ctan.org/pkg/hyperref
 [listings]: https://ctan.org/pkg/listings
 [minted]: https://ctan.org/pkg/minted

package/generators/app/index.js

@@ -60,6 +60,50 @@ module.exports = class extends Generator {
         ],
         default: "scientific-thesis"
       },
+      {
+        type: 'list',
+        name: 'acm_format',
+        when: function(response) {
+          return response.documentclass === 'acm';
+        },
+        message: 'Which format of ACM?',
+        choices: [
+          {
+            value: "manuscript",
+            name: "A manuscript. This is the default.",
+          },
+          {
+            value: "acmsmall",
+            name: "Small single-column format. Used for CIE, CSUR, JACM, JDIQ, JEA, JERIC, JETC, PACMCGIT, PACMHCI, PACMPL, TAAS, TACCESS, TACO, TALG, TALLIP (formerly TALIP), TCPS, TDS, TEAC, TECS, TELO, THRI, TIIS, TIOT, TISSEC, TIST, TKDD, TMIS, TOCE, TOCHI, TOCL, TOCS, TOCT, TODAES, TODS, TOIS, TOIT, TOMACS, TOMM (formerly TOMCCAP), TOMPECS, TOMS, TOPC, TOPLAS, TOPS, TOS, TOSEM, TOSN, TQC, TRETS, TSAS, TSC, TSLP and TWEB, including special issues.",
+          },
+          {
+            value: "acmlarge",
+            name: "Large single-column format. Used for DTRAP, HEALTH, IMWUT, JOCCH, POMACS and TAP, including special issues.",
+          },
+          {
+            value: "acmtog",
+            name: "Large double-column format. Used for TOG, including annual conference Technical Papers.",
+          },
+          {
+            value: "sigconf",
+            name: "Proceedings format for most ACM conferences (with the exceptionslisted below) and all ICPS volumes.",
+          },
+          {
+            value: "sigplan",
+            name: "Proceedings format for SIGPLAN conferences",
+          }
+        ],
+        default: "sigconf"
+      },
+      {
+        type: 'confirm',
+        name: 'acm_review',
+        when: function(response) {
+          return response.documentclass === 'acm';
+        },
+        message: 'Format as document to review?',
+        default: true
+      },
       {
         type: 'list',
         name: 'ieee_variant',
@@ -102,28 +146,50 @@ module.exports = class extends Generator {
         ],
         default: "a4paper"
       },
+      {
+        type: 'list',
+        name: 'overleaf',
+        message: 'Overleaf compatibility?',
+        choices: [
+          {
+            name: "yes",
+            value: true
+          },
+          {
+            name: "no",
+            value: false
+          }
+        ],
+        default: true
+      },
       {
         type: 'list',
         name: 'texlive',
-        message: 'Which texlive compatiblity?',
+        when: function(response) {
+          return (!response.overleaf || (response.overleaf == "false"));
+        },
+        message: 'Which TeXLive compatibility?',
         choices: [
           {
             name: "TeXLive 2021",
             value: 2021
           },
           {
-            name: "TeXLive 2019",
-            value: 2019
+            name: "TeXLive 2022",
+            value: 2022
           }
         ],
-        default:  2021
+        default: 2022
       },
       {
         type: 'list',
         name: 'latexcompiler',
         message: 'Which latex compiler should be used?',
         choices: ["pdflatex", "lualatex"],
-        default: "pdflatex"
+        default: "pdflatex",
+        when: function(response) {
+          return !(response.documentclass === 'ieee');
+        }
       },
       {
         when: function(response) {
@@ -153,6 +219,26 @@ module.exports = class extends Generator {
           }
         },
       },
+      {
+        type: 'list',
+        name: 'docker',
+        message: 'Should a Dockerfile be generated?',
+        choices: [
+          {
+            name: "no",
+            value: false
+          },
+          {
+            name: "yes (Reiztig)",
+            value: "reitzig"
+          },
+          {
+            name: "yes (DANTE e.V.)",
+            value: "dante"
+          }
+        ],
+        default: false,
+      },
       {
         type: 'list',
         name: 'language',
@@ -331,12 +417,25 @@ module.exports = class extends Generator {
       // To access props later use this.props.someAnswer;
       this.props = props;
 
-      this.props.texlive = parseInt(this.props.texlive);
+      if (this.props.overleaf) {
+        // we do not prompt for texlive version in case of overleaf
+        this.props.texlive = 2021;
+      }
+
+      // somehow texlive is not routed through
+      // special handling
+      if (this.params.options.texlive) {
+        this.props.texlive = parseInt(this.params.options.texlive)
+      }
 
       // Command line argument "--githubpublish" switches the generator to generate a template deployable on a GitHub repository (causing e.g., a refined README.md)
       this.props.githubpublish = this.params.options.githubpublish;
       this.props.githubpublish = (this.props.githubpublish === true) || (this.props.githubpublish === 'true')
 
+      // Command line argument "--preparereitzig" switches the generator to generate a template to be used to generate Texlivefile required by https://github.com/reitzig/texlive-docker
+      this.props.preparereitzig = this.params.options.preparereitzig;
+      this.props.preparereitzig = (this.props.preparereitzig === true) || (this.props.preparereitzig === 'true')
+
       // Ensure all values are set - even if the user was not asked
       if ((this.props.documentclass === 'acmart') || (this.props.documentclass === 'ieee')) {
         this.props.bibtextool = 'bibtex';
@@ -348,10 +447,16 @@ module.exports = class extends Generator {
       // In 2021 this is not used any more, all papers are the "normal" IEEE format
       this.props.ieee_compsoc = false;
 
+      // As of 2021-12-24 the IEEE setup does not work on TeXLive 2021 and lualatex (TeXLive 2019 and 2020 work)
+      if ((this.props.documentclass === 'ieee') && (this.props.texlive == 2021)) {
+        this.props.latexcompiler = 'pdflatex';
+      }
+
       // convert "String" Boolean command line options
       this.props.cleveref = (this.props.cleveref === true) || (this.props.cleveref === 'true')
       this.props.examples = (this.props.examples === true) || (this.props.examples === 'true')
       this.props.howtotext = (this.props.howtotext === true) || (this.props.howtotext === 'true')
+      this.props.overleaf = (this.props.overleaf === true) || (this.props.overleaf === 'true')
 
       if (this.props.examples) {
         this.props.useExampleEnvironment = true;
@@ -379,8 +484,12 @@ module.exports = class extends Generator {
 
       this.props.requiresShellEscape = (this.props.listings === 'minted');
 
-      this.props.isPaper = (this.props.documentclass === 'ieee') || (this.props.documentclass === 'lncs');
+      this.props.feature = {};
+      this.props.feature.acronyms = (this.props.documentclass === 'scientific-thesis');
+
+      this.props.isPaper = (this.props.documentclass === 'acmart') || (this.props.documentclass === 'ieee') || (this.props.documentclass === 'lncs');
       if (this.props.isPaper) {
+        // this sets filenames.main and filenames.bib
         this.props.filenames = {
           "main": "paper",
           "bib": "paper"
@@ -413,121 +522,124 @@ module.exports = class extends Generator {
   }
 
   writing() {
-    var promise = new Promise(function(resolve, reject) {resolve();});
-    if ((this.props.documentclass === "lncs") && !fs.existsSync('llncs.cls')) {
-      if (!fs.existsSync('llncs2e.zip')) {
-        console.log("Need to llncs2e.zip from Springer");
-        const ftp = require("basic-ftp");
-        const client = new ftp.Client()
-        client.ftp.verbose = true
-        promise = client.access({
-            host: "ftp.springernature.com",
-            user: "anonymous",
-            password: "anonymous",
-            secure: false
-        }).then(function() {
-          return client.ensureDir("cs-proceeding/llncs")
-        }).then(function() {
-          return client.downloadTo("llncs2e.zip", "llncs2e.zip")
-        }).then(function() {
-          return new Promise(function(resolve, reject) {
-            console.log("Downloaded");
-            client.close();
-            resolve();
-          });
-        });
-      } else {
-        console.log("llncs2e.zip already exists. Needs to be extracted.");
-        promise = new Promise(function(resolve, reject) {resolve();});
-      }
-      var oldPromise = promise;
-      promise = oldPromise.then(function() {
-        return fs.createReadStream('llncs2e.zip')
-        .pipe(unzipper.Parse())
-        .on('entry', function (entry) {
-          const fileName = entry.path;
-          const type = entry.type; // 'Directory' or 'File'
-          const size = entry.vars.uncompressedSize; // There is also compressedSize;
-          if ((fileName === "llncs.cls") || (fileName === "splncs04.bst")) {
-            entry.pipe(fs.createWriteStream(fileName));
-          } else {
-            entry.autodrain();
-          }
-        })
-      });
-    }
     let global = this;
     global.props.config = global.props;
-    promise.then(function() {
+    global.fs.copy(
+      // .gitignore is not uploaded by npm publish
+      // Thus, we prefix it with `dot`.
+      global.templatePath('dot.gitignore'),
+      global.destinationPath('.gitignore')
+    );
+    global.fs.copyTpl(
+      global.templatePath('dot.editorconfig'),
+      global.destinationPath('.editorconfig'),
+      global.props
+    );
+    global.fs.copyTpl(
+      global.templatePath('bibliography.bib'),
+      global.destinationPath(global.props.filenames.bib + ".bib"),
+      global.props
+    );
+    global.fs.copyTpl(
+      global.templatePath('latexmkrc'),
+      global.destinationPath(global.props.overleaf ? '_latexmkrc' : 'latexmkrc'),
+      global.props
+    );
+    global.fs.copyTpl(
+      global.templatePath('localSettings.yaml'),
+      global.destinationPath('localSettings.yaml'),
+      global.props
+    );
+    global.fs.copyTpl(
+      global.templatePath('LICENSE'),
+      global.destinationPath('LICENSE'),
+      global.props
+    );
+    global.fs.copyTpl(
+      global.templatePath('Makefile'),
+      global.destinationPath('Makefile'),
+      global.props
+    );
+    if (global.props.documentclass === 'lncs') {
       global.fs.copy(
-        // .gitignore is not uploaded by npm publish
-        // Thus, we prefix it with `dot`.
-        global.templatePath('dot.gitignore'),
-        global.destinationPath('.gitignore')
-      );
-      global.fs.copyTpl(
-        global.templatePath('dot.editorconfig'),
-        global.destinationPath('.editorconfig'),
-        global.props
-      );
-      global.fs.copyTpl(
-        global.templatePath('dot.latexmkrc'),
-        global.destinationPath('.latexmkrc'),
-        global.props
-      );
-      global.fs.copyTpl(
-        global.templatePath('bibliography.bib'),
-        global.destinationPath(global.props.filenames.bib + ".bib"),
-        global.props
+        global.templatePath('splncs04nat.bst'),
+        global.destinationPath('splncs04nat.bst')
       );
+    }
+    if (global.props.language === 'de') {
       global.fs.copyTpl(
-        global.templatePath('localSettings.yaml'),
-        global.destinationPath('localSettings.yaml'),
+        global.templatePath('main.de.tex'),
+        global.destinationPath(global.props.filenames.main + ".tex"),
         global.props
       );
+      if (global.props.documentclass === 'scientific-thesis') {
+        global.fs.copy(
+          global.templatePath('acronyms.de.tex'),
+          global.destinationPath('acronyms.tex')
+        );
+      }
+      if (!global.props.githubpublish) {
+        // we keep the English README.md in case of GitHub publish
+        global.fs.copyTpl(
+          global.templatePath('README.de.md'),
+          global.destinationPath('README.md'),
+          global.props
+        );
+      }
+    } else {
       global.fs.copyTpl(
-        global.templatePath('LICENSE'),
-        global.destinationPath('LICENSE'),
+        global.templatePath('main.en.tex'),
+        global.destinationPath(global.props.filenames.main + ".tex"),
         global.props
       );
+      if (global.props.documentclass === 'scientific-thesis') {
+        global.fs.copy(
+          global.templatePath('acronyms.en.tex'),
+          global.destinationPath('acronyms.tex')
+        );
+      }
       global.fs.copyTpl(
-        global.templatePath('Makefile'),
-        global.destinationPath('Makefile'),
+        global.templatePath('README.en.md'),
+        global.destinationPath('README.md'),
         global.props
       );
-      if (global.props.documentclass === 'lncs') {
+    }
+    switch (global.props.docker) {
+      case "reitzig":
         global.fs.copy(
-          global.templatePath('splncsnat.bst'),
-          global.destinationPath('splncsnat.bst')
+          global.templatePath('dot.dockerignore'),
+          global.destinationPath('.dockerignore')
         );
-      }
-      if (global.props.language === 'de') {
         global.fs.copyTpl(
-          global.templatePath('main.de.tex'),
-          global.destinationPath(global.props.filenames.main + ".tex"),
+          global.templatePath('Dockerfile.reitzig'),
+          global.destinationPath('Dockerfile'),
           global.props
         );
-        if (!global.props.githubpublish) {
-          // we keep the English README.md in case of GitHub publish
-          global.fs.copyTpl(
-            global.templatePath('README.de.md'),
-            global.destinationPath('README.md'),
-            global.props
-          );
-        }
-      } else {
         global.fs.copyTpl(
-          global.templatePath('main.en.tex'),
-          global.destinationPath(global.props.filenames.main + ".tex"),
+          global.templatePath('Texlivefile'),
+          global.destinationPath('Texlivefile'),
           global.props
         );
+        break;
+      case "dante":
+        global.fs.copy(
+          global.templatePath('dot.dockerignore'),
+          global.destinationPath('.dockerignore')
+        );
         global.fs.copyTpl(
-          global.templatePath('README.en.md'),
-          global.destinationPath('README.md'),
+          global.templatePath('Dockerfile.dante'),
+          global.destinationPath('Dockerfile'),
           global.props
         );
-      }
-    });
+        break;
+    }
+    if (global.props.docker) {
+      global.fs.copyTpl(
+        global.templatePath('.github/workflows/check.yml'),
+        global.destinationPath('.github/workflows/check.yml'),
+        global.props
+      );
+    }
   }
 
   install() {

package/generators/app/templates/.github/workflows/check.yml

@@ -0,0 +1,43 @@
+on:
+  push:
+  workflow_dispatch:
+concurrency:
+  group: check
+  cancel-in-progress: true
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    services:
+      registry:
+        image: registry:2
+        ports:
+          - 5000:5000
+    steps:
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+        with:
+          driver-opts: network=host
+      - name: Cache Docker layers
+        uses: actions/cache@v2
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx
+      - name: Build Docker image
+        uses: docker/build-push-action@v2
+        with:
+          push: true
+          tags: localhost:5000/name/app:latest
+      - name: Set up Git repository
+        uses: actions/checkout@v3
+      - run: |
+          mkdir /tmp/out
+          mkdir /tmp/res
+      - run: docker run -v $(pwd):/work/src -v /tmp/out:/work/out localhost:5000/name/app:latest work "latexmk -pdf -pdflatex='<% if ((latexcompiler == "pdflatex") || githubpublish) { %>pdflatex<% } else { %>lualatex<% } %> --interaction=nonstopmode' <%= filenames.main %>"
+      - run: mv /tmp/out/*.pdf /tmp/res
+      - uses: actions/upload-artifact@v2
+        with:
+          name: test-result
+          path: |
+            /tmp/res/*.pdf

package/generators/app/templates/Dockerfile.dante

@@ -0,0 +1,9 @@
+FROM danteev/texlive:<% switch (texlive) {
+  case 2021: %>edge<% break;
+} -%>
+
+WORKDIR /workdir
+
+COPY . /workdir
+
+RUN latexmk <%= filenames.main %>

package/generators/app/templates/Dockerfile.reitzig

@@ -0,0 +1,37 @@
+FROM reitzig/texlive-<% switch (latexcompiler) {
+  case "pdflatex": %>base<% break;
+  case "lualatex": %>base-luatex<% break;
+  default: %>base<% break;
+} -%>:<% switch (texlive) {
+  case 2022: %>2022.2<% break;
+  case 2021: %>2021.10<% break;
+} -%>
+
+RUN apk update && apk add --no-cache bash perl python3 py3-pip
+RUN pip3 install pygments
+
+# Emulate "Install dependencies" of "entrypoint work ..."
+<% if (texlive < 2022) { -%>
+RUN tlmgr update --self --repository http://ftp.math.utah.edu/pub/tex/historic/systems/texlive/<%= texlive %>/tlnet-final
+COPY Texlivefile /work/src
+RUN xargs tlmgr install --repository http://ftp.math.utah.edu/pub/tex/historic/systems/texlive/<%= texlive %>/tlnet-final < "/work/src/Texlivefile" && \
+<% } else { -%>
+RUN tlmgr update --self --repository https://mirror.mwt.me/ctan/systems/texlive/tlnet
+COPY Texlivefile /work/src
+RUN xargs tlmgr install --repository https://mirror.mwt.me/ctan/systems/texlive/tlnet < "/work/src/Texlivefile" && \
+<% } -%>
+    sha256sum "/work/src/Texlivefile" > "/work/tmp/Texlivefile.sha" && \
+#
+# make <% if (bibtextool == "biblatex") { %>biber, <% } %>latexmk and texlogsieve available
+<% if (bibtextool == "biblatex") { -%>
+    cp /usr/local/texlive/<%= texlive %>/bin/x86_64-linuxmusl/biber /usr/local/bin && \
+<% } -%>
+    cp /usr/local/texlive/<%= texlive %>/bin/x86_64-linuxmusl/latexmk /usr/local/bin && \
+    cp /usr/local/texlive/<%= texlive %>/bin/x86_64-linuxmusl/texlogsieve /usr/local/bin && \
+<% if (latexcompiler === "lualatex") { -%>
+#
+# update font index
+    luaotfload-tool --update && \
+<% } -%>
+# use latest texlogsieve
+    cd /usr/local/bin && wget https://gitlab.com/lago/texlogsieve/-/raw/main/texlogsieve?inline=false

package/generators/app/templates/Makefile

@@ -1,22 +1,9 @@
 sources = <%= filenames.main %>.tex
-<% if (documentclass == 'lncs') { -%>
-llncs-class = llncs.cls
-<% } -%>
 
 .PHONY: clean reformat split-sentences indent
 
 compile: $(sources)
 	latexmk $(sources)
-<% if (documentclass == 'lncs') { -%>
-
-$(sources): $(llncs-class)
-$(llncs-class): download
-
-download:
-ifeq (,$(wildcard ./$(llncs-class)))
-	./download-llncs-files-from-springer.sh
-endif
-<% } -%>
 
 format:
 	latexindent -l -s -sl -w $(sources)