initial commit

Author: ossgroupp

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 OSSPIM
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

git.js

@@ -0,0 +1,56 @@
+const execSync = require('child_process').execSync;
+const fs = require('fs-extra');
+const path = require('path');
+const { logInfo, logError, logDebug } = require('./log');
+
+/**
+ * Initialises a repository and creates an initial commit. Deletes existing
+ * .git folder if it already exists and reinitialises the repo.
+ *
+ * @param {string} projectPath The path of the project
+ */
+const initialiseRepository = projectPath => {
+  logInfo('Initialising git repository');
+  process.chdir(projectPath);
+
+  if (fs.existsSync(path.resolve(projectPath, '.git'))) {
+    fs.removeSync(path.resolve(projectPath, '.git'));
+  }
+
+  try {
+    execSync('git init', { stdio: 'ignore' });
+    execSync('git add -A', { stdio: 'ignore' });
+    execSync('git commit -m "Initial commit"', { stdio: 'ignore' });
+    return true;
+  } catch (err) {
+    // Perhaps git is not installed
+    logError('Unable to initialise a git repository');
+    return false;
+  }
+};
+
+/**
+ * Clones a repository from the specified git remote.
+ *
+ * @param {string} remote The git remote to clone
+ * @param {string} destination The destination folder
+ */
+const cloneRepository = (remote, destination) => {
+  logInfo(`Cloning ${remote}`);
+
+  try {
+    execSync(`git clone --depth 1 ${remote} ${destination}`);
+    return true;
+  } catch (err) {
+    logDebug(err);
+
+    // Perhaps git is not installed
+    logError(`Unable to clone ${remote}`);
+    return false;
+  }
+};
+
+module.exports = {
+  initialiseRepository,
+  cloneRepository
+};

index.js

@@ -0,0 +1,9 @@
+const git = require('./git');
+const log = require('./log');
+const node = require('./node');
+
+module.exports = {
+  ...git,
+  ...log,
+  ...node
+};

log.js

@@ -0,0 +1,20 @@
+const chalk = require('chalk');
+
+const logDebug = (...parts) => {
+  if (process.env.DEV) {
+    console.log(chalk.blue('debug'), ...parts);
+  }
+};
+
+const logError = (...parts) => console.log(chalk.red('error'), ...parts);
+const logInfo = (...parts) => console.log(chalk.blue('info'), ...parts);
+const logSuccess = (...parts) => console.log(chalk.green('success'), ...parts);
+const logWarning = (...parts) => console.log(chalk.yellow('warning'), ...parts);
+
+module.exports = {
+  logDebug,
+  logError,
+  logInfo,
+  logSuccess,
+  logWarning
+};

node.js

@@ -0,0 +1,31 @@
+const execSync = require('child_process').execSync;
+const { logInfo } = require('./log');
+
+/**
+ * Determines whether yarn is installed.
+ */
+const shouldUseYarn = () => {
+  try {
+    execSync('yarnpkg --version', { stdio: 'ignore' });
+    return true;
+  } catch (e) {
+    return false;
+  }
+};
+
+/**
+ * Installs Node dependencies using either npm or Yarn.
+ *
+ * @param {boolean} useYarn Should Yarn be used for installing dependencies?
+ * @param {array} dependencies Array of dependencies to install
+ */
+const installNodeDependencies = useYarn => {
+  execSync(useYarn ? 'yarnpkg install' : 'npm install', {
+    stdio: 'inherit'
+  });
+};
+
+module.exports = {
+  shouldUseYarn,
+  installNodeDependencies
+};

package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@osspim/cli-utils",
+  "version": "1.0.2",
+  "main": "index.js",
+  "license": "MIT",
+  "dependencies": {
+    "chalk": "^2.4.2",
+    "fs-extra": "^8.1.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}