date-format 3.0.0 → 4.0.1

package/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '34 6 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

package/.github/workflows/node.js.yml

@@ -0,0 +1,31 @@
+# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 16.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run build --if-present
+    - run: npm test

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,38 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a milestone is closed
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  milestone:
+    types: [closed]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+      - run: npm ci
+      - run: npm test
+  
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: |
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+      - run: npm version ${{ github.event.milestone.title }}
+      - run: git push && git push --tags
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# log4js-node changelog
+
+## 4.0.0
+
+- [Fix timezone format to include colon separator](https://github.com/nomiddlename/date-format/pull/27) - thanks [@peteriman](https://github.com/peteriman)
+  - [test: have a test case for timezone with colon](https://github.com/nomiddlename/date-format/pull/32) - thanks [@peteriman](https://github.com/peteriman)
+- [Docs: Updated README.md with more examples and expected output](https://github.com/nomiddlename/date-format/pull/33) - thanks [@peteriman](https://github.com/peteriman)
+- Updated dependencies
+  - [should-util from 1.0.0 to 1.0.1](https://github.com/nomiddlename/date-format/pull/31) 
+  - [eslint from 5.16.0 to 8.6.0 and mocha from 5.2.0 to 9.1.3](https://github.com/nomiddlename/date-format/pull/30) 
+  - [acorn from 6.2.0 to 6.4.2](https://github.com/nomiddlename/date-format/pull/29)
+  - [lodash from 4.17.14 to 4.17.21](https://github.com/nomiddlename/date-format/pull/26)
+
+## Previous versions
+
+Change information for older versions can be found by looking at the milestones in github.

package/README.md

@@ -15,18 +15,28 @@ Formatting dates as strings
 
 ```javascript
 var format = require('date-format');
-format.asString(); //defaults to ISO8601 format and current date.
-format.asString(new Date()); //defaults to ISO8601 format
-format.asString('hh:mm:ss.SSS', new Date()); //just the time
+format.asString(); // defaults to ISO8601 format and current date
+format.asString(new Date()); // defaults to ISO8601 format
+format.asString('hh:mm:ss.SSS', new Date()); // just the time
+format.asString(format.ISO8601_WITH_TZ_OFFSET_FORMAT, new Date()); // in ISO8601 with timezone
 ```
 
 or
 
 ```javascript
 var format = require('date-format');
-format(); //defaults to ISO8601 format and current date.
-format(new Date());
-format('hh:mm:ss.SSS', new Date());
+format(); // defaults to ISO8601 format and current date
+format(new Date()); // defaults to ISO8601 format
+format('hh:mm:ss.SSS', new Date()); // just the time
+format(format.ISO8601_WITH_TZ_OFFSET_FORMAT, new Date()); // in ISO8601 with timezone
+```
+
+**output:**
+```javascript
+2017-03-14T14:10:20.391
+2017-03-14T14:10:20.391
+14:10:20.391
+2017-03-14T14:10:20.391+11:00
 ```
 
 Format string can be anything, but the following letters will be replaced (and leading zeroes added if necessary):
@@ -38,11 +48,11 @@ Format string can be anything, but the following letters will be replaced (and l
 * mm - `date.getMinutes()`
 * ss - `date.getSeconds()`
 * SSS - `date.getMilliseconds()`
-* O - timezone offset in +hm format (note that time will be in UTC if displaying offset)
+* O - timezone offset in ±hh:mm format (note that time will still be local if displaying offset)
 
 Built-in formats:
 * `format.ISO8601_FORMAT` - `2017-03-14T14:10:20.391` (local time used)
-* `format.ISO8601_WITH_TZ_OFFSET_FORMAT` - `2017-03-14T03:10:20.391+1100` (UTC + TZ used)
+* `format.ISO8601_WITH_TZ_OFFSET_FORMAT` - `2017-03-14T14:10:20.391+11:00` (local + TZ used)
 * `format.DATETIME_FORMAT` - `14 03 2017 14:10:20.391` (local time used)
 * `format.ABSOLUTETIME_FORMAT` - `14:10:20.391` (local time used)
 
@@ -54,5 +64,8 @@ The date format library has limited ability to parse strings into dates. It can
 var format = require('date-format');
 // pass in the format of the string as first argument
 format.parse(format.ISO8601_FORMAT, '2017-03-14T14:10:20.391');
+format.parse(format.ISO8601_WITH_TZ_OFFSET_FORMAT, '2017-03-14T14:10:20.391+1100');
+format.parse(format.ISO8601_WITH_TZ_OFFSET_FORMAT, '2017-03-14T14:10:20.391+11:00');
+format.parse(format.ISO8601_WITH_TZ_OFFSET_FORMAT, '2017-03-14T03:10:20.391Z');
 // returns Date
 ```

package/lib/index.js

@@ -27,7 +27,7 @@ function offset(timezoneOffset) {
   if (m.length === 1) {
     m = "0" + m;
   }
-  return timezoneOffset < 0 ? "+" + h + m : "-" + h + m;
+  return timezoneOffset === 0 ? "Z" : (timezoneOffset < 0 ? "+" : "-") + h + ":" + m;
 }
 
 function asString(format, date) {
@@ -126,11 +126,14 @@ function extractDateParts(pattern, str, missingValuesDate) {
     },
     {
       pattern: /O/,
-      regexp: "[+-]\\d{3,4}|Z",
+      regexp: "[+-]\\d{1,2}:?\\d{2}?|Z",
       fn: function(date, value) {
         if (value === "Z") {
           value = 0;
         }
+        else {
+          value = value.replace(":", "");
+        }
         var offset = Math.abs(value);
         var timezoneOffset = (value > 0 ? -1 :  1 ) * ((offset % 100) + Math.floor(offset / 100) * 60);
         // Per ISO8601 standard: UTC = local time - offset

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "date-format",
-  "version": "3.0.0",
+  "version": "4.0.1",
   "description": "Formatting Date objects as strings since 2013",
   "main": "lib/index.js",
   "repository": {
@@ -25,9 +25,9 @@
   "readmeFilename": "README.md",
   "gitHead": "bf59015ab6c9e86454b179374f29debbdb403522",
   "devDependencies": {
-    "eslint": "^5.16.0",
+    "eslint": "^8.6.0",
     "eslint-plugin-mocha": "^5.3.0",
-    "mocha": "^5.2.0",
+    "mocha": "^9.1.3",
     "should": "^13.2.3"
   }
 }

package/test/date_format-test.js

@@ -35,7 +35,7 @@ describe('date_format', function() {
 
         // when tz offset is in the pattern, the date should be in local time
         dateFormat.asString(dateFormat.ISO8601_WITH_TZ_OFFSET_FORMAT, tzDate)
-            .should.eql('2010-01-11T14:31:30.005+1100');
+            .should.eql('2010-01-11T14:31:30.005+11:00');
 
         tzDate = createFixedDate();
         tzDate.getTimezoneOffset = function () {
@@ -43,7 +43,7 @@ describe('date_format', function() {
         };
 
         dateFormat.asString(dateFormat.ISO8601_WITH_TZ_OFFSET_FORMAT, tzDate)
-            .should.eql('2010-01-11T14:31:30.005-0200');
+            .should.eql('2010-01-11T14:31:30.005-02:00');
     });
 
     it('should provide a just-the-time format', function() {
@@ -56,6 +56,6 @@ describe('date_format', function() {
             return 120;
         };
 
-        dateFormat.asString('O.SSS.ss.mm.hh.dd.MM.yy', customDate).should.eql('-0200.005.30.31.14.11.01.10');
+        dateFormat.asString('O.SSS.ss.mm.hh.dd.MM.yy', customDate).should.eql('-02:00.005.30.31.14.11.01.10');
     });
 });

package/test/parse-test.js

@@ -159,8 +159,8 @@ describe("dateFormat.parse", function() {
         verifyDate(date, { hours: 7, minutes: 23 });
       });
 
-      it("works with hh:mm O (+0930)", function() {
-        var date = dateFormat.parse("hh:mm O", "05:23 +0930");
+      it("works with hh:mm O (+09:30)", function() {
+        var date = dateFormat.parse("hh:mm O", "05:23 +09:30");
         verifyDate(date, { hours: 19, minutes: 53 });
       });
     });