@nzz/q-cli 1.10.3 → 2.0.0-beta.7

package/skeletons/tool-skeleton/package.json

@@ -1,45 +0,0 @@
-{
-  "name": "tool-skeleton",
-  "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "build": "rollup -c",
-    "autobuild": "rollup -c -w",
-    "dev": "run-p autobuild start",
-    "start": "nodemon index.js",
-    "test": "lab -a @hapi/code -c -P tests --verbose --leaks"
-  },
-  "author": "",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/github/tool-skeleton.git"
-  },
-  "dependencies": {
-    "@hapi/boom": "^9.1.4",
-    "@hapi/hapi": "^20.2.0",
-    "@hapi/inert": "^6.0.4",
-    "ajv": "^8.6.3",
-    "joi": "^17.4.2",
-    "svelte": "^3.44.2"
-  },
-  "devDependencies": {
-    "@hapi/code": "^8.0.3",
-    "@hapi/lab": "^24.3.2",
-    "@rollup/plugin-commonjs": "^21.0.0",
-    "@rollup/plugin-node-resolve": "^13.0.5",
-    "autoprefixer": "^10.4.0",
-    "cssnano": "^5.0.10",
-    "glob": "^7.1.7",
-    "nodemon": "^2.0.13",
-    "npm-run-all": "^4.1.5",
-    "postcss": "^8.3.11",
-    "rollup": "^2.60.0",
-    "rollup-plugin-livereload": "^2.0.5",
-    "rollup-plugin-scss": "^3.0.0",
-    "rollup-plugin-svelte": "^7.1.0",
-    "rollup-plugin-terser": "^7.0.2",
-    "sass": "^1.43.4"
-  }
-}

package/skeletons/tool-skeleton/resources/display-options-schema.json

@@ -1,11 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "title": "Anzeigeoptionen",
-  "properties": {
-    "hideTitle": {
-      "type": "boolean",
-      "title": "Titel ausblenden"
-    }
-  }
-}

package/skeletons/tool-skeleton/resources/fixtures/data/basic.json

@@ -1,4 +0,0 @@
-{
-  "title": "Title",
-  "subtitle": "Subtitle"
-}

package/skeletons/tool-skeleton/resources/locales/de/translation.json

@@ -1 +0,0 @@
-{}

package/skeletons/tool-skeleton/resources/locales/en/translation.json

@@ -1 +0,0 @@
-{}

package/skeletons/tool-skeleton/resources/locales/fr/translation.json

@@ -1 +0,0 @@
-{}

package/skeletons/tool-skeleton/resources/schema.json

@@ -1,16 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "title": "tool-skeleton",
-  "properties": {
-    "title": {
-      "title": "Titel",
-      "type": "string"
-    },
-    "subtitle": {
-      "title": "Untertitel",
-      "type": "string"
-    }
-  },
-  "required": ["title"]
-}

package/skeletons/tool-skeleton/rollup.config.js

@@ -1,75 +0,0 @@
-import * as fs from "fs";
-import * as path from "path";
-import * as crypto from "crypto";
-import nodeResolve from "@rollup/plugin-node-resolve";
-import commonjs from "@rollup/plugin-commonjs";
-import svelte from "rollup-plugin-svelte";
-import { terser } from "rollup-plugin-terser";
-import livereload from "rollup-plugin-livereload";
-import scss from "rollup-plugin-scss";
-const sassConfig = require("./sass.config");
-
-const production = !process.env.ROLLUP_WATCH;
-const scriptsDir = path.join(__dirname, "/scripts_src/");
-const filename = "default";
-const scriptDirDefaultFileName = path.join(scriptsDir, `/${filename}.js`);
-
-function writeHashmap(hashmapPath, file, fileext) {
-  const hash = crypto.createHash("md5");
-  hash.update(file.content, { encoding: "utf8" });
-  file.hash = hash.digest("hex");
-
-  const hashMap = {};
-  hashMap[file.name] = `${file.name}.${file.hash.substring(0, 8)}.${fileext}`;
-  fs.writeFileSync(hashmapPath, JSON.stringify(hashMap));
-}
-
-function generateHashmap() {
-  return {
-    name: "generateHashmap",
-    async generateBundle(outputOptions, bundle, isWrite) {
-      const scriptsDir = "scripts";
-      // Create directory if not yet exist or recreate directory if it already exists
-      if (!fs.existsSync(scriptsDir)) {
-        fs.mkdirSync(scriptsDir);
-      } else {
-        fs.rmdirSync(scriptsDir, { recursive: true });
-        fs.mkdirSync(scriptsDir);
-      }
-      writeHashmap(
-        "scripts/hashMap.json",
-        {
-          name: filename,
-          content: bundle[`${filename}.js`].code,
-        },
-        "js"
-      );
-    },
-  };
-}
-
-export default {
-  input: scriptDirDefaultFileName,
-  output: {
-    format: "iife",
-    // TODO: Rename 'window._q_your_tool.YourTool' to 'window._q_<tool-name>.<ToolName>'
-    name: "window._q_your_tool.YourTool",
-    file: `scripts/${filename}.js`,
-  },
-  plugins: [
-    svelte(),
-    scss({ ...sassConfig.get(production, writeHashmap) }),
-    nodeResolve({ browser: true }),
-    commonjs(),
-    !production && livereload({ watch: ["scripts"], delay: 800 }),
-    production && terser(),
-    generateHashmap(),
-  ],
-  watch: {
-    clearScreen: false,
-  },
-  onwarn: function (warning, warn) {
-    if (warning.code === "CIRCULAR_DEPENDENCY") return;
-    warn(warning);
-  },
-};

package/skeletons/tool-skeleton/routes/fixtures/data.js

@@ -1,15 +0,0 @@
-const fixtureDataDirectory = "../../resources/fixtures/data";
-
-// provide every fixture data file present in ../../resources/fixtures/data
-const fixtureData = [require(`${fixtureDataDirectory}/basic.json`)];
-
-module.exports = {
-  path: "/fixtures/data",
-  method: "GET",
-  options: {
-    tags: ["api"],
-  },
-  handler: (request, h) => {
-    return fixtureData;
-  },
-};

package/skeletons/tool-skeleton/routes/health.js

@@ -1,10 +0,0 @@
-module.exports = {
-  path: "/health",
-  method: "GET",
-  options: {
-    tags: ["api"]
-  },
-  handler: (request, h) => {
-    return "ok";
-  }
-};

package/skeletons/tool-skeleton/routes/locales.js

@@ -1,21 +0,0 @@
-const Joi = require("joi");
-const localesDir = __dirname + "/../resources/locales/";
-
-module.exports = {
-  path: "/locales/{lng}/translation.json",
-  method: "GET",
-  options: {
-    description: "Returns translations for given language",
-    tags: ["api"],
-    validate: {
-      params: {
-        lng: Joi.string().required(),
-      },
-    },
-  },
-  handler: (request, h) => {
-    return h
-      .file(localesDir + request.params.lng + "/translation.json")
-      .type("application/json");
-  },
-};

package/skeletons/tool-skeleton/routes/rendering-info/web.js

@@ -1,97 +0,0 @@
-const Boom = require("@hapi/boom");
-const fs = require("fs");
-const path = require("path");
-const Ajv = require("ajv");
-
-const staticViewsDir = path.join(__dirname, "/../../views/static/");
-const stylesDir = path.join(__dirname, "/../../styles/");
-const scriptsDir = path.join(__dirname, "../../scripts/");
-
-require("svelte/register");
-const staticTemplate = require(path.join(
-  staticViewsDir,
-  "/App.svelte"
-)).default;
-const styles = fs.readFileSync(path.join(stylesDir, "/default.css")).toString();
-const styleHashMap = require(path.join(stylesDir, "hashMap.json"));
-const scriptHashMap = require(path.join(scriptsDir, "hashMap.json"));
-
-// POSTed item will be validated against given schema
-// hence we fetch the JSON schema...
-const schemaString = JSON.parse(
-  fs.readFileSync(path.join(__dirname, "../../resources/", "schema.json"), {
-    encoding: "utf-8",
-  })
-);
-
-const ajv = new Ajv({ strict: false });
-const validate = ajv.compile(schemaString);
-
-function validateAgainstSchema(item, options) {
-  if (validate(item)) {
-    return item;
-  } else {
-    throw Boom.badRequest(JSON.stringify(validate.errors));
-  }
-}
-
-async function validatePayload(payload, options, next) {
-  if (typeof payload !== "object") {
-    return next(Boom.badRequest(), payload);
-  }
-  if (typeof payload.item !== "object") {
-    return next(Boom.badRequest(), payload);
-  }
-  if (typeof payload.toolRuntimeConfig !== "object") {
-    return next(Boom.badRequest(), payload);
-  }
-  await validateAgainstSchema(payload.item, options);
-}
-
-module.exports = {
-  method: "POST",
-  path: "/rendering-info/web",
-  options: {
-    validate: {
-      options: {
-        allowUnknown: true,
-      },
-      payload: validatePayload,
-    },
-  },
-  handler: async function (request, h) {
-    const toolRuntimeConfig = request.payload.toolRuntimeConfig;
-    const context = {
-      // TODO: Rename 'q_your_tool_' to 'q_<tool_name>_'
-      id: `q_your_tool_${toolRuntimeConfig.requestId}`,
-      displayOptions: toolRuntimeConfig.displayOptions || {},
-      item: request.payload.item,
-    };
-
-    const staticTemplateRender = staticTemplate.render(context);
-
-    const renderingInfo = {
-      polyfills: ["Promise"],
-      stylesheets: [{ content: styles }, { name: styleHashMap["default"] }],
-      scripts: [
-        { name: scriptHashMap["default"] },
-        // TODO: Rename 'new window._q_your_tool.YourTool' to 'new window._q_<tool-name>.<ToolName>'
-        {
-          content: `
-          (function () {
-            var target = document.querySelector('#${context.id}_container');
-            target.innerHTML = "";
-            var props = ${JSON.stringify(context)};
-            new window._q_your_tool.YourTool({
-              "target": target,
-              "props": props
-            })
-          })();`,
-        },
-      ],
-      markup: staticTemplateRender.html,
-    };
-
-    return renderingInfo;
-  },
-};

package/skeletons/tool-skeleton/routes/routes.js

@@ -1,8 +0,0 @@
-module.exports = [
-  require("./rendering-info/web.js"),
-  require("./stylesheet.js"),
-  require("./script.js"),
-  require("./health.js"),
-  require("./fixtures/data.js"),
-  require("./locales.js"),
-].concat(require("./schema.js"));

package/skeletons/tool-skeleton/routes/schema.js

@@ -1,19 +0,0 @@
-const path = require("path");
-const resourcesDir = path.join(__dirname, "/../resources/");
-
-module.exports = [
-  {
-    method: "GET",
-    path: "/schema.json",
-    handler: function(request, h) {
-      return h.file(path.join(resourcesDir, "schema.json"));
-    }
-  },
-  {
-    method: "GET",
-    path: "/display-options-schema.json",
-    handler: function(request, h) {
-      return h.file(path.join(resourcesDir, "display-options-schema.json"));
-    }
-  }
-];

package/skeletons/tool-skeleton/routes/script.js

@@ -1,17 +0,0 @@
-const path = require("path");
-
-module.exports = {
-  method: "GET",
-  path: "/script/{filename}.{hash}.{extension}",
-  options: {
-    files: {
-      relativeTo: path.join(__dirname, "/../scripts/"),
-    },
-  },
-  handler: function (request, h) {
-    return h
-      .file(`${request.params.filename}.${request.params.extension}`)
-      .type("text/javascript")
-      .header("cache-control", `max-age=${60 * 60 * 24 * 365}, immutable`); // 1 year
-  },
-};

package/skeletons/tool-skeleton/routes/stylesheet.js

@@ -1,17 +0,0 @@
-const path = require("path");
-
-module.exports = {
-  method: "GET",
-  path: "/stylesheet/{filename}.{hash}.{extension}",
-  options: {
-    files: {
-      relativeTo: path.join(__dirname, "/../styles/"),
-    },
-  },
-  handler: function (request, h) {
-    return h
-      .file(`${request.params.filename}.${request.params.extension}`)
-      .type("text/css")
-      .header("cache-control", `max-age=${60 * 60 * 24 * 365}, immutable`); // 1 year
-  },
-};

package/skeletons/tool-skeleton/sass.config.js

@@ -1,66 +0,0 @@
-const fs = require("fs");
-const path = require("path");
-const postcss = require("postcss");
-const autoprefixer = require("autoprefixer");
-const cssnano = require("cssnano");
-
-function createOutputCssFunction(writeHashmapFunction) {
-  const outputCssFunction = (styles, styleNodes) => {
-    const stylesDir = "styles";
-
-    if (!fs.existsSync(stylesDir)) {
-      fs.mkdirSync(stylesDir);
-    }
-
-    fs.writeFileSync(`styles/default.css`, styles);
-    writeHashmapFunction(
-      "styles/hashMap.json",
-      {
-        name: "default",
-        content: styles,
-      },
-      "css"
-    );
-  };
-
-  return outputCssFunction;
-}
-
-function getPostcssPlugins(isProduction) {
-  const postcssPlugins = [autoprefixer];
-
-  if (isProduction) {
-    postcssPlugins.push(cssnano);
-  }
-
-  return postcssPlugins;
-}
-
-function get(isProduction, writeHashmapFunction) {
-  const config = {
-    outputStyle: isProduction ? "compressed" : "expanded",
-    // Sourcemap generation (specifically writing the file to system) is currently not supported by rollup-plugin-sass (but soon!)
-    // See: https://github.com/thgh/rollup-plugin-scss/issues/7
-    // outFile: path.join(__dirname, "/styles/default.css"), // <- Uncomment after: https://github.com/thgh/rollup-plugin-scss/issues/7
-    sourceMap: !isProduction,
-    sourceMapEmbed: !isProduction, // Remove after: https://github.com/thgh/rollup-plugin-scss/issues/7
-    failOnError: !isProduction,
-    watch: [
-      path.join(__dirname, "/styles_src"),
-      path.join(__dirname, "/views"),
-    ],
-    processor: (css) =>
-      postcss(getPostcssPlugins(isProduction))
-        .process(css, {
-          from: path.join(__dirname, "/styles/default.css"),
-          to: path.join(__dirname, "/styles/default.css"),
-          map: isProduction ? false : { inline: true }, // Set to false after: https://github.com/thgh/rollup-plugin-scss/issues/7
-        })
-        .then((result) => result.css),
-    output: createOutputCssFunction(writeHashmapFunction),
-  };
-
-  return config;
-}
-
-module.exports = { get };

package/skeletons/tool-skeleton/scripts_src/default.js

@@ -1,3 +0,0 @@
-import YourTool from "./../views/dynamic/YourTool.svelte";
-import "./../styles_src/main.scss";
-export default YourTool;

package/skeletons/tool-skeleton/styles_src/_variables.scss

@@ -1 +0,0 @@
-$color: salmon;

package/skeletons/tool-skeleton/styles_src/main.scss

@@ -1,2 +0,0 @@
-@use "../views/static/App.scss";
-@use "../views/dynamic/YourTool.scss";

package/skeletons/tool-skeleton/test/e2e-tests.js

@@ -1,162 +0,0 @@
-const fs = require("fs");
-const Lab = require("@hapi/lab");
-const Code = require("@hapi/code");
-const Hapi = require("@hapi/hapi");
-const Joi = require("joi");
-const lab = (exports.lab = Lab.script());
-
-const glob = require("glob");
-
-const expect = Code.expect;
-const before = lab.before;
-const after = lab.after;
-const it = lab.it;
-
-const routes = require("../routes/routes.js");
-
-let server;
-
-before(async () => {
-  try {
-    server = Hapi.server({
-      port: process.env.PORT || 3000,
-      routes: {},
-    });
-    server.validator(Joi);
-    await server.register(require("@hapi/inert"));
-    server.route(routes);
-  } catch (err) {
-    expect(err).to.not.exist();
-  }
-});
-
-after(async () => {
-  await server.stop({ timeout: 2000 });
-  server = null;
-});
-
-lab.experiment("basics", () => {
-  it("starts the server", () => {
-    expect(server.info.created).to.be.a.number();
-  });
-
-  it("is healthy", async () => {
-    const response = await server.inject("/health");
-    expect(response.payload).to.equal("ok");
-  });
-});
-
-lab.experiment("schema endpoint", () => {
-  it("returns 200 for /schema.json", async () => {
-    const response = await server.inject("/schema.json");
-    expect(response.statusCode).to.be.equal(200);
-  });
-});
-
-lab.experiment("locales endpoint", () => {
-  it("returns 200 for en translations", async () => {
-    const request = {
-      method: "GET",
-      url: "/locales/en/translation.json",
-    };
-    const response = await server.inject(request);
-    expect(response.statusCode).to.be.equal(200);
-  });
-  it("returns 200 for fr translations", async () => {
-    const request = {
-      method: "GET",
-      url: "/locales/fr/translation.json",
-    };
-    const response = await server.inject(request);
-    expect(response.statusCode).to.be.equal(200);
-  });
-  it("returns 200 for de translations", async () => {
-    const request = {
-      method: "GET",
-      url: "/locales/de/translation.json",
-    };
-    const response = await server.inject(request);
-    expect(response.statusCode).to.be.equal(200);
-  });
-});
-
-lab.experiment("stylesheets endpoint", () => {
-  it(
-    "returns existing stylesheet with right cache control header",
-    { plan: 2 },
-    async () => {
-      const filename = require("../styles/hashMap.json").default;
-      const response = await server.inject(`/stylesheet/${filename}`);
-      expect(response.statusCode).to.be.equal(200);
-      expect(response.headers["cache-control"]).to.be.equal(
-        "max-age=31536000, immutable"
-      );
-    }
-  );
-
-  it("returns Not Found when requesting an inexisting stylesheet", async () => {
-    const response = await server.inject("/stylesheet/inexisting.123.css");
-    expect(response.statusCode).to.be.equal(404);
-  });
-});
-
-// all the fixtures render
-lab.experiment("all fixtures render", () => {
-  const fixtureFiles = glob.sync(
-    `${__dirname}/../resources/fixtures/data/*.json`
-  );
-  for (let fixtureFile of fixtureFiles) {
-    const fixture = require(fixtureFile);
-    it(`doesnt fail in rendering fixture ${fixture.title}`, async () => {
-      const request = {
-        method: "POST",
-        url: "/rendering-info/web",
-        payload: {
-          item: fixture,
-          toolRuntimeConfig: {},
-        },
-      };
-      const response = await server.inject(request);
-      expect(response.statusCode).to.be.equal(200);
-    });
-  }
-});
-
-lab.experiment("rendering-info", () => {
-  it("web: returns error 400 if invalid item is given", async () => {
-    const request = {
-      method: "POST",
-      url: "/rendering-info/web",
-      payload: {
-        item: {
-          some: "object",
-          that: "doesn't validate against the schema",
-        },
-        toolRuntimeConfig: {},
-      },
-    };
-    const response = await server.inject(request);
-    expect(response.statusCode).to.be.equal(400);
-  });
-});
-
-lab.experiment("assets", () => {
-  it("returns stylesheet", async () => {
-    const fixture = fs.readFileSync(
-      `${__dirname}/../resources/fixtures/data/basic.json`,
-      { encoding: "utf-8" }
-    );
-    const res = await server.inject({
-      url: "/rendering-info/web",
-      method: "POST",
-      payload: {
-        item: JSON.parse(fixture),
-        toolRuntimeConfig: {},
-      },
-    });
-    const stylesheetRes = await server.inject(
-      `/stylesheet/${res.result.stylesheets[1].name}`
-    );
-    expect(stylesheetRes.statusCode).to.be.equal(200);
-  });
-});

package/skeletons/tool-skeleton/views/dynamic/YourTool.scss

@@ -1,5 +0,0 @@
-@use "variables";
-
-.your-tool__is-working-label {
-  color: variables.$color !important; // Please refrain from using '!important' :)
-}

package/skeletons/tool-skeleton/views/dynamic/YourTool.svelte

@@ -1,19 +0,0 @@
-<script>
-  // TODO: Rename 'YourTool.svelte' to '<Tool-Name>.svelte' & change all references
-  let isWorkingLabel = "";
-  let i = 0;
-
-  function worksOnClick() {
-    i++;
-    isWorkingLabel = i < 5 ? "is working!" : "is still working!";
-  }
-</script>
-
-<!-- Client side code is written/imported inside this component (e.g. Client interaction components) -->
-<div class="s-font-title">
-  Client-Side code
-  <span class="your-tool__is-working-label">{isWorkingLabel}</span>
-</div>
-<button class="s-button s-button--small" on:click={worksOnClick}>
-  Click me!
-</button>

package/skeletons/tool-skeleton/views/static/App.scss

@@ -1,5 +0,0 @@
-@use "variables";
-
-h3 {
-  color: variables.$color !important; // Please refrain from using '!important' :)
-}

package/skeletons/tool-skeleton/views/static/App.svelte

@@ -1,21 +0,0 @@
-<script>
-  import Header from "./components/Header.svelte";
-  import Footer from "./components/Footer.svelte";
-
-  export let item;
-  export let id;
-  export let displayOptions;
-</script>
-
-<!-- Static code is written/imported inside 'q-item-container' (e.g. Header, Title components) -->
-<div class="q-item-container">
-  {#if !displayOptions.hideTitle}
-    <Header title={item.title} />
-    {#if item.subtitle}
-      <div class="s-q-item__subtitle s-font-note">{item.subtitle}</div>
-    {/if}
-  {/if}
-  <!-- TODO: Rename 'q-your-tool-container' to 'q-<tool-name>-container' & change all references -->
-  <div id="{id}_container" class="q-your-tool-container" />
-  <Footer notes={item.notes} sources={item.sources} acronym={item.acronym} />
-</div>