3.0.6

.gitlab-ci.yml

@@ -26,6 +26,7 @@ mirror:
 snyk:
   stage: security
   script:
+    - npmci npm prepare
     - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
@@ -33,24 +34,39 @@ snyk:
   - 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
+  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
+  tags:
+  - docker
+  - priv
+
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
 testLTS:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install lts
   - npmci npm install
   - npmci npm test
@@ -62,6 +78,7 @@ testLTS:
 testSTABLE:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install stable
   - npmci npm install
   - npmci npm test
@@ -118,6 +135,7 @@ pages:
   stage: metadata
   script:
     - npmci command npm install -g typedoc typescript
+    - npmci npm prepare
     - npmci npm install
     - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
   tags:
@@ -130,13 +148,3 @@ pages:
     paths:
     - public
   allow_failure: true
-
-windowsCompatibility:
-  image: stefanscherer/node-windows:10-build-tools
-  stage: metadata
-  script:
-  - npm install & npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - windows
-  allow_failure: true

npmextra.json

@@ -1,8 +1,6 @@
 {
   "npmci": {
-    "npmGlobalTools": [
-      "@gitzone/npmts"
-    ],
+    "npmGlobalTools": [],
     "npmAccessLevel": "public"
   },
   "npmdocker": {

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@pushrocks/smartstring",
-  "version": "3.0.2",
+  "version": "3.0.6",
   "private": false,
   "description": "handle strings in smart ways. TypeScript ready.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "tstest test/",
-    "build": "(tstest)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild)"
   },
   "repository": {
     "type": "git",
@@ -24,17 +24,17 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartstring#readme",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tsrun": "^1.1.12",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/tapbundle": "^3.0.5",
-    "@types/node": "^10.5.8"
+    "@gitzone/tsbuild": "^2.1.4",
+    "@gitzone/tsrun": "^1.1.17",
+    "@gitzone/tstest": "^1.0.18",
+    "@pushrocks/tapbundle": "^3.0.7",
+    "@types/node": "^10.12.18"
   },
   "dependencies": {
     "crypto-random-string": "^1.0.0",
-    "js-base64": "^2.4.8",
+    "js-base64": "^2.5.0",
     "normalize-newline": "^3.0.0",
-    "randomatic": "^3.1.0",
+    "randomatic": "^3.1.1",
     "strip-indent": "^2.0.0"
   }
 }

test/test.normalize.ts

@@ -0,0 +1,19 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+
+import * as smartstring from '../ts/index';
+
+tap.test('should normalize a string', async () => {
+  const testString = `
+    myawesome string;
+      is indented with two spaces
+  `
+  const normalizedString = smartstring.normalize.standard(testString);
+  expect(normalizedString).to.equal(
+`
+myawesome string;
+  is indented with two spaces
+  `
+  )
+})
+
+tap.start()

ts/smartstring.create.ts

@@ -1,13 +1,29 @@
 import * as plugins from './smartstring.plugins';
 
+/**
+ * creates a random string
+ * 
+ * ```ts
+ * createRandomString('AAAA')
+ * //=> 'AGHR' 
+ * ```
+ * 
+ * @param patternArg the pattern argument to use, Aa0!* are viable pattern descritors
+ * @param lengthArg  the length of the random string
+ * @param optionsArg options
+ */
 export const createRandomString = (
   patternArg: string,
-  lengthArg: number,
-  optionsArg: any
+  lengthArg?: number,
+  optionsArg?: any
 ): string => {
   return plugins.randomatic(patternArg, lengthArg, optionsArg);
 };
 
-export const createCryptoRandomString = (lengthArg): string => {
+/**
+ * creates a crytic string in the speicifed length
+ * @param lengthArg the length of the crypto string
+ */
+export const createCryptoRandomString = (lengthArg: number): string => {
   return plugins.cryptoRandomString(lengthArg);
 };

tslint.json

@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
+  "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"
 }