@nzz/q-cli 1.8.2 → 1.9.0

package/bin/commands/bootstrap.js

@@ -2,7 +2,6 @@ const fs = require("fs-extra");
 const path = require("path");
 const replaceInFile = require("replace-in-file");
 const chalk = require("chalk");
-const { replace } = require("nunjucks/src/filters");
 const errorColor = chalk.red;
 const successColor = chalk.green;
 const warningColor = chalk.yellow;

package/bin/q.js

@@ -61,17 +61,42 @@ async function main() {
     )
     .description("bootstrap a new tool")
     .action(async (command) => {
-      const name = command.args[0];
+      let name = command.args[0];
+
       if (!name) {
         console.error(errorColor("no toolname given"));
         process.exit(1);
       }
+
+      // Make sure the name matches the spec.
+      if (!name.match(/^(Q-|q-)\w+/g)) {
+        console.error(errorColor("Tool must be named according to this format: Q-[a-z+]"));
+        process.exit(1);
+      }
+
+      // Capitalize first letter.
+      name = name[0].toUpperCase() + name.substring(1).toLowerCase();
+
+      let nameNodashes = name.replace(/\-/g, '');
+      toolnameCamelCase = nameNodashes[0].toUpperCase() + nameNodashes[1].toUpperCase() + nameNodashes.substring(2);
+
       const baseDir = program.dir || name;
       const textReplacements = [
-        { regex: new RegExp(`tool-skeleton`, "g"), replaceWith: name },
+        // deprecated.
+        { regex: /tool-skeleton/g, replaceWith: name },
+
+        // Replace all instance of tool name with underscore.
+        { regex: /\[tool_name\]/g, replaceWith: name.toLowerCase().replace(/\-/g, '_') },
+
+        // Replace all instances with minuses.
+        { regex: /\[Tool-name\]/g, replaceWith: name },
+        { regex: /\[tool-name\]/g, replaceWith: name.toLowerCase() },
+
+        // Replace all CamelCase instances.
+        { regex: /\[ToolName\]/g, replaceWith: toolnameCamelCase},
       ];
 
-      await bootstrap("tool", baseDir, textReplacements);
+      await bootstrap("toolv2", baseDir, textReplacements);
     });
 
   program

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nzz/q-cli",
-  "version": "1.8.2",
+  "version": "1.9.0",
   "description": "Cli tool to setup new Q tools, new Q server implementations and start Q dev server to test developing Q tools",
   "main": "index.js",
   "scripts": {
@@ -40,4 +40,4 @@
     "promptly": "^3.2.0",
     "replace-in-file": "^3.4.4"
   }
-}
+}

package/skeletons/et-utils-package-skeleton/README.md

@@ -5,3 +5,8 @@
 ## Content
 
 TODO: Package documentation
+
+## Modules & Node support
+
+The package follows a hybrid module structure, supporting ES6 & CommonJS Module imports.
+Node support can be implemented by changing the internal, relative import statements to include the file type suffix `.js` (not `.ts`!). This however breaks the CommonJS Module imports (`require()`), which should not be an issue if Node 12+ is used in the project.

package/skeletons/et-utils-package-skeleton/package.json

@@ -8,16 +8,21 @@
     "directory": "<package-name>"
   },
   "scripts": {
-    "prepublishOnly": "npm run test && npm run clean && npm run build && rollup -c",
-    "clean": "rimraf dist && rimraf index.js && rimraf index.d.ts",
-    "build": "tsc -p .",
-    "start": "npm run build -- -w",
+    "prepublishOnly": "npm run test && npm run clean && npm run buildMjs && npm run buildCjs && ./scripts/package-fixup.sh",
+    "clean": "rimraf dist",
+    "buildMjs": "tsc -p tsconfig.json",
+    "buildCjs": "tsc -p tsconfig-cjs.json",
+    "start": "npm run buildMjs -- -w",
     "test": "jest --config jest.config.ts"
   },
-  "files": [
-    "index.js",
-    "index.d.ts"
-  ],
+  "main": "dist/cjs/index.js",
+  "module": "dist/mjs/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/mjs/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
   "publishConfig": {
     "access": "public"
   },
@@ -26,8 +31,6 @@
     "@types/node": "^16.11.36",
     "jest": "^28.1.0",
     "rimraf": "^3.0.2",
-    "rollup": "^2.75.0",
-    "rollup-plugin-dts": "^4.2.2",
     "ts-jest": "^28.0.3",
     "ts-node": "^10.8.0",
     "typescript": "^4.6.4"

package/skeletons/et-utils-package-skeleton/scripts/package-fixup.sh

@@ -0,0 +1,13 @@
+#Add external dependencies under 'dependencies'
+cat >dist/cjs/package.json <<!EOF
+{
+    "type": "commonjs"
+}
+!EOF
+
+#Add external dependencies under 'dependencies'
+cat >dist/mjs/package.json <<!EOF
+{
+    "type": "module"
+}
+!EOF

package/skeletons/et-utils-package-skeleton/test/tsconfig.json

@@ -1,5 +1,8 @@
 {
   "compilerOptions": {
-    "types": ["jest", "node"]
+    "moduleResolution": "node",
+    "types": ["jest", "node"],
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true
   }
 }

package/skeletons/et-utils-package-skeleton/tsconfig-base.json

@@ -0,0 +1,10 @@
+{
+  "include": ["src/**/*"],
+  "exclude": ["test/**/*"],
+  "compilerOptions": {
+    "declaration": true,
+    "moduleResolution": "node"
+    // "esModuleInterop": true,
+    // "allowSyntheticDefaultImports": true,
+  }
+}

package/skeletons/et-utils-package-skeleton/tsconfig-cjs.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig-base.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "outDir": "dist/cjs",
+    "target": "es2015"
+  }
+}

package/skeletons/et-utils-package-skeleton/tsconfig.json

@@ -1,9 +1,8 @@
 {
-  "include": ["src/**/*"],
-  "exclude": ["test/**/*"],
+  "extends": "./tsconfig-base.json",
   "compilerOptions": {
-    "target": "es6",
-    "outDir": "dist",
-    "declaration": true
+    "module": "esnext",
+    "outDir": "dist/mjs",
+    "target": "es6"
   }
 }

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

@@ -0,0 +1,6 @@
+#!/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

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

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

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,30 @@
+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

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

package/skeletons/toolv2-skeleton/Dockerfile

@@ -0,0 +1,19 @@
+# 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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,99 @@
+# [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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,39 @@
+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

@@ -0,0 +1,39 @@
+// 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

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