Merge pull request #4 from appcelerator/v3

V3

Author: cb1kenobi

.eslintrc

@@ -1,5 +1,64 @@
 {
+    "env": {
+        "es6": true,
+        "node": true
+    },
+    "extends": "eslint:recommended",
+    "parserOptions": {
+        "ecmaVersion": "2022",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "chai-expect",
+        "mocha",
+        "promise",
+        "security"
+    ],
+    "root": true,
     "rules": {
-        "security/detect-non-literal-require": 0
+        "array-bracket-spacing": [ "warn", "always" ],
+        "brace-style": [ 2, "1tbs", { "allowSingleLine": true } ],
+        "camelcase": "off",
+        "chai-expect/missing-assertion": "error",
+        "chai-expect/terminating-properties": "warn",
+        "curly": [ "error", "all" ],
+        "eol-last": "error",
+        "indent": [ "error", "tab", { "SwitchCase": 1 } ],
+        "keyword-spacing": [ "error" ],
+        "linebreak-style": [ "error", "unix" ],
+        "max-len": [ "error", 200 ],
+        "no-case-declarations": "off",
+        "no-cond-assign": "off",
+        "no-console": "off",
+        "no-constant-condition": "off",
+        "no-control-regex": "off",
+        "no-empty": "warn",
+        "no-inner-declarations": "off",
+        "no-mixed-spaces-and-tabs": "error",
+        "no-multi-str": "error",
+        "no-multiple-empty-lines": "error",
+        "no-trailing-spaces": "error",
+        "no-unused-vars": "off",
+        "no-useless-escape": "warn",
+        "promise/always-return": "error",
+        "promise/no-return-wrap": "error",
+        "promise/param-names": "error",
+        "promise/catch-or-return": "error",
+        "promise/no-native": "off",
+        "promise/no-nesting": "warn",
+        "promise/no-promise-in-callback": "warn",
+        "promise/no-callback-in-promise": "warn",
+        "promise/avoid-new": "off",
+        "promise/no-new-statics": "error",
+        "promise/no-return-in-finally": "warn",
+        "promise/valid-params": "warn",
+        "quotes": [ "error", "single" ],
+        "semi": [ "error", "always" ],
+        "space-before-blocks": [ "error", "always" ],
+        "space-before-function-paren": [ "error", { "anonymous": "always", "named": "ignore", "asyncArrow": "always" }],
+        "space-in-parens": [ "error", "never" ],
+        "space-infix-ops": "error",
+        "space-unary-ops": [ "error", { "nonwords": false, "overrides": {} } ],
+        "valid-jsdoc": [ "warn", { "requireReturn": false, "requireReturnDescription": false } ]
     }
 }

.gitattributes

@@ -0,0 +1,3 @@
+*.js text eol=lf
+*.json text eol=lf
+*.md text eol=lf

.github/workflows/build.yml

@@ -0,0 +1,40 @@
+name: Build
+on:
+  - pull_request
+  - push
+
+jobs:
+  Lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+      - name: Install dependencies
+        run: yarn
+      - name: Lint
+        run: yarn run lint
+
+  Test:
+    needs: Lint
+    name: ${{ matrix.os }} ${{ matrix.nodeVersion }} Tests
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        nodeVersion: [ '14.19.3', '16.15.1', '18.4.0' ]
+        os: [ macos-latest, ubuntu-latest, windows-latest ]
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.nodeVersion }}
+      - name: Install dependencies
+        run: yarn
+      - name: Run tests
+        run: yarn run test

CHANGELOG.md

@@ -1,3 +1,9 @@
+# v3.0.0 (July 5, 2022)
+
+ * BREAKING CHANGE: Require Node.js 14.15.0 LTS or newer.
+ * BREAKING CHANGE: Changed package to a ES module.
+ * chore: Updated dependencies.
+
 # v2.0.0 (Feb 15, 2022)
 
  * BREAKING CHANGE: Require Node.js 12.13.0 LTS or newer.

Jenkinsfile

@@ -2,5 +2,5 @@
 library 'pipeline-library'
 
 runNPMPackage {
-  nodeVersions = [ '12.18.0', '14.4.0' ]
+  nodeVersions = [ '14.19.3', '16.15.1', '18.4.0' ]
 }

gulpfile.js

@@ -2,7 +2,8 @@
   "name": "check-kit",
   "version": "2.0.0",
   "description": "Checks if a newer version is available for command line interfaces",
-  "main": "./dist/index.js",
+  "type": "module",
+  "exports": "./src/index.js",
   "author": "Axway, Inc. <npmjs@appcelerator.com>",
   "maintainers": [
     "Chris Barber <cbarber@axway.com>"
@@ -21,26 +22,31 @@
     "latest"
   ],
   "scripts": {
-    "build": "gulp build",
-    "coverage": "gulp coverage",
-    "docs": "gulp docs",
-    "lint": "gulp lint",
-    "prepare": "gulp build",
-    "test": "gulp test"
+    "coverage": "c8 npm run test",
+    "lint": "eslint --ignore-pattern test/fixtures src test",
+    "prepublishOnly": "npm run lint",
+    "test": "npm run lint && mocha test/**/test-*.js --reporter spec"
   },
   "dependencies": {
-    "@axway/amplify-request": "^3.0.6",
-    "babel-plugin-source-map-support": "^2.1.3",
-    "ci-info": "^3.3.0",
-    "fs-extra": "^9.1.0",
-    "registry-auth-token": "4.2.1",
-    "semver": "^7.3.5",
-    "snooplogg": "^3.0.2",
+    "@axway/amplify-request": "^3.0.10",
+    "ci-info": "^3.3.2",
+    "fs-extra": "^10.1.0",
+    "registry-auth-token": "5.0.1",
+    "semver": "^7.3.7",
+    "snooplogg": "^5.0.0",
     "source-map-support": "^0.5.21",
     "tmp": "^0.2.1"
   },
   "devDependencies": {
-    "@axway/gulp-tasks": "^4.1.1"
+    "c8": "^7.11.3",
+    "chai": "^4.3.6",
+    "chai-as-promised": "^7.1.1",
+    "eslint": "^8.19.0",
+    "eslint-plugin-chai-expect": "^3.0.0",
+    "eslint-plugin-mocha": "^10.0.5",
+    "eslint-plugin-promise": "^6.0.0",
+    "eslint-plugin-security": "^1.5.0",
+    "mocha": "^10.0.0"
   },
   "homepage": "https://github.com/appcelerator/check-kit",
   "bugs": "https://github.com/appcelerator/check-kit/issues",
@@ -49,6 +55,6 @@
     "url": "git://github.com/appcelerator/check-kit.git"
   },
   "engines": {
-    "node": ">=12.13.0"
+    "node": ">=14.15.0"
   }
 }

package.json

@@ -1,16 +1,11 @@
-/* istanbul ignore if */
-if (!Error.prepareStackTrace) {
-	require('source-map-support/register');
-}
-
 import fs from 'fs-extra';
 import path from 'path';
 import semver from 'semver';
 import snooplogg from 'snooplogg';
 import * as request from '@axway/amplify-request';
 import { isCI } from 'ci-info';
-import { tmpdir } from 'tmp';
-import { writeFileSync } from './fsutil';
+import tmp from 'tmp';
+import { writeFileSync } from './fsutil.js';
 
 const { error, log, warn } = snooplogg('check-kit');
 const { highlight } = snooplogg.styles;
@@ -56,7 +51,7 @@ export async function check(opts = {}) {
 
 	// bail immediately if update notifications have been explicitly disabled or we're running
 	// within a test
-	if (!force && (process.env.NO_UPDATE_NOTIFIER || process.env.NODE_ENV === 'test' || isCI)) {
+	if (!force && !process.env.FORCE_UPDATE_NOTIFIER && (process.env.NO_UPDATE_NOTIFIER || process.env.NODE_ENV === 'test' || isCI)) {
 		return {};
 	}
 
@@ -66,7 +61,7 @@ export async function check(opts = {}) {
 
 	// determine the meta directory
 	if (!metaDir) {
-		metaDir = process.env.TEST_META_DIR || path.join(tmpdir, 'check-kit');
+		metaDir = process.env.TEST_META_DIR || path.join(tmp.tmpdir, 'check-kit');
 	} else if (typeof metaDir !== 'string') {
 		throw new TypeError('Expected metaDir to be a string');
 	}
@@ -239,7 +234,7 @@ export async function loadPackageJson(opts = {}) {
  */
 async function getLatestVersion(name, distTag, opts) {
 	const p = name.indexOf('/');
-	const regUrl = opts.registryUrl || require('registry-auth-token/registry-url')(p !== -1 ? name.substring(0, p) : '');
+	const regUrl = opts.registryUrl || (await import('registry-auth-token/registry-url.js')).default(p !== -1 ? name.substring(0, p) : '');
 	const got = request.init(opts);
 	const reqOpts = {
 		followRedirect: true,
@@ -248,7 +243,9 @@ async function getLatestVersion(name, distTag, opts) {
 		},
 		responseType: 'json',
 		retry: 0,
-		timeout: Object.prototype.hasOwnProperty.call(opts, 'timeout') ? opts.timeout : 1000,
+		timeout: {
+			request: Object.prototype.hasOwnProperty.call(opts, 'timeout') ? opts.timeout : 1000
+		},
 		url: new URL(encodeURIComponent(name).replace(/^%40/, '@'), regUrl)
 	};
 	let info;
@@ -279,7 +276,7 @@ async function getLatestVersion(name, distTag, opts) {
 			}
 
 			// package does not exist or we can't access it
-			const authInfo = require('registry-auth-token')(regUrl, { recursive: true });
+			const authInfo = (await import('registry-auth-token')).default(regUrl, { recursive: true });
 			if (!authInfo) {
 				// no auth info, bail out
 				return null;

src/index.js

@@ -1,16 +1,27 @@
-import check, { loadPackageJson } from '../dist/index';
+import chai, { expect } from 'chai';
+import chaiAsPromised from 'chai-as-promised';
+import check, { loadPackageJson } from '../src/index.js';
 import fs from 'fs-extra';
 import http from 'http';
 import path from 'path';
 import snooplogg from 'snooplogg';
 import tmp from 'tmp';
+import { fileURLToPath } from 'url';
+
+chai.use(chaiAsPromised);
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 const { log } = snooplogg('test:check-kit');
 const { highlight } = snooplogg.styles;
 
 process.env.TEST_META_DIR = tmp.dirSync({ prefix: 'check-kit-test' }).name;
 
 describe('check-kit', function () {
+	beforeEach(() => {
+		process.env.FORCE_UPDATE_NOTIFIER = 1;
+	});
+
 	afterEach(async () => {
 		await fs.remove(process.env.TEST_META_DIR);
 	});
@@ -69,6 +80,7 @@ describe('check-kit', function () {
 	describe('Environment check skip', () => {
 		it('should skip check if NO_UPDATE_NOTIFIER is set', async () => {
 			try {
+				delete process.env.FORCE_UPDATE_NOTIFIER;
 				process.env.NO_UPDATE_NOTIFIER = 1;
 				expect(await check()).to.deep.equal({});
 			} finally {
@@ -78,6 +90,7 @@ describe('check-kit', function () {
 
 		it('should skip check if NODE_ENV is set to test', async () => {
 			try {
+				delete process.env.FORCE_UPDATE_NOTIFIER;
 				process.env.NODE_ENV = 'test';
 				expect(await check()).to.deep.equal({});
 			} finally {
@@ -126,7 +139,9 @@ describe('check-kit', function () {
 			expect(result.updateAvailable).to.equal(true);
 		});
 
-		it('should check a valid package.json with scoped name', async () => {
+		it('should check a valid package.json with scoped name', async function () {
+			this.timeout(5000);
+
 			const result = await check({
 				pkg: path.resolve(__dirname, 'fixtures/good-scoped/package.json')
 			});