2.0.9

.gitignore

@@ -1,6 +1,20 @@
-node_modules/
+.nogit/
+
+# artifacts
 coverage/
 public/
 pages/
-test/testresult/
-.nogit/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,81 +1,52 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
+
+before_script:
+  - npm install -g @shipzone/npmci
 
 # ====================
 # security stage
 # ====================
-mirror:
-  stage: security
-  script:
-  - npmci git mirror
-  tags:
-  - docker
-  - notpriv
-
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
     - docker
-  - notpriv
-
-sast:
-  stage: security
-  image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
-  variables:
-    DOCKER_DRIVER: overlay2
   allow_failure: true
-  services:
-    - docker:stable-dind
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
   script:
     - npmci npm prepare
-    - npmci npm install
-    - npmci command npm run build
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SAST_CONFIDENCE_LEVEL="${SAST_CONFIDENCE_LEVEL:-3}"
-        --volume "$PWD:/code"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/sast:$SP_VERSION" /app/bin/run /code
-  artifacts:
-    reports:
-      sast: gl-sast-report.json
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
     - docker
-  - priv
+  allow_failure: true
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+testStable:
   stage: test
   script:
     - npmci npm prepare
@@ -85,7 +56,17 @@ testSTABLE:
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
-  - notpriv
+
+testBuild:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - docker
 
 release:
   stage: release
@@ -95,6 +76,7 @@ release:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -103,20 +85,15 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
+  only:
+    - tags
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
+    - npmci command npm install -g typescript
+    - npmci npm prepare
+    - npmci npm install
   tags:
+    - lossless
     - docker
     - priv
 
@@ -127,18 +104,19 @@ trigger:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install stable 
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command npm run buildDocs
   tags:
+    - lossless
     - docker
     - notpriv
   only:

.snyk

@@ -1,4 +0,0 @@
-# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
-version: v1.13.3
-ignore: {}
-patch: {}

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,40 +0,0 @@
-# @pushrocks/smarthbs
-handlebars with better fs support
-
-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smarthbs)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/smarthbs)
-* [github.com (source mirror)](https://github.com/pushrocks/smarthbs)
-* [docs (typedoc)](https://pushrocks.gitlab.io/smarthbs/)
-
-## Status for master
-[![build status](https://gitlab.com/pushrocks/smarthbs/badges/master/build.svg)](https://gitlab.com/pushrocks/smarthbs/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smarthbs/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smarthbs/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smarthbs.svg)](https://www.npmjs.com/package/@pushrocks/smarthbs)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smarthbs/badge.svg)](https://snyk.io/test/npm/@pushrocks/smarthbs)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
-
-## Usage
-
-> Note: Why did we decide against a class based architecture?  
-> Easy: handlebars.js is already pretty determined how things are handled internally, namely a global partial template registry
-> It doesn't make sense to then introduce a scoped partial template approach.
-
-```javascript
-import * as smarthbs from 'smarthbs';
-
-// read all .hbs files in a directory and any child directories and use relative path as partial string identifier
-smarthbs.registerPartialDir(testPartialDir);
-
-// read all .hbs files in a particular directory and level, output them to a destination and specify a .json file to read any referenced data
-smarthbs.compileDirectory(testHbsDir, testResultDir, 'data.json');
-```
-
-For further information read the linked docs at the top of this readme.
-
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
-
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

npmextra.json

@@ -4,11 +4,12 @@
     "npmAccessLevel": "public"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smarthbs",
-      "shortDescription": "handlebars with better fs support",
+      "description": "handlebars with better fs support",
       "npmPackagename": "@pushrocks/smarthbs",
       "license": "MIT"
     }

package.json

@@ -1,13 +1,14 @@
 {
   "name": "@pushrocks/smarthbs",
-  "version": "2.0.3",
+  "version": "2.0.9",
   "private": false,
   "description": "handlebars with better fs support",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --allowimplicitany)"
   },
   "repository": {
     "type": "git",
@@ -23,17 +24,33 @@
   },
   "homepage": "https://gitlab.com/pkunz/smarthbs#README",
   "dependencies": {
-    "@pushrocks/smartfile": "^6.0.12",
-    "@pushrocks/smartpromise": "^2.0.5",
-    "@types/lodash": "^4.14.121",
-    "handlebars": "^4.1.0",
-    "lodash": "^4.17.11"
+    "@pushrocks/smartfile": "^10.0.2",
+    "@pushrocks/smartpath": "^5.0.5",
+    "@pushrocks/smartpromise": "^3.1.7",
+    "@types/lodash.uniq": "^4.5.7",
+    "handlebars": "^4.7.7",
+    "lodash.uniq": "^4.5.0"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.8",
-    "@gitzone/tsrun": "^1.1.17",
-    "@gitzone/tstest": "^1.0.18",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^11.9.4"
-  }
+    "@gitzone/tsbuild": "^2.1.63",
+    "@gitzone/tsrun": "^1.2.37",
+    "@gitzone/tstest": "^1.0.72",
+    "@pushrocks/tapbundle": "^5.0.4",
+    "@types/node": "^18.0.6"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
 }

test/test.ts

@@ -1,10 +1,14 @@
 import { expect, tap } from '@pushrocks/tapbundle';
-import * as smarthbs from '../ts/index';
+import * as smarthbs from '../ts/index.js';
+
+import * as smartpath from '@pushrocks/smartpath';
 import * as path from 'path';
 
-let testHbsDir = path.join(__dirname, 'hbs_testfiles');
+const dirname = smartpath.get.dirnameFromImportMetaUrl(import.meta.url);
+
+let testHbsDir = path.join(dirname, 'hbs_testfiles');
 let testPartialDir = path.join(testHbsDir, 'partials');
-let testResultDir = path.join(__dirname, 'testresult');
+let testResultDir = path.join(dirname, 'testresult');
 
 tap.test('smarthbs -> should create partials', async () => {
   await smarthbs.registerPartialDir(testPartialDir);
@@ -17,8 +21,8 @@ tap.test('smarthbs -> should compile a directory', async () => {
 tap.test('', async () => {
   let templateString = '{{{firstVar}}} {{secondVar}}';
   let templateVars = await smarthbs.findVarsInHbsString(templateString);
-  expect(templateVars).to.include('firstVar');
-  expect(templateVars).to.include('secondVar');
+  expect(templateVars).toContain('firstVar');
+  expect(templateVars).toContain('secondVar');
 });
 
 tap.test('', async () => {
@@ -29,12 +33,14 @@ tap.test('', async () => {
     secondVar: 'hello',
     fourthVar: {
       otherKey: {
-        nextKey: 'wow'
-      }
-    }
+        nextKey: 'wow',
+      },
+    },
   });
-  expect(missingVars).to.contain('thirdVar', 'fourthVar.someKey');
-  expect(missingVars).to.not.contain('secondVar', 'fourthVar.otherKey.nextKey');
+  expect(missingVars).toContain('thirdVar');
+  expect(missingVars).toContain('fourthVar.someKey');
+  expect(missingVars).not.toContain('secondVar');
+  expect(missingVars).not.toContain('fourthVar.otherKey.nextKey');
 });
 
 tap.start();

test/testresult/index.html

@@ -0,0 +1 @@
+<head></head>analyzed

test/testresult/index2.html

@@ -0,0 +1 @@
+A second hbs file!

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smarthbs',
+  version: '2.0.9',
+  description: 'handlebars with better fs support'
+}

ts/index.ts

@@ -1,10 +1,10 @@
-import * as plugins from './smarthbs.plugins';
+import * as plugins from './smarthbs.plugins.js';
 export type TTemplateStringType = 'filePath' | 'code';
 
 export let handlebars = plugins.handlebars;
-export * from './smarthbs.compile';
-import './smarthbs.helpers';
-export * from './smarthbs.partials';
-export * from './smarthbs.template';
-export * from './smarthbs.variables';
-export * from './smarthbs.postprocess';
+export * from './smarthbs.compile.js';
+import './smarthbs.helpers.js';
+export * from './smarthbs.partials.js';
+export * from './smarthbs.template.js';
+export * from './smarthbs.variables.js';
+export * from './smarthbs.postprocess.js';

ts/smarthbs.compile.ts

@@ -1,4 +1,4 @@
-import * as plugins from './smarthbs.plugins';
+import * as plugins from './smarthbs.plugins.js';
 
 /**
  * compiles a directory and outputs it

ts/smarthbs.helpers.ts

@@ -1,10 +1,10 @@
-import * as plugins from './smarthbs.plugins';
+import * as plugins from './smarthbs.plugins.js';
 
 /**
  * Helper:
  * Allows you to analyze a context
  */
-plugins.handlebars.registerHelper('__analyze', analyzeContext => {
+plugins.handlebars.registerHelper('__analyze', (analyzeContext) => {
   if (typeof analyzeContext === 'string') {
     if (plugins.handlebars.partials[analyzeContext]) {
       console.log(`The analyzed partial ${analyzeContext} looks like this`);
@@ -20,7 +20,7 @@ plugins.handlebars.registerHelper('__analyze', analyzeContext => {
  * Helper:
  * logs all registered partials to console
  */
-plugins.handlebars.registerHelper('__allPartialsLog', analyzeContext => {
+plugins.handlebars.registerHelper('__allPartialsLog', (analyzeContext) => {
   console.log(plugins.handlebars.partials);
   return 'analyzed';
 });

ts/smarthbs.partials.ts

@@ -1,11 +1,11 @@
-import * as plugins from './smarthbs.plugins';
+import * as plugins from './smarthbs.plugins.js';
 
 /**
  * registers a directory of partials to make them available within handlebars compilation
  */
 export let registerPartialDir = (dirPathArg: string): Promise<any> => {
   let done = plugins.smartpromise.defer();
-  plugins.smartfile.fs.listFileTree(dirPathArg, '**/*.hbs').then(hbsFileArrayArg => {
+  plugins.smartfile.fs.listFileTree(dirPathArg, '**/*.hbs').then((hbsFileArrayArg) => {
     for (let hbsFilePath of hbsFileArrayArg) {
       let parsedPath = plugins.path.parse(hbsFilePath);
       let hbsFileString = plugins.smartfile.fs.toStringSync(

ts/smarthbs.plugins.ts

@@ -1,7 +1,8 @@
-import * as handlebars from 'handlebars';
-import * as lodash from 'lodash';
+import handlebars from 'handlebars';
+import lodashUniq from 'lodash.uniq';
+import * as smartpath from '@pushrocks/smartpath';
 import * as path from 'path';
 import * as smartfile from '@pushrocks/smartfile';
 import * as smartpromise from '@pushrocks/smartpromise';
 
-export { handlebars, lodash, path, smartfile, smartpromise };
+export { handlebars, lodashUniq, path, smartfile, smartpromise };

ts/smarthbs.postprocess.ts

@@ -1,4 +1,4 @@
-import * as plugins from './smarthbs.plugins';
+import * as plugins from './smarthbs.plugins.js';
 
 let safeSyntaxBeginRegex = /{-{/g;
 let safeSyntaxEndRegex = /}-}/g;

ts/smarthbs.template.ts

@@ -1,4 +1,4 @@
-import * as plugins from './smarthbs.plugins';
+import * as plugins from './smarthbs.plugins.js';
 
 /**
  * get a template for a file on disk

ts/smarthbs.variables.ts

@@ -1,7 +1,7 @@
 // This file contains code that makes it easy to search handlebar templates for variables.
 // Why? To get a clue if you are missing some.
 
-import * as plugins from './smarthbs.plugins';
+import * as plugins from './smarthbs.plugins.js';
 
 // the curly regex objects
 let tripleCurlyRegex = /{{{\s*[\w\.]+\s*}}}/g;
@@ -18,20 +18,20 @@ export let findVarsInHbsString = async (hbsStringArg: string) => {
   let tripleCurlyMatches = hbsString.match(tripleCurlyRegex);
   if (tripleCurlyMatches) {
     hbsString = hbsString.replace(tripleCurlyRegex, '[[[replaced]]]');
-    varNameArray = plugins.lodash.concat(varNameArray, tripleCurlyMatches);
+    varNameArray = varNameArray.concat(tripleCurlyMatches);
   }
   let doubleCurlyMatches = hbsString.match(doubleCurlyRegex);
   if (doubleCurlyMatches) {
-    varNameArray = plugins.lodash.concat(varNameArray, doubleCurlyMatches);
+    varNameArray = varNameArray.concat(doubleCurlyMatches);
   }
 
   // make sure we are clean from curly brackets
-  varNameArray = varNameArray.map(x => {
+  varNameArray = varNameArray.map((x) => {
     return x.match(nameInCurlsRegex)[0];
   });
 
   // make sure are uniq
-  varNameArray = plugins.lodash.uniq(varNameArray);
+  varNameArray = plugins.lodashUniq(varNameArray);
   return varNameArray;
 };
 

tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true
+  }
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}