diff-ymd-package - npm Package Compare versions

Comparing version 2.0.3 to 2.1.0

CHANGELOG.md

@@ -150,2 +150,37 @@ ## Changelog
 
+
+### [v2.1.0] - [2024-02-17]
+
+#### Added
+
+- **Simplification:** Modularize the diff-ymd-package
+- Added the `DatesYMD` class in separate file
+- Added the `diffDates` function in separate file
+- Updated tests codes
+- Updated the README.md documentation for better presentation.
+- Enhanced README.md for follwing best practices
+
+#### Changed
+
+- Improved algorithm efficiency: Enhanced performance for existing methods to provide faster calculations.
+- Modified internal structure: Refactored internal code for better readability and maintainability.
+- Enhanced README.md for follwing best practices
+
+
+#### Fixed
+
+- Fixed some issues related to the new changes.
+- Configured files for publishing diff-ymd-package v2.1.0 on npm registry.
+
+#### Documentation
+
+- README.md updated: Added consistent formating and recommended for best practices.
+- Enhanced code comments: Provided thorough inline documentation for better codes understanding.
+
+#### Testing
+
+- Continuous Integration: Integrated automated testing with GitHub Actions for ongoing code quality assurance.
+
+
+
 ### [Next Release] - Collecting issues and new features for next release
@@ -155,4 +190,4 @@
 
-- [Unreleased](https://github.com/farhan7reza7/diff-ymd-package/compare/v2.0.3...HEAD)
-- [v2.0.3](https://github.com/farhan7reza7/diff-ymd-package/releases/tag/v2.0.3)
+- [Unreleased](https://github.com/farhan7reza7/diff-ymd-package/compare/v2.1.0...HEAD)
+- [v2.1.0](https://github.com/farhan7reza7/diff-ymd-package/releases/tag/v2.1.0)
 - [Next Release](https://github.com/farhan7reza7/diff-ymd-package/milestone/2)

package.json

 {
   "name": "diff-ymd-package",
-  "version": "2.0.3",
+  "version": "2.1.0",
   "description": "A javascript library for calculating the difference between two dates in formatted ways like (aY bM cD)(aYears bMonths cDays) or customized desired formats like aY-bM-cD or aYears-bMonths-cDays or kDays or mWeeks or nMonths etc.",
@@ -35,2 +35,5 @@ "main": "src/diff-ymd.js",
     "eslint-plugin-prettier": "^5.1.3",
+    "@babel/core": "^7.23.9",
+    "@babel/preset-env": "^7.23.9",
+    "babel-jest": "^29.7.0",
     "jest": "^27.0.0",
@@ -37,0 +40,0 @@ "prettier": "^3.2.2"

README.md

@@ -10,4 +10,17 @@ # diff-ymd-package
 [![License][license-image]][licence-url]
-[![LinkedIn](https://img.shields.io/badge/LinkedIn-farhan7reza7-blue)](https://www.linkedin.com/in/farhan7reza7/)
+[![LinkedIn](https://img.shields.io/badge/LinkedIn-farhanReza-blue)](https://www.linkedin.com/in/farhan7reza7/)
 
+## Table of Contents
+
+- [Installation](#installation)
+  - [Install from npm registry](#install-from-npm-registry)
+  - [Install from Github Packages registry](#install-from-github-packages-registry)
+- [Usages](#usages)
+- [API References](#api-references)
+- [API Documentation](#api-documentation)  
+- [Contributing](#contributing)
+- [Best Practices](#best-practices)
+- [License](#license)
+- [History](#history)
+
 ## Installation
@@ -138,2 +151,20 @@
 
+## API References
+**diff-ymd-package**
+- [Classes](#api-documentation)
+  - [DatesYMD](#datesymd)
+    - [Create an instance of DatesYMD](#create-an-instance-of-datesymd)
+    - [OR for version 2.x.x and above, Can use simplified function diffDates on module-object](#can-use-simplified-function-diffdates-on-module-object)
+  - [Methods](#methods)
+    - [diffArray()](#diffarray)
+    - [formattedYMD()](#formattedymd)
+    - [customizeFormat(yearUnit, monthUnit, dayUnit, partSeparator)](#customizeformatyearunit-monthunit-dayunit-partseparator)
+    - [diffInMonths()](#diffinmonths)
+    - [diffInWeeks()](#diffinweeks)
+    - [diffInDays()](#diffindays)
+    - [diffInYears()](#diffinyears)
+    - [diffInHours()](#diffinhours)
+    - [diffInMinutes()](#diffinminutes)
+    - [diffInSeconds()](#diffinseconds)
+
 ## API Documentation
@@ -297,3 +328,3 @@
 
-See [CONTRIBUTING.md](CONTRIBUTING.md) for more informations.
+[See CONTRIBUTING.md](CONTRIBUTING.md) for more informations.
 
@@ -317,4 +348,5 @@ ## Best Practices:
 For more details about what has changed in each version of this project.  
-See [CHANGELOG.md](CHANGELOG.md).
 
+[See CHANGELOG.md](CHANGELOG.md).
+
 [npm-image]: https://img.shields.io/npm/v/diff-ymd-package
@@ -321,0 +353,0 @@ [npm-url]: https://www.npmjs.com/package/diff-ymd-package

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of package files

55

increased by10%

Number of lines in readme file

358

increased by9.82%

Worsened metrics

Total package byte prevSize

1139710

decreased by-0.32%

Dev dependency count

9

increased by50%

Lines of code

1212

decreased by-15.54%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes