@i2analyze/create-connector 2.0.0-next.0

package/CHANGELOG.md

@@ -0,0 +1,33 @@
+# @i2analyze/create-connector
+
+## 2.0.0-next.0
+
+### Major Changes
+
+- 07d9ec3: BREAKING CHANGE: Removed "--no-connectors" argument when creating new connector server
+
+## 1.0.3
+
+### Patch Changes
+
+- cc9d526: Update copyright information.
+- ed28e8e: Update urls to use correct github organization.
+
+## 1.0.2
+
+### Patch Changes
+
+- 927589d: Update READMEs and homepages for public packages
+
+## 1.0.1
+
+### Patch Changes
+
+- 358415b: Use a `^` dependency for i2connect-scripts.
+- e46293f: Rename `sample` to `skeleton` in the template, and change casing to better reflect the nature of the files produced.
+
+## 1.0.0
+
+### Major Changes
+
+- 79b1db9: Initial release.

package/README.md

@@ -0,0 +1,3 @@
+# @i2analyze/create-connector
+
+This package is part of the [i2 Connect SDK](https://github.com/i2group/analyze-connect-node-sdk).

package/index.js

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+/*!
+ * Copyright 2022- N. Harris Computer Corporation. All rights reserved
+ * SPDX-License-Identifier: MIT
+ */
+
+'use strict';
+
+var thisVersion = process.versions.node;
+var thisMajor = thisVersion.split('.')[0];
+var minimumMajorRequired = 14;
+
+if (thisMajor < minimumMajorRequired) {
+  console.error(
+    'Node ' +
+      minimumMajorRequired +
+      ' or higher is required. You are using ' +
+      thisVersion +
+      '. Update your version of Node.'
+  );
+  process.exit(5);
+}
+
+var { main } = require('./main');
+main();

package/main.js

@@ -0,0 +1,211 @@
+/*!
+ * Copyright 2022- N. Harris Computer Corporation. All rights reserved
+ * SPDX-License-Identifier: MIT
+ */
+
+const commander = require('commander');
+const chalk = require('chalk');
+const fileUriToPath = require('file-uri-to-path');
+const fs = require('fs');
+const path = require('path');
+const spawn = require('cross-spawn');
+const fileUrl = require('file-url');
+
+const thisPackageJson = require('./package.json');
+
+exports.main = async function main() {
+  /** @type string */
+  let projectDirOrName;
+
+  const program = new commander.Command(thisPackageJson.name)
+    .version(thisPackageJson.version)
+    .option('--i2connect-version <version>', 'the version of the i2connect package to use', 'latest')
+    .option('--i2connect-scripts-version <version>', 'the version of i2connect-scripts to use', 'latest')
+    .arguments('<project-directory>')
+    .usage(`${chalk.green('<project-directory>')} [options]`)
+    .action((name) => {
+      projectDirOrName = name;
+    })
+    .on('--help', () => {
+      console.log();
+    })
+    .parse(process.argv);
+
+  if (typeof projectDirOrName === 'undefined') {
+    console.error(`Specify a project directory.`);
+    console.log(`  ${chalk.cyan(program.name())} ${chalk.green('<project-directory>')}`);
+    process.exit(5);
+  }
+
+  const projectDir = path.resolve(process.cwd(), projectDirOrName);
+  const projectName = path.basename(projectDir);
+
+  const packageJson = {
+    name: projectName,
+    version: '0.1.0',
+    private: true,
+  };
+
+  console.log(`Creating a new i2 Connect server in ${chalk.green(projectDir)}.`);
+
+  try {
+    const stat = await fs.promises.stat(projectDir);
+    // Oh dear. Target already exists.
+    console.error(chalk.red(`ERROR: Target folder ${projectDir} already exists.`));
+    process.exit(5);
+  } catch (_e) {
+    // Target does not exist. Good.
+  }
+
+  await fs.promises.mkdir(projectDir);
+  await fs.promises.writeFile(path.join(projectDir, 'package.json'), JSON.stringify(packageJson, null, 2), 'utf8');
+  process.chdir(projectDir);
+
+  const developmentLocation = process.env.I2CONNECT_DEVELOPMENT_OVERRIDE;
+
+  const { i2connectScriptsVersion, i2connectVersion } = program.opts();
+
+  function findPackage(officialPackageName, localDirectoryName) {
+    if (developmentLocation) {
+      return fileUrl(developmentLocation) + '/packages/' + localDirectoryName;
+    } else {
+      return officialPackageName;
+    }
+  }
+
+  const scriptsPackage = findPackage('@i2analyze/i2connect-scripts', 'i2connect-scripts');
+  const scriptsPackageName = getPackageInfo(scriptsPackage);
+
+  let restoreDevelopmentPackage = () => {};
+
+  if (developmentLocation) {
+    // This message is for developers of this SDK package, not end users.
+    console.warn(`i2 Connect development mode: Loading scripts package from ${scriptsPackage}.`);
+    const scriptsPackageJson = path.join(developmentLocation, 'packages', 'i2connect-scripts', 'package.json');
+
+    // When we 'install' a local development version of i2connect-scripts, npm will follow
+    // the @i2analyze/eslint-config-i2connect dependency, trying to install a version
+    // that may not have been published. (It doesn't understand workspaces, i.e. that
+    // we already have the package.)  So, just before we 'install' the local i2connect-scripts,
+    // we patch its package.json dependency section to point the eslint-config dependency
+    // explicitly at the local path. (We put it back again in the finally block.)
+
+    const originalPackageJsonString = await fs.promises.readFile(scriptsPackageJson, 'utf8');
+    const packageJson = JSON.parse(originalPackageJsonString);
+    packageJson.dependencies['@i2analyze/eslint-config-i2connect'] = findPackage(
+      '@i2analyze/eslint-config-i2connect',
+      'eslint-config-i2connect'
+    );
+    await fs.promises.writeFile(scriptsPackageJson, JSON.stringify(packageJson, null, 2), 'utf8');
+    restoreDevelopmentPackage = async () => {
+      await fs.promises.writeFile(scriptsPackageJson, originalPackageJsonString, 'utf8');
+    };
+  }
+
+  const versionedScriptsPackage =
+    i2connectScriptsVersion && !developmentLocation ? `${scriptsPackage}@${i2connectScriptsVersion}` : scriptsPackage;
+
+  let installFailed = false;
+
+  try {
+    await install(projectDir, false, true, [versionedScriptsPackage]);
+  } catch (_e) {
+    installFailed = true;
+  } finally {
+    await restoreDevelopmentPackage();
+  }
+
+  if (installFailed) {
+    console.error(chalk.red(`ERROR: Failed to install ${versionedScriptsPackage}.`));
+    process.exit(5);
+  }
+
+  /**
+   * @type {import("@i2analyze/i2connect-scripts/src/init").IInitParams}
+   */
+  const initParams = {
+    projectPath: projectDir,
+    i2connectVersion: developmentLocation ? undefined : i2connectVersion,
+  };
+
+  // Pass control over to the init.js file in the i2connect-scripts package.
+  try {
+    await runNode(
+      `var init = require('${scriptsPackageName}/dist/cjs/init.js'); init.run(...JSON.parse(process.argv[1]));`,
+      [initParams],
+      process.cwd()
+    );
+  } catch (_e) {
+    // Errors will already be reported by init. We don't want to report messy unhandled
+    // exceptions _after_ init has emitted clean errors.
+  }
+};
+
+/**
+ * Given a package specifier (a package name or a file: URL),
+ * returns the simple name of the package.
+ * @param {string} pkg
+ */
+function getPackageInfo(pkg) {
+  if (pkg.startsWith('file:')) {
+    const pkgInfo = require(path.join(fileUriToPath(pkg), 'package.json'));
+    return pkgInfo.name;
+  }
+
+  return pkg;
+}
+
+function runNode(script, data, cwd) {
+  const serializedData = JSON.stringify(data);
+  const child = spawn(process.execPath, ['-e', script, '--', serializedData], {
+    cwd,
+    stdio: 'inherit',
+  });
+
+  return waitForChildProcess(child, 'node', data);
+}
+
+/**
+ * @param {string} rootDir
+ * @param {string} useYarn
+ * @param {boolean} dependenciesAreDevelopment
+ * @param {string} dependencies
+ * @returns Promise<void>
+ */
+function install(rootDir, useYarn, dependenciesAreDevelopment, dependencies) {
+  /** @type string */
+  let command;
+
+  /** @type string[] */
+  let args = [];
+
+  if (useYarn) {
+    command = 'yarn';
+    args = ['add', '--exact'];
+    if (dependenciesAreDevelopment) {
+      args.push('-D');
+    }
+    args.push(...dependencies);
+  } else {
+    command = 'npm';
+    args = ['install', dependenciesAreDevelopment ? '--save-dev' : '--save', '--loglevel', 'error', ...dependencies];
+  }
+
+  const child = spawn(command, args, { stdio: 'inherit', cwd: rootDir });
+
+  return waitForChildProcess(child, command, args);
+}
+
+function waitForChildProcess(child, command, args) {
+  return new Promise((resolve, reject) => {
+    child.on('close', (code) => {
+      if (code !== 0) {
+        reject({
+          command: `${command} ${args.join(' ')}`,
+        });
+        return;
+      }
+      resolve();
+    });
+  });
+}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@i2analyze/create-connector",
+  "version": "2.0.0-next.0",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "homepage": "https://github.com/i2group/analyze-connect-node-sdk",
+  "bin": "index.js",
+  "files": [
+    "index.js",
+    "main.js"
+  ],
+  "devDependencies": {
+    "@i2analyze/i2connect-scripts": "2.0.0-next.5",
+    "@types/node-fetch": "^2.5.12",
+    "node-fetch": "^2.6.1"
+  },
+  "dependencies": {
+    "chalk": "^4.1.0",
+    "commander": "^8.0.0",
+    "cross-spawn": "^7.0.3",
+    "file-uri-to-path": "^2.0.0",
+    "file-url": "^3.0.0"
+  },
+  "engines": {
+    "node": ">=14"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  },
+  "scripts": {
+    "lint": "eslint .",
+    "test": "node ./test.js"
+  }
+}