saitho / ts-appversion

Display the version of your app in your frontend. For Angular and any other TypeScript framework.

🛠️ Tech Stack

Category	Technologies
Frontend
Frameworks
Core
DevOps
Testing
Misc
Editors

See ➡️ Full Tech Stack, for a list of projects using each of the above technologies

👨‍💻 Coding stats

🐙💻 GitHub stats

🕊️ Open Source commitment

Making software available for others to use and improve is a great thing, which is why I decided to open-source most of my work.

Open-sourcing software goes beyond just pushing some code onto GitHub. That's why I'll regularly update the dependencies of my active repositories each month. Please see my maintainance project for a list of maintained repositories.

• My NPM packages: https://www.npmjs.com/~saitho

🤝 Supporting others

---

I'm contributing to awesome software

• Gitea: A self-hosted Git service
• semantic-releases: Emotionless automated semantic releases
• Robo: Modern task runner for PHP
• GitHub Readme Stats

💻 Technology	🚀 Projects

ts-appversion's Issues

Documentation for example app

README of example app is currently Angular default.
It should describe what the example app is about and explain what to run and which results to expect.

Git tag date

versionDate should refer to the date of the version, thus the date of when the tag was created.
Would be great if we can get that information.

Consequently what is currently named versionDate should be renamed into buildDate. As this is part of the same version which hasn't been released yet, it is not a breaking change.

Command-line option to validate that new version is greater than existing version

We run into the situation where someone erroneously manually updated a version in the generated src/_versions.ts from 0.1.0 to 0.2.0

Further uses of ts-appversion then gets the correct current version 0.1.0 and generates src/_versions.ts

So now we have a _versions.ts that goes from 0.1.0 to 0.2.0 to 0.1.0 again.

Could be useful to add a flag option to check that the new version is semantically greater than the previous version of _versions.ts?

how do I use the --git switch

hello, how do I use the git switch
my .git folder is c:\a\b.git
and my webApp package.json is c:\a\b\c\d\e\f\package.json
I have

Rewrite codebase with TypeScript

Code base should be rewritten into TypeScript to allow structuring the code better.

Move dependency of snyk to devDependencies

Right now snyk is listed as a dependency in the package.json. This causes snyk to be installed in every project using this tool.
I think it should be a devDependency instead. That should work since the code of this tool itself does not use snyk just the tooling around it.

Git Tag is always null

I'm running into an issue where the git tag is always null, even when the most recent commit is tagged. All of the other git properties populate as they should, and when I run git describe in my repo I see the tag as expected. Is there a particular way I'm supposed to create the tag so ts-appversion can find it?

[CVE-2018-3721 / CVE-2018-16487] Lodash security issues

CVE-2018-3721

lodash node module before 4.17.5 suffers from a Modification of Assumed-Immutable Data (MAID) vulnerability via defaultsDeep, merge, and mergeWith functions, which allows a malicious user to modify the prototype of "Object" via proto, causing the addition or modification of an existing property that will exist on all objects.

Remediation: Upgrade lodash to version 4.17.5 or later.

CVE-2018-16487

A prototype pollution vulnerability was found in lodash <4.17.11 where the functions merge, mergeWith, and defaultsDeep can be tricked into adding or modifying properties of Object.prototype.

Remediation: Upgrade lodash to version 4.17.11 or later.

Add timestamp

Add a timestamp to know the exact time when the app was built.
This helps in development conditions

Please comment that the file is auto-generated

Hi
It would be helpful to have a comment in the file saying that it's automatically generated

Thanks for this useful module.

Always getting wrong (and non-existing) git ref

I always get the git ref version gcfb9f4f instead of current HEAD:

export const version = '2.3.1-SNAPSHOT';
export const versionLong = '2.3.1-SNAPSHOT-gcfb9f4f';

but:

git log|grep -i gcfb9f4f
[et2448@Davids-Work-MacBook-Pro tac-jfr-js-client (⎈ |icp-global-context:kube-system)]$ 

Documentation: default value for --file argument in "Command arguments" table wrong.

A minor issue with the documentation: in the table Command arguments the default value for the --file argument (path) is wrong.

The value in the table is ./src/_version.ts while it should be ./src/_versions.ts (with an s).

Remove --force-git

As --force-git was deprecated in favour of --git in v1.2.0 the argument has to be removed.

Cannot find package.json in root path

I installed ts-appversion in my angular project and ran:
node ./node_modules/@saithodev/ts-appversion/index.js
and got the following error:

[NgAppVersion] Cannot find package.json in root path. Skipping...

Looking in ./node_modules/@saithodev/ts-appversion/index.js I changed line 8 from:
let rootPath = path.join('..', '..');
to:
let rootPath = path.join('..', '..', '..');

This seemed to fix the error.