Merge pull request #10 from citizensas/custom-branch-name

Custom branch name

README.md

@@ -32,6 +32,7 @@ Just put the command in your package.json scripts section.
 
 | Flag              | Default value | Description                                          |
 | :---------------- | :------------ | :--------------------------------------------------- |
+| `-b, --branch`    | `origin`      | Specify a custom branch name to be pushed to your repository                               |
 | `-r, --remote`    | `origin`      | Git remote name to use                               |
 | `-p, --protocole` | `git+ssh`     | Git protocol (i.e. git+ssh, https)                   |
 | `--token`         |               | Git user token for remote authentication             |

package.json

@@ -17,7 +17,7 @@
     },
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/citizensas/generate-preview.git"
+        "url": "https://github.com/citizensas/generate-preview.git"
     },
     "author": "Sassoun Derderian",
     "bugs": {
@@ -26,26 +26,26 @@
     "homepage": "https://github.com/citizensas/generate-preview#readme",
     "license": "MIT",
     "dependencies": {
-        "commander": "4.1.0",
+        "commander": "^5.0.0",
         "git-url-parse": "11.1.2",
-        "rimraf": "3.0.0",
-        "simple-git": "1.129.0",
-        "tar": "5.0.5",
-        "tempy": "0.3.0",
+        "rimraf": "^3.0.2",
+        "simple-git": "^1.132.0",
+        "tar": "^6.0.1",
+        "tempy": "^0.3.0",
         "winston": "3.2.1"
     },
     "devDependencies": {
         "@types/git-url-parse": "^9.0.0",
-        "@types/node": "^13.1.6",
-        "@types/rimraf": "^2.0.2",
+        "@types/node": "^13.11.1",
+        "@types/rimraf": "^3.0.0",
         "@types/tar": "^4.0.3",
         "husky": "^4.0.6",
-        "prettier": "^1.15.2",
+        "prettier": "^2.0.4",
         "pretty-quick": "^2.0.1",
         "typescript": "^3.6.4"
     },
     "engines": {
-        "node": ">=8",
-        "npm": ">=5.2"
+        "node": ">=10",
+        "npm": ">=5.6.0"
     }
 }

src/cleanup.ts

@@ -4,11 +4,11 @@ import {logger} from './logger'
 export function cleanup(pathsToRemove: string[]) {
     logger.info('Cleaning up')
     const promises: Array<Promise<void>> = []
-    pathsToRemove.forEach(path => {
+    pathsToRemove.forEach((path) => {
         logger.verbose(`Removing ${path}`)
         promises.push(
             new Promise((resolve, reject) => {
-                rimraf(path, err => {
+                rimraf(path, (err) => {
                     if (err) {
                         reject(err)
                     } else {

src/cliFlags.ts

@@ -2,6 +2,7 @@ export interface IFlags {
     remoteName: string
     protocol: string
     token: string
+    branchName?: string
 }
 
 let flags: IFlags

src/constants.ts

@@ -13,5 +13,5 @@ export const REMOTE_URL_TYPES = {
     FTP: 'ftp',
     FTPS: 'ftps',
     HTTPS: 'https',
-    HTTP: 'http'
+    HTTP: 'http',
 } as const

src/generate-preview.ts

@@ -24,7 +24,7 @@ export function generatePreview(flags: IFlags) {
                     return {
                         pathsToRemove: [TMP_DIR, packedFilePath],
                         remoteUrl: remoteUrl,
-                        distBranchName: distBranchName
+                        distBranchName: distBranchName,
                     }
                 })
                 .catch((err: unknown) =>
@@ -33,7 +33,7 @@ export function generatePreview(flags: IFlags) {
                     })
                 )
         })
-        .then(res =>
+        .then((res) =>
             cleanup(res.pathsToRemove).then(() => {
                 logger.info(
                     `Now you can install generated URL in you module using Yarn or NPM. Just run the following command.`
@@ -43,7 +43,7 @@ export function generatePreview(flags: IFlags) {
                 console.log(`yarn add ${res.remoteUrl}#${res.distBranchName}`)
             })
         )
-        .catch(err => {
+        .catch((err) => {
             logger.error(err)
             process.exit(1)
         })

src/getBranchName.ts

@@ -1,15 +1,21 @@
 import * as gitP from 'simple-git/promise'
 import {MODULE_DIR} from './constants'
 import {logger} from './logger'
+import {getFlags} from './cliFlags'
 
 const moduleGit = gitP(MODULE_DIR)
 
 export function getBranchName() {
+    const {branchName} = getFlags()
     logger.verbose('Getting branch name')
+    if (branchName) {
+        logger.info(`Branch name: ${branchName}`)
+        return Promise.resolve(branchName)
+    }
     return moduleGit
         .branchLocal()
-        .then(branchSummary => branchSummary.current)
-        .then(branchName => {
+        .then((branchSummary) => branchSummary.current)
+        .then((branchName) => {
             logger.info(`Branch name: ${branchName}-dist`)
             return branchName + '-dist'
         })

src/getRemoteUrl.ts

@@ -11,14 +11,14 @@ export function getRemoteUrl() {
     logger.verbose('Getting remote url')
     return moduleGit
         .getRemotes(true)
-        .then(remotes => {
-            const remoteFound = remotes.find(remote => remote.name === remoteName)
+        .then((remotes) => {
+            const remoteFound = remotes.find((remote) => remote.name === remoteName)
             if (remoteFound) {
                 return remoteFound
             }
             throw `Remote "${remoteName}" not found.`
         })
-        .then(remote => {
+        .then((remote) => {
             const parsedUrl = GitUrlParse(remote.refs.fetch)
             let remoteUrl
             if (

src/index.ts

@@ -9,6 +9,7 @@ const pkg = require('../package.json')
 program
     .version(pkg.version)
     .name('npx generate-preview')
+    .option('-b, --branch [name]', 'specify a custom branch name to be pushed to your repository')
     .option('-r, --remote [name]', 'git remote name to use', REMOTE_NAME)
     .option('-p, --protocol [protocol]', 'git protocol (i.e. git+ssh, https)', REMOTE_URL_TYPES.GIT_SSH)
     .option('--verbose', 'prints higher level of logs')
@@ -22,5 +23,6 @@ logger.info(`Running generate-preview with version ${pkg.version}`)
 generatePreview({
     remoteName: program.remote,
     protocol: program.protocol,
-    token: program.token
+    token: program.token,
+    branchName: program.branch,
 })

src/initializeGit.ts

@@ -6,7 +6,7 @@ import {logger} from './logger'
 
 function createTempDirectory(dir: string) {
     return new Promise<void>((resolve, reject) => {
-        fs.mkdir(dir, {recursive: true}, err => {
+        fs.mkdir(dir, {recursive: true}, (err) => {
             if (err) {
                 reject(err)
             } else {

src/logger.ts

@@ -8,7 +8,7 @@ export function initLogger(level: TLoglevels) {
     logger = createLogger({
         level: level,
         format: format.cli(),
-        transports: [new transports.Console()]
+        transports: [new transports.Console()],
     })
 }
 

src/npmPack.ts

@@ -6,7 +6,7 @@ import {logger} from './logger'
 export function npmPack() {
     logger.verbose(`Packing ${PACKAGE_JSON.name}`)
     return new Promise<string>((resolve, reject) =>
-        child_process.exec(`npm_config_loglevel=silent npm pack`, {cwd: MODULE_DIR, maxBuffer: 1024 * 500}, function(
+        child_process.exec(`npm_config_loglevel=silent npm pack`, {cwd: MODULE_DIR, maxBuffer: 1024 * 500}, function (
             err,
             stdout
         ) {

src/unpack.ts

@@ -7,9 +7,9 @@ export function unpack(packedFilename: string) {
     return tar
         .x({
             file: packedFilename,
-            cwd: TMP_DIR
+            cwd: TMP_DIR,
         })
-        .then(result => {
+        .then((result) => {
             logger.verbose(`Package "${PACKAGE_JSON.name}" unpacked in ${TMP_PACKAGE_DIR}`)
             return result
         })