fix(core): update

2022-07-24 15:30:19 +02:00 · 2022-07-24 15:30:19 +02:00 · b382256cc7
commit b382256cc7
parent 97400fa501
21 changed files with 13690 additions and 1078 deletions
--- a/.gitignore
+++ b/.gitignore
@ -15,8 +15,6 @@ node_modules/

 # builds
 dist/
-dist_web/
-dist_serve/
-dist_ts_web/
+dist_*/

 # custom
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@ -3,36 +3,44 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci

 cache:
  paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  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
+    - docker
+  allow_failure: true
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - 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
+  allow_failure: true

 # ====================
 # test stage
@ -41,37 +49,36 @@ snyk:
 testStable:
  stage: test
  script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
  coverage: /\d+.?\d+?\%\s*coverage/
  tags:
-  - docker
-  - priv
+    - docker

 testBuild:
  stage: test
  script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci command npm run build
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
  coverage: /\d+.?\d+?\%\s*coverage/
  tags:
-  - docker
-  - notpriv
+    - docker

 release:
  stage: release
  script:
-  - npmci node install stable
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
  only:
-  - tags
+    - tags
  tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv

 # ====================
 # metadata stage
@ -79,35 +86,37 @@ release:
 codequality:
  stage: metadata
  allow_failure: true
+  only:
+    - tags
  script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
+    - npmci npm prepare
    - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
  tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv

 trigger:
  stage: metadata
  script:
-  - npmci trigger
+    - npmci trigger
  only:
-  - tags
+    - tags
  tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv

 pages:
-  image: hosttoday/ht-docker-dbase:npmci
-  services:
-   - docker:stable-dind
  stage: metadata
  script:
-    - npmci command npm install -g @gitzone/tsdoc
+    - npmci node install stable 
    - npmci npm prepare
    - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
  tags:
+    - lossless
    - docker
    - notpriv
  only:
@ -115,5 +124,5 @@ pages:
  artifacts:
    expire_in: 1 week
    paths:
-    - public
+      - public
  allow_failure: true
--- a/.snyk
+++ b/.snyk
@ -1,4 +0,0 @@
-# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
-version: v1.13.3
-ignore: {}
-patch: {}
--- a/.vscode/launch.json
+++ b/.vscode/launch.json
@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}
--- a/.vscode/settings.json
+++ b/.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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}
--- a/README.md
+++ b/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-prettier-ff69b4.svg)](https://prettier.io/)
-
-## 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 | **&copy;** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
-
-[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
--- a/npmextra.json
+++ b/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"
    }
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@ -3,11 +3,12 @@
  "version": "2.0.8",
  "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,27 +24,33 @@
  },
  "homepage": "https://gitlab.com/pkunz/smarthbs#README",
  "dependencies": {
-    "@pushrocks/smartfile": "^7.0.4",
-    "@pushrocks/smartpromise": "^3.0.2",
-    "handlebars": "^4.2.0",
+    "@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.17",
-    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.13",
-    "@types/node": "^12.7.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_web/*",
-    "dist_ts_web/*",
-    "assets/*",
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
    "cli.js",
    "npmextra.json",
    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
  ]
 }
--- a/test/test.ts
+++ b/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();
--- a/ts/00_commitinfo_data.ts
+++ b/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'
+}
--- a/ts/index.ts
+++ b/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';
--- a/ts/smarthbs.compile.ts
+++ b/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
--- a/ts/smarthbs.helpers.ts
+++ b/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';
 });
--- a/ts/smarthbs.partials.ts
+++ b/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(
--- a/ts/smarthbs.plugins.ts
+++ b/ts/smarthbs.plugins.ts
@ -1,5 +1,6 @@
-import * as handlebars from 'handlebars';
+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';
--- a/ts/smarthbs.postprocess.ts
+++ b/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;
--- a/ts/smarthbs.template.ts
+++ b/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
--- a/ts/smarthbs.variables.ts
+++ b/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;
@ -26,7 +26,7 @@ export let findVarsInHbsString = async (hbsStringArg: string) => {
  }

  // make sure we are clean from curly brackets
-  varNameArray = varNameArray.map(x => {
+  varNameArray = varNameArray.map((x) => {
    return x.match(nameInCurlsRegex)[0];
  });

--- a/tsconfig.json
+++ b/tsconfig.json
@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true
+  }
+}
--- a/tslint.json
+++ b/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"
-}