clever-tools 3.13.1 → 4.0.0

package/package.json

@@ -1,22 +1,33 @@
 {
   "name": "clever-tools",
-  "version": "3.13.1",
+  "version": "4.0.0",
   "description": "Command Line Interface for Clever Cloud.",
-  "main": "bin/clever.js",
-  "type": "module",
   "keywords": [
-    "clever-tools",
     "cli",
-    "clever cloud"
+    "command-line",
+    "tool",
+    "clever-cloud",
+    "paas",
+    "deployment",
+    "cloud",
+    "devops",
+    "automation"
   ],
-  "engines": {
-    "node": ">=18"
+  "homepage": "https://github.com/CleverCloud/clever-tools",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/CleverCloud/clever-tools.git"
+  },
+  "bugs": {
+    "url": "https://github.com/CleverCloud/clever-tools/issues"
   },
-  "pkg-node-version": "18",
   "author": "Clever Cloud <ci@clever-cloud.com>",
   "license": "Apache-2.0",
+  "type": "module",
+  "main": "bin/clever.js",
   "bin": {
     "clever": "bin/clever.js",
+    "clever-tools": "bin/clever.js",
     "install-clever-completion": "scripts/install-autocomplete.sh",
     "uninstall-clever-completion": "scripts/uninstall-autocomplete.sh"
   },
@@ -25,86 +36,60 @@
     "src",
     "scripts/*.sh"
   ],
+  "scripts": {
+    "fix-all": "npm run lint:fix && npm run format",
+    "format": "prettier . --write",
+    "format:check": "prettier . --check",
+    "install-local:cliparse": "(cd ../cliparse-node && npm pack) && mv ../cliparse-node/cliparse-*.tgz . && npm i -f ./cliparse-*.tgz",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
+    "validate": "npm run lint && npm run format:check && npm run typecheck",
+    "typecheck": "tsc -p tsconfig.json"
+  },
   "dependencies": {
-    "@clevercloud/client": "9.2.0",
-    "@inquirer/prompts": "7.3.2",
+    "@clevercloud/client": "11.0.1",
+    "@inquirer/prompts": "7.8.4",
+    "char-regex": "2.0.2",
     "cliparse": "0.5.0",
-    "colors": "1.4.0",
-    "common-env": "6.4.0",
-    "curlconverter": "3.21.0",
-    "dedent": "1.5.3",
-    "eventsource": "1.1.0",
-    "ioredis": "5.4.1",
+    "dedent": "1.6.0",
+    "eventsource": "4.0.0",
+    "ioredis": "5.7.0",
     "iso8601-duration": "2.1.2",
-    "isomorphic-git": "1.25.3",
+    "isomorphic-git": "1.33.1",
     "linux-release-info": "3.0.0",
     "lodash": "4.17.21",
-    "mkdirp": "1.0.4",
-    "moment": "2.29.1",
-    "open": "8.4.0",
-    "slugify": "1.5.3",
-    "string-length": "4.0.2",
-    "superagent": "6.1.0",
-    "text-table": "0.2.0",
-    "tldts": "6.1.30",
-    "update-notifier": "5.1.0",
-    "uuid": "8.3.2",
-    "ws": "7.4.6",
+    "open": "10.2.0",
+    "semver": "7.7.2",
+    "slugify": "1.6.6",
+    "tldts": "7.0.12",
+    "update-notifier": "7.3.1",
     "xdg": "0.1.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "18.4.3",
-    "@commitlint/config-conventional": "18.4.3",
-    "@rollup/plugin-commonjs": "26.0.1",
+    "@aws-sdk/client-s3": "3.876.0",
+    "@clevercloud/eslint-config": "1.0.1",
+    "@commitlint/cli": "19.8.1",
+    "@commitlint/config-conventional": "19.8.1",
+    "@eslint/compat": "1.3.2",
+    "@rollup/plugin-commonjs": "28.0.6",
     "@rollup/plugin-json": "6.1.0",
-    "@rollup/plugin-node-resolve": "15.2.3",
-    "aws-sdk": "2.919.0",
-    "chai": "4.3.4",
-    "del": "6.0.0",
-    "eslint": "7.27.0",
-    "eslint-config-standard": "16.0.3",
-    "eslint-plugin-import": "2.23.4",
-    "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-promise": "5.1.0",
-    "eslint-plugin-standard": "5.0.0",
-    "fs-extra": "10.0.0",
-    "glob": "7.1.7",
-    "grunt": "1.4.1",
-    "grunt-cli": "1.4.3",
-    "grunt-http": "2.3.3",
-    "grunt-mocha-test": "0.13.3",
-    "magic-string": "0.30.11",
-    "mime-types": "2.1.35",
-    "mocha": "8.4.0",
-    "pkg": "5.8.1",
-    "rollup": "4.14.1",
-    "semver": "7.3.5"
-  },
-  "overrides": {
-    "pkg-fetch": "3.5.2"
-  },
-  "scripts": {
-    "build": "rollup -c rollup.config.js",
-    "pretest": "npm run lint",
-    "test": "grunt test",
-    "lint": "eslint bin src scripts",
-    "lint:fix": "eslint --fix bin src scripts",
-    "install-local:cliparse": "(cd ../cliparse-node && npm pack) && mv ../cliparse-node/cliparse-*.tgz . && npm i -f ./cliparse-*.tgz"
+    "@rollup/plugin-node-resolve": "16.0.1",
+    "@types/mime-types": "3.0.1",
+    "@yao-pkg/pkg": "6.6.0",
+    "eslint": "9.34.0",
+    "globals": "16.3.0",
+    "mime-types": "3.0.1",
+    "prettier": "3.6.2",
+    "prettier-plugin-organize-imports": "4.2.0",
+    "rollup": "4.49.0",
+    "simple-git": "3.28.0",
+    "tinyglobby": "0.2.14",
+    "typescript": "5.9.2"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/CleverCloud/clever-tools.git"
-  },
-  "bugs": {
-    "url": "https://github.com/CleverCloud/clever-tools/issues"
-  },
-  "homepage": "https://github.com/CleverCloud/clever-tools",
-  "pkg": {
-    "scripts": [
-      "src/**/*.js"
-    ]
+  "engines": {
+    "node": ">=22"
   },
   "volta": {
-    "node": "18.15.0"
+    "node": "22.17.0"
   }
 }

package/src/clever-client/auth-bridge.js

@@ -1,4 +1,4 @@
-export function createApiToken ({ email, password, mfaCode, name, description = '', expirationDate }) {
+export function createApiToken({ email, password, mfaCode, name, description = '', expirationDate }) {
   return Promise.resolve({
     method: 'post',
     url: '/api-tokens',
@@ -7,7 +7,7 @@ export function createApiToken ({ email, password, mfaCode, name, description =
   });
 }
 
-export function listApiTokens () {
+export function listApiTokens() {
   return Promise.resolve({
     method: 'get',
     url: '/api-tokens',
@@ -15,7 +15,7 @@ export function listApiTokens () {
   });
 }
 
-export function updateApiToken (apiTokenId, { name, description }) {
+export function updateApiToken(apiTokenId, { name, description }) {
   return Promise.resolve({
     method: 'put',
     url: `/api-tokens/${apiTokenId}`,
@@ -24,7 +24,7 @@ export function updateApiToken (apiTokenId, { name, description }) {
   });
 }
 
-export function deleteApiToken (apiTokenId) {
+export function deleteApiToken(apiTokenId) {
   return Promise.resolve({
     method: 'delete',
     url: `/api-tokens/${apiTokenId}`,
@@ -32,13 +32,11 @@ export function deleteApiToken (apiTokenId) {
   });
 }
 
-export function addOauthHeaderPlaintext (tokens) {
-
+export function addOauthHeaderPlaintext(tokens) {
   return async function (requestParams) {
-
-    const authorizationHeader = (
-      'OAuth '
-      + [
+    const authorizationHeader =
+      'OAuth ' +
+      [
         `oauth_consumer_key="${tokens.OAUTH_CONSUMER_KEY}"`,
         `oauth_token="${tokens.API_OAUTH_TOKEN}"`,
         // %26 is URL escaped character "&"
@@ -47,8 +45,7 @@ export function addOauthHeaderPlaintext (tokens) {
         // oauth_signature_method is not mandatory, it defaults to PLAINTEXT
         // oauth_timestamp is not mandatory
         // oauth_version is not mandatory, it defaults to 1.0
-      ].join(', ')
-    );
+      ].join(', ');
 
     return {
       ...requestParams,

package/src/clever-client/ng.js

@@ -6,7 +6,7 @@
  * @param {String} params.ownerId
  * @param {String} params.query
  */
-export function searchNetworkGroupOrResource (params) {
+export function searchNetworkGroupOrResource(params) {
   // no multipath for /self or /organisations/{id}
   return Promise.resolve({
     method: 'get',

package/src/clever-client/operators.js

@@ -6,7 +6,7 @@
  * @param {String} params.provider
  * @param {String} params.realId
  */
-export function getOperator (params) {
+export function getOperator(params) {
   // no multipath for /self or /organisations/{id}
   return Promise.resolve({
     method: 'get',
@@ -23,7 +23,7 @@ export function getOperator (params) {
  * @param {String} params.provider
  * @param {String} params.realId
  */
-export function rebootOperator (params) {
+export function rebootOperator(params) {
   // no multipath for /self or /organisations/{id}
   return Promise.resolve({
     method: 'post',
@@ -40,7 +40,7 @@ export function rebootOperator (params) {
  * @param {String} params.provider
  * @param {String} params.realId
  */
-export function rebuildOperator (params) {
+export function rebuildOperator(params) {
   // no multipath for /self or /organisations/{id}
   return Promise.resolve({
     method: 'post',
@@ -57,7 +57,7 @@ export function rebuildOperator (params) {
  * @param {String} params.provider
  * @param {String} params.realId
  */
-export function ngEnableOperator (params) {
+export function ngEnableOperator(params) {
   // no multipath for /self or /organisations/{id}
   return Promise.resolve({
     method: 'post',
@@ -74,7 +74,7 @@ export function ngEnableOperator (params) {
  * @param {String} params.provider
  * @param {String} params.realId
  */
-export function ngDisableOperator (params) {
+export function ngDisableOperator(params) {
   // no multipath for /self or /organisations/{id}
   return Promise.resolve({
     method: 'delete',
@@ -91,7 +91,7 @@ export function ngDisableOperator (params) {
  * @param {String} params.provider
  * @param {String} params.realId
  */
-export function versionCheck (params) {
+export function versionCheck(params) {
   // no multipath for /self or /organisations/{id}
   return Promise.resolve({
     method: 'get',
@@ -109,7 +109,7 @@ export function versionCheck (params) {
  * @param {String} params.realId
  * @param {Object} body
  */
-export function versionUpdate (params, body) {
+export function versionUpdate(params, body) {
   // no multipath for /self or /organisations/{id}
   return Promise.resolve({
     method: 'post',

package/src/command-options.js

@@ -1,6 +1,6 @@
 import cliparse from 'cliparse';
 
-export function getOutputFormatOption (formats = []) {
+export function getOutputFormatOption(formats = []) {
   const availableFormats = ['human', 'json', ...formats];
   return cliparse.option('format', {
     aliases: ['F'],
@@ -12,13 +12,13 @@ export function getOutputFormatOption (formats = []) {
     },
     default: 'human',
     description: `Output format (${availableFormats.join(', ')})`,
-    complete () {
+    complete() {
       return cliparse.autocomplete.words(availableFormats);
     },
   });
 }
 
-export function getSameCommitPolicyOption () {
+export function getSameCommitPolicyOption() {
   const availablePolicies = ['error', 'ignore', 'restart', 'rebuild'];
   return cliparse.option('same-commit-policy', {
     aliases: ['p'],
@@ -30,13 +30,13 @@ export function getSameCommitPolicyOption () {
     },
     default: 'error',
     description: `What to do when local and remote commit are identical (${availablePolicies.join(', ')})`,
-    complete () {
+    complete() {
       return cliparse.autocomplete.words(availablePolicies);
     },
   });
 }
 
-export function getExitOnOption () {
+export function getExitOnOption() {
   const availableExitOn = ['deploy-start', 'deploy-end', 'never'];
   return cliparse.option('exit-on', {
     aliases: ['e'],
@@ -48,7 +48,7 @@ export function getExitOnOption () {
     },
     default: 'deploy-end',
     description: `Step at which the logs streaming is ended, steps are: ${availableExitOn.join(', ')}`,
-    complete () {
+    complete() {
       return cliparse.autocomplete.words(availableExitOn);
     },
   });

package/src/command-promise-handler.js

@@ -1,15 +1,15 @@
-import { Logger } from './logger.js';
-import { getPackageJson } from './load-package-json.cjs';
 import semver from 'semver';
+import pkg from '../package.json' with { type: 'json' };
+import { Logger } from './logger.js';
 
-const pkg = getPackageJson();
-
-export function handleCommandPromise (promise) {
+export function handleCommandPromise(promise) {
   promise.catch((error) => {
     Logger.error(error);
     const semverIsOk = semver.satisfies(process.version, pkg.engines.node);
     if (!semverIsOk) {
-      Logger.warn(`You are using node ${process.version}, some of our commands require node ${pkg.engines.node}. The error may be caused by this.`);
+      Logger.warn(
+        `You are using node ${process.version}, some of our commands require node ${pkg.engines.node}. The error may be caused by this.`,
+      );
     }
     process.exit(1);
   });

package/src/commands/accesslogs.js

@@ -1,10 +1,10 @@
-import * as Application from '../models/application.js';
-import { Logger } from '../logger.js';
-import { getHostAndTokens } from '../models/send-to-api.js';
 import { ApplicationAccessLogStream } from '@clevercloud/client/esm/streams/access-logs.js';
-import { JsonArray } from '../models/json-array.js';
-import colors from 'colors/safe.js';
+import { styleText } from 'node:util';
 import { formatTable } from '../format-table.js';
+import { Logger } from '../logger.js';
+import * as Application from '../models/application.js';
+import { JsonArray } from '../models/json-array.js';
+import { getHostAndTokens } from '../models/send-to-api.js';
 import { truncateWithEllipsis } from '../models/utils.js';
 
 // 2000 logs per 100ms maximum
@@ -12,8 +12,7 @@ const THROTTLE_ELEMENTS = 2000;
 const THROTTLE_PER_IN_MILLISECONDS = 100;
 const CITY_MAX_LENGTH = 20;
 
-export async function accessLogs (params) {
-
+export async function accessLogs(params) {
   // TODO: drop when add-ons are supported in API
   if (params.options.addon) {
     throw new Error('Access Logs are not available for add-ons yet');
@@ -35,10 +34,10 @@ export async function accessLogs (params) {
   });
 
   if (format === 'human') {
-    Logger.warn(colors.yellow('/!\\ Access Logs feature is in Alpha testing phase'));
+    Logger.warn(styleText('yellow', '/!\\ Access Logs feature is in Alpha testing phase'));
   }
 
-  if (format === 'json' && (!until)) {
+  if (format === 'json' && !until) {
     throw new Error('JSON format only works with a limiting parameter such as `before`');
   }
 
@@ -46,14 +45,14 @@ export async function accessLogs (params) {
   const jsonArray = new JsonArray();
 
   stream
-    .on('open', (event) => {
-      Logger.debug(colors.blue(`Logs stream (open) ${JSON.stringify({ appId })}`));
+    .on('open', () => {
+      Logger.debug(styleText('blue', `Logs stream (open) ${JSON.stringify({ appId })}`));
       if (format === 'json') {
         jsonArray.open();
       }
     })
     .on('error', (event) => {
-      Logger.debug(colors.red(`Logs stream (error) ${event.error.message}`));
+      Logger.debug(styleText('red', `Logs stream (error) ${event.error.message}`));
     })
     .onLog((log) => {
       switch (format) {
@@ -87,21 +86,26 @@ export async function accessLogs (params) {
   Logger.debug(`stream closed: ${closeReason?.type}`);
 }
 
-function formatHuman (log) {
+function formatHuman(log) {
   const { date, http, source } = log;
   const country = source.countryCode ?? '(unknown)';
   const hasSourceCity = source.city ?? '';
 
-  return row([[
-    colors.grey(date.toISOString(date)),
-    source.ip,
-    `${country}${hasSourceCity ? '/' + truncateWithEllipsis(CITY_MAX_LENGTH, source.city) : ''}`,
-    colorStatusCode(http.response.statusCode),
-    http.request.method.toString().padEnd(4, ' ') + ' ' + http.request.path,
-  ]]);
+  return formatTable(
+    [
+      [
+        styleText('grey', date.toISOString(date)),
+        source.ip,
+        `${country}${hasSourceCity ? '/' + truncateWithEllipsis(CITY_MAX_LENGTH, source.city) : ''}`,
+        colorStatusCode(http.response.statusCode),
+        http.request.method.toString().padEnd(4, ' ') + ' ' + http.request.path,
+      ],
+    ],
+    ACCESSLOG_COLUMN_WIDTHS,
+  );
 }
 
-const row = formatTable([
+const ACCESSLOG_COLUMN_WIDTHS = [
   '2024-06-24T08:05:43.880Z',
   '255.255.255.255',
   // country / city
@@ -110,20 +114,25 @@ const row = formatTable([
   // longest method name
   'OPTIONS',
   // path
-]);
-
-function colorStatusCode (code) {
+];
+
+/**
+ * @param {number} code
+ * @returns {string}
+ */
+function colorStatusCode(code) {
+  const codeString = code.toString();
   if (code >= 500) {
-    return colors.red(code);
+    return styleText('red', codeString);
   }
   if (code >= 400) {
-    return colors.yellow(code);
+    return styleText('yellow', codeString);
   }
   if (code >= 300) {
-    return colors.blue(code);
+    return styleText('blue', codeString);
   }
   if (code >= 200) {
-    return colors.green(code);
+    return styleText('green', codeString);
   }
-  return code;
+  return codeString;
 }