generator-ehrcraft-script 1.1.0 → 1.2.0

package/README.md

@@ -1,5 +1,9 @@
-# generator-ehrcraft-script [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage percentage][coveralls-image]][coveralls-url]
-> 
+# generator-ehrcraft-script
+
+## Version log 
+
+1.2.0 - simplified gulp and package dependencies
+
 
 ## Installation
 
@@ -7,8 +11,13 @@ First, install [Yeoman](http://yeoman.io) and generator-ehrcraft-script using [n
 
 ```bash
 npm install -g yo
-npm link
-# npm install -g generator-ehrcraft-script
+```
+
+Then install this generator 
+
+
+```bash 
+npm install -g generator-ehrcraft-script
 ```
 
 Then generate your new project:
@@ -17,6 +26,13 @@ Then generate your new project:
 yo ehrcraft-script
 ```
 
+## Development 
+If you want to test the generator during developement you might use npm link like this: 
+
+```bash 
+npm link
+```
+
 ## Getting To Know Yeoman
 
  * Yeoman has a heart of gold.

package/generators/app/index.js

@@ -30,7 +30,7 @@ module.exports = class extends Generator {
         type: "input",
         name: "form_scripts",
         message: "The folder where the script should be placed",
-        default: "../../form_scripts"
+        default: "../../form-scripts"
       }
     ];
 

package/generators/app/templates/gulpfile.js/index.js

@@ -1,73 +1,42 @@
-var gulp = require('gulp');
-var ts = require('gulp-typescript');
-var browserify = require('browserify');
-var tap = require('gulp-tap');
-const babel = require('gulp-babel');
-var rename = require('gulp-rename');
-var inject = require('gulp-inject-string');
+// Gulp is the library/tool to automate slow, repetitive workflows and compose them into efficient build pipelines.
+const gulp = require("gulp");
+const { series, watch } = require('gulp');
+const inject = require('gulp-inject-string');
+// used to minify javascript
+const terser = require('gulp-terser');
+// used to compile typescript source code 
+const ts = require('gulp-typescript');
+// used to rename files in the pipes of compilation, budle, renaming, etc. 
+const rename = require('gulp-rename');
+// used to bundle the generated javascript code to one file 
+const browserify = require('browserify');
+
+// used for the pipes working with the files. vinyl is a meta-defintion of a file. 
+// See: https://github.com/gulpjs/vinyl 
+const source = require('vinyl-source-stream');
+const buffer = require('vinyl-buffer');
+const through = require('through');
+
+/* Used for configuration */
 const YAML = require('yaml');
+/* Used to read configuration */
 const fs = require('fs');
-const { watch,series,parallel } = require('gulp');
-const del = require('del');
-var through = require('through');
-var log = require('gulplog');
-let uglify = require('gulp-uglify-es').default;
-var source = require('vinyl-source-stream');
-var buffer = require('vinyl-buffer');
-var bundler = require('./bundle');
 
-var buffer = require('vinyl-buffer');
-var transformEhrCraftPackage = require('./removeEhrCraftPackage');
+const full_deploy_series = series(compile, injectBootStrapLine, bundle, minify, deploy);
 
 
-function getFolderAndName() {
-  const file = fs.readFileSync('./ehrcraft.config.yml','utf8');
-  let n = YAML.parse(file);
-  return n;
-
-}
-
-
-
-//ehrcraft_form_api_1.
-function compress() {
-  return gulp.src('./build/js/*.js')
-    .pipe(uglify(/* options */))
-    .pipe(gulp.dest('./build/dist'))
-
-
-}
 
 /**
- * Typescript compiler filene
- */
-function compile() {
-  return gulp.src('src/**/*.ts')
-    .pipe(ts({
-      target: "es3",
-      noImplicitAny: true,
-      module: "commonjs",
-      outDir: "ehrcraft"
-    }))
-    .pipe(babel({
-      presets: ["@babel/typescript"],
-      plugins: ["@babel/proposal-class-properties",
-        "@babel/proposal-object-rest-spread"]
-    }))
-    .pipe(gulp.dest('./build'))
-
-};
-
-/**
- * Dette er trikset som gjør at FormRenderer starter scriptet vårt ved lasting.
- * Ved å kalle funksjonen main(api) i index.js
- *
- * NOTE:
+ * Defines the injected function call to main. 
+ * * NOTE:
  * Change or modify this if you need ctx and/or http for your script
  * i.e.
  * main(api, ctx, http)
  * main(api, ctx)
  * 
+ * Since version 2.3.x there is support for terminology search and system configuration - they are exposed as "terminology" and "config". 
+ * main(api,ctx,terminology, config)
+ * 
  * NOTE: 
  * If you want to use api2, the second generation of script api delivered with DIPS Arena 22.2, add the following: 
  * 
@@ -75,98 +44,130 @@ function compile() {
  *
  * Then you have to changes the export function main(......) in index.ts as well
  */
-function setup() {
-  let boot = "main(api);";
-  return gulp.src("./build/index.js")
-    .pipe(inject.append(boot))
-    .pipe(gulp.dest("./build"));
-
-};
+const boot = 'main(api,ctx,terminology, config);';
 
 /**
- * Benytter browserify for å bundle sammen javascript filene til en fil.
+ * Task to compile source as typescript
+ * @param {*} cb 
+ * @returns 
  */
-function oldbundle() {
-  return gulp.src('./build/index.js',{ read: true })
-    .pipe(tap(function (file) {
-      log.info('bundling ' + file.path);
-      // replace file contents with browserify's bundle stream
-      file.contents = browserify(file.path,{
-        debug: true,
-        transform: [
-          //   removeEhrCraftFormRequire,
-          //    removeEhrCraftPackage,
-          removeEhrCraftFormRequire2,
-          removeEhrCraftPackage2
-        ]
-      }).bundle();
-
-    })).pipe(gulp.dest('./build/js'));
-};
-
-function bundle(cb) {
-  return browserify('./build/index.js')
-    //.transform(bundler.removeEhrCraftPackage)
-    .transform(transformEhrCraftPackage)
-    .bundle()
-    .pipe(source('index.js'))
-    .pipe(buffer())
-    .pipe(gulp.dest('./build/bundle'));
-}
-
-function olderbundle(cb) {
-  bundler.bundleScript("./build/index.js","./build/bundle.js")
-    .then(result => {
-      console.log("Bundled finsihed");
-      cb();
-    }).catch(error => {
-      console.error("Error bundling");
-    })
-
+function compile(cb) {
+    return gulp.src('src/**/*.ts')
+        .pipe(ts({
+            target: "es5",
+            noImplicitAny: true,
+            removeComments: false,
+            module: "commonjs"
+        }))
+
+        .pipe(gulp.dest('./dist'))
 }
-
-
 /**
- * Kopierer den kompilerte fila til form_scripts folderen definert i ehrcraft.config.yml
- * @param {*} cb
+ * Task to inject the call to main method 
+ * See boot variable above. 
+ *
+ * @returns 
  */
-function deployBundledFileToFormScripts(cb) {
-  let n = getFolderAndName();
-  let formScriptsFolder = n.form_scripts;
-  let formName = n.form_name;
-  console.log("Deploy to folder " + formScriptsFolder + ", file: " + formName + ".js");
-  if (formScriptsFolder && formName) {
-    return gulp.src('./build/bundle/index.js')
-      .pipe(rename(formName + ".js"))
-      .pipe(gulp.dest(formScriptsFolder));
-  }
-  else {
-    cb();
-  }
+function injectBootStrapLine(cb) {
 
-};
+    return gulp.src("./dist/index.js")
+        .pipe(inject.append(boot))
+        .pipe(inject.append(`console.log("Script kompilert dato:  ${new Date().toISOString()}");`))
+        .pipe(gulp.dest("./dist"));
 
-function cleanBuild() {
-  return del('./build');
+};
 
+/**
+ * Task to minify the generated javascript. 
+ * This task is optional. The idea is to reduce the size of the generated javascript. 
+ * @param {*} cb 
+ * @returns 
+ */
+function minify(cb) {
+    return gulp.src("./build/app.js")
+        .pipe(terser())        
+        .pipe(gulp.dest("./build"));
 }
 
-function cleanDist() {
-  return del('./dist');
+/**
+ * Task to bundle all compiled javascript files into a single bundle. 
+ * Will also remove package names from the EHR Craft API. 
+ * @param {*} cb 
+ * @returns 
+ */
+function bundle(cb) {
+    var b = browserify({
+        entries: './dist/index.js',
+        debug: false,
+        transform: [removeEhrCraftPackage]
+    });
+    return b.bundle()
+        .pipe(source('app.js'))
+        .pipe(buffer())
+        .pipe(gulp.dest('./build'));
+
+
+    function removeEhrCraftPackage(file) {
+        var data = '';
+        var stream = through(write, end);
+        return stream;
+
+        function write(buf) {
+            data += buf.toString('utf8')
+                .replace(/(var ehrcraft_form_api_1)/gm, "// Kommentert ut av byggescript")
+                .replace(/(ehrcraft_form_api_1\.)/gm, "");
+            ;
+        }
+        function end() {
+            process(file, data, function (result) {
+                stream.queue(result);
+                stream.queue(null);
+            });
+        }
+        function process(file, data, callback) {
+            //console.log(`Processing file ${file}`)
+            callback(data);
+        }
+
+    }
 }
-//exports.uglify = compress;
-//exports.bundle = series(this.clean,this.compile,this.setup,this.bundle);
-exports.build = series(compile,setup);
-exports.bundle = bundle;
-exports.clean = parallel(cleanBuild,cleanDist);
-exports.deploy = series(this.clean,compile,setup,bundle,compress,deployBundledFileToFormScripts);
-exports.default = function () {
-  //watch('./src/*.ts',series(compile,setup,bundle,compress,deployBundledFileToFormScripts));
-  //watch('./src/**/*.ts',series(compile,setup,bundle,compress,deployBundledFileToFormScripts));
-  watch('./src/**/*.ts',series(compile,setup,bundle,deployBundledFileToFormScripts));
+/**
+ * Task to deploy the bundled javascript file to form script folder of EHR Craft. 
+ * Uses the configuration defined un ehrcraft.config.yml 
+ * @param {*} cb 
+ * @returns 
+ */
+function deploy(cb) {
+    const ehrCraftConfig = loadEhrCraftConfigAsYaml();
+    const formScriptsFolder = ehrCraftConfig.form_scripts;
+    const formName = ehrCraftConfig.form_name;
+    console.log("Deploy to folder " + formScriptsFolder + ", file: " + formName + ".js");
+    if (formScriptsFolder && formName) {
+        return gulp
+            .src('./build/app.js')
+            .pipe(rename(formName + ".js"))
+            .pipe(gulp.dest(formScriptsFolder));
+    }
+    else {
+        cb();
+    }
+
+    function loadEhrCraftConfigAsYaml() {
+        const file = fs.readFileSync('./ehrcraft.config.yml', 'utf8');
+        let n = YAML.parse(file);
+        return n;
+
+    }
+}
+/**
+ * Task to watch for changes in typescript and start the full serie of compile, bundle, deploy
+ * @param {*} cb 
+ */
+function watchForChanges(cb) {
+    watch('./src/**/*.ts', full_deploy_series);
+    cb();
 }
 
-exports.justdeploy = deployBundledFileToFormScripts;
-
-
-//
+exports.default = watchForChanges;
+exports.deploy = full_deploy_series;
+exports.bundle = series(compile, bundle)

package/generators/app/templates/package.json

@@ -1,60 +1,34 @@
-{
-  "name": "<%= appname %>",
-  "version": "1.0.0",
-  "description": "<%= appname %>",
-  "main": "index.js",
-  "scripts": {
-    "test": "ts-mocha test/**/*.spec.ts"
-  },
-  "keywords": [
-    "openEHR",
-    "<%= appname %>",
-    "BIFROST",
-    "Arena"
-  ],
-  "author": "Bjørn Næss <bna@dips.no>",
-  "license": "ISC",
-  "devDependencies": {
-    "@babel/cli": "^7.6.4",
-    "@babel/core": "^7.6.4",
-    "@babel/plugin-proposal-class-properties": "^7.5.5",
-    "@babel/plugin-proposal-object-rest-spread": "^7.6.2",
-    "@babel/preset-typescript": "^7.6.0",
-    "@types/adm-zip": "^0.4.32",
-    "@types/chai": "^4.2.3",
-    "@types/mocha": "^8.2.0",
-    "@types/node": "^14.0.0",
-    "@types/voca": "^1.4.0",
-    "adm-zip": "^0.5.2",
-    "aliasify": "^2.1.0",
-    "chai": "^4.2.0",
-    "del": "^6.0.0",
-    "gulp": "^4.0.2",
-    "gulp-babel": "^8.0.0",
-    "gulp-browserify": "^0.5.1",
-    "gulp-buffer": "0.0.2",
-    "gulp-concat": "^2.6.1",
-    "gulp-copy": "^4.0.1",
-    "gulp-inject-string": "^1.1.2",
-    "gulp-rename": "^2.0.0",
-    "gulp-tap": "^2.0.0",
-    "gulp-typescript": "^5.0.1",
-    "gulp-uglify": "^3.0.2",
-    "gulp-uglify-es": "^2.0.0",
-    "gulp-watch": "^5.0.1",
-    "gulplog": "^1.0.0",
-    "mocha": "^8.0.0",
-    "nyc": "^15.0.0",
-    "ts-mocha": "^8.0.0",
-    "ts-mockito": "^2.5.0",
-    "ts-node": "^9.1.1",
-    "typescript": "^4.0.0",
-    "vinyl-buffer": "^1.0.1",
-    "vinyl-source-stream": "^2.0.0",
-    "voca": "^1.4.0"
-  },
-  "dependencies": {
-    "ehrcraft-form-api": "^2",
-    "yaml": "^1.7.2"
-  }
-}
+{
+  "name": "<%= appname %>",
+  "version": "1.0.0",
+  "description": "<%= appname %>",
+  "main": "index.js",
+  "scripts": {
+    "test": "ts-mocha test/**/*.spec.ts"
+  },
+  "keywords": [
+    "openEHR",
+    "<%= appname %>",
+    "BIFROST",
+    "Arena"
+  ],
+  "author": "Bjørn Næss <bna@dips.no>",
+  "license": "ISC",
+  "devDependencies": {
+    "browserify": "^17.0.0",
+    "ehrcraft-form-api": "^2.3.9",
+    "gulp": "^4.0.0",
+    "gulp-inject-string": "^1.1.2",
+    "gulp-rename": "^2.0.0",
+    "gulp-terser": "^2.1.0",
+    "gulp-typescript": "^6.0.0-alpha.1",
+    "mocha": "^10.2.0",
+    "through": "^2.3.8",
+    "ts-mocha": "^10.0.0",
+    "typescript": "^4.9.5",
+    "vinyl-buffer": "^1.0.1",
+    "vinyl-source-stream": "^2.0.0",
+    "yaml": "^2.2.1"
+  },
+  "dependencies": {}
+}

package/package.json

@@ -1,87 +1,86 @@
-{
-  "name": "generator-ehrcraft-script",
-  "version": "1.1.0",
-  "description": "A code generator for DIPS Forms typescript",
-  "homepage": "https://dev.azure.com/dips/DIPS%20Configured%20Products/_git/generator-ehrcraft-script",
-  "author": {
-    "name": "Bjørn Næss",
-    "email": "bna@dips.no",
-    "url": "https://dev.azure.com/dips/DIPS%20Configured%20Products/_git/generator-ehrcraft-script"
-  },
-  "files": [
-    "generators"
-  ],
-  "main": "generators/index.js",
-  "keywords": [
-    "",
-    "yeoman-generator"
-  ],
-  "devDependencies": {
-    "@types/chai": "^4.0.0",
-    "@types/mocha": "^8.0.0",
-    "chai": "^4.2.0",
-    "coveralls": "^3.0.7",
-    "ehrcraft-form-api": "^1.0.0",
-    "eslint": "^7.0.0",
-    "eslint-config-prettier": "^7.0.0",
-    "eslint-plugin-prettier": "^3.1.1",
-    "husky": "^4.0.0",
-    "jest": "^26.0.0",
-    "lint-staged": "^10.0.0",
-    "mocha": "^8.2.1",
-    "prettier": "^2.0.0",
-    "ts-mockito": "^2.6.1",
-    "yeoman-assert": "^3.1.0",
-    "yeoman-test": "^4.0.0"
-  },
-  "engines": {
-    "npm": ">= 4.0.0"
-  },
-  "dependencies": {
-    "chalk": "^4.0.0",
-    "loadash": "^1.0.0",
-    "lodash": "^4.17.20",
-    "yeoman-generator": "^4.0.0",
-    "yosay": "^2.0.1"
-  },
-  "jest": {
-    "testEnvironment": "node"
-  },
-  "lint-staged": {
-    "*.js": [
-      "eslint --fix",
-      "git add"
-    ],
-    "*.json": [
-      "prettier --write",
-      "git add"
-    ]
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
-  },
-  "eslintConfig": {
-    "extends": [
-      "xo",
-      "prettier"
-    ],
-    "env": {
-      "jest": true,
-      "node": true
-    },
-    "rules": {
-      "prettier/prettier": "error"
-    },
-    "plugins": [
-      "prettier"
-    ]
-  },
-  "scripts": {
-    "pretest": "eslint .",
-    "test": "jest"
-  },
-  "repository": "ehrforce/generator-ehrcraft-script",
-  "license": "MIT"
-}
+{
+  "name": "generator-ehrcraft-script",
+  "version": "1.2.0",
+  "description": "A code generator for DIPS Forms typescript",
+  "homepage": "https://dev.azure.com/dips/DIPS%20Configured%20Products/_git/generator-ehrcraft-script",
+  "author": {
+    "name": "Bjørn Næss",
+    "email": "bna@dips.no",
+    "url": "https://dev.azure.com/dips/DIPS%20Configured%20Products/_git/generator-ehrcraft-script"
+  },
+  "files": [
+    "generators"
+  ],
+  "main": "generators/index.js",
+  "keywords": [
+    "",
+    "yeoman-generator"
+  ],
+  "devDependencies": {
+    "@types/chai": "^4.3.4",
+    "@types/mocha": "^10.0.1",
+    "chai": "^4.3.7",
+    "coveralls": "^3.1.1",
+    "ehrcraft-form-api": "^2.3.4",
+    "eslint": "^8.31.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "husky": "^4.3.8",
+    "jest": "^29.3.1",
+    "lint-staged": "^13.1.0",
+    "mocha": "^10.2.0",
+    "prettier": "^2.8.2",
+    "ts-mockito": "^2.6.1",
+    "yeoman-assert": "^3.1.1",
+    "yeoman-test": "^7.2.0"
+  },
+  "engines": {
+    "npm": ">= 4.0.0"
+  },
+  "dependencies": {
+    "chalk": "^5.2.0",
+    "loadash": "^1.0.0",
+    "lodash": "^4.17.21",
+    "yeoman-generator": "^5.7.0",
+    "yosay": "^2.0.2"
+  },
+  "jest": {
+    "testEnvironment": "node"
+  },
+  "lint-staged": {
+    "*.js": [
+      "eslint --fix",
+      "git add"
+    ],
+    "*.json": [
+      "prettier --write",
+      "git add"
+    ]
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "eslintConfig": {
+    "extends": [
+      "eslint:recommended"
+    ],
+    "env": {
+      "jest": true,
+      "node": true
+    },
+    "rules": {
+      "prettier/prettier": "error"
+    },
+    "plugins": [
+      "prettier"
+    ]
+  },
+  "scripts": {
+    "pretest": "eslint .",
+    "test": "jest"
+  },
+  "repository": "ehrforce/generator-ehrcraft-script",
+  "license": "MIT"
+}

package/generators/app/templates/gulpfile.js/bundle.js

@@ -1,62 +0,0 @@
-var browserify = require('browserify');
-var through = require('through');
-const fs = require('fs');
-
-/**
- * Denne fila er ikke i bruk - ligger her fordi den ble brukt for å teste ut funksjonene som brukes for å fjerne ehrcraft spesifikke forhold 
- */
-
-const regexptest = function () {
-    var data = '';
-    return through(write,end);
-    function write(buf) {
-        data += buf.toString('utf8').replace(/(ehrcraft_form_api_1\.)/gm,"");
-    }
-    function end() {
-        this.queue(data);
-        this.queue(null);
-    }
-}
-const removerequire = function () {
-    var data = '';
-    return through(write,end);
-    function write(buf) {
-        data += buf.toString('utf8').replace(/(var ehrcraft_form_api_1)/gm,"// Kommentert ut av byggescript");
-    }
-    function end() {
-        this.queue(data);
-        this.queue(null);
-    }
-}
-
-
-/**
- * 
- * @param {string} inFile - the js file to bundle 
- * @param {string} outFile - the bundled js file to write to
- */
-const bundleFile = function (inFile,outFile) {
-    return new Promise((resolve,reject) => {
-        try {
-            var b = browserify();
-            b.add(inFile);
-            b.transform(regexptest);
-            b.transform(removerequire);
-            b.bundle()
-                .pipe(fs.createWriteStream(outFile));
-            resolve("OK");
-        } catch (error) {
-            reject(err);
-        }
-    });
-
-
-
-}
-
-
-
-exports.bundleScript = bundleFile;
-exports.removeEhrCraftPackage = this.removeEhrCraftPackage;
-exports.removeEhrCraftRequire = this.removeEhrCraftRequire;
-

package/generators/app/templates/gulpfile.js/removeEhrCraftPackage.js

@@ -1,28 +0,0 @@
-var through = require('through');
-var path = require('path');
-function process(file,data,callback) {
-    //console.log(`Processing file ${file}`)
-    callback(data);
-}
-
-function transform(file) {
-    var data = '',stream = through(write,end);
-
-    return stream;
-
-    function write(buf) {
-        //data += buf;
-        data += buf.toString('utf8')
-            .replace(/(var ehrcraft_form_api_1)/gm,"// Kommentert ut av byggescript")
-            .replace(/(ehrcraft_form_api_1\.)/gm,"");
-        ;
-    }
-    function end() {
-        process(file,data,function (result) {
-            stream.queue(result);
-            stream.queue(null);
-        });
-    }
-    return through();
-}
-module.exports = transform;