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

package/skeletons/tool-skeleton/views/static/components/Footer.svelte

@@ -1,31 +0,0 @@
-<script>
-  export let notes;
-  export let sources;
-  export let acronym;
-</script>
-
-<div class="s-q-item__footer">
-  {#if notes}
-    <div class="s-q-item__footer__notes">{notes}</div>
-  {/if}
-  <div class="s-q-item__footer__details">
-    {#if sources && sources.length > 0}
-      <div class="s-q-item__footer__sources">
-        {#if sources.length > 1}Quellen:{:else}Quelle:{/if}
-        {#each sources as source, index}
-          {#if source.text !== ""}
-            {#if source.link && source.link.url && source.link.isValid}<a
-                href={source.link.url}
-                target="blank"
-                rel="noopener noreferrer">{source.text}</a
-              >{:else}{source.text}{/if}{#if index !== sources.length - 1 && sources[index + 1] !== ""},&nbsp;{/if}{/if}
-        {/each}
-      </div>
-    {/if}
-    {#if acronym}
-      <div class="s-q-item__footer__acronym">NZZ / {acronym}</div>
-    {:else}
-      <div class="s-q-item__footer__acronym">NZZ</div>
-    {/if}
-  </div>
-</div>

package/skeletons/tool-skeleton/views/static/components/Header.svelte

@@ -1,7 +0,0 @@
-<script>
-  export let title;
-</script>
-
-<h3 class="s-q-item__title">
-  {title}
-</h3>

package/skeletons/toolv2-skeleton/.husky/pre-commit

@@ -1,6 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npm run build
-
-npm run prettier-format && npm run lint:all && npm run jest

package/skeletons/toolv2-skeleton/.nvmrc

@@ -1 +0,0 @@
-16

package/skeletons/toolv2-skeleton/.prettierrc.cjs

@@ -1,15 +0,0 @@
-module.exports = {
-  arrowParens: 'avoid',
-  bracketSameLine: true,
-  bracketSpacing: true,
-  plugins: [require('prettier-plugin-svelte')],
-  printWidth: 160,
-  semi: true,
-  singleQuote: true,
-  svelteIndentScriptAndStyle: false,
-  svelteSortOrder: 'options-scripts-markup-styles',
-  svelteStrictMode: false,
-  tabWidth: 2,
-  trailingComma: 'all',
-  useTabs: false,
-};

package/skeletons/toolv2-skeleton/.travis.yml

@@ -1,30 +0,0 @@
-dist: trusty
-sudo: true
-services:
-  - docker
-language: node_js
-node_js:
-  - '16'
-cache:
-  directories:
-    - node_modules
-install:
-  - npm set-script postinstall ""
-  - npm install
-before_script:
-  - DOCKER_IMAGE_NAME="[tool-name]"
-  - DOCKER_TAG=${TRAVIS_BRANCH//[^a-zA-Z0-9\_\-\.]/_}
-script:
-  - npm run lint
-  - npm run ts-check
-  - npm run svelte-check
-  - npm run build
-  - npm run jest
-  - 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then docker build -t $DOCKER_IMAGE_NAME:$DOCKER_TAG .; fi'
-after_success:
-  - 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then echo $DOCKER_PASSWORD | docker login -u="$DOCKER_USERNAME" --password-stdin; docker tag $DOCKER_IMAGE_NAME:$DOCKER_TAG nzzonline/$DOCKER_IMAGE_NAME:$DOCKER_TAG; docker push nzzonline/$DOCKER_IMAGE_NAME:$DOCKER_TAG; fi'
-
-# TODO: Create token for slack notifications, then insert below & uncomment lines
-#notifications:
-  #slack:
-    #secure: <Slack-Token>

package/skeletons/toolv2-skeleton/.vscode/settings.json

@@ -1,6 +0,0 @@
-{
-    "editor.tabSize": 2,
-    "[svelte]": {
-        "editor.defaultFormatter": "svelte.svelte-vscode"
-    }
-}

package/skeletons/toolv2-skeleton/Dockerfile

@@ -1,19 +0,0 @@
-# Use following version of node alpine as the base image
-FROM node:16-alpine
-
-# Set work directory for run/cmd
-WORKDIR /app
-
-# Copy package.json and package-lock.json into work directory and install dependencies
-COPY package.json /app/package.json
-COPY package-lock.json /app/package-lock.json
-RUN npm install --production
-
-# Copy everthing else in work directory
-COPY . /app
-
-# Expose server port
-EXPOSE 3000
-
-# Run node
-CMD node index.js

package/skeletons/toolv2-skeleton/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) NZZ Management AG
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/skeletons/toolv2-skeleton/README.md

@@ -1,99 +0,0 @@
-# [tool-name] <travis-badge>
-
-**maintainer**: <maintainer>
-
-Short description of tool and link to either [demo](https://editor.q.tools/) or [playground](https://q-playground.st.nzz.ch).
-
-## Table of contents
-
-- [Installation](#installation)
-- [Configuration](#configuration)
-- [Development](#development)
-  - [Watching files](#watching-files-dev)
-- [Testing](#testing)
-- [Deployment](#deployment)
-- [Functionality](#functionality)
-- [License](#license)
-
-## Installation
-
-```
-nvm use
-npm install
-npm start
-```
-
-[to the top](#table-of-contents)
-
-## Configuration
-
-If env variables, explained here
-
-## Development
-
-Start the Q dev server:
-
-```
-npx @nzz/q-cli server
-```
-
-Run the Q tool:
-
-```
-npm start
-```
-
-## Watching files (DEV)
-
-Please see nodemon.json for a specific list of extension that trigger a rebuilt when changed in development. You can extend this list at your liking.
-
-[to the top](#table-of-contents)
-
-## Testing
-
-Run the tests:
-
-```
-npm run test
-```
-
-### Implementing a new test
-
-When changing or implementing...
-
-- A `route`, it needs to be tested in the `tests/e2e-tests.js` file.
-- Something on the frontend, it needs to be tested in it's own  `***.spec.ts` file.
-
-[to the top](#table-of-contents)
-
-## Deployment
-
-We provide automatically built docker images at https://hub.docker.com/r/nzzonline/[tool-name]/.
-There are three options for deployment:
-
-- Use the provided images
-- Build your own docker images
-- Deploy the service using another technology
-
-### Use the provided docker images
-
-1. Deploy `nzzonline/[tool-name]` to a docker environment
-2. Set the ENV variables as described in the [configuration section](#configuration)
-
-[to the top](#table-of-contents)
-
-## Functionality
-
-The tool structure follows the general structure of each Q tool. Further information can be found in [Q server documentation - Developing tools](https://nzzdev.github.io/Q-server/developing-tools.html).
-
-[to the top](#table-of-contents)
-
-### Options
-
-All options should be listed and explained. The varieties should be listed. If there's a visual aspect, a printscreen would be nice. The options should be listed as they are named in the `schema`
-
-[to the top](#table-of-contents)
-
-## License (if open source)
-
-Adding the license + updating the year.

package/skeletons/toolv2-skeleton/dev.js

@@ -1,7 +0,0 @@
-process.env.METHOD_BOX_ARTICLE = `{
-    "title": "Mehr zur Datenberechnung der NZZ",
-    "url": "https://www.nzz.ch/ld.1580452"
-}`;
-
-
-import './index.js';

package/skeletons/toolv2-skeleton/index.js

@@ -1,39 +0,0 @@
-import Hapi from '@hapi/hapi';
-import routes from './dist/routes.js';
-
-// Because the package is set as module we cannot directly call require
-// in js files. We must import and create it.
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-
-const server = Hapi.server({
-  port: process.env.PORT || 3000,
-});
-
-async function init() {
-  await server.register(require('@hapi/inert'));
-  server.validator(require('joi'));
-
-  server.route(routes);
-
-  await server.start();
-  console.log('server running ', server.info.uri);
-}
-
-init();
-
-async function gracefullyStop() {
-  console.log('stopping hapi server');
-  try {
-    await server.stop({ timeout: 10000 });
-    console.log('hapi server stopped');
-  } catch (err) {
-    console.log(err);
-    process.exit(1);
-  }
-  process.exit(0);
-}
-
-// listen on SIGINT and SIGTERM signal and gracefully stop the server.
-process.on('SIGINT', gracefullyStop);
-process.on('SIGTERM', gracefullyStop);

package/skeletons/toolv2-skeleton/jest.config.ts

@@ -1,39 +0,0 @@
-// Testing with Svelte + TS + ESM + Jest requires quite the setup.
-// https://github.com/svelteness/svelte-jester/issues/72#issuecomment-1021356664
-
-import type { Config } from '@jest/types';
-
-const config: Config.InitialOptions = {
-  preset: 'ts-jest/presets/default-esm',
-  testEnvironment: 'jsdom',
-  verbose: true,
-  transform: {
-    '^.+\\.ts$': 'ts-jest',
-    '^.+\\.svelte$': [
-
-      // This line is very important for it to work with ESM modules
-      './node_modules/svelte-jester/dist/transformer.mjs',
-      {
-        preprocess: true,
-      },
-    ],
-  },
-  extensionsToTreatAsEsm: ['.svelte', '.ts'],
-  moduleFileExtensions: ['js', 'ts', 'svelte'],
-  globals: {
-    'ts-jest': {
-      useESM: true,
-    },
-  },
-  moduleNameMapper: {
-    '^(\\.{1,2}/.*)\\.js$': '$1',
-    '^@rs(.*)$': '<rootDir>/resources$1',
-    '^@src(.*)$': '<rootDir>/src$1',
-  },
-  testPathIgnorePatterns: ['node_modules'],
-  transformIgnorePatterns: ['node_modules'],
-  bail: false,
-  setupFilesAfterEnv: ['@testing-library/jest-dom/extend-expect'],
-};
-
-export default config;

package/skeletons/toolv2-skeleton/nodemon.json

@@ -1,4 +0,0 @@
-{
-    "watch": ["src/**/*", "resources/**/*"],
-    "ext": "ts, js, css, svelte, json"
-}