5.0.1

.gitlab-ci.yml

@@ -12,6 +12,9 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
@@ -19,23 +22,36 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-audit:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - 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
+  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
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -50,9 +66,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +77,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,11 +97,12 @@ 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:
     - lossless
     - docker

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
+      "command": "npm test",
-      "type": "node",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
+      "type": "node-terminal"
-        "${relativeFile}"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
-    },
-    {
-      "name": "test.ts",
-      "type": "node",
-      "request": "launch",
-      "args": [
-        "test/test.ts"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
     }
   ]
 }

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

npmextra.json

@@ -9,7 +9,7 @@
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "projectinfo",
-      "shortDescription": "gather information about projects. supports npm, git etc.",
+      "description": "gather information about projects. supports npm, git etc.",
       "npmPackagename": "@pushrocks/projectinfo",
       "license": "MIT"
     }

package.json

@@ -1,13 +1,14 @@
 {
   "name": "@pushrocks/projectinfo",
-  "version": "4.0.3",
+  "version": "5.0.1",
   "private": false,
   "description": "gather information about projects. supports npm, git etc.",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web --allowimplicitany)"
   },
   "repository": {
     "type": "git",
@@ -27,19 +28,19 @@
   },
   "homepage": "https://gitlab.com/pushrocks/projectinfo#readme",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.24",
+    "@gitzone/tsbuild": "^2.1.61",
-    "@gitzone/tsrun": "^1.2.12",
+    "@gitzone/tsrun": "^1.2.32",
-    "@gitzone/tstest": "^1.0.33",
+    "@gitzone/tstest": "^1.0.70",
-    "@pushrocks/tapbundle": "^3.2.1",
+    "@pushrocks/tapbundle": "^5.0.3",
-    "@types/node": "^14.0.6",
+    "@types/node": "^17.0.25",
-    "tslint": "^6.1.2",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartfile": "^7.0.12",
+    "@pushrocks/smartfile": "^9.0.6",
-    "@pushrocks/smartpath": "^4.0.3",
+    "@pushrocks/smartpath": "^5.0.5",
-    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartpromise": "^3.1.7",
-    "@pushrocks/smartstring": "^3.0.18"
+    "@pushrocks/smartstring": "^4.0.2"
   },
   "files": [
     "ts/**/*",
@@ -52,5 +53,8 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -0,0 +1,51 @@
+# @pushrocks/projectinfo
+gather information about projects. supports npm, git etc.
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/projectinfo)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/projectinfo)
+* [github.com (source mirror)](https://github.com/pushrocks/projectinfo)
+* [docs (typedoc)](https://pushrocks.gitlab.io/projectinfo/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/projectinfo/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/projectinfo/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/projectinfo)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/projectinfo)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/projectinfo)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/projectinfo)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/projectinfo)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
+
+## Usage
+
+Use TypeScript for best in class instellisense.
+
+```javascript
+import { ProjectInfo } from 'projectinfo';
+
+let myProjectInfo = new ProjectInfo('/some/path/to/proejct');
+let npmName = myProjectInfo.npm.name; // returns npm name from package.json
+let npmVersion = myProjectInfo.npm.version; // returns version from package.json
+let gitRepo = myProjectInfo.git.gitrepo; // returns the name of the gitrepo
+let gitRemotes = myProjectInfo.git.remotes; // returns array with registered remotes
+
+// for more info check out the module in your IDE with TypeScript intellisense enabled
+```
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+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)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/package.json

@@ -2,6 +2,7 @@
   "name": "testpackage",
   "version": "1.0.0",
   "description": "some test",
+  "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/someuser/somerepo.git"

test/test.ts

@@ -1,31 +1,32 @@
 import { tap, expect } from '@pushrocks/tapbundle';
-import projectinfo = require('../ts/index');
+import * as smartpath from '@pushrocks/smartpath';
+import * as projectinfo from '../ts/index.js';
 
-let path = require('path');
+import * as path from 'path';
-let testBasePath = path.resolve(__dirname);
+let testBasePath = path.resolve(smartpath.get.dirnameFromImportMetaUrl(import.meta.url));
 
 let myNpm = new projectinfo.ProjectinfoNpm(testBasePath, { gitAccessToken: 'sometoken' });
 tap.test('should have .packageJson', async () => {
-  expect(myNpm.packageJson).have.property('version', '1.0.0');
+  expect(myNpm.packageJson).property('version').toEqual('1.0.0');
-  expect(myNpm.packageJson).have.property('name', 'testpackage');
+  expect(myNpm.packageJson).property('name').toEqual('testpackage');
 });
 
 tap.test('should have .version', async () => {
-  expect(myNpm).have.property('version', '1.0.0');
+  expect(myNpm).property('version').toEqual('1.0.0');
 });
 
 tap.test('should have .name', async () => {
-  expect(myNpm).have.property('name', 'testpackage');
+  expect(myNpm).property('name').toEqual('testpackage');
 });
 
 tap.test('should have .license', async () => {
-  expect(myNpm).have.property('license', 'MIT');
+  expect(myNpm).property('license').toEqual('MIT');
 });
 tap.test('should have .git', async () => {
-  expect(myNpm.git.httpsUrl).equal('https://sometoken@github.com/someuser/somerepo.git');
+  expect(myNpm.git.httpsUrl).toEqual('https://sometoken@github.com/someuser/somerepo.git');
 });
 tap.test('should return a name', async () => {
-  expect(projectinfo.getNpmNameForDir(testBasePath)).equal('testpackage');
+  expect(projectinfo.getNpmNameForDir(testBasePath)).toEqual('testpackage');
 });
 
 tap.start();

ts/index.ts

@@ -1,19 +1,19 @@
-import plugins = require('./projectinfo.plugins');
+import * as plugins from './projectinfo.plugins.js';
 
 // direct access to classes
-export * from './projectinfo.classes.git';
+export * from './projectinfo.classes.git.js';
-export * from './projectinfo.classes.npm';
+export * from './projectinfo.classes.npm.js';
-export * from './projectinfo.classes.projectinfo';
+export * from './projectinfo.classes.projectinfo.js';
 
 // npm
-import { ProjectinfoNpm } from './projectinfo.classes.npm';
+import { ProjectinfoNpm } from './projectinfo.classes.npm.js';
 
 // quick functions
 
 /**
  * gets the name from package.json in a specified directory
  */
-export let getNpmNameForDir = function(cwdArg) {
+export let getNpmNameForDir = function (cwdArg) {
   let localNpm = new ProjectinfoNpm(cwdArg);
   if (localNpm.status === 'ok') {
     return localNpm.name;

ts/projectinfo.classes.git.ts

@@ -1,4 +1,4 @@
-import * as plugins from './projectinfo.plugins';
+import * as plugins from './projectinfo.plugins.js';
 
 export class ProjectinfoGit {
   isGit: boolean;

ts/projectinfo.classes.npm.ts

@@ -1,4 +1,5 @@
-import plugins = require('./projectinfo.plugins');
+import * as plugins from './projectinfo.plugins.js';
+
 export class ProjectinfoNpm {
   isNpm: boolean = false;
   packageJson: any;

ts/projectinfo.classes.projectinfo.ts

@@ -1,6 +1,6 @@
-import * as plugins from './projectinfo.plugins';
+import * as plugins from './projectinfo.plugins.js';
-import { ProjectinfoNpm } from './projectinfo.classes.npm';
+import { ProjectinfoNpm } from './projectinfo.classes.npm.js';
-import { ProjectinfoGit } from './projectinfo.classes.git';
+import { ProjectinfoGit } from './projectinfo.classes.git.js';
 export type TProjectType = 'git' | 'npm';
 
 /**

tsconfig.json

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

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"
-}